< Home

< Table of Contents

REFERENCE MANUAL

NavigationCubeControl Class Reference

#include <sprk.h>

Inheritance diagram for NavigationCubeControl:
SprocketControl Sprocket Object

Public Types

enum  Location { Location::TopRight, Location::TopLeft, Location::BottomRight, Location::BottomLeft }
 
- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 

Public Member Functions

bool GetInteractivity ()
 
Location GetLocation () const
 
UTF8 GetMaterialPalette ()
 
SegmentKey GetSegmentKey ()
 
bool GetTextVisibility ()
 
bool GetVisibility ()
 
 NavigationCubeControl (View const &in_view)
 
 NavigationCubeControl (NavigationCubeControl const &in_that)
 
 NavigationCubeControl (NavigationCubeControl &&in_that)
 
Type ObjectType () const
 
NavigationCubeControloperator= (NavigationCubeControl &&in_that)
 
NavigationCubeControloperator= (NavigationCubeControl const &in_that)
 
NavigationCubeControlSetInteractivity (bool in_interactivity)
 
NavigationCubeControlSetLocation (Location in_location)
 
NavigationCubeControlSetMaterialPalette (const char *in_material_palette)
 
NavigationCubeControlSetTextVisibility (bool in_text_visibility)
 
NavigationCubeControlSetVisibility (bool in_visibility)
 
 ~NavigationCubeControl ()
 
- Public Member Functions inherited from Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from 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.

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.

Constructor & Destructor Documentation

NavigationCubeControl::NavigationCubeControl ( View const &  in_view)
explicit

Initializes a control tied to the view in_view.

NavigationCubeControl::NavigationCubeControl ( NavigationCubeControl const &  in_that)

Initializes a control tied to the same object as in_that.

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

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

Member Function Documentation

bool NavigationCubeControl::GetInteractivity ( )

Gets the interactivity of this navigation cube.

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

Gets the location of the navigation cube.

Returns
The location of the navigation cube relative to the view.
UTF8 NavigationCubeControl::GetMaterialPalette ( )

Gets the material palette used for this navigation cube.

Returns
The name of the material palette used for this navigation cube.
SegmentKey NavigationCubeControl::GetSegmentKey ( )

Gets the segment where this navigation cube resides.

Returns
The segment key associated with this navigation cube.
bool NavigationCubeControl::GetTextVisibility ( )

Gets the text visibility of the navigation cube.

Returns
true if the text on the navigation cube is visible, false otherwise.
bool NavigationCubeControl::GetVisibility ( )

Gets the visibility of the navigation cube.

Returns
true if the navigation cube is visible, false otherwise.
Type 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 SprocketControl.

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

Share the smart-pointer.

NavigationCubeControl& 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& NavigationCubeControl::SetLocation ( Location  in_location)

Sets the location of this navigation cube.

Parameters
in_locationthe location of this navigation cube
Returns
A reference to this object. By default the navigation cube is set to the top right corner of the View
NavigationCubeControl& NavigationCubeControl::SetMaterialPalette ( const char *  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& 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& 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: