REFERENCE MANUAL
#include <sprk.h>
Public Types | |
enum | Location { Location::TopRight, Location::TopLeft, Location::BottomRight, Location::BottomLeft } |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
Public Member Functions | |
AxisTriadControl (View const &in_view) | |
AxisTriadControl (AxisTriadControl const &in_that) | |
AxisTriadControl (AxisTriadControl &&in_that) | |
bool | GetInteractivity () |
Location | GetLocation () const |
UTF8 | GetMaterialPalette () |
SegmentKey | GetSegmentKey () |
bool | GetTextVisibility () |
bool | GetVisibility () |
Type | ObjectType () const |
AxisTriadControl & | operator= (AxisTriadControl &&in_that) |
AxisTriadControl & | operator= (AxisTriadControl const &in_that) |
AxisTriadControl & | SetInteractivity (bool in_interactivity) |
AxisTriadControl & | SetLocation (Location in_location) |
AxisTriadControl & | SetMaterialPalette (const char *in_material_palette) |
AxisTriadControl & | SetTextVisibility (bool in_text_visibility) |
AxisTriadControl & | SetVisibility (bool in_visibility) |
~AxisTriadControl () | |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketControl & | operator= (SprocketControl &&in_that) |
SprocketControl (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.
AxisTriadControl::AxisTriadControl | ( | AxisTriadControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
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. |
AxisTriadControl::~AxisTriadControl | ( | ) |
Releases a reference to the database object this control is tied to.
bool AxisTriadControl::GetInteractivity | ( | ) |
Gets the interactivity of this axis triad.
Location AxisTriadControl::GetLocation | ( | ) | const |
Gets the location of the axis triad.
UTF8 AxisTriadControl::GetMaterialPalette | ( | ) |
Gets the material palette used for this axis triad.
SegmentKey AxisTriadControl::GetSegmentKey | ( | ) |
Gets the segment where this axis triad resides.
bool AxisTriadControl::GetTextVisibility | ( | ) |
Gets the text visibility of the axis triad.
bool AxisTriadControl::GetVisibility | ( | ) |
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 SprocketControl.
AxisTriadControl& 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& AxisTriadControl::operator= | ( | AxisTriadControl const & | in_that | ) |
Share the smart-pointer.
AxisTriadControl& 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 |
AxisTriadControl& AxisTriadControl::SetLocation | ( | Location | in_location | ) |
Sets the location of this axis triad.
in_location | the location of this axis triad |
AxisTriadControl& AxisTriadControl::SetMaterialPalette | ( | const char * | 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& 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 |
AxisTriadControl& AxisTriadControl::SetVisibility | ( | bool | in_visibility | ) |
Sets the visibility of this axis triad.
in_visibility | the visibility of this axis triad |