NAME

cxPickHitCylinderGet - get detail information about a pick hit on a cylinder
#include <cx/Pick.h>

cxErrorCode cxPickHitCylinderGet( cxPick *pick, int n, long *part)
integer function cxPickHitCylinderGet(pick,n,part)
integer pick
integer n
integer part
pick
Pick data structure to interrogate.
n
Index of hit in pick structure.
part
Part of the cylinder intersected.
The return value for this function is an integer error code enumeration. This function extracts detail hit information about a cylinder. The part of the cylinder is returned in part. The part information is a set of bit flags identical to those used in Inventor:
Side = 0x01
Top = 0x02
Bottom = 0x04
All = 0x07

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.

The user can tell the function not to get information on a particular field by passing a NULL pointer value. You need not create dummy variables in the calling routine which calls cxPickHitCylinderGet, because the request is simply ignored when the pointer comes in NULL.


Last modified: Mon Nov 6 16:33:38 GMT 2000
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996