|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The SelectionItem class is a smart-pointer to a database object. It represents an item in a SelectionResults object.
◆ SelectionItem() [1/2]
HPS.SelectionItem.SelectionItem |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized SelectionItem object. The Type() function will return Type.None.
◆ SelectionItem() [2/2]
The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem.
- Parameters
-
◆ Equals()
Check if the source SelectionItem is equivalent to this SelectionItem.
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
override HPS.Type HPS.SelectionItem.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.Object.
◆ Set()
◆ ShowCharacters()
bool HPS.SelectionItem.ShowCharacters |
( |
out ulong [] |
out_characters | ) |
|
|
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.
◆ ShowEdges()
bool HPS.SelectionItem.ShowEdges |
( |
out ulong [] |
out_vertices1, |
|
|
out ulong [] |
out_vertices2 |
|
) |
| |
|
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.
◆ ShowFaces()
bool HPS.SelectionItem.ShowFaces |
( |
out ulong [] |
out_faces | ) |
|
|
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.
◆ ShowNormalizedSelectionPosition()
bool HPS.SelectionItem.ShowNormalizedSelectionPosition |
( |
out HPS.WindowPoint |
out_location | ) |
|
|
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.
◆ ShowPath()
bool HPS.SelectionItem.ShowPath |
( |
out HPS.KeyPath |
out_path | ) |
|
|
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.
◆ ShowSelectedItem()
bool HPS.SelectionItem.ShowSelectedItem |
( |
out HPS.Key |
out_selection | ) |
|
|
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.
◆ ShowSelectionLevel()
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.
◆ ShowSelectionPosition() [1/2]
bool HPS.SelectionItem.ShowSelectionPosition |
( |
out HPS.WindowPoint |
out_location | ) |
|
|
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.
◆ ShowSelectionPosition() [2/2]
bool HPS.SelectionItem.ShowSelectionPosition |
( |
out HPS.WorldPoint |
out_location | ) |
|
|
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.
◆ ShowVertices()
bool HPS.SelectionItem.ShowVertices |
( |
out ulong [] |
out_vertices | ) |
|
|
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.
- Parameters
-
out_vertices | The indices to the vertices within a shell, mesh, line, polygon, or NURBS curve for the item that was selected. |
- 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