|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ SelectabilityControl() [1/2]
HPS.SelectabilityControl.SelectabilityControl |
( |
HPS.SegmentKey |
in_seg | ) |
|
|
inline |
Initializes a control tied to the segment in_seg.
◆ SelectabilityControl() [2/2]
Initializes a control tied to the same object as in_that.
◆ ObjectType()
override HPS.Type HPS.SelectabilityControl.ObjectType |
( |
| ) |
|
|
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.Control.
◆ SetEdges() [1/2]
Controls whether edges can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetEdges() [2/2]
Controls whether edges can be selected by selection actions.
- Parameters
-
in_val | Whether visible edges should be selectable. |
- Returns
- A reference to this object.
◆ SetEverything() [1/2]
Sets the selectability of all geometry, subgeometry and windows.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetEverything() [2/2]
Sets the selectability of all geometry, subgeometry and windows.
- Parameters
-
in_val | Whether everything visible should be selectable. |
- Returns
- A reference to this object.
◆ SetFaces() [1/2]
Controls whether faces can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetFaces() [2/2]
Controls whether faces can be selected by selection actions.
- Parameters
-
in_val | Whether visible faces should be selectable. |
- Returns
- A reference to this object.
◆ SetGeometry() [1/2]
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.
◆ SetGeometry() [2/2]
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.
◆ SetLights() [1/2]
Controls whether lights can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetLights() [2/2]
Controls whether lights can be selected by selection actions.
- Parameters
-
in_val | Whether visible lights should be selectable. |
- Returns
- A reference to this object.
◆ SetLines() [1/2]
Controls whether lines can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetLines() [2/2]
Controls whether lines can be selected by selection actions.
- Parameters
-
in_val | Whether visible lines should be selectable. |
- Returns
- A reference to this object.
◆ SetMarkers() [1/2]
Controls whether markers can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetMarkers() [2/2]
Controls whether markers can be selected by selection actions.
- Parameters
-
in_val | Whether visible markers should be selectable. |
- Returns
- A reference to this object.
◆ SetText() [1/2]
Controls whether text can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetText() [2/2]
Controls whether text can be selected by selection actions.
- Parameters
-
in_val | Whether visible text should be selectable. |
- Returns
- A reference to this object.
◆ SetVertices() [1/2]
Controls whether vertices can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetVertices() [2/2]
Controls whether vertices can be selected by selection actions.
- Parameters
-
in_val | Whether visible vertices should be selectable. |
- Returns
- A reference to this object.
◆ SetWindows() [1/2]
Controls whether windows can be selected by selection actions.
- Parameters
-
in_val | The level of selectability. |
- Returns
- A reference to this object.
◆ SetWindows() [2/2]
Controls whether windows can be selected by selection actions.
- Parameters
-
in_val | Whether visible windows should be selectable. |
- Returns
- A reference to this object.
◆ ShowEdges()
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.
◆ ShowFaces()
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.
◆ ShowLights()
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.
◆ ShowLines()
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.
◆ ShowMarkers()
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.
◆ ShowText()
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.
◆ ShowVertices()
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.
◆ ShowWindows()
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.
◆ Type()
override HPS.Type HPS.SelectabilityControl.Type |
( |
| ) |
|
|
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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- 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