NAME

cxPickHitConeGet - get detail information about a pick hit on a cone

C SPECIFICATION

#include <cx/Pick.h>

cxErrorCode cxPickHitConeGet(
cxPick *pick,
int n,
long *part)

FORTRAN SPECIFICATION

integer function cxPickHitConeGet(pick,n,part)
integer pick
integer n
integer part

PARAMETERS

pick: Pick data structure to interrogate.
n: Index of hit in pick structure.
part: Part of the cone intersected.

FUNCTION RETURN VALUE

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

DESCRIPTION

This function extracts detail hit information about a cone. The part of the cone is returned in part. The part information is a set of bit flags identical to those used in Inventor:

  Side = 0x01
  Bottom = 0x02
  All = 0x03

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 cxPickHitConeGet, because the request is simply ignored when the pointer comes in NULL.

Last modified: Mon Nov 18 13:52:00 GMT 1996
[ Documentation Home ]