Public Types | Public Member Functions | List of all members
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 Types inherited from HPS::Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 

Public Member Functions

 NavigationCubeControl (View const &in_view)
 
 NavigationCubeControl (NavigationCubeControl const &in_that)
 
 NavigationCubeControl (NavigationCubeControl &&in_that)
 
NavigationCubeControloperator= (NavigationCubeControl &&in_that)
 
 ~NavigationCubeControl ()
 
HPS::Type ObjectType () const
 
NavigationCubeControloperator= (NavigationCubeControl const &in_that)
 
NavigationCubeControlSetLocation (Location in_location, HPS::Rectangle const &in_rectangle=HPS::Rectangle())
 
Location GetLocation () const
 
NavigationCubeControlSetPosition (HPS::Rectangle const &in_rectangle)
 
HPS::Rectangle GetPosition () const
 
NavigationCubeControlSetVisibility (bool in_visibility)
 
bool GetVisibility () const
 
NavigationCubeControlSetTextVisibility (bool in_text_visibility)
 
bool GetTextVisibility () const
 
NavigationCubeControlSetMaterialPalette (char const *in_material_palette)
 
HPS::UTF8 GetMaterialPalette () const
 
NavigationCubeControlSetInteractivity (bool in_interactivity)
 
bool GetInteractivity () const
 
NavigationCubeControlSetSize (float in_size)
 
float GetSize () const
 
HPS::SegmentKey GetSegmentKey () const
 
- Public Member Functions inherited from HPS::SprocketControl
 SprocketControl (HPS::SprocketControl const &in_that)=default
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (HPS::Sprocket const &in_that)=default
 
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
 Object (Object const &that)
 
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

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
 SprocketControl (SprocketControl &&in_that)
 
SprocketControloperator= (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.

Member Enumeration Documentation

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

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

Initializes a control tied to the view in_view.

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

Initializes a control tied to the same object as in_that.

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.
HPS::NavigationCubeControl::~NavigationCubeControl ( )

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

Member Function Documentation

bool HPS::NavigationCubeControl::GetInteractivity ( ) const

Gets the interactivity of this navigation cube.

Returns
true if the navigation cube is interactive, false otherwise.
Location HPS::NavigationCubeControl::GetLocation ( ) const

Gets the location of the navigation cube.

Returns
The location of the navigation cube relative to the view.
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.
HPS::Rectangle HPS::NavigationCubeControl::GetPosition ( ) const

Gets the poition of the subwindow containing the navigation cube.

Returns
The position of the subwindow containing the navigation cube.
HPS::SegmentKey HPS::NavigationCubeControl::GetSegmentKey ( ) const

Gets the segment where this navigation cube resides.

Returns
The segment key associated with this navigation cube.
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.
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.
bool HPS::NavigationCubeControl::GetVisibility ( ) const

Gets the visibility of the navigation cube.

Returns
true if the navigation cube is visible, false otherwise.
HPS::Type HPS::NavigationCubeControl::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS::SprocketControl.

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.
NavigationCubeControl& HPS::NavigationCubeControl::operator= ( NavigationCubeControl const &  in_that)

Share the smart-pointer.

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
NavigationCubeControl& HPS::NavigationCubeControl::SetLocation ( Location  in_location,
HPS::Rectangle const &  in_rectangle = HPS::Rectangle() 
)

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.
Returns
A reference to this object. By default the navigation cube is set to the top right corner of the View
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.
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.
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
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.
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: