NAME

cxPickHitLineGet - get detail pick information on a line hit

C SPECIFICATION

#include <cx/Pick.h>

cxErrorCode cxPickHitLineGet(
cxPick *pick,
int n,
long index[2],
float point[6],
float normal[6])

FORTRAN SPECIFICATION

integer function cxPickHitLineGet(pick,n,index,point,normal)
integer pick
integer n
integer index[2]
real point(3,2)
real normal(3,2)

PARAMETERS

pick: Pick structure to interrogate.
n: Index of the requested hit in the pick structure.
index: Endpoint indices of the line segment.
point: Endpoints of the line segment.
normal: Normals at the endpoints of the line segment.

FUNCTION RETURN VALUE

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

DESCRIPTION

This function extracts detail hit information about a line segment. The indices of the endpoints are returned in index. The coordinates of the endpoints are returned in point. If this object has endpoint normals, they are returned in normal.

The function returns cx_err_none on success. A nonzero 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 cxPickHitLineGet, because the request is simply ignored when the pointer comes in NULL.

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