API Search || Global Search

#include <hps.h>

Inheritance diagram for HPS::SelectionItem:
HPS::Object

Public Member Functions

bool Equals (SelectionItem const &in_that) const
 
HPS::Type ObjectType () const
 
bool operator!= (SelectionItem const &in_that) const
 
SelectionItemoperator= (SelectionItem &&in_that)
 
SelectionItemoperator= (SelectionItem const &in_that)
 
bool operator== (SelectionItem const &in_that) const
 
 SelectionItem ()
 
 SelectionItem (SelectionItem const &in_that)
 
 SelectionItem (SelectionItem &&in_that)
 
void Set (SelectionItem const &in_that)
 
bool ShowCharacters (SizeTArray &out_characters) const
 
bool ShowEdges (SizeTArray &out_vertices1, SizeTArray &out_vertices2) const
 
bool ShowFaces (SizeTArray &out_faces) const
 
bool ShowNormalizedSelectionPosition (WindowPoint &out_location) const
 
bool ShowPath (KeyPath &out_path) const
 
bool ShowSelectedItem (Key &out_selection) const
 
bool ShowSelectionLevel (Selection::Level &out_level) const
 
bool ShowSelectionPosition (WindowPoint &out_location) const
 
bool ShowSelectionPosition (WorldPoint &out_location) const
 
bool ShowVertices (SizeTArray &out_vertices) const
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SelectionItem
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The SelectionItem class is a smart-pointer to a database object. It represents an item in a SelectionResults object.

Constructor & Destructor Documentation

HPS::SelectionItem::SelectionItem ( )

The default constructor creates an uninitialized SelectionItem object. The Type() function will return Type::None.

HPS::SelectionItem::SelectionItem ( SelectionItem const &  in_that)

The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem.

Parameters
in_thatThe source SelectionItem to copy.
HPS::SelectionItem::SelectionItem ( SelectionItem &&  in_that)

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_thatAn rvalue reference to a SelectionItem to take the impl from.

Member Function Documentation

bool HPS::SelectionItem::Equals ( SelectionItem const &  in_that) const

Check if the source SelectionItem is equivalent to this SelectionItem.

Parameters
in_kitThe source SelectionItem to compare to this SelectionItem.
Returns
true if the objects are equivalent, false otherwise.
bool HPS::SelectionItem::operator!= ( SelectionItem const &  in_that) const

Check if the source SelectionItem is not equivalent to this SelectionItem.

Parameters
in_kitThe source SelectionItem to compare to this SelectionItem.
Returns
true if the objects are not equivalent, false otherwise.
SelectionItem& HPS::SelectionItem::operator= ( SelectionItem &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionItem thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a SelectionItem to take the impl from.
Returns
A reference to this SelectionItem.
SelectionItem& HPS::SelectionItem::operator= ( SelectionItem const &  in_that)

Associate this SelectionItem with the same underlying impl as the source SelectionItem.

Parameters
in_thatThe source SelectionItem for the assignment.
Returns
A reference to this SelectionItem.
bool HPS::SelectionItem::operator== ( SelectionItem const &  in_that) const

Check if the source SelectionItem is equivalent to this SelectionItem.

Parameters
in_kitThe source SelectionItem to compare to this SelectionItem.
Returns
true if the objects are equivalent, false otherwise.
void HPS::SelectionItem::Set ( SelectionItem const &  in_that)

Associate this SelectionItem with the same underlying impl as the source SelectionItem.

Parameters
in_thatThe source SelectionItem for the assignment.
bool HPS::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_charactersThe 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 HPS::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_facesThe 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 HPS::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_facesThe 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 HPS::SelectionItem::ShowNormalizedSelectionPosition ( WindowPoint out_location) const

Shows the Z-normalized selection position in window space for the item that was selected.

Parameters
out_locationThe 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.
bool HPS::SelectionItem::ShowPath ( KeyPath out_path) const

Shows the key path for the item that was selected.

Parameters
out_pathThe key path for the item that was selected.
Returns
true if the key path is valid, false otherwise.
bool HPS::SelectionItem::ShowSelectedItem ( Key out_selection) const

Shows the key for the item that was selected.

Parameters
out_selectionThe key for the item that was selected.
Returns
true if the key is valid, false otherwise.
bool HPS::SelectionItem::ShowSelectionLevel ( Selection::Level out_level) const

Shows the selection level used when this item was selected.

Parameters
out_levelThe selection level used when this item was selected.
Returns
true if the selection level is valid, false otherwise.
bool HPS::SelectionItem::ShowSelectionPosition ( WindowPoint out_location) const

Shows the selection position in window space for the item that was selected.

Parameters
out_locationThe selection position in window space for the item that was selected.
Returns
true if the window space position is valid, false otherwise.
bool HPS::SelectionItem::ShowSelectionPosition ( WorldPoint out_location) const

Shows the selection position in world space for the item that was selected.

Parameters
out_locationThe selection position in world space for the item that was selected.
Returns
true if the world space position is valid, false otherwise.
bool HPS::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_facesThe 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: