poINote SetPosition

Sets the note position.

Syntax

poINote_handle SetPosition location

poINote_handle SetPosition {x_pos y_pos}

poINote_handle SetPosition {x_pos y_pos z_pos}

Application

HyperView Tcl Modify

Description

This command sets the note position.

Inputs

This command has two possible argument types:
Two value list: used with the "screen" position type (see poINote::SetPositionType)
x_pos:
The x coordinate on the screen; value between 0 (left) and 1 (right).
y_pos:
The y coordinate on the screen; value between 0 (top) and 1 (bottom).
Three value list: used with the “coordinate” position type (see poINote::SetPositionType)
x_pos:
The x coordinate in model coordinates.
y_pos:
The y coordinate in model coordinates.
z_pos:
The z coordinate in model coordinates.

Example

To position a note at the top left corner of the modeling window:
poINote_handle SetPosition 0 0;
poiPost_handle Draw;
To position a note at the center of the modeling window:
poINote_handle SetPosition 0.5 0.5;
poiPost_handle Draw;
To position a note at the model center:
poINote_handle SetPositionType coordinates
poINote_handle SetPosition 0.0 0.0 0.0
poiPost_handle Draw;

Errors

Returns 0 if successful, otherwise an error code.