HPS.TransformMaskControl Class Reference

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

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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
HPS.TransformMaskControl SetCameraEverything (bool in_state)
 Applies a mask which removes transforms related to camera. More...
 
HPS.TransformMaskControl SetCameraNearLimit (bool in_state)
 Applies a mask which removes transforms related to camera near limit. More...
 
HPS.TransformMaskControl SetCameraOffset (bool in_state)
 Applies a mask which removes transforms related to camera offsets. More...
 
HPS.TransformMaskControl SetCameraPerspectiveScale (bool in_state)
 Applies a mask which removes transforms related to the camera perspective scale. More...
 
HPS.TransformMaskControl SetCameraProjection (bool in_state)
 Applies a mask which removes transforms related to the camera perspective projection. More...
 
HPS.TransformMaskControl SetCameraRotation (bool in_state)
 Applies a mask which removes transforms related to camera rotations. More...
 
HPS.TransformMaskControl SetCameraScale (bool in_state)
 Applies a mask which removes transforms related to camera scales. More...
 
HPS.TransformMaskControl SetCameraTranslation (bool in_state)
 Applies a mask which removes transforms related to camera translations. More...
 
HPS.TransformMaskControl SetEverything (bool in_state)
 Applies a mask which removes all transforms related to both modelling matrix and camera. More...
 
HPS.TransformMaskControl SetModellingMatrixEverything (bool in_state)
 Applies a mask which removes transforms related to modelling matrix. More...
 
HPS.TransformMaskControl SetModellingMatrixOffset (bool in_state)
 Applies a mask which removes transforms related to all modelling matrix offset. More...
 
HPS.TransformMaskControl SetModellingMatrixRotation (bool in_state)
 Applies a mask which removes transforms related to all modelling matrix rotations. More...
 
HPS.TransformMaskControl SetModellingMatrixScale (bool in_state)
 Applies a mask which removes transforms related to all modelling matrix scales. More...
 
HPS.TransformMaskControl SetModellingMatrixTranslation (bool in_state)
 Applies a mask which removes transforms related to all modelling matrix translation. More...
 
bool ShowCameraNearLimit (out bool out_state)
 Shows the camera near limit mask setting More...
 
bool ShowCameraOffset (out bool out_state)
 Shows the camera offset mask setting More...
 
bool ShowCameraPerspectiveScale (out bool out_state)
 Shows the camera perspective scale mask setting More...
 
bool ShowCameraProjection (out bool out_state)
 Shows the camera perspective projection mask setting More...
 
bool ShowCameraRotation (out bool out_state)
 Shows the camera rotation mask setting More...
 
bool ShowCameraScale (out bool out_state)
 Shows the camera scale mask setting More...
 
bool ShowCameraTranslation (out bool out_state)
 Shows the camera translation mask setting More...
 
bool ShowModellingMatrixOffset (out bool out_state)
 Shows the modelling matrix offset mask setting More...
 
bool ShowModellingMatrixRotation (out bool out_state)
 Shows the modelling matrix rotation mask setting More...
 
bool ShowModellingMatrixScale (out bool out_state)
 Shows the modelling matrix scale mask setting More...
 
bool ShowModellingMatrixTranslation (out bool out_state)
 Shows the modelling matrix translation mask setting More...
 
 TransformMaskControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 TransformMaskControl (HPS.TransformMaskControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
HPS.TransformMaskControl UnsetCameraEverything ()
 Removes the mask which removes transforms related to camera. More...
 
HPS.TransformMaskControl UnsetCameraNearLimit ()
 Removes the mask which removes transforms related to camera near limit. More...
 
HPS.TransformMaskControl UnsetCameraOffset ()
 Removes the mask which removes transforms related to camera offset. More...
 
HPS.TransformMaskControl UnsetCameraPerspectiveScale ()
 Removes the mask which removes transforms related to the camera perspective scale. More...
 
HPS.TransformMaskControl UnsetCameraProjection ()
 Removes the mask which removes transforms related to the camera perspective projection. More...
 
HPS.TransformMaskControl UnsetCameraRotation ()
 Removes the mask which removes transforms related to camera rotation. More...
 
HPS.TransformMaskControl UnsetCameraScale ()
 Removes the mask which removes transforms related to camera scale. More...
 
HPS.TransformMaskControl UnsetCameraTranslation ()
 Removes the mask which removes transforms related to camera translation. More...
 
HPS.TransformMaskControl UnsetEverything ()
 Removes the mask which removes transforms related to camera and modelling matrix. More...
 
HPS.TransformMaskControl UnsetModellingMatrixEverything ()
 Removes the mask which removes transforms related to modelling matrix everything. More...
 
HPS.TransformMaskControl UnsetModellingMatrixOffset ()
 Removes the mask which removes transforms related to modelling matrix offset. More...
 
HPS.TransformMaskControl UnsetModellingMatrixRotation ()
 Removes the mask which removes transforms related to modelling matrix rotation. More...
 
HPS.TransformMaskControl UnsetModellingMatrixScale ()
 Removes the mask which removes transforms related to modelling matrix scale. More...
 
HPS.TransformMaskControl UnsetModellingMatrixTranslation ()
 Removes the mask which removes transforms related to modelling matrix translation. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 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. More...
 

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

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

Initializes a control tied to the segment in_seg.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

override HPS.Type HPS.TransformMaskControl.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraEverything ( )
inline

Removes the mask which removes transforms related to camera.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraNearLimit ( )
inline

Removes the mask which removes transforms related to camera near limit.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraOffset ( )
inline

Removes the mask which removes transforms related to camera offset.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraPerspectiveScale ( )
inline

Removes the mask which removes transforms related to the camera perspective scale.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraProjection ( )
inline

Removes the mask which removes transforms related to the camera perspective projection.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraRotation ( )
inline

Removes the mask which removes transforms related to camera rotation.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraScale ( )
inline

Removes the mask which removes transforms related to camera scale.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetCameraTranslation ( )
inline

Removes the mask which removes transforms related to camera translation.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetEverything ( )
inline

Removes the mask which removes transforms related to camera and modelling matrix.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixEverything ( )
inline

Removes the mask which removes transforms related to modelling matrix everything.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixOffset ( )
inline

Removes the mask which removes transforms related to modelling matrix offset.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixRotation ( )
inline

Removes the mask which removes transforms related to modelling matrix rotation.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixScale ( )
inline

Removes the mask which removes transforms related to modelling matrix scale.

Returns
A reference to this object.
HPS.TransformMaskControl HPS.TransformMaskControl.UnsetModellingMatrixTranslation ( )
inline

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