#include <sprk.h>
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::SegmentKey | GetSegmentKey () const |
float | GetSize () 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 |
NavigationCubeControl & | operator= (NavigationCubeControl &&in_that) |
NavigationCubeControl & | operator= (NavigationCubeControl const &in_that) |
NavigationCubeControl & | SetInteractivity (bool in_interactivity) |
NavigationCubeControl & | SetLocation (Location in_location, HPS::Rectangle const &in_rectangle=HPS::Rectangle()) |
NavigationCubeControl & | SetMaterialPalette (char const *in_material_palette) |
NavigationCubeControl & | SetPosition (HPS::Rectangle const &in_rectangle) |
NavigationCubeControl & | SetSize (float in_size) |
NavigationCubeControl & | SetTextVisibility (bool in_text_visibility) |
NavigationCubeControl & | SetVisibility (bool in_visibility) |
~NavigationCubeControl () | |
![]() | |
SprocketControl (HPS::SprocketControl const &in_that)=default | |
![]() | |
Sprocket (HPS::Sprocket const &in_that)=default | |
Sprocket (Sprocket &&in_that) | |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
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.
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.
in_that | An 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.
bool HPS::NavigationCubeControl::GetInteractivity | ( | ) | const |
Gets the interactivity of this navigation cube.
Location HPS::NavigationCubeControl::GetLocation | ( | ) | const |
Gets the location of the navigation cube.
HPS::UTF8 HPS::NavigationCubeControl::GetMaterialPalette | ( | ) | const |
Gets the material palette used for this navigation cube.
HPS::Rectangle HPS::NavigationCubeControl::GetPosition | ( | ) | const |
Gets the poition of the subwindow containing the navigation cube.
HPS::SegmentKey HPS::NavigationCubeControl::GetSegmentKey | ( | ) | const |
Gets the segment where this navigation cube resides.
float HPS::NavigationCubeControl::GetSize | ( | ) | const |
Gets 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.
bool HPS::NavigationCubeControl::GetVisibility | ( | ) | const |
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 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.
in_that | An rvalue reference to a NavigationCubeControl to take the impl from. |
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
in_interactivity | the interactivity of this navigation cube |
NavigationCubeControl& HPS::NavigationCubeControl::SetLocation | ( | Location | in_location, |
HPS::Rectangle const & | in_rectangle = HPS::Rectangle() |
||
) |
Sets the location of this navigation cube.
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. |
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
in_material_palette | the name of the material palette to be used for this navigation cube |
NavigationCubeControl& HPS::NavigationCubeControl::SetPosition | ( | HPS::Rectangle const & | in_rectangle | ) |
Sets the position of the subwindow containing this navigation cube.
in_rectangle | a rectangle describing the subwindow containing the navigation cube |
NavigationCubeControl& HPS::NavigationCubeControl::SetSize | ( | float | in_size | ) |
Sets the size of the subwindow containing the navigation cube, as a percentage of the main window.
in_size | The size of the subwindow containing the navigation cube, as a percentage of the main window. [0-1] |
NavigationCubeControl& HPS::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& HPS::NavigationCubeControl::SetVisibility | ( | bool | in_visibility | ) |
Sets the visibility of this navigation cube.
in_visibility | the visibility of this navigation cube |