HOldSelItem Class Reference

The HOldSelItem class implements selection using the old style highlighting which does not handle includes. More...

#include <HSelectionItem.h>

Public Member Functions

virtual bool Delete ()
 
virtual bool Equals (const HSelectionItem *i2) const
 
virtual int GetIncludeCount () const
 
virtual const HC_KEY *const GetIncludeKeys () const
 
virtual void GetIncludeKeys (HC_KEY[]) const
 
virtual const char * GetName () const
 
virtual bool Highlight ()
 
 HOldSelItem (HC_KEY key, HSelectionSet *selection_set, const char *selection_path, HC_KEY include_key, HC_KEY includer_key)
 
virtual bool IsHighlighted () const
 
virtual bool IsInstanced () const
 
virtual bool QueryIncludeDependency (HC_KEY include_key, HC_KEY &ret_dependent_key)
 
virtual bool UnHighlight ()
 
virtual bool UpdateIncludeDependency (HC_KEY include_key, HC_KEY dependent_key, HC_KEY replacement_key)
 
- Public Member Functions inherited from HSelectionItem
virtual int GetFullPathCount (HBaseView *view)
 
virtual const HC_KEY * GetFullPathKeys (HBaseView *view)
 
virtual void GetFullPathKeys (HBaseView *view, HC_KEY path[])
 
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

- 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.
 

Detailed Description

The HOldSelItem class implements selection using the old style highlighting which does not handle includes.

This class is purely provided for backward compatibility reasons and should be considered obsolete. HOldSelItem implement HSelectionItem interfaces using the old style of highlighting which couldn't handle the multiply included segments/entities.

Constructor & Destructor Documentation

◆ HOldSelItem()

HOldSelItem::HOldSelItem ( HC_KEY  key,
HSelectionSet selection_set,
const char *  selection_path,
HC_KEY  include_key,
HC_KEY  includer_key 
)

Constructor

Member Function Documentation

◆ Delete()

virtual bool HOldSelItem::Delete ( )
virtual

Call this function to delete the selection item NOTE: If the selection is a non-instanced segment or entity it will be deleted. If the selection is an instanced segment or entity, it's include link will be removed.

Returns
A true if the delete is succesful

Implements HSelectionItem.

◆ Equals()

virtual bool HOldSelItem::Equals ( const HSelectionItem i2) const
virtual
Returns
A true when the two selection elements are equal.
Parameters
i2An HOldSelItem object to be compared with this object

Reimplemented from HSelectionItem.

◆ GetIncludeCount()

virtual int HOldSelItem::GetIncludeCount ( ) const
inlinevirtual
Returns
A count of number of include keys in the include path. Old selection doesn't deal with it.

Implements HSelectionItem.

◆ GetIncludeKeys() [1/2]

virtual const HC_KEY* const HOldSelItem::GetIncludeKeys ( ) const
inlinevirtual
Returns
An array to include keys. The return pointer is meant for read-only purpose Old selection doesn't deal with it.

Implements HSelectionItem.

◆ GetIncludeKeys() [2/2]

virtual void HOldSelItem::GetIncludeKeys ( HC_KEY  includes[]) const
inlinevirtual
Parameters
includesAn array of include keys (returned to the user). Note that the caller must ensure that the array is of the appropriate size, e.g, via the GetIncludeCount function.

Implements HSelectionItem.

◆ GetName()

virtual const char* HOldSelItem::GetName ( ) const
inlinevirtual
Returns
A character pointer denoting the name of operator.

Reimplemented from HSelectionItem.

◆ Highlight()

virtual bool HOldSelItem::Highlight ( )
virtual

Call this function to highlight the selection item

Returns
A true when the highlight is succesful

Implements HSelectionItem.

◆ IsHighlighted()

virtual bool HOldSelItem::IsHighlighted ( ) const
virtual

Checks to see if an item is currently highlighted

Returns
true if the item is currently highlighted, false if not

Implements HSelectionItem.

◆ IsInstanced()

virtual bool HOldSelItem::IsInstanced ( ) const
inlinevirtual

Checks to see if the selection item has any segments/geometry which might be potentially shared. In the old selection behaviour we never handled instancing. To preserve the behaviour, this returns false.

Implements HSelectionItem.

◆ QueryIncludeDependency()

virtual bool HOldSelItem::QueryIncludeDependency ( HC_KEY  include_key,
HC_KEY &  ret_dependent_key 
)
virtual

Finds out if the selection item has any dependency on the include key being provide. If it has, the api returns true and returns which key is dependent as the second argument.

Parameters
include_keyHC_KEY to include key on which the dependency is wanted
ret_dependent_keyHC_KEY to segment/entity which depends on the include key
Returns
true if the item has dependency on the include_key

Implements HSelectionItem.

◆ UnHighlight()

virtual bool HOldSelItem::UnHighlight ( )
virtual

Call this function to unhighlight the selection item

Returns
A true if the unhighlight is succesful

Implements HSelectionItem.

◆ UpdateIncludeDependency()

virtual bool HOldSelItem::UpdateIncludeDependency ( HC_KEY  include_key,
HC_KEY  dependent_key,
HC_KEY  replacement_key 
)
virtual

Call to selection item to update its selection data. Specifically the key which depended on the include key and have it replaced.

Parameters
include_keyHC_KEY to include key which is deleted/going to be deleted
dependent_keyHC_KEY to segment/entity which depends on the include key
replacement_keynew HC_KEY as a replacement to the dependent key
Returns
true if the dependency has been successfully updated

Implements HSelectionItem.


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