Inheritance diagram for HPS.TransformMaskKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.TransformMaskKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.TransformMaskKit in_kit)
 
HPS.TransformMaskKit SetCameraEverything (bool in_state)
 
HPS.TransformMaskKit SetCameraNearLimit (bool in_state)
 
HPS.TransformMaskKit SetCameraOffset (bool in_state)
 
HPS.TransformMaskKit SetCameraPerspectiveScale (bool in_state)
 
HPS.TransformMaskKit SetCameraProjection (bool in_state)
 
HPS.TransformMaskKit SetCameraRotation (bool in_state)
 
HPS.TransformMaskKit SetCameraScale (bool in_state)
 
HPS.TransformMaskKit SetCameraTranslation (bool in_state)
 
HPS.TransformMaskKit SetEverything (bool in_state)
 
HPS.TransformMaskKit SetModellingMatrixEverything (bool in_state)
 
HPS.TransformMaskKit SetModellingMatrixOffset (bool in_state)
 
HPS.TransformMaskKit SetModellingMatrixRotation (bool in_state)
 
HPS.TransformMaskKit SetModellingMatrixScale (bool in_state)
 
HPS.TransformMaskKit SetModellingMatrixTranslation (bool in_state)
 
void Show (out HPS.TransformMaskKit out_kit)
 
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)
 
 TransformMaskKit ()
 
 TransformMaskKit (HPS.TransformMaskKit in_kit)
 
HPS.TransformMaskKit UnsetCameraEverything ()
 
HPS.TransformMaskKit UnsetCameraNearLimit ()
 
HPS.TransformMaskKit UnsetCameraOffset ()
 
HPS.TransformMaskKit UnsetCameraPerspectiveScale ()
 
HPS.TransformMaskKit UnsetCameraProjection ()
 
HPS.TransformMaskKit UnsetCameraRotation ()
 
HPS.TransformMaskKit UnsetCameraScale ()
 
HPS.TransformMaskKit UnsetCameraTranslation ()
 
HPS.TransformMaskKit UnsetEverything ()
 
HPS.TransformMaskKit UnsetModellingMatrixEverything ()
 
HPS.TransformMaskKit UnsetModellingMatrixOffset ()
 
HPS.TransformMaskKit UnsetModellingMatrixRotation ()
 
HPS.TransformMaskKit UnsetModellingMatrixScale ()
 
HPS.TransformMaskKit UnsetModellingMatrixTranslation ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.TransformMaskKit GetDefault ()
 
static bool operator!= (HPS.TransformMaskKit a, HPS.TransformMaskKit b)
 
static bool operator== (HPS.TransformMaskKit a, HPS.TransformMaskKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ TransformMaskKit() [1/2]

HPS.TransformMaskKit.TransformMaskKit ( )
inline

Initializes an empty kit.

◆ TransformMaskKit() [2/2]

HPS.TransformMaskKit.TransformMaskKit ( HPS.TransformMaskKit  in_kit)
inline

Copies the kit in_kit into this kit.

Member Function Documentation

◆ Empty()

override bool HPS.TransformMaskKit.Empty ( )
inlinevirtual

Returns whether this kit has any values currently set on it.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.TransformMaskKit.Equals ( HPS.TransformMaskKit  in_kit)
inline

Compares the contents of in_kit and this kit.

◆ ObjectType()

override HPS.Type HPS.TransformMaskKit.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.Kit.

◆ Set()

void HPS.TransformMaskKit.Set ( HPS.TransformMaskKit  in_kit)
inline

Copies the kit in_kit into this kit.

◆ SetCameraEverything()

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

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

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

◆ SetCameraProjection()

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

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

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

◆ SetCameraRotation()

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

◆ Show()

void HPS.TransformMaskKit.Show ( out HPS.TransformMaskKit  out_kit)
inline

Copies this kit into out_kit.

◆ ShowCameraNearLimit()

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

◆ UnsetCameraEverything()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetCameraEverything ( )
inline

Removes the mask which removes transforms related to camera.

Returns
A reference to this object.

◆ UnsetCameraNearLimit()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetCameraNearLimit ( )
inline

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

Returns
A reference to this object.

◆ UnsetCameraOffset()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetCameraOffset ( )
inline

Removes the mask which removes transforms related to camera offset.

Returns
A reference to this object.

◆ UnsetCameraPerspectiveScale()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetCameraPerspectiveScale ( )
inline

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

Returns
A reference to this object.

◆ UnsetCameraProjection()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetCameraProjection ( )
inline

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

Returns
A reference to this object.

◆ UnsetCameraRotation()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetCameraRotation ( )
inline

Removes the mask which removes transforms related to camera rotation.

Returns
A reference to this object.

◆ UnsetCameraScale()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetCameraScale ( )
inline

Removes the mask which removes transforms related to camera scale.

Returns
A reference to this object.

◆ UnsetCameraTranslation()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetCameraTranslation ( )
inline

Removes the mask which removes transforms related to camera translation.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetEverything ( )
inline

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

Returns
A reference to this object.

◆ UnsetModellingMatrixEverything()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetModellingMatrixEverything ( )
inline

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

Returns
A reference to this object.

◆ UnsetModellingMatrixOffset()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetModellingMatrixOffset ( )
inline

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

Returns
A reference to this object.

◆ UnsetModellingMatrixRotation()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetModellingMatrixRotation ( )
inline

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

Returns
A reference to this object.

◆ UnsetModellingMatrixScale()

HPS.TransformMaskKit HPS.TransformMaskKit.UnsetModellingMatrixScale ( )
inline

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

Returns
A reference to this object.

◆ UnsetModellingMatrixTranslation()

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