SelectionItem

class HPS.SelectionItem : public HPS.Object

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

Public Functions

override void Dispose ()

bool Equals (HPS.SelectionItem in_that)

Check if the source SelectionItem is equivalent to this SelectionItem.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

SelectionItem ()

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

SelectionItem (HPS.SelectionItem in_that)

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

Param in_that

The source SelectionItem to copy.

void Set (HPS.SelectionItem in_that)

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

Param in_that

The source SelectionItem for the assignment.

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.

Param out_characters

The indices to the characters within a text string for the item that was selected.

Return

true if the indices array is valid, false otherwise.

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.

Param out_vertices1

The list of the first vertex index for each edge. Returned to caller.

Param out_vertices2

The list of the second vertex index for each edge. Returned to caller.

Return

true if the indices array is valid, false otherwise.

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.

Param out_faces

The indices to the faces within a shell or mesh for the item that was selected.

Return

true if the indices array is valid, false otherwise.

bool ShowNormalizedSelectionPosition (out HPS.WindowPoint out_location)

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

Param out_location

The selection position in window space with a normalized Z-coordinate for the item that was selected.

Return

true if the window space position is valid, false otherwise.

bool ShowPath (out HPS.KeyPath out_path)

Shows the key path for the item that was selected.

Param out_path

The key path for the item that was selected.

Return

true if the key path is valid, false otherwise.

bool ShowSelectedItem (out HPS.Key out_selection)

Shows the key for the item that was selected.

Param out_selection

The key for the item that was selected.

Return

true if the key is valid, false otherwise.

bool ShowSelectionLevel (out HPS.Selection.Level out_level)

Shows the selection level used when this item was selected.

Param out_level

The selection level used when this item was selected.

Return

true if the selection level is valid, false otherwise.

bool ShowSelectionPosition (out HPS.WindowPoint out_location)

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

Param out_location

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

Return

true if the window space position is valid, false otherwise.

bool ShowSelectionPosition (out HPS.WorldPoint out_location)

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

Param out_location

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

Return

true if the world space position is valid, false otherwise.

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.

Param out_vertices

The indices to the vertices within a shell, mesh, line, polygon, or NURBS curve for the item that was selected.

Return

true if the indices array is valid, false otherwise.

Public Static Functions

bool operator!= (HPS.SelectionItem a, HPS.SelectionItem b)

bool operator== (HPS.SelectionItem a, HPS.SelectionItem b)