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

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SelectabilityKit in_kit) |
Check if the source SelectabilityKit is equivalent to this object. More... | |
override int | GetHashCode () |
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... | |
SelectabilityKit () | |
Initializes an empty kit. More... | |
SelectabilityKit (HPS.SelectabilityKit in_kit) | |
The copy constructor creates a new SelectabilityKit object that contains the same settings as the source object. More... | |
void | Set (HPS.SelectabilityKit in_kit) |
Copies all settings from the source SelectabilityKit into this object. More... | |
HPS.SelectabilityKit | SetEdges (HPS.Selectability.Value in_val) |
Controls whether edges can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetEdges (bool in_val) |
Controls whether edges can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetEverything (HPS.Selectability.Value in_val) |
Sets the selectability of all geometry, subgeometry and windows. More... | |
HPS.SelectabilityKit | SetEverything (bool in_val) |
Sets the selectability of all geometry, subgeometry and windows. More... | |
HPS.SelectabilityKit | SetFaces (HPS.Selectability.Value in_val) |
Controls whether faces can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetFaces (bool in_val) |
Controls whether faces can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetGeometry (HPS.Selectability.Value in_val) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More... | |
HPS.SelectabilityKit | SetGeometry (bool in_val) |
Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More... | |
HPS.SelectabilityKit | SetLights (HPS.Selectability.Value in_val) |
Controls whether lights can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetLights (bool in_val) |
Controls whether lights can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetLines (HPS.Selectability.Value in_val) |
Controls whether lines can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetLines (bool in_val) |
Controls whether lines can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetMarkers (HPS.Selectability.Value in_val) |
Controls whether markers can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetMarkers (bool in_val) |
Controls whether markers can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetText (HPS.Selectability.Value in_val) |
Controls whether text can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetText (bool in_val) |
Controls whether text can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetVertices (HPS.Selectability.Value in_val) |
Controls whether vertices can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetVertices (bool in_val) |
Controls whether vertices can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetWindows (HPS.Selectability.Value in_val) |
Controls whether windows can be selected by selection actions. More... | |
HPS.SelectabilityKit | SetWindows (bool in_val) |
Controls whether windows can be selected by selection actions. More... | |
void | Show (out HPS.SelectabilityKit out_kit) |
Copies all settings from this SelectabilityKit into the given SelectabilityKit. 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.SelectabilityKit | UnsetEdges () |
Removes the selectability setting from edges. More... | |
HPS.SelectabilityKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.SelectabilityKit | UnsetFaces () |
Removes the selectability setting from faces. More... | |
HPS.SelectabilityKit | UnsetGeometry () |
Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text. More... | |
HPS.SelectabilityKit | UnsetLights () |
Removes the selectability setting from lights. More... | |
HPS.SelectabilityKit | UnsetLines () |
Removes the selectability setting from lines. More... | |
HPS.SelectabilityKit | UnsetMarkers () |
Removes the selectability setting from markers. More... | |
HPS.SelectabilityKit | UnsetText () |
Removes the selectability setting from text. More... | |
HPS.SelectabilityKit | UnsetVertices () |
Removes the selectability setting from vertices. More... | |
HPS.SelectabilityKit | UnsetWindows () |
Removes the selectability setting from windows. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override 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... | |
![]() | |
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... | |
Static Public Member Functions | |
static HPS.SelectabilityKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.SelectabilityKit a, HPS.SelectabilityKit b) |
static bool | operator== (HPS.SelectabilityKit a, HPS.SelectabilityKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
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.
Member Function Documentation
|
inlinevirtual |
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.
|
inline |
Check if the source SelectabilityKit is equivalent to this object.
- Parameters
-
in_kit The source SelectabilityKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
|
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.Kit.
|
inline |
Copies all settings from the source SelectabilityKit into this object.
- Parameters
-
in_kit The source SelectabilityKit to copy.
|
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 |
Copies all settings from this SelectabilityKit into the given SelectabilityKit.
- Parameters
-
out_kit The SelectabilityKit to populate with the contents of 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.SelectabilityKit.cs