HPS::TransformMaskControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::TransformMaskControl:
HPS::Control HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
TransformMaskControloperator= (TransformMaskControl &&in_that)
 
TransformMaskControloperator= (TransformMaskControl const &in_that)
 
TransformMaskControlSetCameraEverything (bool in_state)
 
TransformMaskControlSetCameraNearLimit (bool in_state)
 
TransformMaskControlSetCameraOffset (bool in_state)
 
TransformMaskControlSetCameraPerspectiveScale (bool in_state)
 
TransformMaskControlSetCameraProjection (bool in_state)
 
TransformMaskControlSetCameraRotation (bool in_state)
 
TransformMaskControlSetCameraScale (bool in_state)
 
TransformMaskControlSetCameraTranslation (bool in_state)
 
TransformMaskControlSetEverything (bool in_state)
 
TransformMaskControlSetModellingMatrixEverything (bool in_state)
 
TransformMaskControlSetModellingMatrixOffset (bool in_state)
 
TransformMaskControlSetModellingMatrixRotation (bool in_state)
 
TransformMaskControlSetModellingMatrixScale (bool in_state)
 
TransformMaskControlSetModellingMatrixTranslation (bool in_state)
 
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
 
 TransformMaskControl (SegmentKey &in_seg)
 
 TransformMaskControl (TransformMaskControl const &in_that)
 
 TransformMaskControl (TransformMaskControl &&in_that)
 
virtual HPS::Type Type () const
 
TransformMaskControlUnsetCameraEverything ()
 
TransformMaskControlUnsetCameraNearLimit ()
 
TransformMaskControlUnsetCameraOffset ()
 
TransformMaskControlUnsetCameraPerspectiveScale ()
 
TransformMaskControlUnsetCameraProjection ()
 
TransformMaskControlUnsetCameraRotation ()
 
TransformMaskControlUnsetCameraScale ()
 
TransformMaskControlUnsetCameraTranslation ()
 
TransformMaskControlUnsetEverything ()
 
TransformMaskControlUnsetModellingMatrixEverything ()
 
TransformMaskControlUnsetModellingMatrixOffset ()
 
TransformMaskControlUnsetModellingMatrixRotation ()
 
TransformMaskControlUnsetModellingMatrixScale ()
 
TransformMaskControlUnsetModellingMatrixTranslation ()
 
 ~TransformMaskControl ()
 
- 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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::TransformMaskControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- 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::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The HPS::TransformMaskControl class is a smart pointer that is tied to a database object. This class allows you to manipulate the settings associated with a transform mask. A transform mask allows a segment to ignore its inherited transform. For example, if you want to be able to rotate a scene at a high level, but have a piece of geometry ignore rotations, you could achieve that effect using a transform mask. This table lists default values for the various segment attributes accessible from HPS::TransformMaskControl.

Constructor & Destructor Documentation

◆ TransformMaskControl() [1/3]

HPS::TransformMaskControl::TransformMaskControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ TransformMaskControl() [2/3]

HPS::TransformMaskControl::TransformMaskControl ( TransformMaskControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ TransformMaskControl() [3/3]

HPS::TransformMaskControl::TransformMaskControl ( TransformMaskControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a TransformMaskControl to take the impl from.

◆ ~TransformMaskControl()

HPS::TransformMaskControl::~TransformMaskControl ( )

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

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::TransformMaskControl::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::Control.

◆ operator=() [1/2]

TransformMaskControl& HPS::TransformMaskControl::operator= ( TransformMaskControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a TransformMaskControl to take the impl from.
Returns
A reference to this TransformMaskControl.

◆ operator=() [2/2]

TransformMaskControl& HPS::TransformMaskControl::operator= ( TransformMaskControl const &  in_that)

Share the underlying smart-pointer of the TransformMaskControl source.

Parameters
in_thatThe TransformMaskControl source of the assignment.
Returns
A reference to this TransformMaskControl.

◆ SetCameraEverything()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::SetCameraPerspectiveScale ( bool  in_state)

Applies a mask which removes transforms related to the camera perspective scale.

Parameters
in_stateWhether the mask should be applied.
Returns
A reference to this object.

◆ SetCameraProjection()

TransformMaskControl& HPS::TransformMaskControl::SetCameraProjection ( bool  in_state)

Applies a mask which removes transforms related to the camera perspective projection.

Parameters
in_stateWhether the mask should be applied.
Returns
A reference to this object.

◆ SetCameraRotation()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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()

TransformMaskControl& HPS::TransformMaskControl::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.

◆ ShowCameraNearLimit()

bool HPS::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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::TransformMaskControl::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.

◆ Type()

virtual HPS::Type HPS::TransformMaskControl::Type ( ) const
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetCameraEverything()

TransformMaskControl& HPS::TransformMaskControl::UnsetCameraEverything ( )

Removes the mask which removes transforms related to camera. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetCameraNearLimit()

TransformMaskControl& HPS::TransformMaskControl::UnsetCameraNearLimit ( )

Removes the mask which removes transforms related to camera near limit. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetCameraOffset()

TransformMaskControl& HPS::TransformMaskControl::UnsetCameraOffset ( )

Removes the mask which removes transforms related to camera offset. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetCameraPerspectiveScale()

TransformMaskControl& HPS::TransformMaskControl::UnsetCameraPerspectiveScale ( )

Removes the mask which removes transforms related to the camera perspective scale. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetCameraProjection()

TransformMaskControl& HPS::TransformMaskControl::UnsetCameraProjection ( )

Removes the mask which removes transforms related to the camera perspective projection. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetCameraRotation()

TransformMaskControl& HPS::TransformMaskControl::UnsetCameraRotation ( )

Removes the mask which removes transforms related to camera rotation. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetCameraScale()

TransformMaskControl& HPS::TransformMaskControl::UnsetCameraScale ( )

Removes the mask which removes transforms related to camera scale. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetCameraTranslation()

TransformMaskControl& HPS::TransformMaskControl::UnsetCameraTranslation ( )

Removes the mask which removes transforms related to camera translation. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetEverything()

TransformMaskControl& HPS::TransformMaskControl::UnsetEverything ( )

Removes the mask which removes transforms related to camera and modelling matrix. If the control is attached to a WindowKey this function restores the default settings of this control as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetModellingMatrixEverything()

TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixEverything ( )

Removes the mask which removes transforms related to modelling matrix everything. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetModellingMatrixOffset()

TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixOffset ( )

Removes the mask which removes transforms related to modelling matrix offset. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetModellingMatrixRotation()

TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixRotation ( )

Removes the mask which removes transforms related to modelling matrix rotation. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetModellingMatrixScale()

TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixScale ( )

Removes the mask which removes transforms related to modelling matrix scale. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

◆ UnsetModellingMatrixTranslation()

TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixTranslation ( )

Removes the mask which removes transforms related to modelling matrix translation. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().

Returns
A reference to this object.

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