HPS::SceneTreeItem Class Referenceabstract

#include <sprk.h>

Inheritance diagram for HPS::SceneTreeItem:
HPS::Sprocket HPS::Object

Public Member Functions

virtual SceneTreeItemPtr AddChild (Key const &in_key, SceneTree::ItemType in_type, char const *in_title=nullptr)=0
 
virtual void Assign (SceneTreeItem const &in_that)
 
virtual void Collapse ()
 
bool Equals (SceneTreeItem const &in_that) const
 
virtual void Expand ()
 
SceneTree::ItemType GetItemType () const
 
Key GetKey () const
 
KeyPath GetKeyPath () const
 
UTF8 GetTitle () const
 
SceneTreePtr GetTree () const
 
bool HasChildren () const
 
bool HasItemType (SceneTree::ItemType in_mask) const
 
void Highlight (size_t in_highlight_options_index=0)
 
void Highlight (HighlightOptionsKit const &in_highlight_options)
 
bool IsExpanded () const
 
bool IsHighlightable () const
 
bool IsHighlighted () const
 
bool IsSelected () const
 
HPS::Type ObjectType () const
 
bool operator!= (SceneTreeItem const &in_that) const
 
SceneTreeItemoperator= (SceneTreeItem const &in_that)
 
SceneTreeItemoperator= (SceneTreeItem &&in_that)
 
bool operator== (SceneTreeItem const &in_that) const
 
void ReExpand ()
 
 SceneTreeItem ()
 
 SceneTreeItem (SceneTreeItem const &in_that)
 
 SceneTreeItem (SceneTreeItem &&in_that)
 
 SceneTreeItem (SceneTreePtr const &in_tree, Model const &in_model)
 
 SceneTreeItem (SceneTreePtr const &in_tree, View const &in_view)
 
 SceneTreeItem (SceneTreePtr const &in_tree, Layout const &in_layout)
 
 SceneTreeItem (SceneTreePtr const &in_tree, Canvas const &in_canvas)
 
 SceneTreeItem (SceneTreePtr const &in_tree, Key const &in_key, SceneTree::ItemType in_type, char const *in_title=nullptr)
 
virtual void Select ()
 
void Unhighlight (size_t in_highlight_options_index=0)
 
void Unhighlight (HighlightOptionsKit const &in_highlight_options)
 
virtual void Unselect ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SceneTreeItem
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The SceneTreeItem class is a smart pointer which corresponds to an item or node in a tree object in a GUI toolkit, e.g., a TreeViewItem in WPF or an HTREEITEM in MFC. This class must be derived from to facilitate tree creation in the various GUI toolkits. It is used to represent items in a scene graph or segment browser.

Constructor & Destructor Documentation

◆ SceneTreeItem() [1/8]

HPS::SceneTreeItem::SceneTreeItem ( )

The default constructor creates an uninitialized SceneTreeItem object. The Type() function will return Type::None.

◆ SceneTreeItem() [2/8]

HPS::SceneTreeItem::SceneTreeItem ( SceneTreeItem const &  in_that)

The copy constructor creates a SceneTreeItem object that shares the underlying smart-pointer of the source SceneTreeItem.

Parameters
in_thatThe source SceneTreeItem to copy.

◆ SceneTreeItem() [3/8]

HPS::SceneTreeItem::SceneTreeItem ( SceneTreeItem &&  in_that)

The move constructor creates a SceneTreeItem by transferring the underlying object of the rvalue reference to this SceneTreeItem.

Parameters
in_thatAn rvalue reference to a SceneTreeItem to take the underlying object from.

◆ SceneTreeItem() [4/8]

HPS::SceneTreeItem::SceneTreeItem ( SceneTreePtr const &  in_tree,
Model const &  in_model 
)

This constructor creates a SceneTreeItem suitable for acting as a root in a SceneTree. This root would start at the Model. The Model provided to this constructor should be accessible from the Canvas associated with the SceneTree, otherwise an exception will be thrown.

Parameters
in_treeThe SceneTree with which to associate this new root SceneTreeItem.
in_modelThe Model for this root SceneTreeItem.
See also
SceneTree::SetRoot

◆ SceneTreeItem() [5/8]

HPS::SceneTreeItem::SceneTreeItem ( SceneTreePtr const &  in_tree,
View const &  in_view 
)

This constructor creates a SceneTreeItem suitable for acting as a root in a SceneTree. This root would start at the View. The View provided to this constructor should be accessible from the Canvas associated with the SceneTree, otherwise an exception will be thrown.

Parameters
in_treeThe SceneTree with which to associate this new root SceneTreeItem.
in_viewThe View for this root SceneTreeItem.
See also
SceneTree::SetRoot

◆ SceneTreeItem() [6/8]

HPS::SceneTreeItem::SceneTreeItem ( SceneTreePtr const &  in_tree,
Layout const &  in_layout 
)

This constructor creates a SceneTreeItem suitable for acting as a root in a SceneTree. This root would start at the Layout. The Layout provided to this constructor should be accessible from the Canvas associated with the SceneTree, otherwise an exception will be thrown.

Parameters
in_treeThe SceneTree with which to associate this new root SceneTreeItem.
in_layoutThe Layout for this root SceneTreeItem.
See also
SceneTree::SetRoot

◆ SceneTreeItem() [7/8]

HPS::SceneTreeItem::SceneTreeItem ( SceneTreePtr const &  in_tree,
Canvas const &  in_canvas 
)

This constructor creates a SceneTreeItem suitable for acting as a root in a SceneTree. This root would start at the Canvas. The Canvas provided to this constructor should be the same as the Canvas associated with the SceneTree, otherwise an exception will be thrown.

Parameters
in_treeThe SceneTree with which to associate this new root SceneTreeItem.
in_canvasThe Canvas for this root SceneTreeItem.
See also
SceneTree::SetRoot

◆ SceneTreeItem() [8/8]

HPS::SceneTreeItem::SceneTreeItem ( SceneTreePtr const &  in_tree,
Key const &  in_key,
SceneTree::ItemType  in_type,
char const *  in_title = nullptr 
)

This constructor creates a SceneTreeItem which is not suitable for acting as a root in a SceneTree, but is suitable to be a SceneTreeItem under the root of the SceneTree. This constructor should be the one invoked in the overridden AddChild function.

Parameters
in_treeThe SceneTree with which to associate this new SceneTreeItem.
in_keyThe Key for this SceneTreeItem. This value should come from the corresponding argument to AddChild.
in_typeThe type of this SceneTreeItem. This value should come from the corresponding argument to AddChild.
in_titleThe title for this SceneTreeItem. This value should come from the corresponding argument to AddChild.
See also
AddChild

Member Function Documentation

◆ AddChild()

virtual SceneTreeItemPtr HPS::SceneTreeItem::AddChild ( Key const &  in_key,
SceneTree::ItemType  in_type,
char const *  in_title = nullptr 
)
pure virtual

This function is used to create a new SceneTreeItem to be the child of this SceneTreeItem. This function will be invoked if this SceneTreeItem has children and Expand has been invoked on it. This function should contain any necessary calls to GUI toolkits to create the appropriate GUI elements, e.g., see the implementations in the mfc_sandbox or wpf_sandbox. Additionally, since this function requires the creation of a derived SceneTreeItem, that derived SceneTreeItem should use the base constructor which takes the same arguments this function.

Parameters
in_keyThe Key for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor.
in_typeThe type for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor.
in_titleThe title for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor.
Returns
A newly created object derived from SceneTreeItem.

◆ Assign()

virtual void HPS::SceneTreeItem::Assign ( SceneTreeItem const &  in_that)
virtual

Share the underlying smart-pointer of the SceneTreeItem source.

Parameters
in_thatThe SceneTreeItem source of the assignment.
Returns
A reference to this SceneTreeItem.

◆ Collapse()

virtual void HPS::SceneTreeItem::Collapse ( )
virtual

This function should be invoked when this SceneTreeItem needs to collapse. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always release all children for this SceneTreeItem when invoked.

◆ Equals()

bool HPS::SceneTreeItem::Equals ( SceneTreeItem const &  in_that) const

Check if the source SceneTreeItem points to the same underlying impl as this SceneTreeItem.

Parameters
in_thatThe source SceneTreeItem to compare to this SceneTreeItem.
Returns
true if the objects reference the same impl, false otherwise.

◆ Expand()

virtual void HPS::SceneTreeItem::Expand ( )
virtual

This function should be invoked when this SceneTreeItem needs to expand. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always repopulate the children for this SceneTreeItem when invoked.

◆ GetItemType()

SceneTree::ItemType HPS::SceneTreeItem::GetItemType ( ) const

Gets the item type for this SceneTreeItem. This is used to determine what type of data this SceneTreeItem represents in the SceneTree.

Returns
The item type for this SceneTreeItem.

◆ GetKey()

Key HPS::SceneTreeItem::GetKey ( ) const

Gets the key for this SceneTreeItem. The type of the key depends on the SceneTree::ItemType for this SceneTreeItem.

Returns
The key for this SceneTreeItem.

◆ GetKeyPath()

KeyPath HPS::SceneTreeItem::GetKeyPath ( ) const

Gets the key path for this SceneTreeItem.

Returns
The key path for this SceneTreeItem.

◆ GetTitle()

UTF8 HPS::SceneTreeItem::GetTitle ( ) const

Gets the title for this SceneTreeItem. This is the text that should be displayed for this SceneTreeItem in the SceneTree.

Returns
The title for this SceneTreeItem.

◆ GetTree()

SceneTreePtr HPS::SceneTreeItem::GetTree ( ) const

Gets the SceneTree associated with this SceneTreeItem. This provides a means of accessing the derived SceneTree by this SceneTreeItem if necessary.

Returns
The SceneTree associated with this SceneTreeItem.

◆ HasChildren()

bool HPS::SceneTreeItem::HasChildren ( ) const

Indicates whether this SceneTreeItem has any children.

Returns
Whether this SceneTreeItem has any children.

◆ HasItemType()

bool HPS::SceneTreeItem::HasItemType ( SceneTree::ItemType  in_mask) const

Indicates whether this SceneTreeItem has the given ItemType mask.

Parameters
in_maskThe ItemType mask to check against this SceneTreeItem.
Returns
true if this SceneTreeItem has the given ItemType mask, false otherwise.

◆ Highlight() [1/2]

void HPS::SceneTreeItem::Highlight ( size_t  in_highlight_options_index = 0)

This function will cause this SceneTreeItem to be highlighted with the options specified in the associated SceneTree. This will cause elements along the path to this item (and this item itself) to be marked as selected if they aren't already. Depending on the type of the SceneTreeItem, sometimes a highlight is nonsensical. In this case, no highlight will be performed.

Parameters
in_higlight_options_indexThe index in the highlight options array held by the associated SceneTree. Defaults to 0.
See also
Select

◆ Highlight() [2/2]

void HPS::SceneTreeItem::Highlight ( HighlightOptionsKit const &  in_highlight_options)

This function will cause this SceneTreeItem to be highlighted with the options specified in the associated SceneTree. This will cause elements along the path to this item (and this item itself) to be marked as selected if they aren't already. Depending on the type of the SceneTreeItem, sometimes a highlight is nonsensical. In this case, no highlight will be performed. If the options requested is not part of the associated SceneTree highlight options, it will be added to them.

Parameters
in_highlight_optionsThe highlight options used during highlighting
See also
Select

◆ IsExpanded()

bool HPS::SceneTreeItem::IsExpanded ( ) const

Indicates whether this SceneTreeItem is currently expanded.

Returns
Whether this SceneTreeItem is currently expanded.

◆ IsHighlightable()

bool HPS::SceneTreeItem::IsHighlightable ( ) const

Indicates whether this SceneTreeItem is able to be highlighted. Some items, like those in static trees, cannot be highlighted.

Returns
Whether this SceneTreeItem is highlightable.
See also
Highlight
IsHighlighted

◆ IsHighlighted()

bool HPS::SceneTreeItem::IsHighlighted ( ) const

Indicates whether this SceneTreeItem is currently highlighted with the options specified in the associated SceneTree. This may mean that the Highlight function on this SceneTreeItem was invoked, or that the key backing this SceneTreeItem was highlighted by the HighlightOperator or HighlightAreaOperator.

Returns
Whether this SceneTreeItem is currently highlighted with the options specified in the associated SceneTree.
See also
Highlight
Unhighlight

◆ IsSelected()

bool HPS::SceneTreeItem::IsSelected ( ) const

Indicates whether this SceneTreeItem is currently marked as selected.

Returns
Whether this SceneTreeItem is currently marked as selected.
See also
Select
Unselect

◆ ObjectType()

HPS::Type HPS::SceneTreeItem::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Object.

◆ operator!=()

bool HPS::SceneTreeItem::operator!= ( SceneTreeItem const &  in_that) const

Check if the source SceneTreeItem points to a different impl than this SceneTreeItem.

Parameters
in_thatThe source SceneTreeItem to compare to this SceneTreeItem.
Returns
true if the objects reference different impls, false otherwise.

◆ operator=() [1/2]

SceneTreeItem& HPS::SceneTreeItem::operator= ( SceneTreeItem const &  in_that)

Share the underlying smart-pointer of the SceneTreeItem source.

Parameters
in_thatThe SceneTreeItem source of the assignment.
Returns
A reference to this SceneTreeItem.

◆ operator=() [2/2]

SceneTreeItem& HPS::SceneTreeItem::operator= ( SceneTreeItem &&  in_that)

The move assignment operator transfers the underlying object of the rvalue reference to this SceneTreeItem.

Parameters
in_thatAn rvalue reference to a SceneTreeItem to take the underlying object from.
Returns
A reference to this SceneTreeItem.

◆ operator==()

bool HPS::SceneTreeItem::operator== ( SceneTreeItem const &  in_that) const

Check if the source SceneTreeItem points to the same underlying impl as this SceneTreeItem.

Parameters
in_thatThe source SceneTreeItem to compare to this SceneTreeItem.
Returns
true if the objects reference the same impl, false otherwise.

◆ ReExpand()

void HPS::SceneTreeItem::ReExpand ( )

Collapses this SceneTreeItem and then re-expands the tree. It will try to preserve the original expansion state, however, if the underlying scene structure has changed, the resulting expansion may look different.

◆ Select()

virtual void HPS::SceneTreeItem::Select ( )
virtual

This function will be invoked when this SceneTreeItem should be marked as selected. Marking an item as selected means that the key backing this SceneTreeItem has been highlighted with the options specified in the associated SceneTree or is along a path in which a highlight has occurred. This highlighting may have come as a result of the Highlight function on a SceneTreeItem being invoked (not necessarily this SceneTreeItem), or potentially due to the HighlightOperator or HighlightAreaOperator highlighting the key backing this SceneTreeItem or highlighting some path which includes the key backing this SceneTreeItem. This function is meant to be overridden to allow one to change the appearance of a selected SceneTreeItem, e.g., by bolding the text or changing an icon, to signify this new state. If this function is overridden, the overriding function should invoke this base function.

◆ Unhighlight() [1/2]

void HPS::SceneTreeItem::Unhighlight ( size_t  in_highlight_options_index = 0)

This function will remove the highlight with the options specified in the associated SceneTree from this SceneTreeItem. This can cause elements along the path to this item (and this item itself) to be marked as unselected unless those items lie along a path which is still highlighted. Depending on the type of the SceneTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed.

Parameters
in_higlight_options_indexThe index in the highlight options array held by the associated SceneTree. Defaults to 0.
See also
Unselect

◆ Unhighlight() [2/2]

void HPS::SceneTreeItem::Unhighlight ( HighlightOptionsKit const &  in_highlight_options)

This function will remove the highlight with the options specified in the associated SceneTree from this SceneTreeItem. This can cause elements along the path to this item (and this item itself) to be marked as unselected unless those items lie along a path which is still highlighted. Depending on the type of the SceneTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed. If the options requested is not part of the associated SceneTree highlight options, it will be added to them.

Parameters
in_higlight_options_indexThe index in the highlight options array held by the associated SceneTree. Defaults to 0.
See also
Unselect

◆ Unselect()

virtual void HPS::SceneTreeItem::Unselect ( )
virtual

This function will be invoked when this SceneTreeItem should be marked as unselected. Marking an item as unselected means that the key backing this SceneTreeItem is no longer highlighted with the options specified in the associated SceneTree or is no longer along a path in which a highlight has occurred. This unhighlighting may have come as a result of the Unhighlight function on a SceneTreeItem being invoked (not necessarily this SceneTreeItem), or potentially due to the HighlightOperator or HighlightAreaOperator unhighlighting the key backing this SceneTreeItem. or unhighlighting some path which includes the key backing this SceneTreeItem. This function is meant to be overridden to allow one to change the appearance of a selected SceneTreeItem, e.g., by no longer bolding the text or changing an icon, to signify this new state. If this function is overridden, the overriding function should invoke this base function.


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