Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.SelectionItem Class Reference

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

Inheritance diagram for HPS.SelectionItem:
HPS.Object

Public Member Functions

override void Dispose ()
 
 SelectionItem ()
 The default constructor creates an uninitialized SelectionItem object. The Type() function will return Type::None. More...
 
 SelectionItem (HPS.SelectionItem in_that)
 The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.SelectionItem in_that)
 Associate this SelectionItem with the same underlying impl as the source SelectionItem. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.SelectionItem in_that)
 Check if the source SelectionItem is equivalent to this SelectionItem. More...
 
bool ShowSelectionLevel (out HPS.Selection.Level out_level)
 Shows the selection level used when this item was selected. More...
 
bool ShowSelectedItem (out HPS.Key out_selection)
 Shows the key for the item that was selected. More...
 
bool ShowPath (out HPS.KeyPath out_path)
 Shows the key path for the item that was selected. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
bool ShowSelectionPosition (out HPS.WindowPoint out_location)
 Shows the selection position in window space for the item that was selected. More...
 
bool ShowSelectionPosition (out HPS.WorldPoint out_location)
 Shows the selection position in window space for the item that was selected. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

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

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 <ref refid="class_h_p_s_1_1_selection_item" kindref="compound">SelectionItem</ref> to copy.

Member Function Documentation

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.
override HPS.Type HPS.SelectionItem.ObjectType ( )
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 HPS.Object.

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 <ref refid="class_h_p_s_1_1_selection_item" kindref="compound">SelectionItem</ref> for the assignment.
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.
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.
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.
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.
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.
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.
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.
bool HPS.SelectionItem.ShowSelectionPosition ( out HPS.WorldPoint  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.
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: