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. More...

Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
SelectabilityControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
SelectabilityControl (HPS.SelectabilityControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
HPS.SelectabilityControl | SetEdges (HPS.Selectability.Value in_val) |
Controls whether edges can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetEdges (bool in_val) |
Controls whether edges can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetEverything (HPS.Selectability.Value in_val) |
Sets the selectability of all geometry, subgeometry and windows. More... | |
HPS.SelectabilityControl | SetEverything (bool in_val) |
Sets the selectability of all geometry, subgeometry and windows. More... | |
HPS.SelectabilityControl | SetFaces (HPS.Selectability.Value in_val) |
Controls whether faces can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetFaces (bool in_val) |
Controls whether faces can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetGeometry (HPS.Selectability.Value in_val) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More... | |
HPS.SelectabilityControl | SetGeometry (bool in_val) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More... | |
HPS.SelectabilityControl | SetLights (HPS.Selectability.Value in_val) |
Controls whether lights can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetLights (bool in_val) |
Controls whether lights can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetLines (HPS.Selectability.Value in_val) |
Controls whether lines can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetLines (bool in_val) |
Controls whether lines can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetMarkers (HPS.Selectability.Value in_val) |
Controls whether markers can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetMarkers (bool in_val) |
Controls whether markers can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetText (HPS.Selectability.Value in_val) |
Controls whether text can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetText (bool in_val) |
Controls whether text can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetVertices (HPS.Selectability.Value in_val) |
Controls whether vertices can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetVertices (bool in_val) |
Controls whether vertices can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetWindows (HPS.Selectability.Value in_val) |
Controls whether windows can be selected by selection actions. More... | |
HPS.SelectabilityControl | SetWindows (bool in_val) |
Controls whether windows can be selected by selection actions. More... | |
bool | ShowEdges (out HPS.Selectability.Value out_val) |
Shows whether edges can be selected by selection actions. More... | |
bool | ShowFaces (out HPS.Selectability.Value out_val) |
Shows whether faces can be selected by selection actions. More... | |
bool | ShowLights (out HPS.Selectability.Value out_val) |
Shows whether lights can be selected by selection actions. More... | |
bool | ShowLines (out HPS.Selectability.Value out_val) |
Shows whether lines can be selected by selection actions. More... | |
bool | ShowMarkers (out HPS.Selectability.Value out_val) |
Shows whether markers can be selected by selection actions. More... | |
bool | ShowText (out HPS.Selectability.Value out_val) |
Shows whether text can be selected by selection actions. More... | |
bool | ShowVertices (out HPS.Selectability.Value out_val) |
Shows whether vertices can be selected by selection actions. More... | |
bool | ShowWindows (out HPS.Selectability.Value out_val) |
Shows whether windows can be selected by selection actions. More... | |
HPS.SelectabilityControl | UnsetEdges () |
Removes the selectability setting from edges. More... | |
HPS.SelectabilityControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.SelectabilityControl | UnsetFaces () |
Removes the selectability setting from faces. More... | |
HPS.SelectabilityControl | UnsetGeometry () |
Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text. More... | |
HPS.SelectabilityControl | UnsetLights () |
Removes the selectability setting from lights. More... | |
HPS.SelectabilityControl | UnsetLines () |
Removes the selectability setting from lines. More... | |
HPS.SelectabilityControl | UnsetMarkers () |
Removes the selectability setting from markers. More... | |
HPS.SelectabilityControl | UnsetText () |
Removes the selectability setting from text. More... | |
HPS.SelectabilityControl | UnsetVertices () |
Removes the selectability setting from vertices. More... | |
HPS.SelectabilityControl | UnsetWindows () |
Removes the selectability setting from windows. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
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. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
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.Object.
|
inline |
Controls whether edges can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Controls whether edges can be selected by selection actions.
- Parameters
-
in_val Whether visible edges should be selectable.
- Returns
- A reference to this object.
|
inline |
Sets the selectability of all geometry, subgeometry and windows.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Sets the selectability of all geometry, subgeometry and windows.
- Parameters
-
in_val Whether everything visible should be selectable.
- Returns
- A reference to this object.
|
inline |
Controls whether faces can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Controls whether faces can be selected by selection actions.
- Parameters
-
in_val Whether visible faces should be selectable.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
Controls whether lights can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Controls whether lights can be selected by selection actions.
- Parameters
-
in_val Whether visible lights should be selectable.
- Returns
- A reference to this object.
|
inline |
Controls whether lines can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Controls whether lines can be selected by selection actions.
- Parameters
-
in_val Whether visible lines should be selectable.
- Returns
- A reference to this object.
|
inline |
Controls whether markers can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Controls whether markers can be selected by selection actions.
- Parameters
-
in_val Whether visible markers should be selectable.
- Returns
- A reference to this object.
|
inline |
Controls whether text can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Controls whether text can be selected by selection actions.
- Parameters
-
in_val Whether visible text should be selectable.
- Returns
- A reference to this object.
|
inline |
Controls whether vertices can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Controls whether vertices can be selected by selection actions.
- Parameters
-
in_val Whether visible vertices should be selectable.
- Returns
- A reference to this object.
|
inline |
Controls whether windows can be selected by selection actions.
- Parameters
-
in_val The level of selectability.
- Returns
- A reference to this object.
|
inline |
Controls whether windows can be selected by selection actions.
- Parameters
-
in_val Whether visible windows should be selectable.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Removes the selectability setting from edges.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the selectability setting from faces.
- Returns
- A reference to this object.
|
inline |
Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text.
- Returns
- A reference to this object.
|
inline |
Removes the selectability setting from lights.
- Returns
- A reference to this object.
|
inline |
Removes the selectability setting from lines.
- Returns
- A reference to this object.
|
inline |
Removes the selectability setting from markers.
- Returns
- A reference to this object.
|
inline |
Removes the selectability setting from text.
- Returns
- A reference to this object.
|
inline |
Removes the selectability setting from vertices.
- Returns
- A reference to this object.
|
inline |
Removes the selectability setting from windows.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SelectabilityControl.cs