#include <hps.h>

Static Public Member Functions | |
static TransformMaskKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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
HPS::TransformMaskKit::TransformMaskKit | ( | ) |
Initializes an empty kit.
HPS::TransformMaskKit::TransformMaskKit | ( | TransformMaskKit const & | in_kit | ) |
Copies the kit in_kit into this kit.
HPS::TransformMaskKit::TransformMaskKit | ( | TransformMaskKit && | in_that | ) |
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
-
in_that An rvalue reference to a TransformMaskKit to take the impl from.
|
virtual |
Destroy this kit.
Member Function Documentation
|
virtual |
Returns whether this kit has any values currently set on it.
Reimplemented from HPS::Object.
bool HPS::TransformMaskKit::Equals | ( | TransformMaskKit const & | in_kit | ) | const |
Compares the contents of in_kit and this kit.
|
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.
bool HPS::TransformMaskKit::operator!= | ( | TransformMaskKit const & | in_kit | ) | const |
Compares the contents of in_kit and this kit.
TransformMaskKit& HPS::TransformMaskKit::operator= | ( | TransformMaskKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this TransformMaskKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an TransformMaskKit to take the impl from.
- Returns
- A reference to this TransformMaskKit.
TransformMaskKit& HPS::TransformMaskKit::operator= | ( | TransformMaskKit const & | in_kit | ) |
Copies the kit in_kit into this kit.
bool HPS::TransformMaskKit::operator== | ( | TransformMaskKit const & | in_kit | ) | const |
Compares the contents of in_kit and this kit.
void HPS::TransformMaskKit::Set | ( | TransformMaskKit const & | in_kit | ) |
Copies the kit in_kit into this kit.
TransformMaskKit& HPS::TransformMaskKit::SetCameraEverything | ( | bool | in_state | ) |
Applies a mask which removes transforms related to camera.
- Parameters
-
in_state Whether the mask should be applied.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::SetCameraNearLimit | ( | bool | in_state | ) |
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.
TransformMaskKit& HPS::TransformMaskKit::SetCameraOffset | ( | bool | in_state | ) |
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.
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.
TransformMaskKit& HPS::TransformMaskKit::SetCameraProjection | ( | bool | in_state | ) |
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.
TransformMaskKit& HPS::TransformMaskKit::SetCameraRotation | ( | bool | in_state | ) |
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.
TransformMaskKit& HPS::TransformMaskKit::SetCameraScale | ( | bool | in_state | ) |
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.
TransformMaskKit& HPS::TransformMaskKit::SetCameraTranslation | ( | bool | in_state | ) |
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.
TransformMaskKit& HPS::TransformMaskKit::SetEverything | ( | bool | in_state | ) |
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.
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.
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.
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.
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.
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.
void HPS::TransformMaskKit::Show | ( | TransformMaskKit & | out_kit | ) | const |
Copies this kit into out_kit.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
TransformMaskKit& HPS::TransformMaskKit::UnsetCameraEverything | ( | ) |
Removes the mask which removes transforms related to camera.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetCameraNearLimit | ( | ) |
Removes the mask which removes transforms related to camera near limit.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetCameraOffset | ( | ) |
Removes the mask which removes transforms related to camera offset.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetCameraPerspectiveScale | ( | ) |
Removes the mask which removes the perspective scale from perspective cameras.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetCameraProjection | ( | ) |
Removes the mask which removes the perspective projection from perspective cameras.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetCameraRotation | ( | ) |
Removes the mask which removes transforms related to camera rotation.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetCameraScale | ( | ) |
Removes the mask which removes transforms related to camera scale.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetCameraTranslation | ( | ) |
Removes the mask which removes transforms related to camera translation.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetEverything | ( | ) |
Removes the mask which removes transforms related to camera and modelling matrix.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixEverything | ( | ) |
Removes the mask which removes transforms related to modelling matrix everything.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixOffset | ( | ) |
Removes the mask which removes transforms related to modelling matrix offset.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixRotation | ( | ) |
Removes the mask which removes transforms related to modelling matrix rotation.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::UnsetModellingMatrixScale | ( | ) |
Removes the mask which removes transforms related to modelling matrix scale.
- Returns
- A reference to this object.
TransformMaskKit& HPS::TransformMaskKit::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:
- include/hps.h