TransformMaskControl

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

override void Dispose ()

override HPS.Type ObjectType ()

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

Return:The declared type of the object in question, which may differ from the true, underlying type.

HPS.TransformMaskControl SetCameraEverything (bool in_state)

Applies a mask which removes transforms related to camera.

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetCameraNearLimit (bool in_state)

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

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetCameraOffset (bool in_state)

Applies a mask which removes transforms related to camera offsets.

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetCameraPerspectiveScale (bool in_state)

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

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetCameraProjection (bool in_state)

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

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetCameraRotation (bool in_state)

Applies a mask which removes transforms related to camera rotations.

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetCameraScale (bool in_state)

Applies a mask which removes transforms related to camera scales.

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetCameraTranslation (bool in_state)

Applies a mask which removes transforms related to camera translations.

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetEverything (bool in_state)

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

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetModellingMatrixEverything (bool in_state)

Applies a mask which removes transforms related to modelling matrix.

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetModellingMatrixOffset (bool in_state)

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

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetModellingMatrixRotation (bool in_state)

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

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetModellingMatrixScale (bool in_state)

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

Param in_state:Whether the mask should be applied. Return:A reference to this object.

HPS.TransformMaskControl SetModellingMatrixTranslation (bool in_state)

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

Param in_state:Whether the mask should be applied. Return:A reference to this object.

bool ShowCameraNearLimit (out bool out_state)

Shows the camera near limit mask setting

Param out_state:  Whether the camera near limit transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowCameraOffset (out bool out_state)

Shows the camera offset mask setting

Param out_state:  Whether the camera offset transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowCameraPerspectiveScale (out bool out_state)

Shows the camera perspective scale mask setting

Param out_state:  Whether the camera perspective scale transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowCameraProjection (out bool out_state)

Shows the camera perspective projection mask setting

Param out_state:  Whether the camera perspective projection transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowCameraRotation (out bool out_state)

Shows the camera rotation mask setting

Param out_state:  Whether the camera rotation transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowCameraScale (out bool out_state)

Shows the camera scale mask setting

Param out_state:  Whether the camera scale transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowCameraTranslation (out bool out_state)

Shows the camera translation mask setting

Param out_state:  Whether the camera translation transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowModellingMatrixOffset (out bool out_state)

Shows the modelling matrix offset mask setting

Param out_state:  Whether the modelling matrix offset transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowModellingMatrixRotation (out bool out_state)

Shows the modelling matrix rotation mask setting

Param out_state:  Whether the modelling matrix rotation transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowModellingMatrixScale (out bool out_state)

Shows the modelling matrix scale mask setting

Param out_state:  Whether the modelling matrix scale transform mask is applied Return:true if the setting is valid, false otherwise.

bool ShowModellingMatrixTranslation (out bool out_state)

Shows the modelling matrix translation mask setting

Param out_state:  Whether the modelling matrix translation transform mask is applied Return:true if the setting is valid, false otherwise.

TransformMaskControl (HPS.SegmentKey in_seg)

Initializes a control tied to the segment in_seg.

TransformMaskControl (HPS.TransformMaskControl in_that)

Initializes a control tied to the same object as in_that.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.

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

Return:A reference to this object.