HRegionSelItem

Functions

HRegionSelItem
~HRegionSelItem
char const * GetName
int const GetRegion
bool Equals
bool Highlight
bool UnHighlight

Detailed Description

class HRegionSelItem : public HSmartSelItem

The HRegionSelItem - region selection item which can handle instancing.

This implementation of HSmartSelItem class handles instanced regions. It also uses the ‘conditional styling’ mechanism to highlight the selection

Public Functions

HRegionSelItem(HShellObject const &oShellObj, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], int region)

Constructs a HRegionSelItem 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.
inline ~HRegionSelItem()
inline virtual char const *GetName() const
Returns:A character pointer denoting the name which is “HRegionSelItem.”
inline virtual int const GetRegion() const
Returns:The shell region which is selected.
virtual bool Equals(HSelectionItem const *i2) const
Parameters:i2 – An HRegionSelItem object to be compared with this object.
Returns:True if the two region selection elements are equal.
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.