SAMPLE PICK(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

SAMPLE PICK − sample the current measure of a pick device

SYNOPSIS

C Syntax

void
psample_pick ( ws, dev, depth, pick_in_status, rpick )
Pintws;workstation identifier
Pintdev;pick device number
Pintdepth;max. depth of returned path
Pin_status∗pick_in_status;OUT pick input status
Ppick_path∗rpick;OUT pick path

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use SAMPLE PICK to sample the current measure of the specified pick device without waiting for input from the operator. The device must be in SAMPLE mode. See SET PICK MODE and INITIALIZE PICK for more information.

C Input Parameters

wsWorkstation identifier. An integer specifying the workstation with which the specified pick device is associated.

devThe device number of the pick device to be sampled. See the Available Devices section of INITIALIZE PICK for a description of the available devices.

depthThe maximum number of path elements to return.

C Output Parameter

pick_in_status
Pin_status is defined in phigs.h as:

typedef enum {
PIN_STATUS_NONE,
PIN_STATUS_OK,
PIN_STATUS_NO_IN
} Pin_status;

rpickPpick_path is defined in phigs.h as:

typedef struct {
Pintdepth;/∗ pick path depth ∗/
Ppick_path_elem∗path_list;/∗ pick path list ∗/
} Ppick_path;

depth indicates the number of elements in the measure’s path. This is the depth value contained in the device’s current measure. It is not affected by the maximum depth to return parameter. Thus the number of elements returned in path_list may be less than depth.

path_list is the array of path elements defining the location of the picked primitive in the Central Structure Store (CSS). This array must be allocated by the calling program and the array pointer assigned to this field before calling this function. The array must be at least of length maximum depth to return. Ppick_path_elem is defined in phigs.h as:

typedef struct {
Pintstruct_id;/∗ structure identifier ∗/
Pintpick_id;/∗ pick identifier ∗/
Pintelem_pos; /∗ element number ∗/
} Ppick_path_elem;

struct_id, pick_id, and elem_pos are the structure identifier, pick identifier, and element number, respectively, of each element in the path.

Execution

SAMPLE PICK samples the specified pick device. The device must be in SAMPLE mode. See SET PICK MODE and INITIALIZE PICK for more information.

When a device is set to SAMPLE mode, a measure process is created for the device and the device is activated. When SAMPLE PICK is called, the current value of the measure process for the specified device is retrieved without waiting for further input from the operator.

A PICK device measure consists of a status and a pick path. The status indicates whether or not a pick by the operator was successfully resolved. The path describes the location of the picked primitive, if any, in the Central Structure Store (CSS). The pick filter of a PICK device controls which output primitives on the device’s workstation are pickable. By default, no output primitives are pickable. See SET PICK FILTER for more information on the pick filter.

ERRORS

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open

060Ignoring function, specified workstation is not of category OUTIN

250Ignoring function, the specified device is not available on the specified workstation

252Ignoring function, the function requires the input device to be in SAMPLE mode

Museum