#include <sprk.h>
Public Member Functions | |
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) | |
HPS::Type | ObjectType () const |
SceneTreeItem & | operator= (SceneTreeItem const &in_that) |
SceneTreeItem & | operator= (SceneTreeItem &&in_that) |
virtual void | Assign (SceneTreeItem const &in_that) |
bool | Equals (SceneTreeItem const &in_that) const |
bool | operator!= (SceneTreeItem const &in_that) const |
bool | operator== (SceneTreeItem const &in_that) const |
SceneTreePtr | GetTree () const |
UTF8 | GetTitle () const |
SceneTree::ItemType | GetItemType () const |
bool | HasItemType (SceneTree::ItemType in_mask) const |
Key | GetKey () const |
bool | HasChildren () const |
virtual SceneTreeItemPtr | AddChild (Key const &in_key, SceneTree::ItemType in_type, char const *in_title=nullptr)=0 |
virtual void | Expand () |
virtual void | Collapse () |
bool | IsSelected () const |
virtual void | Select () |
virtual void | Unselect () |
bool | IsHighlightable () const |
bool | IsHighlighted () const |
void | Highlight () |
void | Unhighlight () |
![]() | |
Sprocket (HPS::Sprocket const &in_that)=default | |
Sprocket (Sprocket &&in_that) | |
![]() | |
Object (Object const &that) | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
HPS::SceneTreeItem::SceneTreeItem | ( | ) |
The default constructor creates an uninitialized SceneTreeItem object. The Type() function will return Type::None.
HPS::SceneTreeItem::SceneTreeItem | ( | SceneTreeItem const & | in_that | ) |
The copy constructor creates a SceneTreeItem object that shares the underlying smart-pointer of the source SceneTreeItem.
in_that | The source SceneTreeItem to copy. |
HPS::SceneTreeItem::SceneTreeItem | ( | SceneTreeItem && | in_that | ) |
The move constructor creates a SceneTreeItem by transferring the underlying object of the rvalue reference to this SceneTreeItem.
in_that | An rvalue reference to a SceneTreeItem to take the underlying object from. |
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.
in_tree | The SceneTree with which to associate this new root SceneTreeItem. |
in_model | The Model for this root SceneTreeItem. |
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.
in_tree | The SceneTree with which to associate this new root SceneTreeItem. |
in_view | The View for this root SceneTreeItem. |
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.
in_tree | The SceneTree with which to associate this new root SceneTreeItem. |
in_layout | The Layout for this root SceneTreeItem. |
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.
in_tree | The SceneTree with which to associate this new root SceneTreeItem. |
in_canvas | The Canvas for this root SceneTreeItem. |
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.
in_tree | The SceneTree with which to associate this new SceneTreeItem. |
in_key | The Key for this SceneTreeItem. This value should come from the corresponding argument to AddChild. |
in_type | The type of this SceneTreeItem. This value should come from the corresponding argument to AddChild. |
in_title | The title for this SceneTreeItem. This value should come from the corresponding argument to AddChild. |
|
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.
in_key | The Key for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor. |
in_type | The type for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor. |
in_title | The title for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor. |
|
virtual |
Share the underlying smart-pointer of the SceneTreeItem source.
in_that | The SceneTreeItem source of the assignment. |
|
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.
bool HPS::SceneTreeItem::Equals | ( | SceneTreeItem const & | in_that | ) | const |
Check if the source SceneTreeItem points to the same underlying impl as this SceneTreeItem.
in_that | The source SceneTreeItem to compare to this SceneTreeItem. |
|
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.
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.
Key HPS::SceneTreeItem::GetKey | ( | ) | const |
Gets the key for this SceneTreeItem. The type of the key depends on the SceneTree::ItemType for this SceneTreeItem.
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.
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.
bool HPS::SceneTreeItem::HasChildren | ( | ) | const |
Indicates whether this SceneTreeItem has any children.
bool HPS::SceneTreeItem::HasItemType | ( | SceneTree::ItemType | in_mask | ) | const |
Indicates whether this SceneTreeItem has the given ItemType mask.
in_mask | The ItemType mask to check against this SceneTreeItem. |
void HPS::SceneTreeItem::Highlight | ( | ) |
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.
bool HPS::SceneTreeItem::IsHighlightable | ( | ) | const |
Indicates whether this SceneTreeItem is able to be highlighted. Some items, like those in static trees, cannot be highlighted.
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.
bool HPS::SceneTreeItem::IsSelected | ( | ) | const |
Indicates whether this SceneTreeItem is currently marked as selected.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::SceneTreeItem::operator!= | ( | SceneTreeItem const & | in_that | ) | const |
Check if the source SceneTreeItem points to a different impl than this SceneTreeItem.
in_that | The source SceneTreeItem to compare to this SceneTreeItem. |
SceneTreeItem& HPS::SceneTreeItem::operator= | ( | SceneTreeItem const & | in_that | ) |
Share the underlying smart-pointer of the SceneTreeItem source.
in_that | The SceneTreeItem source of the assignment. |
SceneTreeItem& HPS::SceneTreeItem::operator= | ( | SceneTreeItem && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this SceneTreeItem.
in_that | An rvalue reference to a SceneTreeItem to take the underlying object from. |
bool HPS::SceneTreeItem::operator== | ( | SceneTreeItem const & | in_that | ) | const |
Check if the source SceneTreeItem points to the same underlying impl as this SceneTreeItem.
in_that | The source SceneTreeItem to compare to this SceneTreeItem. |
|
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.
void HPS::SceneTreeItem::Unhighlight | ( | ) |
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.
|
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.