GDpick_process

Synopsis

define a module to process the pick information attached to the object

GDpick_obj_notify_templ


group GDpick_obj_notify_templ {
GDpick_info_templ &pick_info;
};


GDpick_process_notify_templ


group GDpick_process_notify_templ {
GDpick_obj_notify_templ+IPort2 &obj_in<NEcolor0=0xff0000>;
method+notify_val upd_func = "GDpick_process_update";
};

GDpick_process_templ

GDpick_process_notify_templ GDpick_process_templ {
int use_pick_data;
group &field_id;
group &coord_id;
group &node_data_array_id;
int vert_index;
group &cell_set_id;
group &conn_id;
int conn_index;
group &cell_data_array_id;
int cell_index;
};

GDpick_process


GDpick_process_templ GDpick_process;

Description

These templates define a module that processes the Graphic Display Kit pick information.

GDpick_process is connected to any GDobject that is part of the hierarchy of objects attached to a view. Whenever a pick takes place, the module runs. If a pick did not occur on the object or any of the object's children, the module returns immediately. Otherwise, the pick information attached to the object that is picked is interrogated and the output information in this group is written.

This module:

only outputs when a pick in the hierarchy it is attached to occurs

converts the pick information and pick data that is several levels down into a more useful form

can provide a mapping from the input field to the source field from which that field was generated if the module provided node or cell pick data

Input

obj_in

GDpick_obj_notify_templ. The input object to check for pick on. This template requires the input connection to have a subobject of type GDpick_info. This template also restricts execution of the module to when the pick information changes.

Parameters

use_pick_data

This parameter enables/disables the usage of pick node or cell data if it exists: 0 disables usage; 1 enables usage. Some modules provide pick data that can be used to map the pick on the field back to the source field from which it is created.

field_id

The OM object id of the field that was picked.

coord_id

The OM object id of the coordinate array in the picked field.

node_data_array_id

The OM object id of the array of node data in the picked field. Note that the id of each entry in the array needs to be retrieved.

vert_index

The index into the coordinate and node data arrays to the picked vertex data.

cell_set_id

The OM object id of the cell set in the picked field.

conn_id

The OM object id of the connectivity array in the picked field.

conn_index

The index into the connectivy array to the cell that was picked.

cell_data_array_id

The OM object id of the array of cell data in the picked field. Note that the id of each entry in the array needs to be retrieved.

cell_index

The index into the cell data array to the picked data.

Example

Not available.

File

v/gd.v

See also related modules

Not Applicable.