graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPGTPK - Get Pick

GPGTPK (length, depth, pickpath)

Purpose

Use GPGTPK 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 value consists of a pick path describing the position of the picked primitive in the structure network. The pick path is returned in the order specified in the Initialize Pick (GPINPK) subroutine, that is, 1=TOP_FIRST or 2=BOTTOM_FIRST If GPINPK has not been called, the default value is 1=TOP_FIRST

The device to which this value corresponds was identified on the previous invocation of GPAWEV (like other Get subroutines)

Parameters

length -- specified by user, fullword integer

Length of the array provided by the application for return of the pick path data (>=0)

This value is specified as the size of the pick path array in pickpath entries. Each entry in the path is three fullword integers. If the actual pick information is longer than the pick path array provided by the application, the overage is truncated.

depth -- returned by the graPHIGS API, fullword integer

Depth of pick path returned in the pickpath parameter.

This value is specified as the size of the pick path array in pickpath entries. Each entry in the path is three fullword integers.

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

Array containing the pick path. The array consists of structure identifier, pick identifier, and element number triplets, making up the path to the picked primitive. The path is returned in the order specified by the initialize pick subroutine.

If the actual pick information is longer than the pickpath array provided by the application, then the overage is truncated.

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     |    Element #1    |
          |                  |                  |                  |
 Entry 2  |  Structure ID 2  |    Pick ID 2     |    Element #2    |
          |                  |                  |                  |
   .      |        .         |        .         |        .         |
   .      |        .         |        .         |        .         |
   .      |        .         |        .         |        .         |
          |                  |                  |                  |
 Entry N  |  Structure ID N  |    Pick ID 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
GPGTXP: Get Extended Pick

RCP code

201336069 (X'0C002505')