Public Types | Public Member Functions | List of all members
HPS::AxisTriadControl Class Reference

#include <sprk.h>

Inheritance diagram for HPS::AxisTriadControl:
HPS::SprocketControl HPS::Sprocket HPS::Object

Public Types

enum  Location {
  Location::TopRight, Location::TopLeft, Location::BottomRight, Location::BottomLeft,
  Location::Custom
}
 
- Public Types inherited from HPS::Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 

Public Member Functions

 AxisTriadControl (View const &in_view)
 
 AxisTriadControl (AxisTriadControl const &in_that)
 
 AxisTriadControl (AxisTriadControl &&in_that)
 
AxisTriadControloperator= (AxisTriadControl &&in_that)
 
 ~AxisTriadControl ()
 
HPS::Type ObjectType () const
 
AxisTriadControloperator= (AxisTriadControl const &in_that)
 
HPS::AxisTriadControlSetLocation (Location in_location, HPS::Rectangle const &in_rectangle=HPS::Rectangle())
 
Location GetLocation () const
 
AxisTriadControlSetPosition (HPS::Rectangle const &in_rectangle)
 
HPS::Rectangle GetPosition () const
 
HPS::AxisTriadControlSetVisibility (bool in_visibility)
 
bool GetVisibility () const
 
HPS::AxisTriadControlSetTextVisibility (bool in_text_visibility)
 
bool GetTextVisibility () const
 
HPS::AxisTriadControlSetMaterialPalette (const char *in_material_palette)
 
HPS::UTF8 GetMaterialPalette () const
 
HPS::AxisTriadControlSetInteractivity (bool in_interactivity)
 
bool GetInteractivity () const
 
AxisTriadControlSetSize (float in_size)
 
float GetSize () const
 
HPS::SegmentKey GetSegmentKey () const
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (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

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::SprocketControl
 SprocketControl (SprocketControl &&in_that)
 
SprocketControloperator= (SprocketControl &&in_that)
 

Detailed Description

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.

Member Enumeration Documentation

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.

Constructor & Destructor Documentation

HPS::AxisTriadControl::AxisTriadControl ( View const &  in_view)
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.

Parameters
in_thatAn 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.

Member Function Documentation

bool HPS::AxisTriadControl::GetInteractivity ( ) const

Gets the interactivity of this axis triad.

Returns
true if the axis triad is interactive, false otherwise.
Location HPS::AxisTriadControl::GetLocation ( ) const

Gets the location of the axis triad.

Returns
The location of the axis triad relative to the view.
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.
HPS::Rectangle HPS::AxisTriadControl::GetPosition ( ) const

Gets the poition of the subwindow containing the axis triad.

Returns
The position of the subwindow containing the axis triad.
HPS::SegmentKey HPS::AxisTriadControl::GetSegmentKey ( ) const

Gets the segment where this axis triad resides.

Returns
The segment key associated with this axis triad.
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.
bool HPS::AxisTriadControl::GetTextVisibility ( ) const

Gets the text visibility of the axis triad.

Returns
true if the axis triad text is visible, false otherwise.
bool HPS::AxisTriadControl::GetVisibility ( ) const

Gets the visibility of the axis triad.

Returns
true if the axis triad is visible, false otherwise.
HPS::Type HPS::AxisTriadControl::ObjectType ( ) const
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.

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.

Parameters
in_thatAn rvalue reference to a AxisTriadControl to take the impl from.
Returns
A reference to this AxisTriadControl.
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

Parameters
in_interactivitythe interactivity of this axis triad
Returns
A reference to this object. By default the axis triad is not interactive.
HPS::AxisTriadControl& HPS::AxisTriadControl::SetLocation ( Location  in_location,
HPS::Rectangle const &  in_rectangle = HPS::Rectangle() 
)

Sets the location of this axis triad.

Parameters
in_locationthe location of this axis triad
in_rectanglethe position of the subwindow containing the axis triad. 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
HPS::AxisTriadControl& HPS::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

Parameters
in_material_palettethe name of the material palette to be used for this axis triad
Returns
A reference to this object.
AxisTriadControl& HPS::AxisTriadControl::SetPosition ( HPS::Rectangle const &  in_rectangle)

Sets the position of the subwindow containing this axis triad.

Parameters
in_rectanglea rectangle describing the subwindow containing the axis triad
Returns
A reference to this object.
AxisTriadControl& HPS::AxisTriadControl::SetSize ( float  in_size)

Sets the size of the subwindow containing the axis triad, as a percentage of the main window.

Parameters
in_sizeThe 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
HPS::AxisTriadControl& HPS::AxisTriadControl::SetTextVisibility ( bool  in_text_visibility)

Sets the text visibility of this axis triad.

Parameters
in_text_visibilitythe visibility of the text for this axis triad
Returns
A reference to this object.
HPS::AxisTriadControl& HPS::AxisTriadControl::SetVisibility ( bool  in_visibility)

Sets the visibility of this axis triad.

Parameters
in_visibilitythe 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: