#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
The SelectionItem class is a smart-pointer to a database object. It represents an item in a SelectionResults object.
SelectionItem::SelectionItem |
( |
| ) |
|
The default constructor creates an uninitialized SelectionItem object. The Type() function will return Type::None.
The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem.
- Parameters
-
The move constructor creates a SelectionItem by transferring the underlying impl of the rvalue reference to this SelectionItem thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a SelectionItem to take the impl from. |
bool SelectionItem::Equals |
( |
SelectionItem const & |
in_that | ) |
const |
Check if the source SelectionItem is equivalent to this SelectionItem.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Type SelectionItem::ObjectType |
( |
| ) |
const |
|
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 Object.
bool SelectionItem::operator!= |
( |
SelectionItem const & |
in_that | ) |
const |
Check if the source SelectionItem is not equivalent to this SelectionItem.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionItem thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a SelectionItem to take the impl from. |
- Returns
- A reference to this SelectionItem.
bool SelectionItem::operator== |
( |
SelectionItem const & |
in_that | ) |
const |
Check if the source SelectionItem is equivalent to this SelectionItem.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
bool SelectionItem::ShowCharacters |
( |
SizeTArray & |
out_characters | ) |
const |
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.
bool SelectionItem::ShowEdges |
( |
SizeTArray & |
out_vertices1, |
|
|
SizeTArray & |
out_vertices2 |
|
) |
| const |
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.
- Parameters
-
out_faces | The indices to the edges within a shell, mesh, or polygon for the item that was selected. |
- Returns
- true if the indices array is valid, false otherwise.
bool SelectionItem::ShowFaces |
( |
SizeTArray & |
out_faces | ) |
const |
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.
bool SelectionItem::ShowPath |
( |
KeyPath & |
out_path | ) |
const |
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.
bool SelectionItem::ShowSelectedItem |
( |
Key & |
out_selection | ) |
const |
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.
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.
bool SelectionItem::ShowSelectionPosition |
( |
WindowPoint & |
out_location | ) |
const |
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.
bool SelectionItem::ShowSelectionPosition |
( |
WorldPoint & |
out_location | ) |
const |
Shows the selection position in camera 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.
bool SelectionItem::ShowVertices |
( |
SizeTArray & |
out_vertices | ) |
const |
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_faces | 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: