Inheritance diagram for HPS.SelectionItem:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SelectionItem in_that)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
 SelectionItem ()
 
 SelectionItem (HPS.SelectionItem in_that)
 
void Set (HPS.SelectionItem in_that)
 
bool ShowCharacters (out ulong[] out_characters)
 
bool ShowEdges (out ulong[] out_vertices1, out ulong[] out_vertices2)
 
bool ShowFaces (out ulong[] out_faces)
 
bool ShowNormalizedSelectionPosition (out HPS.WindowPoint out_location)
 
bool ShowPath (out HPS.KeyPath out_path)
 
bool ShowSelectedItem (out HPS.Key out_selection)
 
bool ShowSelectionLevel (out HPS.Selection.Level out_level)
 
bool ShowSelectionPosition (out HPS.WindowPoint out_location)
 
bool ShowSelectionPosition (out HPS.WorldPoint out_location)
 
bool ShowVertices (out ulong[] out_vertices)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.SelectionItem a, HPS.SelectionItem b)
 
static bool operator== (HPS.SelectionItem a, HPS.SelectionItem b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ 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]

HPS.SelectionItem.SelectionItem ( HPS.SelectionItem  in_that)
inline

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

Parameters
in_thatThe source SelectionItem to copy.

Member Function Documentation

◆ Equals()

bool HPS.SelectionItem.Equals ( HPS.SelectionItem  in_that)
inline

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()

void HPS.SelectionItem.Set ( HPS.SelectionItem  in_that)
inline

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

Parameters
in_thatThe source SelectionItem for the assignment.

◆ 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_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.

◆ 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_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.

◆ 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_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.

◆ ShowPath()

bool HPS.SelectionItem.ShowPath ( out HPS.KeyPath  out_path)
inline

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.

◆ ShowSelectedItem()

bool HPS.SelectionItem.ShowSelectedItem ( out HPS.Key  out_selection)
inline

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.

◆ ShowSelectionLevel()

bool HPS.SelectionItem.ShowSelectionLevel ( out HPS.Selection.Level  out_level)
inline

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.

◆ 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_locationThe 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_locationThe 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.

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