Name

pget_pick − Returns the pick path list. 

Operating States: PHOP, WSOP, ∗, ∗
PHIGS standard function

Syntax

void pget_pick (
  Pint           depth,       /∗ (I) Maximum depth of the pick path to
                                     return ∗/
  Pin_status    ∗in_status,   /∗ (O) Pick status ∗/
  Ppick_path    ∗pick         /∗ (O) Pick path ∗/
)

Data Structures

typedef enum {
    PIN_STATUS_NONE,    /∗ user performed a break action ∗/
    PIN_STATUS_OK,      /∗ user picked a primitive ∗/
    PIN_STATUS_NO_IN    /∗ user triggered the device, but did not make a
                           selection ∗/
} Pin_status;
typedef struct {
    Pint                depth;        /∗ pick path depth ∗/
    Ppick_path_elem    ∗path_list;    /∗ pick path list ∗/
} Ppick_path;
    typedef struct {
        Pint    struct_id;    /∗ structure identifier ∗/
        Pint    pick_id;      /∗ pick identifier ∗/
        Pint    elem_pos;     /∗ element position ∗/
    } Ppick_path_elem;

Description

pget_pick obtains information contained in the current event report entry.  If the report contains input generated by anything other than a pick-class input device, a call to this function generates an error.  (See the pawait_event function for more information about input classes and the current event report entry.) 

The pick path is a list Digital PHIGS uses to trace the traversal of the structure hierarchy and to identify uniquely the picked structure.  The individual components of the list contain the following integer values:

•Structure identifier

•Pick identifier of the element

•Offset (by element) into the structure

The function returns the pick path in the order (TOPFIRST or BOTTOMFIRST) specified by the pick path order entry in the workstation state list. 

See the pinit_pick function for information about how to establish a pick path order (top first or bottom first). 

See Also

pawait_event
pflush_events
pinit_pick
pinit_pick3
preq_pick
psample_pick
pset_pick_filter
pe_set_pick_highl_ind
pset_pick_id
pset_pick_mode