graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPGTXP - Get Extended Pick

GPGTXP (maxdepth, view, point, modelling, depth, pickpath)

Purpose

Use GPGTXP to retrieve a pick input value from the current event report. The event is not removed from the current event report until the next invocation of the Await Event (GPAWEV) subroutine.

This subroutine can be used only for the pick event generated by a pick input device with the extended pick device type. For the pick event generated by a pick input device with the normal pick device type, the Get Pick (GPGTPK) subroutine should be used.

Parameters

maxdepth -- specified by user, fullword integer

Maximum pick path depth to be returned (>=1) This value specifies the size of the array provided in the pickpath parameter in the unit of four fullwords. If the actual pick information is longer than the pick path array provided by the application, the overage is truncated.

view -- returned by the graPHIGS API, fullword integer

Index of the view where the pick event occurred.

point -- returned by the graPHIGS API, 3 short floating-point numbers

Position of the center of pick aperture in NPC when the pick event occurred. For the normal pick input device such as a tablet, only the x value and the y value are meaningful. z value always contains a constant (0)

modelling -- returned by the graPHIGS API, 16 short floating-point numbers

Composite modelling transformation applied to the picked primitive.

depth -- returned by the graPHIGS API, fullword integer

Depth of the actual pick path returned.

pickpath -- returned by the graPHIGS API, array of fullword integers

Pick path for picked primitive. List of pick path quadruples. Each quadruple represents a structure identifier, pick identifier, label and element number of the picked primitive or an execute structure element of the pickpath The path is returned in the order specified by the Initialize Pick (GPINPK) subroutine. Pick path data is set in the pickpath parameter in the following order: Entry 1, Entry 2, ...Entry N.

          --------------------------------------------------------------------
 Entry 1  |  Structure ID 1  |  Pick ID 1    |    Label #1    |  Element #1  |
          |                  |               |                |              |
 Entry 2  |  Structure ID 2  |  Pick ID 2    |    Label #2    |  Element #2  |
          |                  |               |                |              |
   .      |        .         |      .        |       .        |       .      |
   .      |        .         |      .        |       .        |       .      |
   .      |        .         |      .        |       .        |       .      |
          |                  |               |                |              |
 Entry N  |  Structure ID N  |  Pick ID N    |    Label #N    |  Element #N  |
          --------------------------------------------------------------------

Error Codes

150: GET FUNCTION DOES NOT MATCH CURRENT EVENT CLASS
505: LENGTH OF RETURN ARRAY < ZERO
519: NO CURRENT EVENT REPORT AVAILABLE

Related Subroutines

GPAWEV: Await Event
GPGTPK: Get Pick

RCP code

201336071 (X'0C002507')