#include <hps.h>
Public Member Functions | |
SelectabilityControl (SegmentKey &in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
SelectabilityControl (SelectabilityControl const &in_that) | |
Initializes a control tied to the same object as in_that. More... | |
SelectabilityControl (SelectabilityControl &&in_that) | |
The move constructor creates a SelectabilityControl by transferring the underlying impl of the rvalue reference to this SelectabilityControl thereby avoiding a copy and allocation. More... | |
SelectabilityControl & | operator= (SelectabilityControl &&in_that) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectabilityControl thereby avoiding a copy. More... | |
~SelectabilityControl () | |
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 |
SelectabilityControl & | operator= (SelectabilityControl const &in_that) |
Share the underlying smart-pointer of the SelectabilityControl source. More... | |
SelectabilityControl & | SetWindows (Selectability::Value in_val) |
Controls whether windows can be selected by selection actions. More... | |
SelectabilityControl & | SetWindows (bool in_val) |
Controls whether windows can be selected by selection actions. More... | |
SelectabilityControl & | SetEdges (Selectability::Value in_val) |
Controls whether edges can be selected by selection actions. More... | |
SelectabilityControl & | SetEdges (bool in_val) |
Controls whether edges can be selected by selection actions. More... | |
SelectabilityControl & | SetFaces (Selectability::Value in_val) |
Controls whether faces can be selected by selection actions. More... | |
SelectabilityControl & | SetFaces (bool in_val) |
Controls whether faces can be selected by selection actions. More... | |
SelectabilityControl & | SetLights (Selectability::Value in_val) |
Controls whether lights can be selected by selection actions. More... | |
SelectabilityControl & | SetLights (bool in_val) |
Controls whether lights can be selected by selection actions. More... | |
SelectabilityControl & | SetLines (Selectability::Value in_val) |
Controls whether lines can be selected by selection actions. More... | |
SelectabilityControl & | SetLines (bool in_val) |
Controls whether lines can be selected by selection actions. More... | |
SelectabilityControl & | SetMarkers (Selectability::Value in_val) |
Controls whether markers can be selected by selection actions. More... | |
SelectabilityControl & | SetMarkers (bool in_val) |
Controls whether markers can be selected by selection actions. More... | |
SelectabilityControl & | SetVertices (Selectability::Value in_val) |
Controls whether vertices can be selected by selection actions. More... | |
SelectabilityControl & | SetVertices (bool in_val) |
Controls whether vertices can be selected by selection actions. More... | |
SelectabilityControl & | SetText (Selectability::Value in_val) |
Controls whether text can be selected by selection actions. More... | |
SelectabilityControl & | SetText (bool in_val) |
Controls whether text can be selected by selection actions. More... | |
SelectabilityControl & | SetGeometry (Selectability::Value in_val) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More... | |
SelectabilityControl & | SetGeometry (bool in_val) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More... | |
SelectabilityControl & | SetEverything (Selectability::Value in_val) |
Sets the selectability of all geometry, subgeometry and windows. More... | |
SelectabilityControl & | SetEverything (bool in_val) |
Sets the selectability of all geometry, subgeometry and windows. More... | |
SelectabilityControl & | UnsetWindows () |
Removes the selectability setting from windows. More... | |
SelectabilityControl & | UnsetEdges () |
Removes the selectability setting from edges. More... | |
SelectabilityControl & | UnsetFaces () |
Removes the selectability setting from faces. More... | |
SelectabilityControl & | UnsetLights () |
Removes the selectability setting from lights. More... | |
SelectabilityControl & | UnsetLines () |
Removes the selectability setting from lines. More... | |
SelectabilityControl & | UnsetMarkers () |
Removes the selectability setting from markers. More... | |
SelectabilityControl & | UnsetVertices () |
Removes the selectability setting from vertices. More... | |
SelectabilityControl & | UnsetText () |
Removes the selectability setting from text. More... | |
SelectabilityControl & | UnsetGeometry () |
Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text. More... | |
SelectabilityControl & | UnsetEverything () |
Removes all settings from this object. More... | |
bool | ShowWindows (Selectability::Value &out_val) const |
Shows whether windows can be selected by selection actions. More... | |
bool | ShowEdges (Selectability::Value &out_val) const |
Shows whether edges can be selected by selection actions. More... | |
bool | ShowFaces (Selectability::Value &out_val) const |
Shows whether faces can be selected by selection actions. More... | |
bool | ShowLights (Selectability::Value &out_val) const |
Shows whether lights can be selected by selection actions. More... | |
bool | ShowLines (Selectability::Value &out_val) const |
Shows whether lines can be selected by selection actions. More... | |
bool | ShowMarkers (Selectability::Value &out_val) const |
Shows whether markers can be selected by selection actions. More... | |
bool | ShowVertices (Selectability::Value &out_val) const |
Shows whether vertices can be selected by selection actions. More... | |
bool | ShowText (Selectability::Value &out_val) const |
Shows whether text can be selected by selection actions. 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::SelectabilityControl |
Private Member Functions | |
SelectabilityControl () | |
Private default constructor to prevent instantiation without a segment. More... | |
The SelectabilityControl class is a smart pointer that is tied to a database object. This object allows you to set and unset the selectability of the various types of geometry, such as faces, lines, markers, and vertices.
Default values for the various fields of SelectabilityControl can be found here.
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::SelectabilityControl::SelectabilityControl | ( | SelectabilityControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::SelectabilityControl::SelectabilityControl | ( | SelectabilityControl && | in_that | ) |
The move constructor creates a SelectabilityControl by transferring the underlying impl of the rvalue reference to this SelectabilityControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a SelectabilityControl to take the impl from. |
HPS::SelectabilityControl::~SelectabilityControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
private |
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.
SelectabilityControl& HPS::SelectabilityControl::operator= | ( | SelectabilityControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectabilityControl thereby avoiding a copy.
in_that | An rvalue reference to a SelectabilityControl to take the impl from. |
SelectabilityControl& HPS::SelectabilityControl::operator= | ( | SelectabilityControl const & | in_that | ) |
Share the underlying smart-pointer of the SelectabilityControl source.
in_that | The SelectabilityControl 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.
SelectabilityControl& HPS::SelectabilityControl::SetEdges | ( | Selectability::Value | in_val | ) |
Controls whether edges can be selected by selection actions.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetEdges | ( | bool | in_val | ) |
Controls whether edges can be selected by selection actions.
in_val | Whether visible edges should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetEverything | ( | Selectability::Value | in_val | ) |
Sets the selectability of all geometry, subgeometry and windows.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetEverything | ( | bool | in_val | ) |
Sets the selectability of all geometry, subgeometry and windows.
in_val | Whether everything visible should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetFaces | ( | Selectability::Value | in_val | ) |
Controls whether faces can be selected by selection actions.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetFaces | ( | bool | in_val | ) |
Controls whether faces can be selected by selection actions.
in_val | Whether visible faces should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetGeometry | ( | Selectability::Value | in_val | ) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetGeometry | ( | bool | in_val | ) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text.
in_val | Whether visible geometry should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetLights | ( | Selectability::Value | in_val | ) |
Controls whether lights can be selected by selection actions.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetLights | ( | bool | in_val | ) |
Controls whether lights can be selected by selection actions.
in_val | Whether visible lights should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetLines | ( | Selectability::Value | in_val | ) |
Controls whether lines can be selected by selection actions.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetLines | ( | bool | in_val | ) |
Controls whether lines can be selected by selection actions.
in_val | Whether visible lines should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetMarkers | ( | Selectability::Value | in_val | ) |
Controls whether markers can be selected by selection actions.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetMarkers | ( | bool | in_val | ) |
Controls whether markers can be selected by selection actions.
in_val | Whether visible markers should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetText | ( | Selectability::Value | in_val | ) |
Controls whether text can be selected by selection actions.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetText | ( | bool | in_val | ) |
Controls whether text can be selected by selection actions.
in_val | Whether visible text should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetVertices | ( | Selectability::Value | in_val | ) |
Controls whether vertices can be selected by selection actions.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetVertices | ( | bool | in_val | ) |
Controls whether vertices can be selected by selection actions.
in_val | Whether visible vertices should be selectable. |
SelectabilityControl& HPS::SelectabilityControl::SetWindows | ( | Selectability::Value | in_val | ) |
Controls whether windows can be selected by selection actions.
in_val | The level of selectability. |
SelectabilityControl& HPS::SelectabilityControl::SetWindows | ( | bool | in_val | ) |
Controls whether windows can be selected by selection actions.
in_val | Whether visible windows should be selectable. |
bool HPS::SelectabilityControl::ShowEdges | ( | Selectability::Value & | out_val | ) | const |
Shows whether edges can be selected by selection actions.
out_val | The level of selectability. |
bool HPS::SelectabilityControl::ShowFaces | ( | Selectability::Value & | out_val | ) | const |
Shows whether faces can be selected by selection actions.
out_val | The level of selectability. |
bool HPS::SelectabilityControl::ShowLights | ( | Selectability::Value & | out_val | ) | const |
Shows whether lights can be selected by selection actions.
out_val | The level of selectability. |
bool HPS::SelectabilityControl::ShowLines | ( | Selectability::Value & | out_val | ) | const |
Shows whether lines can be selected by selection actions.
out_val | The level of selectability. |
bool HPS::SelectabilityControl::ShowMarkers | ( | Selectability::Value & | out_val | ) | const |
Shows whether markers can be selected by selection actions.
out_val | The level of selectability. |
bool HPS::SelectabilityControl::ShowText | ( | Selectability::Value & | out_val | ) | const |
Shows whether text can be selected by selection actions.
out_val | The level of selectability. |
bool HPS::SelectabilityControl::ShowVertices | ( | Selectability::Value & | out_val | ) | const |
Shows whether vertices can be selected by selection actions.
out_val | The level of selectability. |
bool HPS::SelectabilityControl::ShowWindows | ( | Selectability::Value & | out_val | ) | const |
Shows whether windows can be selected by selection actions.
out_val | The level of selectability. |
|
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.
SelectabilityControl& HPS::SelectabilityControl::UnsetEdges | ( | ) |
Removes the selectability setting from edges.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetEverything | ( | ) |
Removes all settings from this object.
If the control is attached to a WindowKey this function restores the default settings of this control as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetFaces | ( | ) |
Removes the selectability setting from faces.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetGeometry | ( | ) |
Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text.
If the control is attached to a WindowKey this function restores the default value of these settings as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetLights | ( | ) |
Removes the selectability setting from lights.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetLines | ( | ) |
Removes the selectability setting from lines.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetMarkers | ( | ) |
Removes the selectability setting from markers.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetText | ( | ) |
Removes the selectability setting from text.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetVertices | ( | ) |
Removes the selectability setting from vertices.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().
SelectabilityControl& HPS::SelectabilityControl::UnsetWindows | ( | ) |
Removes the selectability setting from windows.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().
|
static |