NAME

cxPickHitPointGet - get detail information about a pick hit on a point

C SPECIFICATION

#include <cx/Pick.h>

cxErrorCode cxPickHitPointGet(
cxPick *pick,
int n,
long *index)

FORTRAN SPECIFICATION

integer function cxPickHitPointGet(pick,n,index)
integer pick
integer n
integer index

PARAMETERS

pick: Pick data structure to interrogate.
n: Index of hit in pick structure.
index: Returned index of the point in a point set.

FUNCTION RETURN VALUE

The return value for this function is an integer error code enumeration.

DESCRIPTION

This function extracts detail hit information about a point. The index of the particular point in a point set is returned in index. The function returns a nonzero value if the hit index is not valid or the hit requested is not on a point.

The function returns cx_err_none on success. A non-zero value is returned in case of an error. This will usually be because the hit is not of the proper object type.