#include <sprk.h>
|
static const HPS::Type | staticType = HPS::Type::AxisTriadControl |
|
static const HPS::Type | staticType = HPS::Type::SprocketControl |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The AxisTriadControl allows you to turn on or off the axis triad, move it to a specific corner of the screen, change the material palette used to style it, or otherwise manipulate it.
◆ Location
Enumerator |
---|
TopRight | Position Axis Triad on the top right corner.
|
TopLeft | Position Axis Triad on the top left corner.
|
BottomRight | Position Axis Triad on the bottom right corner.
|
BottomLeft | Position Axis Triad on the bottom left corner.
|
Custom | Position Axis Triad at a custom location.
|
◆ AxisTriadControl() [1/3]
HPS::AxisTriadControl::AxisTriadControl |
( |
View const & |
in_view | ) |
|
|
explicit |
Initializes a control tied to the view in_view.
◆ AxisTriadControl() [2/3]
Initializes a control tied to the same object as in_that.
◆ AxisTriadControl() [3/3]
The move constructor creates a AxisTriadControl by transferring the underlying impl of the rvalue reference to this AxisTriadControl thereby avoiding a copy and allocation.
- Parameters
-
◆ ~AxisTriadControl()
HPS::AxisTriadControl::~AxisTriadControl |
( |
| ) |
|
Releases a reference to the database object this control is tied to.
◆ GetInteractivity()
bool HPS::AxisTriadControl::GetInteractivity |
( |
| ) |
const |
Gets the interactivity of this axis triad.
- Returns
- true if the axis triad is interactive, false otherwise.
◆ GetLocation()
Location HPS::AxisTriadControl::GetLocation |
( |
| ) |
const |
Gets the location of the axis triad.
- Returns
- The location of the axis triad relative to the view.
◆ GetMaterialPalette()
HPS::UTF8 HPS::AxisTriadControl::GetMaterialPalette |
( |
| ) |
const |
Gets the material palette used for this axis triad.
- Returns
- The name of the material palette used for this axis triad.
◆ GetPosition()
Gets the position of the subwindow containing the axis triad.
- Returns
- The position of the subwindow containing the axis triad.
◆ GetPositionOffsets()
Gets the poition of the subwindow containing the axis triad.
- Returns
- The position of the subwindow containing the axis triad.
◆ GetSegmentKey()
Gets the segment where this axis triad resides.
- Returns
- The segment key associated with this axis triad.
◆ GetSize()
float HPS::AxisTriadControl::GetSize |
( |
| ) |
const |
Gets the size of the subwindow containing the axis triad, as a percentage of the main window.
- Returns
- the size of the subwindow containing the axis triad, as a percentage of the main window. If the location is Custom, this will return -1.0f.
◆ GetTextVisibility()
bool HPS::AxisTriadControl::GetTextVisibility |
( |
| ) |
const |
Gets the text visibility of the axis triad.
- Returns
- true if the axis triad text is visible, false otherwise.
◆ GetVisibility()
bool HPS::AxisTriadControl::GetVisibility |
( |
| ) |
const |
Gets the visibility of the axis triad.
- Returns
- true if the axis triad is visible, false otherwise.
◆ ObjectType()
HPS::Type HPS::AxisTriadControl::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]
The move assignment operator transfers the underlying impl of the rvalue reference to this AxisTriadControl thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this AxisTriadControl.
◆ operator=() [2/2]
◆ SetInteractivity()
Sets the interactivity of this axis triad. When the axis triad is interactive, dragging the triad will rotate the scene. Making the Axis Triad interactive pushes the Axis Triad operator on the current View's operator stack with High priority
- Parameters
-
in_interactivity | the interactivity of this axis triad |
- Returns
- A reference to this object. By default the axis triad is not interactive.
◆ SetLocation()
Sets the location of this axis triad.
- Parameters
-
in_location | the location of this axis triad |
in_position | the position of the subwindow containing the axis triad. only used when in_location is 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 axis triad is placed on the bottom left corner of the View
◆ SetMaterialPalette()
Sets the material palette of this axis triad. The material palette supplied to this function should originate from a material kit array with 3 entries. The entries in the material kit array are applied to the navigation cube as follows: Entry 0 - x-axis color Entry 1 - y-axis color Entry 2 - z-axis color
- Parameters
-
in_material_palette | the name of the material palette to be used for this axis triad |
- Returns
- A reference to this object.
◆ SetPosition()
Sets the position of the subwindow containing the axis triad.
- Parameters
-
in_position | a rectangle describing the subwindow containing the axis triad. |
- Returns
- A reference to this object.
◆ SetPositionOffsets()
Sets the position of the subwindow containing this axis triad.
- 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 axis triad, as a percentage of the main window.
- Parameters
-
in_size | The size of the subwindow containing the axis triad, as a percentage of the main window. [0-1] |
- Returns
- A reference to this object. By default the axis triad subwindow is 20% of the main window
◆ SetTextVisibility()
Sets the text visibility of this axis triad.
- Parameters
-
in_text_visibility | the visibility of the text for this axis triad |
- Returns
- A reference to this object.
◆ SetVisibility()
Sets the visibility of this axis triad.
- Parameters
-
in_visibility | the visibility of this axis triad |
- Returns
- A reference to this object. By default the axis triad is not visible
The documentation for this class was generated from the following file: