HPS::AxisTriadControl Class Reference

#include <sprk.h>

Inheritance diagram for HPS::AxisTriadControl:

Public Types
enum	Location { Location::TopRight, Location::TopLeft, Location::BottomRight, Location::BottomLeft, Location::Custom }

Public Member Functions
	AxisTriadControl (View const &in_view)
	AxisTriadControl (AxisTriadControl const &in_that)
	AxisTriadControl (AxisTriadControl &&in_that)
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	GetTextVisibility () const
bool	GetVisibility () const
HPS::Type	ObjectType () const
AxisTriadControl &	operator= (AxisTriadControl &&in_that)
AxisTriadControl &	operator= (AxisTriadControl const &in_that)
HPS::AxisTriadControl &	SetInteractivity (bool in_interactivity)
HPS::AxisTriadControl &	SetLocation (Location in_location, HPS::Rectangle const &in_position=HPS::Rectangle(), HPS::IntRectangle in_offsets=HPS::IntRectangle::Zero())
HPS::AxisTriadControl &	SetMaterialPalette (char const *in_material_palette)
AxisTriadControl &	SetPosition (HPS::Rectangle const &in_position)
AxisTriadControl &	SetPositionOffsets (HPS::IntRectangle const &in_offsets)
AxisTriadControl &	SetSize (float in_size)
HPS::AxisTriadControl &	SetTextVisibility (bool in_text_visibility)
HPS::AxisTriadControl &	SetVisibility (bool in_visibility)
	~AxisTriadControl ()
Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)
Public Member Functions inherited from HPS::Object
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 Public Attributes
static const HPS::Type	staticType = HPS::Type::AxisTriadControl
Static Public Attributes inherited from HPS::SprocketControl
static const HPS::Type	staticType = HPS::Type::SprocketControl
Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

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 &	operator= (SprocketControl &&in_that)
	SprocketControl (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

Location

enum HPS::AxisTriadControl::Location

strong

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

AxisTriadControl() [1/3]

HPS::AxisTriadControl::AxisTriadControl ( View const &  in_view )

explicit

Initializes a control tied to the view in_view.

AxisTriadControl() [2/3]

HPS::AxisTriadControl::AxisTriadControl

(

AxisTriadControl const &

in_that

)

Initializes a control tied to the same object as in_that.

AxisTriadControl() [3/3]

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_that

An rvalue reference to a AxisTriadControl to take the impl from.

~AxisTriadControl()

HPS::AxisTriadControl::~AxisTriadControl

(

)

Releases a reference to the database object this control is tied to.

Member Function Documentation

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()

HPS::Rectangle HPS::AxisTriadControl::GetPosition

(

)

const

Gets the position of the subwindow containing the axis triad.

Returns

The position of the subwindow containing the axis triad.

GetPositionOffsets()

HPS::IntRectangle HPS::AxisTriadControl::GetPositionOffsets

(

)

const

Gets the poition of the subwindow containing the axis triad.

Returns

The position of the subwindow containing the axis triad.

GetSegmentKey()

HPS::SegmentKey HPS::AxisTriadControl::GetSegmentKey

(

)

const

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]

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_that

An rvalue reference to a AxisTriadControl to take the impl from.

Returns

A reference to this AxisTriadControl.

operator=() [2/2]

AxisTriadControl& HPS::AxisTriadControl::operator=

(

AxisTriadControl const &

in_that

)

Share the smart-pointer.

SetInteractivity()

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_interactivity

the interactivity of this axis triad

Returns

A reference to this object. By default the axis triad is not interactive.

SetLocation()

HPS::AxisTriadControl& HPS::AxisTriadControl::SetLocation	(	Location	in_location,
		HPS::Rectangle const &	in_position = HPS::Rectangle(),
		HPS::IntRectangle	in_offsets = HPS::IntRectangle::Zero()
	)

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()

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

Parameters

in_material_palette

the name of the material palette to be used for this axis triad

Returns

A reference to this object.

SetPosition()

AxisTriadControl& HPS::AxisTriadControl::SetPosition

(

HPS::Rectangle const &

in_position

)

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()

AxisTriadControl& HPS::AxisTriadControl::SetPositionOffsets

(

HPS::IntRectangle const &

in_offsets

)

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()

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_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()

HPS::AxisTriadControl& HPS::AxisTriadControl::SetTextVisibility

(

bool

in_text_visibility

)

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()

HPS::AxisTriadControl& HPS::AxisTriadControl::SetVisibility

(

bool

in_visibility

)

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:

• include/sprk.h