#include <sprk.h>

Public Types | |
enum | Location { Location::TopRight, Location::TopLeft, Location::BottomRight, Location::BottomLeft, Location::Custom } |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketControl & | operator= (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
|
strong |
Constructor & Destructor Documentation
|
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_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.
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::IntRectangle HPS::NavigationCubeControl::GetPositionOffsets | ( | ) | 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. If the location is Custom, this will return -1.0f.
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.
|
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_that An 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_interactivity the 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() , |
||
HPS::IntRectangle | in_offsets = HPS::IntRectangle::Zero() |
||
) |
Sets the location of this navigation cube.
- Parameters
-
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. in_offsets the 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
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_palette the 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_rectangle a rectangle describing the subwindow containing the navigation cube
- Returns
- A reference to this object.
NavigationCubeControl& HPS::NavigationCubeControl::SetPositionOffsets | ( | HPS::IntRectangle const & | in_offsets | ) |
Sets the position of the subwindow containing the navigation cube.
- Parameters
-
in_offsets a rectangle describing the offsets being applied to the current position.
- 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_size The 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_visibility the 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_visibility the 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:
- include/sprk.h