HPS.NavigationCubeControl

class HPS.NavigationCubeControl : public HPS.SprocketControl

The NavigationCubeControl allows you to turn on or off the navigation cube, move it to a specific corner of the screen, change the material palette used to style it, or otherwise manipulate it. To allow your users to interact with the Navigation Cube, see HPS.NavigationCubeOperator

.

The orientation of the

NavigationCubeControl is specified by the model in the associated view. See HPS.Model.SetOrientation().

Note

Public Functions

bool GetInteractivity ()

Gets the interactivity of this navigation cube.

Return

true if the navigation cube is interactive, false otherwise.

HPS.NavigationCubeControl.Location GetLocation ()

Gets the location of the navigation cube.

Return

The location of the navigation cube relative to the view.

string GetMaterialPalette ()

Gets the material palette used for this navigation cube.

Return

The name of the material palette used for this navigation cube.

HPS.Rectangle GetPosition ()

Gets the position of the subwindow containing the navigation cube.

Return

The position of the subwindow containing the navigation cube.

HPS.IntRectangle GetPositionOffsets ()

Gets the position of the subwindow containing the navigation cube.

Return

The position of the subwindow containing the navigation cube.

HPS.SegmentKey GetSegmentKey ()

Gets the segment where this navigation cube resides.

Return

The segment key associated with this navigation cube.

float GetSize ()

Gets the size of the subwindow containing the navigation cube, as a percentage of the main window.

Return

the size of the subwindow containing the navigation cube, 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 navigation cube.

Return

true if the text on the navigation cube is visible, false otherwise.

bool GetVisibility ()

Gets the visibility of the navigation cube.

Return

true if the navigation cube is visible, false otherwise.

NavigationCubeControl (HPS.NavigationCubeControl in_that)

Initializes a control tied to the same object as in_that.

NavigationCubeControl (HPS.View in_view)

Initializes a control tied to the view in_view.

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.NavigationCubeControl SetInteractivity (bool in_interactivity)

Sets the interactivity of this navigation cube. When the navigation cube is interactive, dragging the triad will rotate the scene and clicking on a face, edge or vertex of the cube will snap the camera to the appropriate plane. Making the Navigation Cube interactive pushes the Navigation Cube operator on the current View’s operator stack with High priority

Param in_interactivity

the interactivity of this navigation cube

Return

A reference to this object. By default the navigation cube is not interactive

HPS.NavigationCubeControl SetLocation (HPS.NavigationCubeControl.Location in_location)

Sets the location of this navigation cube.

Param in_location

the location of this navigation cube

Return

A reference to this object. By default the navigation cube is set to the top right corner of the View

HPS.NavigationCubeControl SetLocation (HPS.NavigationCubeControl.Location in_location, HPS.Rectangle in_rectangle)

Sets the location of this navigation cube.

Param in_location

the location of this navigation cube

Param in_rectangle

the position of the subwindow containing the navigation cube. Only considered if in_location is set to Custom.

Return

A reference to this object. By default the navigation cube is set to the top right corner of the View

HPS.NavigationCubeControl SetLocation (HPS.NavigationCubeControl.Location in_location, HPS.Rectangle in_rectangle, HPS.IntRectangle in_offsets)

Sets the location of this navigation cube.

Param in_location

the location of this navigation cube

Param in_rectangle

the position of the subwindow containing the navigation cube. Only considered if in_location is set to 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 navigation cube is set to the top right corner of the View

HPS.NavigationCubeControl SetMaterialPalette (string in_material_palette)

Sets the material palette of this navigation cube. The material palette supplied to this function should originate from a material kit array with 9 entries. The entries in the material kit array are applied to the navigation cube as follows: Entry 0 - back face color Entry 1 - top face color Entry 2 - left face color Entry 3 - front face color Entry 4 - bottom face color Entry 5 - right face color Entry 6 - mouse-over highlight color Entry 7 - text color Entry 8 - line color

Param in_material_palette

the name of the material palette to be used for this navigation cube

Return

A reference to this object.

HPS.NavigationCubeControl SetPosition (HPS.Rectangle in_rectangle)

Sets the position of the subwindow containing this navigation cube.

Param in_rectangle

a rectangle describing the subwindow containing the navigation cube

Return

A reference to this object.

HPS.NavigationCubeControl SetPositionOffsets (HPS.IntRectangle in_offsets)

Sets the position of the subwindow containing the navigation cube.

Param in_offsets

a rectangle describing the offsets being applied to the current position.

Return

A reference to this object.

HPS.NavigationCubeControl SetSize (float in_size)

Sets the size of the subwindow containing the navigation cube, as a percentage of the main window.

Param in_size

The size of the subwindow containing the navigation cube, as a percentage of the main window. [0-1]

Return

A reference to this object. By default the navigation cube subwindow is 20% of the main window

HPS.NavigationCubeControl SetTextVisibility (bool in_text_visibility)

Sets the text visibility of this navigation cube.

Param in_text_visibility

the visibility of the text for this navigation cube

Return

A reference to this object.

HPS.NavigationCubeControl SetVisibility (bool in_visibility)

Sets the visibility of this navigation cube.

Param in_visibility

the visibility of this navigation cube

Return

A reference to this object. By default the navigation cube is not visible