HSubentitySelItem

Detailed Description

class HSubentitySelItem : public HSmartSelItem

Public Functions

HSubentitySelItem(HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], int face_count, int const 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:
  • key – HOOPS key to selection item.
  • selection_set – A pointer to the HOOPS selection set which owns this selection item.
  • incl_count – Number of include keys in the selection item segment path.
  • incl_keys – An array of HOOPS keys of all the include keys in the selection item path.
  • face_count – The number of faces to be retained from the source shell, usually returned from HC_Show_Selection_Elements().
  • faces – The faces to be retained from the source shell, usually returned from HC_Show_Selection_Elements().
  • vertex_count – The 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.
  • vertex1 – The vertices to be retained from the source shell, usually returned from HC_Show_Selection_Elements().
  • vertex2 – If 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_faces – If true and if faces are supplied, faces will be highlighted
  • highlight_vertices – If true and if vertices are supplied, vertices will be highlighted
  • highlight_edges – If true and if both vertex arrays are supplied, edges will be highlighted
  • maintain_maps – If 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.
~HSubentitySelItem()
inline virtual char const *GetName() const
Returns:A character pointer denoting the name which is “HRegionSelItem.”
virtual bool Equals(HSelectionItem const *i2) const
Parameters:i2 – An HSelectionItem object to be compared with this object.
Returns:True if the two subentity selection elements are equal.
virtual bool Similar(HSelectionItem const *i2) const
Parameters:i2 – An HSelectionItem object to be compared with this object.
Returns:True if the two subentity selection elements refer to the same object. They may or may not have the same subentity details.
virtual bool Highlight()

Call this function to highlight the selection region.

Returns:A true if the item was successfully highlighted.
virtual bool UnHighlight()

Call this function to unhighlight the selection item.

Returns:A true if the item was successfully unhighlighted.
virtual bool UnHighlight(HSubentitySelItem const *remove_sel)

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

Returns:true if the elements were successfully unhighlighted.
inline bool IsEmpty()
Returns:true if the selection item has no faces, vertices, or edges remaining in its highlight list.
virtual bool Delete()

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

Returns:True if the item was successfully deleted.
inline int GetFaceCount() const
void GetFaces(int faces[])
inline int GetVertexCount() const
void GetVertices(int vertex1[], int vertex2[])
inline bool MaintainMaps()
inline void MaintainMaps(bool maintain_maps)
void GetMapCounts(int *face_map_count, int *vertex_map_count)
void GetMaps(int face_map[], int vertex_map[])
void MergeMaps(HSubentitySelItem *that)