
Public Member Functions | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SelectionItem in_that) |
Check if the source SelectionItem is equivalent to this SelectionItem. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
SelectionItem () | |
The default constructor creates an uninitialized SelectionItem object. The Type() function will return Type.None. More... | |
SelectionItem (HPS.SelectionItem in_that) | |
The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem. More... | |
void | Set (HPS.SelectionItem in_that) |
Associate this SelectionItem with the same underlying impl as the source SelectionItem. More... | |
bool | ShowCharacters (out ulong[] out_characters) |
Shows the indices to the characters within a text string for the item that was selected if using subentity selection. More... | |
bool | ShowEdges (out ulong[] out_vertices1, out ulong[] out_vertices2) |
Shows the indices to the edges (i.e., indices to the vertices at each end of an edge) within a shell, mesh, or polygon for the item that was selected if using subentity selection. More... | |
bool | ShowFaces (out ulong[] out_faces) |
Shows the indices to the faces within a shell or mesh for the item that was selected if using subentity selection. More... | |
bool | ShowNormalizedSelectionPosition (out HPS.WindowPoint out_location) |
Shows the Z-normalized selection position in window space for the item that was selected. More... | |
bool | ShowPath (out HPS.KeyPath out_path) |
Shows the key path for the item that was selected. More... | |
bool | ShowSelectedItem (out HPS.Key out_selection) |
Shows the key for the item that was selected. More... | |
bool | ShowSelectionLevel (out HPS.Selection.Level out_level) |
Shows the selection level used when this item was selected. More... | |
bool | ShowSelectionPosition (out HPS.WindowPoint out_location) |
Shows the selection position in window space for the item that was selected. More... | |
bool | ShowSelectionPosition (out HPS.WorldPoint out_location) |
Shows the selection position in world space for the item that was selected. More... | |
bool | ShowVertices (out ulong[] out_vertices) |
Shows the indices to the vertices within a shell, mesh, line, polygon, or NURBS curve for the item that was selected if using subentity selection. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
virtual 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... | |
Static Public Member Functions | |
static bool | operator!= (HPS.SelectionItem a, HPS.SelectionItem b) |
static bool | operator== (HPS.SelectionItem a, HPS.SelectionItem b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The SelectionItem class is a smart-pointer to a database object. It represents an item in a SelectionResults object.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an uninitialized SelectionItem object. The Type() function will return Type.None.
|
inline |
The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem.
- Parameters
-
in_that The source SelectionItem to copy.
Member Function Documentation
|
inline |
Check if the source SelectionItem is equivalent to this SelectionItem.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Associate this SelectionItem with the same underlying impl as the source SelectionItem.
- Parameters
-
in_that The source SelectionItem for the assignment.
|
inline |
Shows the indices to the characters within a text string for the item that was selected if using subentity selection.
- Parameters
-
out_characters The indices to the characters within a text string for the item that was selected.
- Returns
- true if the indices array is valid, false otherwise.
|
inline |
Shows the indices to the edges (i.e., indices to the vertices at each end of an edge) within a shell, mesh, or polygon for the item that was selected if using subentity selection.
- Returns
- true if the indices array is valid, false otherwise.
|
inline |
Shows the indices to the faces within a shell or mesh for the item that was selected if using subentity selection.
- Parameters
-
out_faces The indices to the faces within a shell or mesh for the item that was selected.
- Returns
- true if the indices array is valid, false otherwise.
|
inline |
Shows the Z-normalized selection position in window space for the item that was selected.
- Parameters
-
out_location The selection position in window space with a normalized Z-coordinate for the item that was selected.
- Returns
- true if the window space position is valid, false otherwise.
|
inline |
Shows the key path for the item that was selected.
- Parameters
-
out_path The key path for the item that was selected.
- Returns
- true if the key path is valid, false otherwise.
|
inline |
Shows the key for the item that was selected.
- Parameters
-
out_selection The key for the item that was selected.
- Returns
- true if the key is valid, false otherwise.
|
inline |
Shows the selection level used when this item was selected.
- Parameters
-
out_level The selection level used when this item was selected.
- Returns
- true if the selection level is valid, false otherwise.
|
inline |
Shows the selection position in window space for the item that was selected.
- Parameters
-
out_location The selection position in window space for the item that was selected.
- Returns
- true if the window space position is valid, false otherwise.
|
inline |
Shows the selection position in world space for the item that was selected.
- Parameters
-
out_location The selection position in world space for the item that was selected.
- Returns
- true if the world space position is valid, false otherwise.
|
inline |
Shows the indices to the vertices within a shell, mesh, line, polygon, or NURBS curve for the item that was selected if using subentity selection.
- Returns
- true if the indices array is valid, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SelectionItem.cs