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.

Note

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

Public Types

enum Location

Values:

enumerator TopRight

Position Navigation Cube on the top right corner.

enumerator TopLeft

Position Navigation Cube on the top left corner.

enumerator BottomRight

Position Navigation Cube on the bottom right corner.

enumerator BottomLeft

Position Navigation Cube on the bottom left corner.

enumerator Custom

Position Navigation Cube at a custom location.

Public Functions

bool GetInteractivity() const

Gets the interactivity of this navigation cube.

Returns

true if the navigation cube is interactive, false otherwise.

Location GetLocation() const

Gets the location of the navigation cube.

Returns

The location of the navigation cube relative to the view.

HPS::UTF8 GetMaterialPalette() const

Gets the material palette used for this navigation cube.

Returns

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

HPS::Rectangle GetPosition() const

Gets the position of the subwindow containing the navigation cube.

Returns

The position of the subwindow containing the navigation cube.

HPS::IntRectangle GetPositionOffsets() const

Gets the position of the subwindow containing the navigation cube.

Returns

The offset to the initial position of the subwindow containing the navigation cube.

HPS::SegmentKey GetSegmentKey() const

Gets the segment where this navigation cube resides.

Returns

The segment key associated with this navigation cube.

float GetSize() const

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

Returns

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 GetText(UTF8 &out_back_string, UTF8 &out_top_string, UTF8 &out_left_string, UTF8 &out_front_string, UTF8 &out_bottom_string, UTF8 &out_right_string, HPS::TextAttributeKit &out_text_attributes, HPS::UTF8Array &out_fallback_fonts) const

Gets the text displayed on the navigation cube.

Parameters

• out_back_string – The text displayed on the back face of the navigation cube

• out_top_string – The text displayed on the top face of the navigation cube

• out_left_string – The text displayed on the left face of the navigation cube

• out_front_string – The text displayed on the front face of the navigation cube

• out_bottom_string – The text displayed on the bottom face of the navigation cube

• out_right_string – The text displayed on the right face of the navigation cube

• out_text_attributes – The attributes applied to the text on the navigation cube

• out_fallback_fonts – The fonts that will be used if the preferred font specified when setting text could not be found at runtime. Can be empty.

Returns

true if the navigation cube text was retrieved successfully, false otherwise.

bool GetTextVisibility() const

Gets the text visibility of the navigation cube.

Returns

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

bool GetVisibility() const

Gets the visibility of the navigation cube.

Returns

true if the navigation cube is visible, false otherwise.

NavigationCubeControl(NavigationCubeControl &&in_that)

The move constructor creates a NavigationCubeControl by transferring the underlying impl of the rvalue reference to this NavigationCubeControl thereby avoiding a copy and allocation.

Parameters

in_that – An rvalue reference to a NavigationCubeControl to take the impl from.

NavigationCubeControl(NavigationCubeControl const &in_that)

Initializes a control tied to the same object as in_that.

explicit NavigationCubeControl(View const &in_view)

Initializes a control tied to the view in_view.

inline virtual HPS::Type ObjectType() const

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).

Returns

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

NavigationCubeControl &operator=(NavigationCubeControl &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this NavigationCubeControl thereby avoiding a copy.

Parameters

in_that – An rvalue reference to a NavigationCubeControl to take the impl from.

Returns

A reference to this NavigationCubeControl.

NavigationCubeControl &operator=(NavigationCubeControl const &in_that)

Share the smart-pointer.

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

Parameters

in_interactivity – the interactivity of this navigation cube

Returns

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

NavigationCubeControl &SetLocation(Location in_location, HPS::Rectangle const &in_rectangle = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero())

Sets the location of this navigation cube.

Parameters

• in_location – the location of this navigation cube

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

• in_offsets – the pixel-space rectangle to offset to the given position. only used when in_location is Custom

Returns

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

NavigationCubeControl &SetMaterialPalette(char const *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

Parameters

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

Returns

A reference to this object.

NavigationCubeControl &SetMaterialPaletteAndText(char const *in_material_palette, char const *in_back_string, char const *in_top_string, char const *in_left_string, char const *in_front_string, char const *in_bottom_string, char const *in_right_string, HPS::TextAttributeKit const &in_text_attributes, HPS::UTF8Array const &in_fallback_fonts = HPS::UTF8Array())

Sets the material palette and text displayed on the navigation cube. note that if you plan on using the navigation cube on a very large and pixel dense screen (example: a large TV), if you wish to specify a custom text size, you should do so using one of the window relative text sizes. 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

Parameters

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

• in_back_string – The text to display on the back face of the navigation cube

• in_top_string – The text to display on the top face of the navigation cube

• in_left_string – The text to display on the left face of the navigation cube

• in_front_string – The text to display on the front face of the navigation cube

• in_bottom_string – The text to display on the bottom face of the navigation cube

• in_right_string – The text to display on the right face of the navigation cube

• in_text_attributes – The attributes applied to the text on the navigation cube

• in_fallback_fonts – An array of fonts to use in case the one specified in in_text_attributes cannot be found at runtime. Generally this should be the same array passed to SetFallbackFonts. If the font specified is not found at runtime, and no fallback fonts are specified, a stroked representation of the text will be used. Non-Latin characters might render as boxes in this eventuality.

Returns

A reference to this object.

NavigationCubeControl &SetPosition(HPS::Rectangle const &in_rectangle)

Sets the position of the subwindow containing this navigation cube.

Parameters

in_rectangle – a rectangle describing the subwindow containing the navigation cube

Returns

A reference to this object.

NavigationCubeControl &SetPositionOffsets(HPS::IntRectangle const &in_offsets)

Sets the position of the subwindow containing the navigation cube.

Parameters

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

Returns

A reference to this object.

NavigationCubeControl &SetSize(float in_size)

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

Parameters

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

Returns

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

NavigationCubeControl &SetText(char const *in_back_string, char const *in_top_string, char const *in_left_string, char const *in_front_string, char const *in_bottom_string, char const *in_right_string, HPS::TextAttributeKit const &in_text_attributes, HPS::UTF8Array const &in_fallback_fonts = HPS::UTF8Array())

Sets the text displayed on the navigation cube. note that if you plan on using the navigation cube on a very large and pixel dense screen (example: a large TV), if you wish to specify a custom text size, you should do so using one of the window relative text sizes.

Parameters

• in_back_string – The text to display on the back face of the navigation cube

• in_top_string – The text to display on the top face of the navigation cube

• in_left_string – The text to display on the left face of the navigation cube

• in_front_string – The text to display on the front face of the navigation cube

• in_bottom_string – The text to display on the bottom face of the navigation cube

• in_right_string – The text to display on the right face of the navigation cube

• in_text_attributes – The attributes applied to the text on the navigation cube

• in_fallback_fonts – An array of fonts to use in case the one specified in in_text_attributes cannot be found at runtime. Generally this should be the same array passed to SetFallbackFonts. If the font specified is not found at runtime, and no fallback fonts are specified, a stroked representation of the text will be used. Non-Latin characters might render as boxes in this eventuality.

Returns

A reference to this object.

NavigationCubeControl &SetTextVisibility(bool in_text_visibility)

Sets the text visibility of this navigation cube.

Parameters

in_text_visibility – the visibility of the text for this navigation cube

Returns

A reference to this object.

NavigationCubeControl &SetVisibility(bool in_visibility)

Sets the visibility of this navigation cube.

Parameters

in_visibility – the visibility of this navigation cube

Returns

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

~NavigationCubeControl()

Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::NavigationCubeControl