|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ TransformMaskControl() [1/2]
HPS.TransformMaskControl.TransformMaskControl |
( |
HPS.SegmentKey |
in_seg | ) |
|
|
inline |
Initializes a control tied to the segment in_seg.
◆ TransformMaskControl() [2/2]
Initializes a control tied to the same object as in_that.
◆ 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()
Applies a mask which removes transforms related to camera.
- Parameters
-
in_state | Whether the mask should be applied. |
- Returns
- A reference to this object.
◆ SetCameraNearLimit()
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.
◆ SetCameraOffset()
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.
◆ SetCameraPerspectiveScale()
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.
◆ SetCameraProjection()
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.
◆ SetCameraRotation()
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.
◆ SetCameraScale()
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.
◆ SetCameraTranslation()
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.
◆ SetEverything()
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.
◆ SetModellingMatrixEverything()
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.
◆ SetModellingMatrixOffset()
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.
◆ SetModellingMatrixRotation()
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.
◆ SetModellingMatrixScale()
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.
◆ SetModellingMatrixTranslation()
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.
◆ ShowCameraNearLimit()
bool HPS.TransformMaskControl.ShowCameraNearLimit |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowCameraOffset()
bool HPS.TransformMaskControl.ShowCameraOffset |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowCameraPerspectiveScale()
bool HPS.TransformMaskControl.ShowCameraPerspectiveScale |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowCameraProjection()
bool HPS.TransformMaskControl.ShowCameraProjection |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowCameraRotation()
bool HPS.TransformMaskControl.ShowCameraRotation |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowCameraScale()
bool HPS.TransformMaskControl.ShowCameraScale |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowCameraTranslation()
bool HPS.TransformMaskControl.ShowCameraTranslation |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowModellingMatrixOffset()
bool HPS.TransformMaskControl.ShowModellingMatrixOffset |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowModellingMatrixRotation()
bool HPS.TransformMaskControl.ShowModellingMatrixRotation |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowModellingMatrixScale()
bool HPS.TransformMaskControl.ShowModellingMatrixScale |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowModellingMatrixTranslation()
bool HPS.TransformMaskControl.ShowModellingMatrixTranslation |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ 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()
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()
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()
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()
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()
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()
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()
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()
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()
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()
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()
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()
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()
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()
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