NAME

cxPickGet - get information out of pick data type

C SPECIFICATION

#include <cx/Pick.h>

cxErrorCode cxPickGet( int *eventType, long *eventData, long *eventModifiers, int position[2], int windowSize[2], float origin[3], float direction[3], float projectionMatrix[16], int *numHits)

FORTRAN SPECIFICATION

integer function cxPickGet(eventType,eventData,eventModifiers,
position,windowSize,origin,direction,projectionMatrix,numHits)
integer eventType
integer eventData
integer eventModifiers
integer position(2)
integer windowSize(2)
real origin(3)
real direction(3)
real projectionMatrix(4, 4)
integer numHits

PARAMETERS

eventType
Type of event that caused the pick.
eventData
Data associated with the event.
eventModifiers
Modifiers associated with the event.
position
Position of the pointer.
windowSize
Window size.
origin
Origin of the pick in 3-space.
direction
Direction of the pick in 3-space.
projectionMatrix
Matrix describing the current view.
numHits
Number of object intersections.

FUNCTION RETURN VALUE

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

DESCRIPTION

This function extracts fields from the IRIS Explorer pick data type. The information passed in the pick structure varies to some degree with the module that created it. However, the following conventions should always be followed when possible.
Should match the X event types.
Button number for button events, ASCII value for key events.
Should match the X event modifiers.
Position of the pointer using the X origin (upper left)

The function returns cx_err_none on success and a non-zero value on an error.

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

SEE ALSO

cxPickHitGet(3E)
Last modified: Mon Nov 18 13:51:59 GMT 1996
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996