#include <hps.h>

Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
Detailed Description
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.
Constructor & Destructor Documentation
|
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.
- Parameters
-
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.
Member Function Documentation
|
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::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.
- Parameters
-
in_that An rvalue reference to a SelectabilityControl to take the impl from.
- Returns
- A reference to this SelectabilityControl.
SelectabilityControl& HPS::SelectabilityControl::operator= | ( | SelectabilityControl const & | in_that | ) |
Share the underlying smart-pointer of the SelectabilityControl source.
- Parameters
-
in_that The SelectabilityControl source of the assignment.
- Returns
- A reference to this SelectabilityControl.
SelectabilityControl& HPS::SelectabilityControl::SetEdges | ( | Selectability::Value | in_val | ) |
Controls whether edges can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetEdges | ( | bool | in_val | ) |
Controls whether edges can be selected by selection actions.
- Parameters
-
in_val Whether visible edges should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetEverything | ( | Selectability::Value | in_val | ) |
Sets the selectability of all geometry, subgeometry and windows.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetEverything | ( | bool | in_val | ) |
Sets the selectability of all geometry, subgeometry and windows.
- Parameters
-
in_val Whether everything visible should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetFaces | ( | Selectability::Value | in_val | ) |
Controls whether faces can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetFaces | ( | bool | in_val | ) |
Controls whether faces can be selected by selection actions.
- Parameters
-
in_val Whether visible faces should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetGeometry | ( | Selectability::Value | in_val | ) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetGeometry | ( | bool | in_val | ) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text.
- Parameters
-
in_val Whether visible geometry should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetLights | ( | Selectability::Value | in_val | ) |
Controls whether lights can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetLights | ( | bool | in_val | ) |
Controls whether lights can be selected by selection actions.
- Parameters
-
in_val Whether visible lights should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetLines | ( | Selectability::Value | in_val | ) |
Controls whether lines can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetLines | ( | bool | in_val | ) |
Controls whether lines can be selected by selection actions.
- Parameters
-
in_val Whether visible lines should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetMarkers | ( | Selectability::Value | in_val | ) |
Controls whether markers can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetMarkers | ( | bool | in_val | ) |
Controls whether markers can be selected by selection actions.
- Parameters
-
in_val Whether visible markers should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetText | ( | Selectability::Value | in_val | ) |
Controls whether text can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetText | ( | bool | in_val | ) |
Controls whether text can be selected by selection actions.
- Parameters
-
in_val Whether visible text should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetVertices | ( | Selectability::Value | in_val | ) |
Controls whether vertices can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetVertices | ( | bool | in_val | ) |
Controls whether vertices can be selected by selection actions.
- Parameters
-
in_val Whether visible vertices should be selectable.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetWindows | ( | Selectability::Value | in_val | ) |
Controls whether windows can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::SetWindows | ( | bool | in_val | ) |
Controls whether windows can be selected by selection actions.
- Parameters
-
in_val Whether visible windows should be selectable.
- Returns
- A reference to this object.
bool HPS::SelectabilityControl::ShowEdges | ( | Selectability::Value & | out_val | ) | const |
Shows whether edges can be selected by selection actions.
- Parameters
-
out_val The level of selectability.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SelectabilityControl::ShowFaces | ( | Selectability::Value & | out_val | ) | const |
Shows whether faces can be selected by selection actions.
- Parameters
-
out_val The level of selectability.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SelectabilityControl::ShowLights | ( | Selectability::Value & | out_val | ) | const |
Shows whether lights can be selected by selection actions.
- Parameters
-
out_val The level of selectability.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SelectabilityControl::ShowLines | ( | Selectability::Value & | out_val | ) | const |
Shows whether lines can be selected by selection actions.
- Parameters
-
out_val The level of selectability.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SelectabilityControl::ShowMarkers | ( | Selectability::Value & | out_val | ) | const |
Shows whether markers can be selected by selection actions.
- Parameters
-
out_val The level of selectability.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SelectabilityControl::ShowText | ( | Selectability::Value & | out_val | ) | const |
Shows whether text can be selected by selection actions.
- Parameters
-
out_val The level of selectability.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SelectabilityControl::ShowVertices | ( | Selectability::Value & | out_val | ) | const |
Shows whether vertices can be selected by selection actions.
- Parameters
-
out_val The level of selectability.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::SelectabilityControl::ShowWindows | ( | Selectability::Value & | out_val | ) | const |
Shows whether windows can be selected by selection actions.
- Parameters
-
out_val The level of selectability.
- Returns
- true if the setting is valid, false otherwise.
|
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
SelectabilityControl& HPS::SelectabilityControl::UnsetEdges | ( | ) |
Removes the selectability setting from edges.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetFaces | ( | ) |
Removes the selectability setting from faces.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetGeometry | ( | ) |
Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetLights | ( | ) |
Removes the selectability setting from lights.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetLines | ( | ) |
Removes the selectability setting from lines.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetMarkers | ( | ) |
Removes the selectability setting from markers.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetText | ( | ) |
Removes the selectability setting from text.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetVertices | ( | ) |
Removes the selectability setting from vertices.
- Returns
- A reference to this object.
SelectabilityControl& HPS::SelectabilityControl::UnsetWindows | ( | ) |
Removes the selectability setting from windows.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h