#include <sprk.h>
Public Types | |
enum | Location { Location::TopRight, Location::TopLeft, Location::BottomRight, Location::BottomLeft, Location::Custom } |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
Public Member Functions | |
AxisTriadControl (View const &in_view) | |
AxisTriadControl (AxisTriadControl const &in_that) | |
AxisTriadControl (AxisTriadControl &&in_that) | |
AxisTriadControl & | operator= (AxisTriadControl &&in_that) |
~AxisTriadControl () | |
HPS::Type | ObjectType () const |
AxisTriadControl & | operator= (AxisTriadControl const &in_that) |
HPS::AxisTriadControl & | SetLocation (Location in_location, HPS::Rectangle const &in_rectangle=HPS::Rectangle()) |
Location | GetLocation () const |
AxisTriadControl & | SetPosition (HPS::Rectangle const &in_rectangle) |
HPS::Rectangle | GetPosition () const |
HPS::AxisTriadControl & | SetVisibility (bool in_visibility) |
bool | GetVisibility () const |
HPS::AxisTriadControl & | SetTextVisibility (bool in_text_visibility) |
bool | GetTextVisibility () const |
HPS::AxisTriadControl & | SetMaterialPalette (char const *in_material_palette) |
HPS::UTF8 | GetMaterialPalette () const |
HPS::AxisTriadControl & | SetInteractivity (bool in_interactivity) |
bool | GetInteractivity () const |
AxisTriadControl & | SetSize (float in_size) |
float | GetSize () const |
HPS::SegmentKey | GetSegmentKey () const |
![]() | |
SprocketControl (HPS::SprocketControl const &in_that)=default | |
![]() | |
Sprocket (HPS::Sprocket const &in_that)=default | |
Sprocket (Sprocket &&in_that) | |
![]() | |
Object (Object const &that) | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketControl (SprocketControl &&in_that) | |
SprocketControl & | operator= (SprocketControl &&in_that) |
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.
|
strong |
|
explicit |
Initializes a control tied to the view in_view.
HPS::AxisTriadControl::AxisTriadControl | ( | AxisTriadControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::AxisTriadControl::AxisTriadControl | ( | AxisTriadControl && | in_that | ) |
The move constructor creates a AxisTriadControl by transferring the underlying impl of the rvalue reference to this AxisTriadControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a AxisTriadControl to take the impl from. |
HPS::AxisTriadControl::~AxisTriadControl | ( | ) |
Releases a reference to the database object this control is tied to.
bool HPS::AxisTriadControl::GetInteractivity | ( | ) | const |
Gets the interactivity of this axis triad.
Location HPS::AxisTriadControl::GetLocation | ( | ) | const |
Gets the location of the axis triad.
HPS::UTF8 HPS::AxisTriadControl::GetMaterialPalette | ( | ) | const |
Gets the material palette used for this axis triad.
HPS::Rectangle HPS::AxisTriadControl::GetPosition | ( | ) | const |
Gets the poition of the subwindow containing the axis triad.
HPS::SegmentKey HPS::AxisTriadControl::GetSegmentKey | ( | ) | const |
Gets the segment where this axis triad resides.
float HPS::AxisTriadControl::GetSize | ( | ) | const |
Gets the size of the subwindow containing the axis triad, as a percentage of the main window.
bool HPS::AxisTriadControl::GetTextVisibility | ( | ) | const |
Gets the text visibility of the axis triad.
bool HPS::AxisTriadControl::GetVisibility | ( | ) | const |
Gets the visibility of the axis triad.
|
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.
AxisTriadControl& HPS::AxisTriadControl::operator= | ( | AxisTriadControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this AxisTriadControl thereby avoiding a copy.
in_that | An rvalue reference to a AxisTriadControl to take the impl from. |
AxisTriadControl& HPS::AxisTriadControl::operator= | ( | AxisTriadControl const & | in_that | ) |
Share the smart-pointer.
HPS::AxisTriadControl& HPS::AxisTriadControl::SetInteractivity | ( | bool | in_interactivity | ) |
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
in_interactivity | the interactivity of this axis triad |
HPS::AxisTriadControl& HPS::AxisTriadControl::SetLocation | ( | Location | in_location, |
HPS::Rectangle const & | in_rectangle = HPS::Rectangle() |
||
) |
Sets the location of this axis triad.
in_location | the location of this axis triad |
in_rectangle | the position of the subwindow containing the axis triad. only used when in_location is Custom |
HPS::AxisTriadControl& HPS::AxisTriadControl::SetMaterialPalette | ( | char const * | in_material_palette | ) |
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
in_material_palette | the name of the material palette to be used for this axis triad |
AxisTriadControl& HPS::AxisTriadControl::SetPosition | ( | HPS::Rectangle const & | in_rectangle | ) |
Sets the position of the subwindow containing this axis triad.
in_rectangle | a rectangle describing the subwindow containing the axis triad |
AxisTriadControl& HPS::AxisTriadControl::SetSize | ( | float | in_size | ) |
Sets the size of the subwindow containing the axis triad, as a percentage of the main window.
in_size | The size of the subwindow containing the axis triad, as a percentage of the main window. [0-1] |
HPS::AxisTriadControl& HPS::AxisTriadControl::SetTextVisibility | ( | bool | in_text_visibility | ) |
Sets the text visibility of this axis triad.
in_text_visibility | the visibility of the text for this axis triad |
HPS::AxisTriadControl& HPS::AxisTriadControl::SetVisibility | ( | bool | in_visibility | ) |
Sets the visibility of this axis triad.
in_visibility | the visibility of this axis triad |