TransformMaskKit

class HPS.TransformMaskKit : public HPS.Kit 

The HPS.TransformMaskKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.TransformMaskKit.GetDefault() will return a kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty (): Returns whether this kit has any values currently set on it.

bool Equals (HPS.TransformMaskKit in_kit): Compares the contents of in_kit and this kit.

override bool Equals (Object obj)

override int GetHashCode ()

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.

void Set (HPS.TransformMaskKit in_kit): Copies the kit in_kit into this kit.

HPS.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit SetCameraPerspectiveScale (bool in_state)

Applies a mask which removes the perspective scale from perspective cameras.

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

HPS.TransformMaskKit SetCameraProjection (bool in_state)

Applies a mask which removes the perspective projection and replaces it with an orthographic projection from perspective cameras.

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

HPS.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit 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.TransformMaskKit 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.

void Show (out HPS.TransformMaskKit out_kit): Copies this kit into out_kit.

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.

TransformMaskKit (): Initializes an empty kit.

TransformMaskKit (HPS.TransformMaskKit in_kit): Copies the kit in_kit into this kit.

HPS.TransformMaskKit UnsetCameraEverything ()

Removes the mask which removes transforms related to camera.

Return: A reference to this object.

HPS.TransformMaskKit UnsetCameraNearLimit ()

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

Return: A reference to this object.

HPS.TransformMaskKit UnsetCameraOffset ()

Removes the mask which removes transforms related to camera offset.

Return: A reference to this object.

HPS.TransformMaskKit UnsetCameraPerspectiveScale ()

Removes the mask which removes the perspective scale from perspective cameras.

Return: A reference to this object.

HPS.TransformMaskKit UnsetCameraProjection ()

Removes the mask which removes the perspective projection from perspective cameras.

Return: A reference to this object.

HPS.TransformMaskKit UnsetCameraRotation ()

Removes the mask which removes transforms related to camera rotation.

Return: A reference to this object.

HPS.TransformMaskKit UnsetCameraScale ()

Removes the mask which removes transforms related to camera scale.

Return: A reference to this object.

HPS.TransformMaskKit UnsetCameraTranslation ()

Removes the mask which removes transforms related to camera translation.

Return: A reference to this object.

HPS.TransformMaskKit UnsetEverything ()

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

Return: A reference to this object.

HPS.TransformMaskKit UnsetModellingMatrixEverything ()

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

Return: A reference to this object.

HPS.TransformMaskKit UnsetModellingMatrixOffset ()

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

Return: A reference to this object.

HPS.TransformMaskKit UnsetModellingMatrixRotation ()

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

Return: A reference to this object.

HPS.TransformMaskKit UnsetModellingMatrixScale ()

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

Return: A reference to this object.

HPS.TransformMaskKit UnsetModellingMatrixTranslation ()

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

Return: A reference to this object.

Public Static Functions

HPS.TransformMaskKit GetDefault ()

bool operator!= (HPS.TransformMaskKit a, HPS.TransformMaskKit b)

bool operator== (HPS.TransformMaskKit a, HPS.TransformMaskKit b)