graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPINPK - Initialize Pick

GPINPK (wsid, device, depth, pickpath, echo, area, datalen, data, order)

Purpose

Use GPINPK to initialize the specified pick device.

The Initialize Pick subroutine stores the prompt/echo type, echo area, initial pick path depth, initial pick path, pick data record and pick path order in the workstation state list for the specified device.

Note:

The pick device must be in Request Mode.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

device -- specified by user, fullword integer

Pick device number (>=1)

depth -- specified by user, fullword integer

Initial pick path depth (>=0)

pickpath -- specified by user, array of fullword integers

Initial pick path. Specified as a list of triplets where each triplet represents the structure identifier, pick identifier, and element number of the initial path.

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

Note: The initial pick path is ignored.

echo -- specified by user, fullword integer

Prompt/echo type (>=1)

area -- specified by user, 6 short floating-point numbers (DC)

Echo area (Xmin, Xmax, Ymin, Ymax, Zmin, Zmax)

datalen -- specified by user, fullword integer

Data record length in bytes (>=0)

Note:

The data record length parameter must equal zero (datalen=0) if no data record is required for the given prompt/echo type. For prompt/echo types which require a data record, the specified data record length must be greater than or equal to 12.

data -- specified by user, variable data

Pick data record.

order -- specified by user, fullword integer

Pick path order for returning subsequent pick input values (1=TOP_FIRST, 2=BOTTOM_FIRST ) The default value is 1=TOP_FIRST

Prompt/echo Types

Type One

uses a workstation-dependent technique that highlights the picked primitive. No data record is required.

Error Codes

25: SPECIFIED WORKSTATION DOES NOT EXIST
140: DEVICE NUMBER < ONE OR DEVICE NOT AVAILABLE
141: INPUT DEVICE NOT IN CORRECT MODE
144: PROMPT/ECHO TYPE NOT AVAILABLE ON WORKSTATION
145: ECHO AREA BOUNDARY VALUE IN ERROR
146: FIELD IN INPUT DEVICE DATA RECORD IN ERROR
156: PICK PATH ORDER IS INVALID
158: INVALID ELEMENTS IN THE INITIAL PICK PATH
324: PROMPT/ECHO TYPE < ONE
502: FIELD IN DATA RECORD NOT SUPPORTED ON WORKSTATION
506: NUMBER OF INITIAL VALUES < ZERO
509: DATA LENGTH VALUE < ZERO OR REQUIRED LENGTH
513: NUMBER OF INITIAL VALUES EXCEEDS DEVICE MAXIMUM

Related Subroutines

GPADCN: Add Class Name to Set
GPPKF: Set Pick Filter
GPPKID: Set Pick Identifier
GPPKMO: Set Pick Mode
GPRCN: Remove Class Name from Set
GPQDPK: Inquire Default Pick Device Data
GPQDS: Inquire Maximum Display Surface Size
GPQLI: Inquire List of Logical Input Devices
GPQPK: Inquire Pick Device State

RCP code

201335301 (X'0C002205')