TransformMaskKit
-
class
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
-
virtual bool
Empty() const Returns whether this kit has any values currently set on it.
-
bool
Equals(TransformMaskKit const &in_kit) const Compares the contents of in_kit and this kit.
-
inline virtual HPS::Type
ObjectType() const 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.
-
bool
operator!=(TransformMaskKit const &in_kit) const Compares the contents of in_kit and this kit.
-
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 &
operator=(TransformMaskKit const &in_kit) Copies the kit in_kit into this kit.
-
bool
operator==(TransformMaskKit const &in_kit) const Compares the contents of in_kit and this kit.
-
void
Set(TransformMaskKit const &in_kit) Copies the kit in_kit into this kit.
-
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 &
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 &
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 &
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 &
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 &
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 &
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 &
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 &
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 &
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 &
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 &
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 &
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 &
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
Show(TransformMaskKit &out_kit) const Copies this kit into out_kit.
-
bool
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
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
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
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
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
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
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
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
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
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
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() Initializes an empty kit.
-
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.
-
TransformMaskKit(TransformMaskKit const &in_kit) Copies the kit in_kit into this kit.
-
TransformMaskKit &
UnsetCameraEverything() Removes the mask which removes transforms related to camera.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetCameraNearLimit() Removes the mask which removes transforms related to camera near limit.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetCameraOffset() Removes the mask which removes transforms related to camera offset.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetCameraPerspectiveScale() Removes the mask which removes the perspective scale from perspective cameras.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetCameraProjection() Removes the mask which removes the perspective projection from perspective cameras.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetCameraRotation() Removes the mask which removes transforms related to camera rotation.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetCameraScale() Removes the mask which removes transforms related to camera scale.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetCameraTranslation() Removes the mask which removes transforms related to camera translation.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetEverything() Removes the mask which removes transforms related to camera and modelling matrix.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetModellingMatrixEverything() Removes the mask which removes transforms related to modelling matrix everything.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetModellingMatrixOffset() Removes the mask which removes transforms related to modelling matrix offset.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetModellingMatrixRotation() Removes the mask which removes transforms related to modelling matrix rotation.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetModellingMatrixScale() Removes the mask which removes transforms related to modelling matrix scale.
Returns: A reference to this object.
-
TransformMaskKit &
UnsetModellingMatrixTranslation() Removes the mask which removes transforms related to modelling matrix translation.
Returns: A reference to this object.
-
virtual
~TransformMaskKit() Destroy this kit.
Public Static Functions
-
static TransformMaskKit
GetDefault()
-
virtual bool