#include <sprk.h>
|
bool | GetInteractivity () const |
|
Location | GetLocation () const |
|
HPS::UTF8 | GetMaterialPalette () const |
|
HPS::Rectangle | GetPosition () const |
|
HPS::IntRectangle | GetPositionOffsets () const |
|
HPS::SegmentKey | GetSegmentKey () const |
|
float | GetSize () const |
|
bool | GetText (UTF8 &out_back_string, UTF8 &out_top_string, UTF8 &out_left_string, UTF8 &out_front_string, UTF8 &out_bottom_string, UTF8 &out_right_string, HPS::TextAttributeKit &out_text_attributes) 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(), HPS::IntRectangle in_offsets=HPS::IntRectangle::Zero()) |
|
NavigationCubeControl & | SetMaterialPalette (char const *in_material_palette) |
|
NavigationCubeControl & | SetPosition (HPS::Rectangle const &in_rectangle) |
|
NavigationCubeControl & | SetPositionOffsets (HPS::IntRectangle const &in_offsets) |
|
NavigationCubeControl & | SetSize (float in_size) |
|
NavigationCubeControl & | SetText (const char *in_back_string, const char *in_top_string, const char *in_left_string, const char *in_front_string, const char *in_bottom_string, const char *in_right_string, HPS::TextAttributeKit const &in_text_attributes) |
|
NavigationCubeControl & | SetTextVisibility (bool in_text_visibility) |
|
NavigationCubeControl & | SetVisibility (bool in_visibility) |
|
| ~NavigationCubeControl () |
|
| 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 () |
|
virtual HPS::Type | Type () const |
|
|
static const HPS::Type | staticType = HPS::Type::NavigationCubeControl |
|
static const HPS::Type | staticType = HPS::Type::SprocketControl |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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. To allow your users to interact with the Navigation Cube, see HPS::NavigationCubeOperator.
- Note
- The orientation of the NavigationCubeControl is specified by the model in the associated view. See HPS::Model::SetOrientation().
◆ Location
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.
|
◆ NavigationCubeControl() [1/3]
HPS::NavigationCubeControl::NavigationCubeControl |
( |
View const & |
in_view | ) |
|
|
explicit |
Initializes a control tied to the view in_view.
◆ NavigationCubeControl() [2/3]
Initializes a control tied to the same object as in_that.
◆ NavigationCubeControl() [3/3]
◆ ~NavigationCubeControl()
HPS::NavigationCubeControl::~NavigationCubeControl |
( |
| ) |
|
Releases a reference to the database object this control is tied to.
◆ GetInteractivity()
bool HPS::NavigationCubeControl::GetInteractivity |
( |
| ) |
const |
Gets the interactivity of this navigation cube.
- Returns
- true if the navigation cube is interactive, false otherwise.
◆ GetLocation()
Location HPS::NavigationCubeControl::GetLocation |
( |
| ) |
const |
Gets the location of the navigation cube.
- Returns
- The location of the navigation cube relative to the view.
◆ GetMaterialPalette()
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.
◆ GetPosition()
Gets the poition of the subwindow containing the navigation cube.
- Returns
- The position of the subwindow containing the navigation cube.
◆ GetPositionOffsets()
Gets the poition of the subwindow containing the navigation cube.
- Returns
- The position of the subwindow containing the navigation cube.
◆ GetSegmentKey()
Gets the segment where this navigation cube resides.
- Returns
- The segment key associated with this navigation cube.
◆ GetSize()
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.
◆ GetTextVisibility()
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.
◆ GetVisibility()
bool HPS::NavigationCubeControl::GetVisibility |
( |
| ) |
const |
Gets the visibility of the navigation cube.
- Returns
- true if the navigation cube is visible, false otherwise.
◆ ObjectType()
HPS::Type HPS::NavigationCubeControl::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::SprocketControl.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ SetInteractivity()
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
◆ SetLocation()
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
◆ SetMaterialPalette()
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.
◆ SetPosition()
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.
◆ SetPositionOffsets()
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.
◆ SetSize()
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
◆ SetTextVisibility()
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.
◆ SetVisibility()
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: