MSharePointer

DESCRIPTION

This module draws a 3D arrow at a picked position. The tip of the arrow is at the picked position and, by default, its orientation is along the normal to the surface at the picked position.

Although the module fires for all types of pick events, it only updates the position of the arrow for button down pick events. For each pick event, the module ignores any hits that originate from the arrow geometry itself.

Additionally, this module has been extended to be collaboratively aware using the COVISA collaborative toolkit (version 2.0). This allows it to be used in single-user mode, or (if connected to a collaborative session using the MServer module) as a collaborative module. In collaborative mode it shares the generated geometry with its companion modules in the Map Editor's of the collaborators. Each collaborator should choose a different color to identify who created the pointer.

A full description of the COVISA module suite and API is given in the IRIS Explorer Collaborative User Guide. You are strongly advised to read this guide before using MShareGraph3D as a collaborative module.

INPUTS

Port: Position
Type: Pick
Optional: This port is optional.
Input pick port.

WIDGETS

Port: Flip?
Type: Radio Box
Menu Item: No
Menu Item: Yes
This parameter determines the direction of the arrow. By default (Flip? = No) the arrow is aligned along the direction of the unit normal to the surface at the picked postion; setting Flip? to Yes aligns it against this direction.

Port: Scale
Type: Dial
Scaling parameter for arrow geometry. By default, (Scale = 1) the arrow is one unit long (in world space coordinates).

Port: Color
Type: Text
Color string used to color the arrow. See cxParamColorFloatGet for valid color names.

Port: Initiate
Type: Button
Makes the module connect to the COVISA server to be used in collaborative mode.

Port: Connection_State
Type: Option Menu
Menu Item: Reconnect
Menu Item: Disconnect
This menu box allows the module to be disconnected and reconnected from/to the COVISA server once the initial connection has been made.

Port: Join
Type: Button
DO NOT USE THIS PORT. It is reserved for communication by underlying Skm commands.

Port: ID
Type: Slider
DO NOT USE THIS PORT. It is reserved for communication by underlying Skm commands.

Port: Name
Type: Text
DO NOT USE THIS PORT. It is reserved for communication by underlying Skm commands.

Port: Application
Type: Text
DO NOT USE THIS PORT. It is reserved for communication by underlying Skm commands.

OUTPUTS

Port: Pointer
Type: Geometry
Output arrow geometry Pointer.

KNOWN PROBLEMS

Wiring parameters into Join, ID, Name, and Application may interfere with the data communication between COVISA modules and this may lead to unexpected results.

SEE ALSO

Other COVISA toolkit modules:

MAdvisor, MServer, MShareGeom, MShareGraph3D, MShareLat, MShareLatToGeom, MShareParam, MSharePyr, cxParamColorFloatGet.

The IRIS Explorer COVISA collaborative module suite and API was developed at the University of Leeds.


[Documentation Home]