HPS.TransformMaskControl Class Reference
Inheritance diagram for HPS.TransformMaskControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.TransformMaskControl SetCameraEverything (bool in_state)
 
HPS.TransformMaskControl SetCameraNearLimit (bool in_state)
 
HPS.TransformMaskControl SetCameraOffset (bool in_state)
 
HPS.TransformMaskControl SetCameraPerspectiveScale (bool in_state)
 
HPS.TransformMaskControl SetCameraProjection (bool in_state)
 
HPS.TransformMaskControl SetCameraRotation (bool in_state)
 
HPS.TransformMaskControl SetCameraScale (bool in_state)
 
HPS.TransformMaskControl SetCameraTranslation (bool in_state)
 
HPS.TransformMaskControl SetEverything (bool in_state)
 
HPS.TransformMaskControl SetModellingMatrixEverything (bool in_state)
 
HPS.TransformMaskControl SetModellingMatrixOffset (bool in_state)
 
HPS.TransformMaskControl SetModellingMatrixRotation (bool in_state)
 
HPS.TransformMaskControl SetModellingMatrixScale (bool in_state)
 
HPS.TransformMaskControl SetModellingMatrixTranslation (bool in_state)
 
bool ShowCameraNearLimit (out bool out_state)
 
bool ShowCameraOffset (out bool out_state)
 
bool ShowCameraPerspectiveScale (out bool out_state)
 
bool ShowCameraProjection (out bool out_state)
 
bool ShowCameraRotation (out bool out_state)
 
bool ShowCameraScale (out bool out_state)
 
bool ShowCameraTranslation (out bool out_state)
 
bool ShowModellingMatrixOffset (out bool out_state)
 
bool ShowModellingMatrixRotation (out bool out_state)
 
bool ShowModellingMatrixScale (out bool out_state)
 
bool ShowModellingMatrixTranslation (out bool out_state)
 
 TransformMaskControl (HPS.SegmentKey in_seg)
 
 TransformMaskControl (HPS.TransformMaskControl in_that)
 
override HPS.Type Type ()
 
HPS.TransformMaskControl UnsetCameraEverything ()
 
HPS.TransformMaskControl UnsetCameraNearLimit ()
 
HPS.TransformMaskControl UnsetCameraOffset ()
 
HPS.TransformMaskControl UnsetCameraPerspectiveScale ()
 
HPS.TransformMaskControl UnsetCameraProjection ()
 
HPS.TransformMaskControl UnsetCameraRotation ()
 
HPS.TransformMaskControl UnsetCameraScale ()
 
HPS.TransformMaskControl UnsetCameraTranslation ()
 
HPS.TransformMaskControl UnsetEverything ()
 
HPS.TransformMaskControl UnsetModellingMatrixEverything ()
 
HPS.TransformMaskControl UnsetModellingMatrixOffset ()
 
HPS.TransformMaskControl UnsetModellingMatrixRotation ()
 
HPS.TransformMaskControl UnsetModellingMatrixScale ()
 
HPS.TransformMaskControl UnsetModellingMatrixTranslation ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.TransformMaskControl.TransformMaskControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ TransformMaskControl() [2/2]

HPS.TransformMaskControl.TransformMaskControl ( HPS.TransformMaskControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.TransformMaskControl.ObjectType ( )
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.

◆ SetCameraEverything()

HPS.TransformMaskControl HPS.TransformMaskControl.SetCameraEverything ( bool  in_state)
inline

Applies a mask which removes transforms related to camera.

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

◆ SetCameraNearLimit()

HPS.TransformMaskControl HPS.TransformMaskControl.SetCameraNearLimit ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetCameraOffset ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetCameraPerspectiveScale ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetCameraProjection ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetCameraRotation ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetCameraScale ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetCameraTranslation ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetEverything ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetModellingMatrixEverything ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetModellingMatrixOffset ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetModellingMatrixRotation ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetModellingMatrixScale ( bool  in_state)
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.SetModellingMatrixTranslation ( bool  in_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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

override HPS.Type HPS.TransformMaskControl.Type ( )
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()

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraEverything ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraNearLimit ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraOffset ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraPerspectiveScale ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraProjection ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraRotation ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraScale ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraTranslation ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetEverything ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixEverything ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixOffset ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixRotation ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixScale ( )
inline

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

HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixTranslation ( )
inline

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:
  • internals/hps_core/source/cs/HPS.TransformMaskControl.cs