TransformMaskControl
-
class
TransformMaskControl: public HPS::Control 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.
Public Functions
-
inline virtual HPS::Type
ObjectType() const 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.
-
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_that – An rvalue reference to a TransformMaskControl to take the impl from. Returns: A reference to this TransformMaskControl.
-
TransformMaskControl &
operator=(TransformMaskControl const &in_that) Share the underlying smart-pointer of the TransformMaskControl source.
Parameters: in_that – The TransformMaskControl source of the assignment. Returns: A reference to this TransformMaskControl.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
SetCameraPerspectiveScale(bool in_state) Applies a mask which removes transforms related to the camera perspective scale.
Parameters: in_state – Whether the mask should be applied. Returns: A reference to this object.
-
TransformMaskControl &
SetCameraProjection(bool in_state) Applies a mask which removes transforms related to the camera perspective projection.
Parameters: in_state – Whether the mask should be applied. Returns: A reference to this object.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
TransformMaskControl &
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
bool
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.
-
explicit
TransformMaskControl(SegmentKey &in_seg) Initializes a control tied to the segment in_seg.
-
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_that – An rvalue reference to a TransformMaskControl to take the impl from.
-
TransformMaskControl(TransformMaskControl const &in_that) Initializes a control tied to the same object as in_that.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
~TransformMaskControl() Releases a reference to the database object this control is tied to.
-
inline virtual HPS::Type