The HPS::TransformMaskControl class is a smart pointer that is tied to a database object. More...
#include <hps.h>
Public Member Functions | |
TransformMaskControl (SegmentKey &in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
TransformMaskControl (TransformMaskControl const &in_that) | |
Initializes a control tied to the same object as in_that. More... | |
TransformMaskControl (TransformMaskControl &&in_that) | |
The move constructor creates a TransformMaskControl by transferring the underlying impl of the rvalue reference to this TransformMaskControl thereby avoiding a copy and allocation. More... | |
TransformMaskControl & | operator= (TransformMaskControl &&in_that) |
The move assignment operator transfers the underlying impl of the rvalue reference to this TransformMaskControl thereby avoiding a copy. More... | |
~TransformMaskControl () | |
Releases a reference to the database object this control is tied to. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. More... | |
HPS::Type | ObjectType () const |
TransformMaskControl & | operator= (TransformMaskControl const &in_that) |
Share the underlying smart-pointer of the TransformMaskControl source. More... | |
TransformMaskControl & | SetCameraRotation (bool in_state) |
Applies a mask which removes transforms related to camera rotations. More... | |
TransformMaskControl & | SetCameraScale (bool in_state) |
Applies a mask which removes transforms related to camera scales. More... | |
TransformMaskControl & | SetCameraTranslation (bool in_state) |
Applies a mask which removes transforms related to camera translations. More... | |
TransformMaskControl & | SetCameraPerspectiveScale (bool in_state) |
Applies a mask which removes transforms related to the camera perspective scale. More... | |
TransformMaskControl & | SetCameraProjection (bool in_state) |
Applies a mask which removes transforms related to the camera perspective projection. More... | |
TransformMaskControl & | SetCameraOffset (bool in_state) |
Applies a mask which removes transforms related to camera offsets. More... | |
TransformMaskControl & | SetCameraNearLimit (bool in_state) |
Applies a mask which removes transforms related to camera near limit. More... | |
TransformMaskControl & | SetModellingMatrixRotation (bool in_state) |
Applies a mask which removes transforms related to all modelling matrix rotations. More... | |
TransformMaskControl & | SetModellingMatrixScale (bool in_state) |
Applies a mask which removes transforms related to all modelling matrix scales. More... | |
TransformMaskControl & | SetModellingMatrixTranslation (bool in_state) |
Applies a mask which removes transforms related to all modelling matrix translation. More... | |
TransformMaskControl & | SetModellingMatrixOffset (bool in_state) |
Applies a mask which removes transforms related to all modelling matrix offset. More... | |
TransformMaskControl & | SetCameraEverything (bool in_state) |
Applies a mask which removes transforms related to camera. More... | |
TransformMaskControl & | SetModellingMatrixEverything (bool in_state) |
Applies a mask which removes transforms related to modelling matrix. More... | |
TransformMaskControl & | SetEverything (bool in_state) |
Applies a mask which removes all transforms related to both modelling matrix and camera. More... | |
TransformMaskControl & | UnsetCameraRotation () |
Removes the mask which removes transforms related to camera rotation. More... | |
TransformMaskControl & | UnsetCameraScale () |
Removes the mask which removes transforms related to camera scale. More... | |
TransformMaskControl & | UnsetCameraTranslation () |
Removes the mask which removes transforms related to camera translation. More... | |
TransformMaskControl & | UnsetCameraPerspectiveScale () |
Removes the mask which removes transforms related to the camera perspective scale. More... | |
TransformMaskControl & | UnsetCameraProjection () |
Removes the mask which removes transforms related to the camera perspective projection. More... | |
TransformMaskControl & | UnsetCameraOffset () |
Removes the mask which removes transforms related to camera offset. More... | |
TransformMaskControl & | UnsetCameraNearLimit () |
Removes the mask which removes transforms related to camera near limit. More... | |
TransformMaskControl & | UnsetCameraEverything () |
Removes the mask which removes transforms related to camera. More... | |
TransformMaskControl & | UnsetModellingMatrixRotation () |
Removes the mask which removes transforms related to modelling matrix rotation. More... | |
TransformMaskControl & | UnsetModellingMatrixScale () |
Removes the mask which removes transforms related to modelling matrix scale. More... | |
TransformMaskControl & | UnsetModellingMatrixTranslation () |
Removes the mask which removes transforms related to modelling matrix translation. More... | |
TransformMaskControl & | UnsetModellingMatrixOffset () |
Removes the mask which removes transforms related to modelling matrix offset. More... | |
TransformMaskControl & | UnsetModellingMatrixEverything () |
Removes the mask which removes transforms related to modelling matrix everything. More... | |
TransformMaskControl & | UnsetEverything () |
Removes the mask which removes transforms related to camera and modelling matrix. More... | |
bool | ShowCameraRotation (bool &out_state) const |
Shows the camera rotation mask setting. More... | |
bool | ShowCameraScale (bool &out_state) const |
Shows the camera scale mask setting. More... | |
bool | ShowCameraTranslation (bool &out_state) const |
Shows the camera translation mask setting. More... | |
bool | ShowCameraPerspectiveScale (bool &out_state) const |
Shows the camera perspective scale mask setting. More... | |
bool | ShowCameraProjection (bool &out_state) const |
Shows the camera perspective projection mask setting. More... | |
bool | ShowCameraOffset (bool &out_state) const |
Shows the camera offset mask setting. More... | |
bool | ShowCameraNearLimit (bool &out_state) const |
Shows the camera near limit mask setting. More... | |
bool | ShowModellingMatrixRotation (bool &out_state) const |
Shows the modelling matrix rotation mask setting. More... | |
bool | ShowModellingMatrixScale (bool &out_state) const |
Shows the modelling matrix scale mask setting. More... | |
bool | ShowModellingMatrixTranslation (bool &out_state) const |
Shows the modelling matrix translation mask setting. More... | |
bool | ShowModellingMatrixOffset (bool &out_state) const |
Shows the modelling matrix offset mask setting. More... | |
virtual bool | Empty () const |
Indicates whether this object has any values set on it. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS::Type in_mask) const |
This function indicates whether this Object has the given Type mask. More... | |
intptr_t | GetClassID () const |
Returns a unique identifier that is shared by all objects of the same class. More... | |
intptr_t | GetInstanceID () const |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
Static Public Member Functions | |
template<typename T > | |
static intptr_t | ClassID () |
Unique identifier for this class. More... | |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::TransformMaskControl |
Private Member Functions | |
TransformMaskControl () | |
Private default constructor to prevent instantiation without a segment. More... | |
The HPS::TransformMaskControl class is a smart pointer that is tied to a database object.
This class allows you to manipulate the settings associated with a transform mask. A transform mask allows a segment to ignore its inherited transform. For example, if you want to be able to rotate a scene at a high level, but have a piece of geometry ignore rotations, you could achieve that effect using a transform mask. This table lists default values for the various segment attributes accessible from HPS::TransformMaskControl.
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::TransformMaskControl::TransformMaskControl | ( | TransformMaskControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::TransformMaskControl::TransformMaskControl | ( | TransformMaskControl && | in_that | ) |
The move constructor creates a TransformMaskControl by transferring the underlying impl of the rvalue reference to this TransformMaskControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a TransformMaskControl to take the impl from. |
HPS::TransformMaskControl::~TransformMaskControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlineprivate |
Private default constructor to prevent instantiation without a segment.
|
inlinestaticinherited |
Unique identifier for this class.
Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.
|
inlinevirtualinherited |
Indicates whether this object has any values set on it.
Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
inherited |
Returns an identifier that can be used to identify which instance of a class an object is.
Different keys and controls will return the same value if they are backed by the same database resource.
|
inherited |
|
inlinevirtual |
Reimplemented from HPS::Control.
TransformMaskControl& HPS::TransformMaskControl::operator= | ( | TransformMaskControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this TransformMaskControl thereby avoiding a copy.
in_that | An rvalue reference to a TransformMaskControl to take the impl from. |
TransformMaskControl& HPS::TransformMaskControl::operator= | ( | TransformMaskControl const & | in_that | ) |
Share the underlying smart-pointer of the TransformMaskControl source.
in_that | The TransformMaskControl source of the assignment. |
|
virtualinherited |
Resets this object to its initial, uninitialized state.
Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.
TransformMaskControl& HPS::TransformMaskControl::SetCameraEverything | ( | bool | in_state | ) |
Applies a mask which removes transforms related to camera.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetCameraNearLimit | ( | bool | in_state | ) |
Applies a mask which removes transforms related to camera near limit.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetCameraOffset | ( | bool | in_state | ) |
Applies a mask which removes transforms related to camera offsets.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetCameraPerspectiveScale | ( | bool | in_state | ) |
Applies a mask which removes transforms related to the camera perspective scale.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetCameraProjection | ( | bool | in_state | ) |
Applies a mask which removes transforms related to the camera perspective projection.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetCameraRotation | ( | bool | in_state | ) |
Applies a mask which removes transforms related to camera rotations.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetCameraScale | ( | bool | in_state | ) |
Applies a mask which removes transforms related to camera scales.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetCameraTranslation | ( | bool | in_state | ) |
Applies a mask which removes transforms related to camera translations.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetEverything | ( | bool | in_state | ) |
Applies a mask which removes all transforms related to both modelling matrix and camera.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetModellingMatrixEverything | ( | bool | in_state | ) |
Applies a mask which removes transforms related to modelling matrix.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetModellingMatrixOffset | ( | bool | in_state | ) |
Applies a mask which removes transforms related to all modelling matrix offset.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetModellingMatrixRotation | ( | bool | in_state | ) |
Applies a mask which removes transforms related to all modelling matrix rotations.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetModellingMatrixScale | ( | bool | in_state | ) |
Applies a mask which removes transforms related to all modelling matrix scales.
in_state | Whether the mask should be applied. |
TransformMaskControl& HPS::TransformMaskControl::SetModellingMatrixTranslation | ( | bool | in_state | ) |
Applies a mask which removes transforms related to all modelling matrix translation.
in_state | Whether the mask should be applied. |
bool HPS::TransformMaskControl::ShowCameraNearLimit | ( | bool & | out_state | ) | const |
Shows the camera near limit mask setting.
out_state | Whether the camera near limit transform mask is applied |
bool HPS::TransformMaskControl::ShowCameraOffset | ( | bool & | out_state | ) | const |
Shows the camera offset mask setting.
out_state | Whether the camera offset transform mask is applied |
bool HPS::TransformMaskControl::ShowCameraPerspectiveScale | ( | bool & | out_state | ) | const |
Shows the camera perspective scale mask setting.
out_state | Whether the camera perspective scale transform mask is applied |
bool HPS::TransformMaskControl::ShowCameraProjection | ( | bool & | out_state | ) | const |
Shows the camera perspective projection mask setting.
out_state | Whether the camera perspective projection transform mask is applied |
bool HPS::TransformMaskControl::ShowCameraRotation | ( | bool & | out_state | ) | const |
Shows the camera rotation mask setting.
out_state | Whether the camera rotation transform mask is applied |
bool HPS::TransformMaskControl::ShowCameraScale | ( | bool & | out_state | ) | const |
Shows the camera scale mask setting.
out_state | Whether the camera scale transform mask is applied |
bool HPS::TransformMaskControl::ShowCameraTranslation | ( | bool & | out_state | ) | const |
Shows the camera translation mask setting.
out_state | Whether the camera translation transform mask is applied |
bool HPS::TransformMaskControl::ShowModellingMatrixOffset | ( | bool & | out_state | ) | const |
Shows the modelling matrix offset mask setting.
out_state | Whether the modelling matrix offset transform mask is applied |
bool HPS::TransformMaskControl::ShowModellingMatrixRotation | ( | bool & | out_state | ) | const |
Shows the modelling matrix rotation mask setting.
out_state | Whether the modelling matrix rotation transform mask is applied |
bool HPS::TransformMaskControl::ShowModellingMatrixScale | ( | bool & | out_state | ) | const |
Shows the modelling matrix scale mask setting.
out_state | Whether the modelling matrix scale transform mask is applied |
bool HPS::TransformMaskControl::ShowModellingMatrixTranslation | ( | bool & | out_state | ) | const |
Shows the modelling matrix translation mask setting.
out_state | Whether the modelling matrix translation transform mask is applied |
|
inlinevirtual |
This function returns the true type of the underlying object.
This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
Reimplemented from HPS::Control.
TransformMaskControl& HPS::TransformMaskControl::UnsetCameraEverything | ( | ) |
Removes the mask which removes transforms related to camera.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetCameraNearLimit | ( | ) |
Removes the mask which removes transforms related to camera near limit.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetCameraOffset | ( | ) |
Removes the mask which removes transforms related to camera offset.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetCameraPerspectiveScale | ( | ) |
Removes the mask which removes transforms related to the camera perspective scale.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetCameraProjection | ( | ) |
Removes the mask which removes transforms related to the camera perspective projection.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetCameraRotation | ( | ) |
Removes the mask which removes transforms related to camera rotation.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetCameraScale | ( | ) |
Removes the mask which removes transforms related to camera scale.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetCameraTranslation | ( | ) |
Removes the mask which removes transforms related to camera translation.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetEverything | ( | ) |
Removes the mask which removes transforms related to camera and modelling matrix.
If the control is attached to a WindowKey this function restores the default settings of this control as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixEverything | ( | ) |
Removes the mask which removes transforms related to modelling matrix everything.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixOffset | ( | ) |
Removes the mask which removes transforms related to modelling matrix offset.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixRotation | ( | ) |
Removes the mask which removes transforms related to modelling matrix rotation.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixScale | ( | ) |
Removes the mask which removes transforms related to modelling matrix scale.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
TransformMaskControl& HPS::TransformMaskControl::UnsetModellingMatrixTranslation | ( | ) |
Removes the mask which removes transforms related to modelling matrix translation.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransformMaskKit::GetDefault().
|
static |