Introduction

Getting Started

Programming Guides

API Reference

Additional Resources

HRegionSelItem Class Reference

The HRegionSelItem - region selection item which can handle instancing. More...

#include <HSelectionItem.h>

Public Member Functions

virtual bool Equals (const HSelectionItem *i2) const
 
virtual const char * GetName () const
 
virtual int const GetRegion () const
 
virtual bool Highlight ()
 
 HRegionSelItem (HShellObject const &oShellObj, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], int region)
 
virtual bool UnHighlight ()
 
- Public Member Functions inherited from HSmartSelItem
virtual bool Delete ()
 
virtual const HC_KEYGetFullPathKeys (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)
 

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 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)
 
- Protected Attributes inherited from HSmartSelItem
struct vlist_s * m_pSelKeyList
 
- Protected Attributes inherited from HSelectionItem
HC_KEYm_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.
 

Detailed Description

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

Constructor & Destructor Documentation

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

Constructs a HRegionSelItem 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.

Member Function Documentation

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

Reimplemented from HSmartSelItem.

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

Reimplemented from HSmartSelItem.

virtual int const HRegionSelItem::GetRegion ( ) const
inlinevirtual
Returns
The shell region which is selected.
virtual bool HRegionSelItem::Highlight ( )
virtual

Call this function to highlight the selection region.

Returns
A true if the item was successfully highlighted.

Reimplemented from HSmartSelItem.

virtual bool HRegionSelItem::UnHighlight ( )
virtual

Call this function to unhighlight the selection item.

Returns
A true if the item was successfully unhighlighted.

Reimplemented from HSmartSelItem.


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