#include <HSelectionItem.h>
Public Member Functions | |
virtual bool | Delete () |
virtual bool | Equals (const HSelectionItem *i2) const |
virtual int | GetIncludeCount () const |
virtual void | GetIncludeKeys (HC_KEY *) const |
virtual const HC_KEY *const | GetIncludeKeys () 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) |
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.
HOldSelItem::HOldSelItem | ( | HC_KEY | key, | |
HSelectionSet * | selection_set, | |||
const char * | selection_path, | |||
HC_KEY | include_key, | |||
HC_KEY | includer_key | |||
) |
Constructor
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.
Implements HSelectionItem.
virtual bool HOldSelItem::Equals | ( | const HSelectionItem * | i2 | ) | const [virtual] |
i2 | An HOldSelItem object to be compared with this object |
Reimplemented from HSelectionItem.
virtual int HOldSelItem::GetIncludeCount | ( | ) | const [inline, virtual] |
Implements HSelectionItem.
virtual void HOldSelItem::GetIncludeKeys | ( | HC_KEY * | includes | ) | const [inline, virtual] |
includes | An 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.
virtual const HC_KEY* const HOldSelItem::GetIncludeKeys | ( | ) | const [inline, virtual] |
Implements HSelectionItem.
References HC_KEY.
virtual const char* HOldSelItem::GetName | ( | ) | const [inline, virtual] |
virtual bool HOldSelItem::Highlight | ( | ) | [virtual] |
Call this function to highlight the selection item
Implements HSelectionItem.
virtual bool HOldSelItem::IsHighlighted | ( | ) | const [virtual] |
Checks to see if an item is currently highlighted
Implements HSelectionItem.
virtual bool HOldSelItem::IsInstanced | ( | ) | const [inline, virtual] |
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.
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.
include_key | HC_KEY to include key on which the dependency is wanted | |
ret_dependent_key | HC_KEY to segment/entity which depends on the include key |
Implements HSelectionItem.
virtual bool HOldSelItem::UnHighlight | ( | ) | [virtual] |
Call this function to unhighlight the selection item
Implements HSelectionItem.
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.
include_key | HC_KEY to include key which is deleted/going to be deleted | |
dependent_key | HC_KEY to segment/entity which depends on the include key | |
replacement_key | new HC_KEY as a replacement to the dependent key |
Implements HSelectionItem.