#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::TransformMaskKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ TransformMaskKit() [1/3]
HPS::TransformMaskKit::TransformMaskKit |
( |
| ) |
|
Initializes an empty kit.
◆ TransformMaskKit() [2/3]
Copies the kit in_kit into this kit.
◆ TransformMaskKit() [3/3]
The move constructor creates a TransformMaskKit by transferring the underlying impl of the rvalue reference to this TransformMaskKit thereby avoiding a copy and allocation.
- Parameters
-
◆ ~TransformMaskKit()
virtual HPS::TransformMaskKit::~TransformMaskKit |
( |
| ) |
|
|
virtual |
◆ Empty()
bool HPS::TransformMaskKit::Empty |
( |
| ) |
const |
|
virtual |
Returns whether this kit has any values currently set on it.
Reimplemented from HPS::Object.
◆ Equals()
Compares the contents of in_kit and this kit.
◆ ObjectType()
HPS::Type HPS::TransformMaskKit::ObjectType |
( |
| ) |
const |
|
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.
◆ operator!=()
Compares the contents of in_kit and this kit.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this TransformMaskKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this TransformMaskKit.
◆ operator=() [2/2]
Copies the kit in_kit into this kit.
◆ operator==()
Compares the contents of in_kit and this kit.
◆ Set()
Copies the kit in_kit into this kit.
◆ 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()
TransformMaskKit& HPS::TransformMaskKit::SetCameraPerspectiveScale |
( |
bool |
in_state | ) |
|
Applies a mask which removes the perspective scale from perspective cameras.
- Parameters
-
in_state | Whether the mask should be applied. |
- Returns
- A reference to this object.
◆ SetCameraProjection()
Applies a mask which removes the perspective projection and replaces it with an orthographic projection from perspective cameras.
- 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()
TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixEverything |
( |
bool |
in_state | ) |
|
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()
TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixOffset |
( |
bool |
in_state | ) |
|
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()
TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixRotation |
( |
bool |
in_state | ) |
|
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()
TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixScale |
( |
bool |
in_state | ) |
|
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()
TransformMaskKit& HPS::TransformMaskKit::SetModellingMatrixTranslation |
( |
bool |
in_state | ) |
|
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.
◆ Show()
Copies this kit into out_kit.
◆ ShowCameraNearLimit()
bool HPS::TransformMaskKit::ShowCameraNearLimit |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowCameraOffset |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowCameraPerspectiveScale |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowCameraProjection |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowCameraRotation |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowCameraScale |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowCameraTranslation |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowModellingMatrixOffset |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowModellingMatrixRotation |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowModellingMatrixScale |
( |
bool & |
out_state | ) |
const |
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::TransformMaskKit::ShowModellingMatrixTranslation |
( |
bool & |
out_state | ) |
const |
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.
◆ UnsetCameraEverything()
Removes the mask which removes transforms related to camera.
- Returns
- A reference to this object.
◆ UnsetCameraNearLimit()
Removes the mask which removes transforms related to camera near limit.
- Returns
- A reference to this object.
◆ UnsetCameraOffset()
Removes the mask which removes transforms related to camera offset.
- Returns
- A reference to this object.
◆ UnsetCameraPerspectiveScale()
Removes the mask which removes the perspective scale from perspective cameras.
- Returns
- A reference to this object.
◆ UnsetCameraProjection()
Removes the mask which removes the perspective projection from perspective cameras.
- Returns
- A reference to this object.
◆ UnsetCameraRotation()
Removes the mask which removes transforms related to camera rotation.
- Returns
- A reference to this object.
◆ UnsetCameraScale()
Removes the mask which removes transforms related to camera scale.
- Returns
- A reference to this object.
◆ UnsetCameraTranslation()
Removes the mask which removes transforms related to camera translation.
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes the mask which removes transforms related to camera and modelling matrix.
- Returns
- A reference to this object.
◆ UnsetModellingMatrixEverything()
Removes the mask which removes transforms related to modelling matrix everything.
- Returns
- A reference to this object.
◆ UnsetModellingMatrixOffset()
Removes the mask which removes transforms related to modelling matrix offset.
- Returns
- A reference to this object.
◆ UnsetModellingMatrixRotation()
Removes the mask which removes transforms related to modelling matrix rotation.
- Returns
- A reference to this object.
◆ UnsetModellingMatrixScale()
Removes the mask which removes transforms related to modelling matrix scale.
- Returns
- A reference to this object.
◆ UnsetModellingMatrixTranslation()
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: