REFERENCE MANUAL
#include <sprk.h>
Public Types | |
enum | Location { Location::TopRight, Location::TopLeft, Location::BottomRight, Location::BottomLeft } |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketControl & | operator= (SprocketControl &&in_that) |
SprocketControl (SprocketControl &&in_that) | |
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.
|
strong |
|
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.
in_that | An rvalue reference to a NavigationCubeControl to take the impl from. |
NavigationCubeControl::~NavigationCubeControl | ( | ) |
Releases a reference to the database object this control is tied to.
bool NavigationCubeControl::GetInteractivity | ( | ) |
Gets the interactivity of this navigation cube.
Location NavigationCubeControl::GetLocation | ( | ) | const |
Gets the location of the navigation cube.
UTF8 NavigationCubeControl::GetMaterialPalette | ( | ) |
Gets the material palette used for this navigation cube.
SegmentKey NavigationCubeControl::GetSegmentKey | ( | ) |
Gets the segment where this navigation cube resides.
bool NavigationCubeControl::GetTextVisibility | ( | ) |
Gets the text visibility of the navigation cube.
bool NavigationCubeControl::GetVisibility | ( | ) |
Gets the visibility of the navigation cube.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
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.
in_that | An rvalue reference to a NavigationCubeControl to take the impl from. |
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
in_interactivity | the interactivity of this navigation cube |
NavigationCubeControl& NavigationCubeControl::SetLocation | ( | Location | in_location | ) |
Sets the location of this navigation cube.
in_location | the location of this navigation cube |
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
in_material_palette | the name of the material palette to be used for this navigation cube |
NavigationCubeControl& NavigationCubeControl::SetTextVisibility | ( | bool | in_text_visibility | ) |
Sets the text visibility of this navigation cube.
in_text_visibility | the visibility of the text for this navigation cube |
NavigationCubeControl& NavigationCubeControl::SetVisibility | ( | bool | in_visibility | ) |
Sets the visibility of this navigation cube.
in_visibility | the visibility of this navigation cube |