#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::SelectabilityKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The HPS::SelectabilityKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::SelectabilityKit::GetDefault() will return a kit with values found in this table.
HPS::SelectabilityKit::SelectabilityKit |
( |
| ) |
|
Initializes an empty kit.
The copy constructor creates a new SelectabilityKit object that contains the same settings as the source object.
- Parameters
-
in_kit | The source object to copy. |
The move constructor creates a SelectabilityKit by transferring the underlying impl of the rvalue reference to this SelectabilityKit thereby avoiding a copy and allocation.
- Parameters
-
virtual HPS::SelectabilityKit::~SelectabilityKit |
( |
| ) |
|
|
virtual |
bool HPS::SelectabilityKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS::Object.
Check if the source SelectabilityKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Creates a SelectabilityKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A SelectabilityKit with the default settings.
HPS::Type HPS::SelectabilityKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
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.
Reimplemented from HPS::Kit.
Check if the source SelectabilityKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectabilityKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this SelectabilityKit.
Copies the source SelectabilityKit into this object.
- Parameters
-
- Returns
- A reference to this object.
Check if the source SelectabilityKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Copies all settings from the source SelectabilityKit into this object.
- Parameters
-
Controls whether edges can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Controls whether edges can be selected by selection actions.
- Parameters
-
in_val | Whether visible edges should be selectable. |
- Returns
- A reference to this object.
Sets the selectability of all geometry, subgeometry and windows.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Sets the selectability of all geometry, subgeometry and windows.
- Parameters
-
in_val | Whether everything visible should be selectable. |
- Returns
- A reference to this object.
Controls whether faces can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Controls whether faces can be selected by selection actions.
- Parameters
-
in_val | Whether visible faces should be selectable. |
- Returns
- A reference to this object.
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.
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.
Controls whether lights can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Controls whether lights can be selected by selection actions.
- Parameters
-
in_val | Whether visible lights should be selectable. |
- Returns
- A reference to this object.
Controls whether lines can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Controls whether lines can be selected by selection actions.
- Parameters
-
in_val | Whether visible lines should be selectable. |
- Returns
- A reference to this object.
Controls whether markers can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Controls whether markers can be selected by selection actions.
- Parameters
-
in_val | Whether visible markers should be selectable. |
- Returns
- A reference to this object.
Controls whether text can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Controls whether text can be selected by selection actions.
- Parameters
-
in_val | Whether visible text should be selectable. |
- Returns
- A reference to this object.
Controls whether vertices can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Controls whether vertices can be selected by selection actions.
- Parameters
-
in_val | Whether visible vertices should be selectable. |
- Returns
- A reference to this object.
Controls whether windows can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
Controls whether windows can be selected by selection actions.
- Parameters
-
in_val | Whether visible windows should be selectable. |
- Returns
- A reference to this object.
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.
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.
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.
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.
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.
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.
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.
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.
Removes the selectability setting from edges.
- Returns
- A reference to this object.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes the selectability setting from faces.
- Returns
- A reference to this object.
Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text.
- Returns
- A reference to this object.
Removes the selectability setting from lights.
- Returns
- A reference to this object.
Removes the selectability setting from lines.
- Returns
- A reference to this object.
Removes the selectability setting from markers.
- Returns
- A reference to this object.
Removes the selectability setting from text.
- Returns
- A reference to this object.
Removes the selectability setting from vertices.
- Returns
- A reference to this object.
Removes the selectability setting from windows.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: