AxisTriadControl

class HPS.AxisTriadControl : public HPS.SprocketControl 

The AxisTriadControl allows you to turn on or off the axis triad, move it to a specific corner of the screen, change the material palette used to style it, or otherwise manipulate it.

Public Types

enum Location

Values:

TopRight: Position Axis Triad on the top right corner.

TopLeft: Position Axis Triad on the top left corner.

BottomRight: Position Axis Triad on the bottom right corner.

BottomLeft: Position Axis Triad on the bottom left corner.

Custom: Position Axis Triad at a custom location.

Public Functions

AxisTriadControl (HPS.AxisTriadControl in_that): Initializes a control tied to the same object as in_that.

AxisTriadControl (HPS.View in_view): Initializes a control tied to the view in_view.

override void Dispose ()

bool GetInteractivity ()

Gets the interactivity of this axis triad.

Return: true if the axis triad is interactive, false otherwise.

HPS.AxisTriadControl.Location GetLocation ()

Gets the location of the axis triad.

Return: The location of the axis triad relative to the view.

string GetMaterialPalette ()

Gets the material palette used for this axis triad.

Return: The name of the material palette used for this axis triad.

HPS.Rectangle GetPosition ()

Gets the position of the subwindow containing the axis triad.

Return: The position of the subwindow containing the axis triad.

HPS.IntRectangle GetPositionOffsets ()

Gets the poition of the subwindow containing the axis triad.

Return: The position of the subwindow containing the axis triad.

HPS.SegmentKey GetSegmentKey ()

Gets the segment where this axis triad resides.

Return: The segment key associated with this axis triad.

float GetSize ()

Gets the size of the subwindow containing the axis triad, as a percentage of the main window.

Return: the size of the subwindow containing the axis triad, as a percentage of the main window. If the location is Custom, this will return -1.0f.

bool GetTextVisibility ()

Gets the text visibility of the axis triad.

Return: true if the axis triad text is visible, false otherwise.

bool GetVisibility ()

Gets the visibility of the axis triad.

Return: true if the axis triad is visible, false otherwise.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return: The declared type of the object in question, which may differ from the true, underlying type.

HPS.AxisTriadControl SetInteractivity (bool in_interactivity)

Sets the interactivity of this axis triad. When the axis triad is interactive, dragging the triad will rotate the scene. Making the Axis Triad interactive pushes the Axis Triad operator on the current View’s operator stack with High priority

Param in_interactivity: the interactivity of this axis triad
Return: A reference to this object. By default the axis triad is not interactive.

HPS.AxisTriadControl SetLocation (HPS.AxisTriadControl.Location in_location)

Sets the location of this axis triad.

Param in_location: the location of this axis triad
Return: A reference to this object. By default the axis triad is placed on the bottom left corner of the View

HPS.AxisTriadControl SetLocation (HPS.AxisTriadControl.Location in_location, HPS.Rectangle in_position)

Sets the location of this axis triad.

Param in_location: the location of this axis triad
Param in_position: the position of the subwindow containing the axis triad. only used when in_location is Custom
Return: A reference to this object. By default the axis triad is placed on the bottom left corner of the View

HPS.AxisTriadControl SetLocation (HPS.AxisTriadControl.Location in_location, HPS.Rectangle in_position, HPS.IntRectangle in_offsets)

Sets the location of this axis triad.

Param in_location: the location of this axis triad
Param in_position: the position of the subwindow containing the axis triad. only used when in_location is Custom
Param in_offsets: the pixel-space rectangle to offset to the given position. only used when in_location is Custom
Return: A reference to this object. By default the axis triad is placed on the bottom left corner of the View

HPS.AxisTriadControl SetMaterialPalette (string in_material_palette)

Sets the material palette of this axis triad. The material palette supplied to this function should originate from a material kit array with 3 entries. The entries in the material kit array are applied to the navigation cube as follows: Entry 0 - x-axis color Entry 1 - y-axis color Entry 2 - z-axis color

Param in_material_palette: the name of the material palette to be used for this axis triad
Return: A reference to this object.

HPS.AxisTriadControl SetPosition (HPS.Rectangle in_position)

Sets the position of the subwindow containing the axis triad.

Param in_position: a rectangle describing the subwindow containing the axis triad.
Return: A reference to this object.

HPS.AxisTriadControl SetPositionOffsets (HPS.IntRectangle in_offsets)

Sets the position of the subwindow containing this axis triad.

Param in_offsets: a rectangle describing the offsets being applied to the current position
Return: A reference to this object.

HPS.AxisTriadControl SetSize (float in_size)

Sets the size of the subwindow containing the axis triad, as a percentage of the main window.

Param in_size: The size of the subwindow containing the axis triad, as a percentage of the main window. [0-1]
Return: A reference to this object. By default the axis triad subwindow is 20% of the main window

HPS.AxisTriadControl SetTextVisibility (bool in_text_visibility)

Sets the text visibility of this axis triad.

Param in_text_visibility: the visibility of the text for this axis triad
Return: A reference to this object.

HPS.AxisTriadControl SetVisibility (bool in_visibility)

Sets the visibility of this axis triad.

Param in_visibility: the visibility of this axis triad
Return: A reference to this object. By default the axis triad is not visible