Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HSubentitySelItem Class Reference

List of all members.

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)

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)

Friends

class HSelectionSet

Constructor & Destructor Documentation

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

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.

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.

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

Reimplemented from HSmartSelItem.

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.

bool HSubentitySelItem::IsEmpty ( ) [inline]
Returns:
true if the selection item has no faces, vertices, or edges remaining in its highlight list.
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.
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.

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: