Public Member Functions

virtual bool Delete ()
 
virtual bool Equals (const HSelectionItem *i2) const
 
int GetFaceCount () const
 
void GetFaces (int faces[])
 
void GetMapCounts (int *face_map_count, int *vertex_map_count)
 
void GetMaps (int face_map[], int vertex_map[])
 
virtual const char * GetName () const
 
int GetVertexCount () const
 
void GetVertices (int vertex1[], int vertex2[])
 
virtual bool Highlight ()
 
 HSubentitySelItem (HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], int face_count, const int faces[], int vertex_count, int const vertex1[], int const vertex2[], bool highlight_faces=true, bool highlight_vertices=true, bool highlight_edges=true, bool maintain_maps=false)
 
bool IsEmpty ()
 
bool MaintainMaps ()
 
void MaintainMaps (bool maintain_maps)
 
void MergeMaps (HSubentitySelItem *that)
 
virtual bool Similar (const HSelectionItem *i2) const
 
virtual bool UnHighlight ()
 
virtual bool UnHighlight (HSubentitySelItem const *remove_sel)
 
- Public Member Functions inherited from HSmartSelItem
virtual const HC_KEY * GetFullPathKeys (HBaseView *view)
 
virtual void GetFullPathKeys (HBaseView *view, HC_KEY path[])
 
void GetHighlightedRefList (HC_KEY *keys)
 
int GetHighlightedRefListCount ()
 
virtual const int GetHighlightMode ()
 
virtual int GetIncludeCount () const
 
virtual const HC_KEY *const GetIncludeKeys () const
 
virtual void GetIncludeKeys (HC_KEY includes[]) const
 
 HSmartSelItem (HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[])
 
 HSmartSelItem (HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], bool is_segment)
 
virtual bool IsHighlighted () const
 
virtual bool IsInstanced () const
 
bool IsSegment ()
 
virtual bool QueryIncludeDependency (HC_KEY include_key, HC_KEY &ret_dependent_key)
 
virtual void SetHighlightMode (HSelectionHighlightMode m)
 
virtual bool UpdateIncludeDependency (HC_KEY include_key, HC_KEY dependent_key, HC_KEY replacement_key)
 
void UpdateIncludePath (int incl_count, HC_KEY incl_keys[])
 
- Public Member Functions inherited from HSelectionItem
virtual int GetFullPathCount (HBaseView *view)
 
virtual HC_KEY GetKey () const
 
virtual HC_KEY GetSegmentKey () const
 
float GetTimeStamp ()
 
 HSelectionItem (HC_KEY key, HSelectionSet *selection_set)
 
void SetTimeStamp (float now)
 

Protected Member Functions

 HSubentitySelItem (bool is_ooc, HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], int face_count, const int faces[], int vertex_count, int const vertex1[], int const vertex2[], bool highlight_faces=true, bool highlight_vertices=true, bool highlight_edges=true, bool maintain_maps=false)
 
- Protected Member Functions inherited from HSmartSelItem
void AddHighlightedRefKey (HC_KEY key)
 
void CommonUnhighlightRef ()
 
void FixIncludePath ()
 
HC_KEY GetHighlightedRefKey ()
 
 HSmartSelItem (bool is_ooc, HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], bool is_segment)
 

Friends

class HSelectionSet
 

Additional Inherited Members

- Static Public Member Functions inherited from HSmartSelItem
static bool IsHighlighted (const HC_KEY key, const HSelectionSet *selection_set, const int incl_count, const HC_KEY incl_keys[])
 
static bool IsRegionHighlighted (const HC_KEY key, const HSelectionSet *selection_set, const int incl_count, const HC_KEY incl_keys[], int region)
 
- Protected Attributes inherited from HSmartSelItem
struct vlist_s * m_pSelKeyList
 
- Protected Attributes inherited from HSelectionItem
HC_KEY * m_FullPath
 The include path plus the selection item and view key. If the object is not a HSmartSelItem, the path may be incomplete.
 
int m_FullPathCount
 The length of the m_FullPath array of keys including the selection item and view key.
 
HC_KEY m_key
 The HOOPS key to the selection element.
 
HSelectionSetm_pSelectionSet
 The selection set which owns this selection item.
 
float m_TimeStamp
 Time the item was created. Used for sorting the selection list.
 

Constructor & Destructor Documentation

◆ HSubentitySelItem()

HSubentitySelItem::HSubentitySelItem ( HC_KEY  key,
HSelectionSet selection_set,
int  incl_count,
HC_KEY  incl_keys[],
int  face_count,
const int  faces[],
int  vertex_count,
int const  vertex1[],
int const  vertex2[],
bool  highlight_faces = true,
bool  highlight_vertices = true,
bool  highlight_edges = true,
bool  maintain_maps = false 
)

Constructs a HSubentitySelItem object.

Parameters
keyHOOPS key to selection item.
selection_setA pointer to the HOOPS selection set which owns this selection item.
incl_countNumber of include keys in the selection item segment path.
incl_keysAn array of HOOPS keys of all the include keys in the selection item path.
face_countThe number of faces to be retained from the source shell, usually returned from HC_Show_Selection_Elements().
facesThe faces to be retained from the source shell, usually returned from HC_Show_Selection_Elements().
vertex_countThe number of vertices to be retained from the source shell, usually returned from HC_Show_Selection_Elements(). Vertices required by faces, above, will be retained in all cases.
vertex1The vertices to be retained from the source shell, usually returned from HC_Show_Selection_Elements().
vertex2If supplied, vertices in this array will also be retained and an edge will be defined between the vertex in this array and the corresponding vertex in vertex1.
highlight_facesIf true and if faces are supplied, faces will be highlighted
highlight_verticesIf true and if vertices are supplied, vertices will be highlighted
highlight_edgesIf true and if both vertex arrays are supplied, edges will be highlighted
maintain_mapsIf true, a mapping from the points and faces of the original shell will be retained after highlighting. This can be useful for performing operations on the original geometry, but will use more memory.

Member Function Documentation

◆ Delete()

virtual bool HSubentitySelItem::Delete ( )
virtual

Call this function to delete the selection item and the selected portion of the geometry.

Returns
True if the item was successfully deleted.

Reimplemented from HSmartSelItem.

◆ Equals()

virtual bool HSubentitySelItem::Equals ( const HSelectionItem i2) const
virtual
Returns
True if the two subentity selection elements are equal.
Parameters
i2An HSelectionItem object to be compared with this object.

Reimplemented from HSmartSelItem.

◆ GetName()

virtual const char* HSubentitySelItem::GetName ( ) const
inlinevirtual
Returns
A character pointer denoting the name which is "HRegionSelItem."

Reimplemented from HSmartSelItem.

◆ Highlight()

virtual bool HSubentitySelItem::Highlight ( )
virtual

Call this function to highlight the selection region.

Returns
A true if the item was successfully highlighted.

Reimplemented from HSmartSelItem.

◆ IsEmpty()

bool HSubentitySelItem::IsEmpty ( )
inline
Returns
true if the selection item has no faces, vertices, or edges remaining in its highlight list.

◆ Similar()

virtual bool HSubentitySelItem::Similar ( const HSelectionItem i2) const
virtual
Returns
True if the two subentity selection elements refer to the same object. They may or may not have the same subentity details.
Parameters
i2An HSelectionItem object to be compared with this object.

◆ UnHighlight() [1/2]

virtual bool HSubentitySelItem::UnHighlight ( )
virtual

Call this function to unhighlight the selection item.

Returns
A true if the item was successfully unhighlighted.

Reimplemented from HSmartSelItem.

◆ UnHighlight() [2/2]

virtual bool HSubentitySelItem::UnHighlight ( HSubentitySelItem const *  remove_sel)
virtual

Call this function to unhighlight select elements from this selection item.

Returns
true if the elements were successfully unhighlighted.

The documentation for this class was generated from the following file: