#include <hps.h>

Inheritance diagram for HPS::TransformMaskKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (TransformMaskKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (TransformMaskKit const &in_kit) const
 
TransformMaskKitoperator= (TransformMaskKit &&in_that)
 
TransformMaskKitoperator= (TransformMaskKit const &in_kit)
 
bool operator== (TransformMaskKit const &in_kit) const
 
void Set (TransformMaskKit const &in_kit)
 
TransformMaskKitSetCameraEverything (bool in_state)
 
TransformMaskKitSetCameraNearLimit (bool in_state)
 
TransformMaskKitSetCameraOffset (bool in_state)
 
TransformMaskKitSetCameraPerspectiveScale (bool in_state)
 
TransformMaskKitSetCameraProjection (bool in_state)
 
TransformMaskKitSetCameraRotation (bool in_state)
 
TransformMaskKitSetCameraScale (bool in_state)
 
TransformMaskKitSetCameraTranslation (bool in_state)
 
TransformMaskKitSetEverything (bool in_state)
 
TransformMaskKitSetModellingMatrixEverything (bool in_state)
 
TransformMaskKitSetModellingMatrixOffset (bool in_state)
 
TransformMaskKitSetModellingMatrixRotation (bool in_state)
 
TransformMaskKitSetModellingMatrixScale (bool in_state)
 
TransformMaskKitSetModellingMatrixTranslation (bool in_state)
 
void Show (TransformMaskKit &out_kit) const
 
bool ShowCameraNearLimit (bool &out_state) const
 
bool ShowCameraOffset (bool &out_state) const
 
bool ShowCameraPerspectiveScale (bool &out_state) const
 
bool ShowCameraProjection (bool &out_state) const
 
bool ShowCameraRotation (bool &out_state) const
 
bool ShowCameraScale (bool &out_state) const
 
bool ShowCameraTranslation (bool &out_state) const
 
bool ShowModellingMatrixOffset (bool &out_state) const
 
bool ShowModellingMatrixRotation (bool &out_state) const
 
bool ShowModellingMatrixScale (bool &out_state) const
 
bool ShowModellingMatrixTranslation (bool &out_state) const
 
 TransformMaskKit ()
 
 TransformMaskKit (TransformMaskKit const &in_kit)
 
 TransformMaskKit (TransformMaskKit &&in_that)
 
TransformMaskKitUnsetCameraEverything ()
 
TransformMaskKitUnsetCameraNearLimit ()
 
TransformMaskKitUnsetCameraOffset ()
 
TransformMaskKitUnsetCameraPerspectiveScale ()
 
TransformMaskKitUnsetCameraProjection ()
 
TransformMaskKitUnsetCameraRotation ()
 
TransformMaskKitUnsetCameraScale ()
 
TransformMaskKitUnsetCameraTranslation ()
 
TransformMaskKitUnsetEverything ()
 
TransformMaskKitUnsetModellingMatrixEverything ()
 
TransformMaskKitUnsetModellingMatrixOffset ()
 
TransformMaskKitUnsetModellingMatrixRotation ()
 
TransformMaskKitUnsetModellingMatrixScale ()
 
TransformMaskKitUnsetModellingMatrixTranslation ()
 
virtual ~TransformMaskKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static TransformMaskKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::TransformMaskKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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_thatAn rvalue reference to a TransformMaskKit to take the impl from.

◆ ~TransformMaskKit()

virtual HPS::TransformMaskKit::~TransformMaskKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ 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.

◆ ObjectType()

HPS::Type HPS::TransformMaskKit::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::Kit.

◆ 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_thatAn 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.

◆ 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether 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_stateWhether the modelling matrix translation transform mask is applied
Returns
true if the setting is valid, false otherwise.

◆ 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.

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