HPS::TransformMaskKit Class Reference

The HPS::TransformMaskKit class is a user space object, useful for carrying a group attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::TransformMaskKit:

Collaboration diagram for HPS::TransformMaskKit:

Public Member Functions
	TransformMaskKit ()
	Initializes an empty kit. More...
	TransformMaskKit (TransformMaskKit const &in_kit)
	Copies the kit in_kit into this kit. More...
	TransformMaskKit (TransformMaskKit &&in_that)
	The move constructor creates a TransformMaskKit by transferring the underlying impl of the rvalue reference to this TransformMaskKit thereby avoiding a copy and allocation. More...
TransformMaskKit &	operator= (TransformMaskKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this TransformMaskKit thereby avoiding a copy. More...
virtual	~TransformMaskKit ()
	Destroy this kit. More...
HPS::Type	ObjectType () const
void	Set (TransformMaskKit const &in_kit)
	Copies the kit in_kit into this kit. More...
void	Show (TransformMaskKit &out_kit) const
	Copies this kit into out_kit. More...
TransformMaskKit &	operator= (TransformMaskKit const &in_kit)
	Copies the kit in_kit into this kit. More...
bool	Empty () const
	Returns whether this kit has any values currently set on it. More...
bool	Equals (TransformMaskKit const &in_kit) const
	Compares the contents of in_kit and this kit. More...
bool	operator== (TransformMaskKit const &in_kit) const
	Compares the contents of in_kit and this kit. More...
bool	operator!= (TransformMaskKit const &in_kit) const
	Compares the contents of in_kit and this kit. More...
TransformMaskKit &	SetCameraRotation (bool in_state)
	Applies a mask which removes transforms related to camera rotations. More...
TransformMaskKit &	SetCameraScale (bool in_state)
	Applies a mask which removes transforms related to camera scales. More...
TransformMaskKit &	SetCameraTranslation (bool in_state)
	Applies a mask which removes transforms related to camera translations. More...
TransformMaskKit &	SetCameraPerspectiveScale (bool in_state)
	Applies a mask which removes the perspective scale from perspective cameras. More...
TransformMaskKit &	SetCameraProjection (bool in_state)
	Applies a mask which removes the perspective projection and replaces it with an orthographic projection from perspective cameras. More...
TransformMaskKit &	SetCameraOffset (bool in_state)
	Applies a mask which removes transforms related to camera offsets. More...
TransformMaskKit &	SetCameraNearLimit (bool in_state)
	Applies a mask which removes transforms related to camera near limit. More...
TransformMaskKit &	SetModellingMatrixRotation (bool in_state)
	Applies a mask which removes transforms related to all modelling matrix rotations. More...
TransformMaskKit &	SetModellingMatrixScale (bool in_state)
	Applies a mask which removes transforms related to all modelling matrix scales. More...
TransformMaskKit &	SetModellingMatrixTranslation (bool in_state)
	Applies a mask which removes transforms related to all modelling matrix translation. More...
TransformMaskKit &	SetModellingMatrixOffset (bool in_state)
	Applies a mask which removes transforms related to all modelling matrix offset. More...
TransformMaskKit &	SetCameraEverything (bool in_state)
	Applies a mask which removes transforms related to camera. More...
TransformMaskKit &	SetModellingMatrixEverything (bool in_state)
	Applies a mask which removes transforms related to modelling matrix. More...
TransformMaskKit &	SetEverything (bool in_state)
	Applies a mask which removes all transforms related to both modelling matrix and camera. More...
TransformMaskKit &	UnsetCameraRotation ()
	Removes the mask which removes transforms related to camera rotation. More...
TransformMaskKit &	UnsetCameraScale ()
	Removes the mask which removes transforms related to camera scale. More...
TransformMaskKit &	UnsetCameraTranslation ()
	Removes the mask which removes transforms related to camera translation. More...
TransformMaskKit &	UnsetCameraPerspectiveScale ()
	Removes the mask which removes the perspective scale from perspective cameras. More...
TransformMaskKit &	UnsetCameraProjection ()
	Removes the mask which removes the perspective projection from perspective cameras. More...
TransformMaskKit &	UnsetCameraOffset ()
	Removes the mask which removes transforms related to camera offset. More...
TransformMaskKit &	UnsetCameraNearLimit ()
	Removes the mask which removes transforms related to camera near limit. More...
TransformMaskKit &	UnsetCameraEverything ()
	Removes the mask which removes transforms related to camera. More...
TransformMaskKit &	UnsetModellingMatrixRotation ()
	Removes the mask which removes transforms related to modelling matrix rotation. More...
TransformMaskKit &	UnsetModellingMatrixScale ()
	Removes the mask which removes transforms related to modelling matrix scale. More...
TransformMaskKit &	UnsetModellingMatrixTranslation ()
	Removes the mask which removes transforms related to modelling matrix translation. More...
TransformMaskKit &	UnsetModellingMatrixOffset ()
	Removes the mask which removes transforms related to modelling matrix offset. More...
TransformMaskKit &	UnsetModellingMatrixEverything ()
	Removes the mask which removes transforms related to modelling matrix everything. More...
TransformMaskKit &	UnsetEverything ()
	Removes the mask which removes transforms related to camera and modelling matrix. More...
bool	ShowCameraRotation (bool &out_state) const
	Shows the camera rotation mask setting. More...
bool	ShowCameraScale (bool &out_state) const
	Shows the camera scale mask setting. More...
bool	ShowCameraTranslation (bool &out_state) const
	Shows the camera translation mask setting. More...
bool	ShowCameraPerspectiveScale (bool &out_state) const
	Shows the camera perspective scale mask setting. More...
bool	ShowCameraProjection (bool &out_state) const
	Shows the camera perspective projection mask setting. More...
bool	ShowCameraOffset (bool &out_state) const
	Shows the camera offset mask setting. More...
bool	ShowCameraNearLimit (bool &out_state) const
	Shows the camera near limit mask setting. More...
bool	ShowModellingMatrixRotation (bool &out_state) const
	Shows the modelling matrix rotation mask setting. More...
bool	ShowModellingMatrixScale (bool &out_state) const
	Shows the modelling matrix scale mask setting. More...
bool	ShowModellingMatrixTranslation (bool &out_state) const
	Shows the modelling matrix translation mask setting. More...
bool	ShowModellingMatrixOffset (bool &out_state) const
	Shows the modelling matrix offset mask setting. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static TransformMaskKit	GetDefault ()
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::TransformMaskKit

Detailed Description

The HPS::TransformMaskKit class is a user space object, useful for carrying a group attribute settings.

Calling HPS::TransformMaskKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

TransformMaskKit() [1/3]

HPS::TransformMaskKit::TransformMaskKit

(

)

Initializes an empty kit.

TransformMaskKit() [2/3]

HPS::TransformMaskKit::TransformMaskKit

(

TransformMaskKit const &

in_kit

)

Copies the kit in_kit into this kit.

TransformMaskKit() [3/3]

HPS::TransformMaskKit::TransformMaskKit

(

TransformMaskKit &&

in_that

)

The move constructor creates a TransformMaskKit by transferring the underlying impl of the rvalue reference to this TransformMaskKit thereby avoiding a copy and allocation.

Parameters

in_that

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

~TransformMaskKit()

virtual HPS::TransformMaskKit::~TransformMaskKit ( )

virtual

Destroy this kit.

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

Empty()

bool HPS::TransformMaskKit::Empty ( ) const

virtual

Returns whether this kit has any values currently set on it.

Reimplemented from HPS::Object.

Equals()

bool HPS::TransformMaskKit::Equals

(

TransformMaskKit const &

in_kit

)

const

Compares the contents of in_kit and this kit.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetDefault()

static TransformMaskKit HPS::TransformMaskKit::GetDefault ( )

static

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::TransformMaskKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

operator!=()

bool HPS::TransformMaskKit::operator!=

(

TransformMaskKit const &

in_kit

)

const

Compares the contents of in_kit and this kit.

operator=() [1/2]

TransformMaskKit& HPS::TransformMaskKit::operator=

(

TransformMaskKit &&

in_that

)

The move assignment operator transfers the underlying impl of the rvalue reference to this TransformMaskKit thereby avoiding a copy.

Parameters

in_that

An rvalue reference to an TransformMaskKit to take the impl from.

Returns

A reference to this TransformMaskKit.

operator=() [2/2]

TransformMaskKit& HPS::TransformMaskKit::operator=

(

TransformMaskKit const &

in_kit

)

Copies the kit in_kit into this kit.

operator==()

bool HPS::TransformMaskKit::operator==

(

TransformMaskKit const &

in_kit

)

const

Compares the contents of in_kit and this kit.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

Set()

void HPS::TransformMaskKit::Set

(

TransformMaskKit const &

in_kit

)

Copies the kit in_kit into this kit.

SetCameraEverything()

TransformMaskKit& HPS::TransformMaskKit::SetCameraEverything

(

bool

in_state

)

Applies a mask which removes transforms related to camera.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetCameraNearLimit()

TransformMaskKit& HPS::TransformMaskKit::SetCameraNearLimit

(

bool

in_state

)

Applies a mask which removes transforms related to camera near limit.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetCameraOffset()

TransformMaskKit& HPS::TransformMaskKit::SetCameraOffset

(

bool

in_state

)

Applies a mask which removes transforms related to camera offsets.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetCameraPerspectiveScale()

TransformMaskKit& HPS::TransformMaskKit::SetCameraPerspectiveScale

(

bool

in_state

)

Applies a mask which removes the perspective scale from perspective cameras.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetCameraProjection()

TransformMaskKit& HPS::TransformMaskKit::SetCameraProjection

(

bool

in_state

)

Applies a mask which removes the perspective projection and replaces it with an orthographic projection from perspective cameras.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetCameraRotation()

TransformMaskKit& HPS::TransformMaskKit::SetCameraRotation

(

bool

in_state

)

Applies a mask which removes transforms related to camera rotations.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetCameraScale()

TransformMaskKit& HPS::TransformMaskKit::SetCameraScale

(

bool

in_state

)

Applies a mask which removes transforms related to camera scales.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetCameraTranslation()

TransformMaskKit& HPS::TransformMaskKit::SetCameraTranslation

(

bool

in_state

)

Applies a mask which removes transforms related to camera translations.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetEverything()

TransformMaskKit& HPS::TransformMaskKit::SetEverything

(

bool

in_state

)

Applies a mask which removes all transforms related to both modelling matrix and camera.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetModellingMatrixEverything()

TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixEverything

(

bool

in_state

)

Applies a mask which removes transforms related to modelling matrix.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetModellingMatrixOffset()

TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixOffset

(

bool

in_state

)

Applies a mask which removes transforms related to all modelling matrix offset.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetModellingMatrixRotation()

TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixRotation

(

bool

in_state

)

Applies a mask which removes transforms related to all modelling matrix rotations.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetModellingMatrixScale()

TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixScale

(

bool

in_state

)

Applies a mask which removes transforms related to all modelling matrix scales.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

SetModellingMatrixTranslation()

TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixTranslation

(

bool

in_state

)

Applies a mask which removes transforms related to all modelling matrix translation.

Parameters

in_state

Whether the mask should be applied.

Returns

A reference to this object.

Show()

void HPS::TransformMaskKit::Show

(

TransformMaskKit &

out_kit

)

const

Copies this kit into out_kit.

ShowCameraNearLimit()

bool HPS::TransformMaskKit::ShowCameraNearLimit

(

bool &

out_state

)

const

Shows the camera near limit mask setting.

Parameters

out_state

Whether the camera near limit transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowCameraOffset()

bool HPS::TransformMaskKit::ShowCameraOffset

(

bool &

out_state

)

const

Shows the camera offset mask setting.

Parameters

out_state

Whether the camera offset transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowCameraPerspectiveScale()

bool HPS::TransformMaskKit::ShowCameraPerspectiveScale

(

bool &

out_state

)

const

Shows the camera perspective scale mask setting.

Parameters

out_state

Whether the camera perspective scale transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowCameraProjection()

bool HPS::TransformMaskKit::ShowCameraProjection

(

bool &

out_state

)

const

Shows the camera perspective projection mask setting.

Parameters

out_state

Whether the camera perspective projection transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowCameraRotation()

bool HPS::TransformMaskKit::ShowCameraRotation

(

bool &

out_state

)

const

Shows the camera rotation mask setting.

Parameters

out_state

Whether the camera rotation transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowCameraScale()

bool HPS::TransformMaskKit::ShowCameraScale

(

bool &

out_state

)

const

Shows the camera scale mask setting.

Parameters

out_state

Whether the camera scale transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowCameraTranslation()

bool HPS::TransformMaskKit::ShowCameraTranslation

(

bool &

out_state

)

const

Shows the camera translation mask setting.

Parameters

out_state

Whether the camera translation transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowModellingMatrixOffset()

bool HPS::TransformMaskKit::ShowModellingMatrixOffset

(

bool &

out_state

)

const

Shows the modelling matrix offset mask setting.

Parameters

out_state

Whether the modelling matrix offset transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowModellingMatrixRotation()

bool HPS::TransformMaskKit::ShowModellingMatrixRotation

(

bool &

out_state

)

const

Shows the modelling matrix rotation mask setting.

Parameters

out_state

Whether the modelling matrix rotation transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowModellingMatrixScale()

bool HPS::TransformMaskKit::ShowModellingMatrixScale

(

bool &

out_state

)

const

Shows the modelling matrix scale mask setting.

Parameters

out_state

Whether the modelling matrix scale transform mask is applied

Returns

true if the setting is valid, false otherwise.

ShowModellingMatrixTranslation()

bool HPS::TransformMaskKit::ShowModellingMatrixTranslation

(

bool &

out_state

)

const

Shows the modelling matrix translation mask setting.

Parameters

out_state

Whether the modelling matrix translation transform mask is applied

Returns

true if the setting is valid, false otherwise.

Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns

The true type of the object in question.

Reimplemented from HPS::Object.

UnsetCameraEverything()

TransformMaskKit& HPS::TransformMaskKit::UnsetCameraEverything

(

)

Removes the mask which removes transforms related to camera.

Returns

A reference to this object.

UnsetCameraNearLimit()

TransformMaskKit& HPS::TransformMaskKit::UnsetCameraNearLimit

(

)

Removes the mask which removes transforms related to camera near limit.

Returns

A reference to this object.

UnsetCameraOffset()

TransformMaskKit& HPS::TransformMaskKit::UnsetCameraOffset

(

)

Removes the mask which removes transforms related to camera offset.

Returns

A reference to this object.

UnsetCameraPerspectiveScale()

TransformMaskKit& HPS::TransformMaskKit::UnsetCameraPerspectiveScale

(

)

Removes the mask which removes the perspective scale from perspective cameras.

Returns

A reference to this object.

UnsetCameraProjection()

TransformMaskKit& HPS::TransformMaskKit::UnsetCameraProjection

(

)

Removes the mask which removes the perspective projection from perspective cameras.

Returns

A reference to this object.

UnsetCameraRotation()

TransformMaskKit& HPS::TransformMaskKit::UnsetCameraRotation

(

)

Removes the mask which removes transforms related to camera rotation.

Returns

A reference to this object.

UnsetCameraScale()

TransformMaskKit& HPS::TransformMaskKit::UnsetCameraScale

(

)

Removes the mask which removes transforms related to camera scale.

Returns

A reference to this object.

UnsetCameraTranslation()

TransformMaskKit& HPS::TransformMaskKit::UnsetCameraTranslation

(

)

Removes the mask which removes transforms related to camera translation.

Returns

A reference to this object.

UnsetEverything()

TransformMaskKit& HPS::TransformMaskKit::UnsetEverything

(

)

Removes the mask which removes transforms related to camera and modelling matrix.

Returns

A reference to this object.

UnsetModellingMatrixEverything()

TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixEverything

(

)

Removes the mask which removes transforms related to modelling matrix everything.

Returns

A reference to this object.

UnsetModellingMatrixOffset()

TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixOffset

(

)

Removes the mask which removes transforms related to modelling matrix offset.

Returns

A reference to this object.

UnsetModellingMatrixRotation()

TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixRotation

(

)

Removes the mask which removes transforms related to modelling matrix rotation.

Returns

A reference to this object.

UnsetModellingMatrixScale()

TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixScale

(

)

Removes the mask which removes transforms related to modelling matrix scale.

Returns

A reference to this object.

UnsetModellingMatrixTranslation()

TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixTranslation

(

)

Removes the mask which removes transforms related to modelling matrix translation.

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::TransformMaskKit::staticType = HPS::Type::TransformMaskKit

static

---

The documentation for this class was generated from the following file:

• hps.h