HPS::NavigationCubeControl Class Reference

#include <sprk.h>

Inheritance diagram for HPS::NavigationCubeControl:
HPS::SprocketControl HPS::Sprocket HPS::Object

Public Types

enum  Location {
Location::TopRight, Location::TopLeft, Location::BottomRight, Location::BottomLeft,
Location::Custom
}


 

Public Member Functions

bool GetInteractivity () const
 
Location GetLocation () const
 
HPS::UTF8 GetMaterialPalette () const
 
HPS::Rectangle GetPosition () const
 
HPS::IntRectangle GetPositionOffsets () const
 
HPS::SegmentKey GetSegmentKey () const
 
float GetSize () const
 
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
 
bool GetTextVisibility () const
 
bool GetVisibility () const
 
 NavigationCubeControl (View const &in_view)
 
 NavigationCubeControl (NavigationCubeControl const &in_that)
 
 NavigationCubeControl (NavigationCubeControl &&in_that)
 
HPS::Type ObjectType () const
 
NavigationCubeControloperator= (NavigationCubeControl &&in_that)
 
NavigationCubeControloperator= (NavigationCubeControl const &in_that)
 
NavigationCubeControlSetInteractivity (bool in_interactivity)
 
NavigationCubeControlSetLocation (Location in_location, HPS::Rectangle const &in_rectangle=HPS::Rectangle(), HPS::IntRectangle in_offsets=HPS::IntRectangle::Zero())
 
NavigationCubeControlSetMaterialPalette (char const *in_material_palette)
 
NavigationCubeControlSetMaterialPaletteAndText (char const *in_material_palette, const char *in_back_string, const char *in_top_string, const char *in_left_string, const char *in_front_string, const char *in_bottom_string, const char *in_right_string, HPS::TextAttributeKit const &in_text_attributes, HPS::UTF8Array const &in_fallback_fonts=HPS::UTF8Array())
 
NavigationCubeControlSetPosition (HPS::Rectangle const &in_rectangle)
 
NavigationCubeControlSetPositionOffsets (HPS::IntRectangle const &in_offsets)
 
NavigationCubeControlSetSize (float in_size)
 
NavigationCubeControlSetText (const char *in_back_string, const char *in_top_string, const char *in_left_string, const char *in_front_string, const char *in_bottom_string, const char *in_right_string, HPS::TextAttributeKit const &in_text_attributes, HPS::UTF8Array const &in_fallback_fonts=HPS::UTF8Array())
 
NavigationCubeControlSetTextVisibility (bool in_text_visibility)
 
NavigationCubeControlSetVisibility (bool in_visibility)
 
 ~NavigationCubeControl ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::NavigationCubeControl
 
- Static Public Attributes inherited from HPS::SprocketControl
static const HPS::Type staticType = HPS::Type::SprocketControl
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::SprocketControl
SprocketControloperator= (SprocketControl &&in_that)
 
 SprocketControl (SprocketControl &&in_that)
 

Detailed Description

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

Member Enumeration Documentation

◆ Location

Enumerator
TopRight 

Position Navigation Cube on the top right corner.

TopLeft 

Position Navigation Cube on the top left corner.

BottomRight 

Position Navigation Cube on the bottom right corner.

BottomLeft 

Position Navigation Cube on the bottom left corner.

Custom 

Position Navigation Cube at a custom location.

Constructor & Destructor Documentation

◆ NavigationCubeControl() [1/3]

HPS::NavigationCubeControl::NavigationCubeControl ( View const &  in_view)
explicit

Initializes a control tied to the view in_view.

◆ NavigationCubeControl() [2/3]

HPS::NavigationCubeControl::NavigationCubeControl ( NavigationCubeControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ NavigationCubeControl() [3/3]

HPS::NavigationCubeControl::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_thatAn rvalue reference to a NavigationCubeControl to take the impl from.

◆ ~NavigationCubeControl()

HPS::NavigationCubeControl::~NavigationCubeControl ( )

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

Member Function Documentation

◆ GetInteractivity()

bool HPS::NavigationCubeControl::GetInteractivity ( ) const

Gets the interactivity of this navigation cube.

Returns
true if the navigation cube is interactive, false otherwise.

◆ GetLocation()

Location HPS::NavigationCubeControl::GetLocation ( ) const

Gets the location of the navigation cube.

Returns
The location of the navigation cube relative to the view.

◆ GetMaterialPalette()

HPS::UTF8 HPS::NavigationCubeControl::GetMaterialPalette ( ) const

Gets the material palette used for this navigation cube.

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

◆ GetPosition()

HPS::Rectangle HPS::NavigationCubeControl::GetPosition ( ) const

Gets the position of the subwindow containing the navigation cube.

Returns
The position of the subwindow containing the navigation cube.

◆ GetPositionOffsets()

HPS::IntRectangle HPS::NavigationCubeControl::GetPositionOffsets ( ) const

Gets the position of the subwindow containing the navigation cube.

Returns
The position of the subwindow containing the navigation cube.

◆ GetSegmentKey()

HPS::SegmentKey HPS::NavigationCubeControl::GetSegmentKey ( ) const

Gets the segment where this navigation cube resides.

Returns
The segment key associated with this navigation cube.

◆ GetSize()

float HPS::NavigationCubeControl::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.

◆ GetText()

bool HPS::NavigationCubeControl::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_stringThe text displayed on the back face of the navigation cube
out_top_stringThe text displayed on the top face of the navigation cube
out_left_stringThe text displayed on the left face of the navigation cube
out_front_stringThe text displayed on the front face of the navigation cube
out_bottom_stringThe text displayed on the bottom face of the navigation cube
out_right_stringThe text displayed on the right face of the navigation cube
out_text_attributesThe attributes applied to the text on the navigation cube
out_fallback_fontsThe 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.

◆ GetTextVisibility()

bool HPS::NavigationCubeControl::GetTextVisibility ( ) const

Gets the text visibility of the navigation cube.

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

◆ GetVisibility()

bool HPS::NavigationCubeControl::GetVisibility ( ) const

Gets the visibility of the navigation cube.

Returns
true if the navigation cube is visible, false otherwise.

◆ ObjectType()

HPS::Type HPS::NavigationCubeControl::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::SprocketControl.

◆ operator=() [1/2]

NavigationCubeControl& HPS::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_thatAn rvalue reference to a NavigationCubeControl to take the impl from.
Returns
A reference to this NavigationCubeControl.

◆ operator=() [2/2]

NavigationCubeControl& HPS::NavigationCubeControl::operator= ( NavigationCubeControl const &  in_that)

Share the smart-pointer.

◆ SetInteractivity()

NavigationCubeControl& 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

Parameters
in_interactivitythe interactivity of this navigation cube
Returns
A reference to this object. By default the navigation cube is not interactive

◆ SetLocation()

NavigationCubeControl& HPS::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_locationthe location of this navigation cube
in_rectanglethe position of the subwindow containing the navigation cube. Only considered if in_location is set to Custom.
in_offsetsthe 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

◆ SetMaterialPalette()

NavigationCubeControl& HPS::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_palettethe name of the material palette to be used for this navigation cube
Returns
A reference to this object.

◆ SetMaterialPaletteAndText()

NavigationCubeControl& HPS::NavigationCubeControl::SetMaterialPaletteAndText ( char const *  in_material_palette,
const char *  in_back_string,
const char *  in_top_string,
const char *  in_left_string,
const char *  in_front_string,
const char *  in_bottom_string,
const char *  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_palettethe name of the material palette to be used for this navigation cube
in_back_stringThe text to display on the back face of the navigation cube
in_top_stringThe text to display on the top face of the navigation cube
in_left_stringThe text to display on the left face of the navigation cube
in_front_stringThe text to display on the front face of the navigation cube
in_bottom_stringThe text to display on the bottom face of the navigation cube
in_right_stringThe text to display on the right face of the navigation cube
in_text_attributesThe attributes applied to the text on the navigation cube
in_fallback_fontsAn 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.

◆ SetPosition()

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

Sets the position of the subwindow containing this navigation cube.

Parameters
in_rectanglea rectangle describing the subwindow containing the navigation cube
Returns
A reference to this object.

◆ SetPositionOffsets()

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

Sets the position of the subwindow containing the navigation cube.

Parameters
in_offsetsa rectangle describing the offsets being applied to the current position.
Returns
A reference to this object.

◆ SetSize()

NavigationCubeControl& HPS::NavigationCubeControl::SetSize ( float  in_size)

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

Parameters
in_sizeThe 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

◆ SetText()

NavigationCubeControl& HPS::NavigationCubeControl::SetText ( const char *  in_back_string,
const char *  in_top_string,
const char *  in_left_string,
const char *  in_front_string,
const char *  in_bottom_string,
const char *  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_stringThe text to display on the back face of the navigation cube
in_top_stringThe text to display on the top face of the navigation cube
in_left_stringThe text to display on the left face of the navigation cube
in_front_stringThe text to display on the front face of the navigation cube
in_bottom_stringThe text to display on the bottom face of the navigation cube
in_right_stringThe text to display on the right face of the navigation cube
in_text_attributesThe attributes applied to the text on the navigation cube
in_fallback_fontsAn 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.

◆ SetTextVisibility()

NavigationCubeControl& HPS::NavigationCubeControl::SetTextVisibility ( bool  in_text_visibility)

Sets the text visibility of this navigation cube.

Parameters
in_text_visibilitythe visibility of the text for this navigation cube
Returns
A reference to this object.

◆ SetVisibility()

NavigationCubeControl& HPS::NavigationCubeControl::SetVisibility ( bool  in_visibility)

Sets the visibility of this navigation cube.

Parameters
in_visibilitythe visibility of this navigation cube
Returns
A reference to this object. By default the navigation cube is not visible

The documentation for this class was generated from the following file: