HSmartSelItem

class HSmartSelItem

The HSmartSelItem - selection item which can handle instancing.

This implementation of HSelectionItem class handles instanced segments and entities. It also uses the ‘conditional styling’ mechanism to highlight the selection.

Inherits from: HSelectionItem

Methods

HSmartSelItem::HSmartSelItem(HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[])

Constructs a HSmartSelItem object.

Parameters

key: HOOPS key to selection item.

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

HSmartSelItem::HSmartSelItem(HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], bool is_segment)

Constructs a HSmartSelItem object.

Parameters

key: HOOPS key to selection item.

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

is_segment: Is the item known to be a segment.

virtual HSmartSelItem::~HSmartSelItem()

virtual

virtual char const *HSmartSelItem::GetName() const

const virtual

Returns

A character pointer denoting the name which is “HSmartSelItem.”
virtual int HSmartSelItem::GetIncludeCount() const

const virtual

Returns

The number of include keys in the include path.
virtual const HC_KEY *const HSmartSelItem::GetIncludeKeys() const

const virtual

Returns

An array to include keys. The return pointer is for read-only purpose.
virtual void HSmartSelItem::GetIncludeKeys(HC_KEY includes[]) const

const virtual

Parameters

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.
virtual const HC_KEY *HSmartSelItem::GetFullPathKeys(HBaseView *view)

virtual

Parameters

view: The HBaseView in which this item is selected.

Returns

An array to include keys, just like GetIncludeKeys, except that the keys array includes the selection item and the view key (as passed in).
virtual void HSmartSelItem::GetFullPathKeys(HBaseView *view, HC_KEY path[])

virtual

Parameters

view: The HBaseView in which the item is selected

path: An array of keys (returned to the user), just like GetIncludeKeys, except that the keys array includes the selection item and the view key (as passed in). Note that the caller must ensure that the array is of the appropriate size, e.g., via the GetFullPathCount function.

virtual bool HSmartSelItem::Equals(HSelectionItem const *i2) const

const virtual

Parameters

i2: An HSelectionItem object to be compared with this object

Returns

True if the two selection elements are equal.
virtual bool HSmartSelItem::Highlight()

virtual

Call this function to highlight the selection item.

Returns

True if the highlight is successful.
virtual bool HSmartSelItem::UnHighlight()

virtual

Call this function to unhighlight the selection item.

Returns

True if the unhighlight is successful.
virtual bool HSmartSelItem::IsHighlighted() const

const virtual

Checks to see if an item is currently highlighted.

Returns

True if the item is currently highlighted, false if otherwise.
virtual bool HSmartSelItem::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

True if the item was successfully deleted.
virtual bool HSmartSelItem::IsInstanced() const

const virtual

Checks to see if the selection item has any segments/geometry which might be potentially shared. This is determined by checking the include keys in the selection path. If there is more than one (the model key), then it is instanced.

Returns

True if the item is instanced.
virtual bool HSmartSelItem::QueryIncludeDependency(HC_KEY include_key, HC_KEY &ret_dependent_key)

virtual

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

Returns

True if the item has dependency on the include_key.
virtual bool HSmartSelItem::UpdateIncludeDependency(HC_KEY include_key, HC_KEY dependent_key, HC_KEY replacement_key)

virtual

This method updates the given key’s dependency on a given include key with a new include key.

Parameters

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

Returns

True if the dependency has been successfully updated.
void HSmartSelItem::UpdateIncludePath(int incl_count, HC_KEY incl_keys[])

Replace the original include path and count passed into the constructor.

Parameters

incl_count: The new number of keys in the include path

incl_keys: An array of include keys

virtual int const HSmartSelItem::GetHighlightMode()

virtual

Returns

The selection highlight mode.
virtual void HSmartSelItem::SetHighlightMode(HSelectionHighlightMode m)

virtual

Sets the selection highlight mode.

Parameters

m: What the new highlight mode should be (see the SelectionHighlightMode enumeration for possible values)
int HSmartSelItem::GetHighlightedRefListCount()

Retrieves the size of the list of highlighted objects

Returns

size of highlighted list
void HSmartSelItem::GetHighlightedRefList(HC_KEY *keys)

Copies the list of Geometry Reference keys from this selection item.

Parameters

array: of Reference Geometry keys. Returned to user. Passed by reference always.
bool HSmartSelItem::IsSegment()
static bool HSmartSelItem::IsHighlighted(const HC_KEY key, HSelectionSet const *selection_set, int const incl_count, const HC_KEY incl_keys[])

static

Checks to see if an item is currently highlighted. If you do not have the HSmartSelItem object, but just have the keys and include list returned from HOOPS, you could use this method to find out if the key was selected.

Parameters

key: HOOPS key to the item to be tested for selection.

selection_set: A pointer to the HOOPS selection set in which this is to be tested.

incl_count: Number of include keys in the item segment path.

incl_keys: An array of HOOPS keys of all the include keys in the item path.

Returns

True if the item is currently highlighted, false if otherwise.
static bool HSmartSelItem::IsRegionHighlighted(const HC_KEY key, HSelectionSet const *selection_set, int const incl_count, const HC_KEY incl_keys[], int region)

static

Checks to see if a region is currently highlighted. If you do not have the HSmartSelItem object, but just have the keys and include list returned from HOOPS, you could use this method to find out if the key was selected

Parameters

key: HOOPS shell key to the item to be tested for selection.

selection_set: A pointer to the HOOPS selection set in which this is to be tested.

incl_count: Number of include keys in the item segment path.

incl_keys: An array of HOOPS keys of all the include keys in the item path.

region: The region number in the shell.

Returns

True if the item is currently highlighted, false if otherwise.
HSmartSelItem::HSmartSelItem(bool is_ooc, HC_KEY key, HSelectionSet *selection_set, int incl_count, HC_KEY incl_keys[], bool is_segment)

protected

void HSmartSelItem::CommonUnhighlightRef()

protected

void HSmartSelItem::FixIncludePath()

protected

Ensure the include path is correct for the type of highlighting performed

HC_KEY HSmartSelItem::GetHighlightedRefKey()

protected

Dequeues a Reference Geometry key from the list of highlighted objects

Returns

the reference geometry key of a highlighted object
void HSmartSelItem::AddHighlightedRefKey(HC_KEY key)

protected

Adds a Reference Geometry key to the list of highlighted objects

Parameters

the: reference geometry key of a highlighted object
void HSmartSelItem::InitCommon(int incl_count, HC_KEY *incl_keys, bool is_segment, bool is_ooc = false)

private

void HSmartSelItem::GetBaseTag(char *retTag)

private

Variables

HC_KEY HSmartSelItem::m_ConditionStyle

private

HC_KEY

The HOOPS conditional style key applied to selected item. Required to unhighlight.

HSelectionHighlightMode HSmartSelItem::m_HighlightMode

private

Stores the current highlighting mode.

struct HSmartSelItem::[anonymous] HSmartSelItem::m_IncludePath

private

struct HSmartSelItem::@0
bool HSmartSelItem::m_is_segment

private

bool
HC_KEY HSmartSelItem::m_entity_proxy_seg_tag

private

HC_KEY
struct vlist_s *HSmartSelItem::m_pSelKeyList

protected

struct vlist_s
int HSmartSelItem::count
int
HC_KEY *HSmartSelItem::keys
HC_KEY