graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPSMPK - Sample Pick

GPSMPK (wsid, device, length, depth, pickpath)

Purpose

Use GPSMPK to immediately retrieve the current measure of the specified pick device.

The pickpath information 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

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

device -- specified by user, fullword integer

Pick device number (>=1)

length -- specified by user, fullword integer

Length of pick path array provided by the application in which the graPHIGS API returns the pick information (>=0)

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

depth -- returned by the graPHIGS API, fullword integer

Depth of the pick path returned in the pickpath parameter.

A depth of the actual pick path equal to zero indicates no pick.

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

Pick path to picked primitive. List of pick path triplets where each triplet represents the structure identifier, the pick identifier and the element number of the pick path.

The pick path is returned in the order specified in the initialize pick subroutine, that is, 1=TOP_FIRST or 2=BOTTOM_FIRST

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

          ----------------------------------------------------------
 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

25: SPECIFIED WORKSTATION DOES NOT EXIST
140: DEVICE NUMBER < ONE OR DEVICE NOT AVAILABLE
505: LENGTH OF RETURN ARRAY < ZERO

Related Subroutines

GPADCN: Add Class Name to Set
GPPKF: Set Pick Filter
GPPKID: Set Pick Identifier
GPPKMO: Set Pick Mode
GPQLI: Inquire List of Logical Input Devices
GPRCN: Remove Class Name from Set
GPSMXP: Sample Extended Pick

RCP code

201335557 (X'0C002305')