REFERENCE MANUAL
The SelectionItem class is a smart-pointer to a database object. More...
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 () |
This function returns the type the object, as declared. More... | |
SelectionItem () | |
The default constructor creates an uninitialized SelectionItem object. 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 | 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 window 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 an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
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. 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 |
HandleRef | scptr |
The SelectionItem class is a smart-pointer to a database object.
It represents an item in a SelectionResults object.
HPS.SelectionItem.SelectionItem | ( | ) |
The default constructor creates an uninitialized SelectionItem object.
The Type() function will return Type::None.
HPS.SelectionItem.SelectionItem | ( | HPS.SelectionItem | in_that | ) |
The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem.
in_that | The source <ref refid="class_h_p_s_1_1_selection_item" kindref="compound">SelectionItem</ref> to copy. |
bool HPS.SelectionItem.Equals | ( | HPS.SelectionItem | in_that | ) |
Check if the source SelectionItem is equivalent to this SelectionItem.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.SelectionItem.Set | ( | HPS.SelectionItem | in_that | ) |
Associate this SelectionItem with the same underlying impl as the source SelectionItem.
in_that | The source <ref refid="class_h_p_s_1_1_selection_item" kindref="compound">SelectionItem</ref> for the assignment. |
bool HPS.SelectionItem.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.
out_characters | The indices to the characters within a text string for the item that was selected. |
bool HPS.SelectionItem.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.
bool HPS.SelectionItem.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.
out_faces | The indices to the faces within a shell or mesh for the item that was selected. |
bool HPS.SelectionItem.ShowPath | ( | out HPS.KeyPath | out_path | ) |
Shows the key path for the item that was selected.
out_path | The key path for the item that was selected. |
bool HPS.SelectionItem.ShowSelectedItem | ( | out HPS.Key | out_selection | ) |
Shows the key for the item that was selected.
out_selection | The key for the item that was selected. |
bool HPS.SelectionItem.ShowSelectionLevel | ( | out HPS.Selection.Level | out_level | ) |
Shows the selection level used when this item was selected.
out_level | The selection level used when this item was selected. |
bool HPS.SelectionItem.ShowSelectionPosition | ( | out HPS.WindowPoint | out_location | ) |
Shows the selection position in window space for the item that was selected.
out_location | The selection position in window space for the item that was selected. |
bool HPS.SelectionItem.ShowSelectionPosition | ( | out HPS.WorldPoint | out_location | ) |
Shows the selection position in window space for the item that was selected.
out_location | The selection position in window space for the item that was selected. |
bool HPS.SelectionItem.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.