# SceneTreeItem

class `SceneTreeItem` : public HPS::Sprocket

  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.

  Public Functions

  virtual SceneTreeItemPtr `AddChild`(Key const &in_key, SceneTree::ItemType in_type, char const *in_title = nullptr) = 0

    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_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.
    Returns: | A newly created object derived from SceneTreeItem.

  virtual void `Assign`(SceneTreeItem const &in_that)

    Share the underlying smart-pointer of the SceneTreeItem source.

    Parameters: | in_that – The SceneTreeItem source of the assignment.
    Returns: | A reference to this SceneTreeItem.

  virtual void `Collapse`()

    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 `Equals`(SceneTreeItem const &in_that) const

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

    Parameters: | in_that – The source SceneTreeItem to compare to this SceneTreeItem.
    Returns: | true if the objects reference the same impl, false otherwise.

  virtual void `Expand`()

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

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

  KeyPath `GetKeyPath`() const

    Gets the key path for this SceneTreeItem.

    Returns: | The key path for this SceneTreeItem.

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

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

  bool `HasChildren`() const

    Indicates whether this SceneTreeItem has any children.

    Returns: | Whether this SceneTreeItem has any children.

  bool `HasItemType`(SceneTree::ItemType in_mask) const

    Indicates whether this SceneTreeItem has the given ItemType mask.

    Parameters: | in_mask – The ItemType mask to check against this SceneTreeItem.
    Returns: | true if this SceneTreeItem has the given ItemType mask, false otherwise.

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

    See also

    Select

    Parameters: | in_highlight_options – The highlight options used during highlighting

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

    See also

    Select

    Parameters: | in_higlight_options_index – The index in the highlight options array held by the associated SceneTree. Defaults to 0.

  bool `IsExpanded`() const

    Indicates whether this SceneTreeItem is currently expanded.

    Returns: | Whether this SceneTreeItem is currently expanded.

  bool `IsHighlightable`() const

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

    See also

    Highlight

    See also

    IsHighlighted

    Returns: | Whether this SceneTreeItem is highlightable.

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

    See also

    Highlight

    See also

    Unhighlight

    Returns: | Whether this SceneTreeItem is currently highlighted with the options specified in the associated SceneTree.

  bool `IsSelected`() const

    Indicates whether this SceneTreeItem is currently marked as selected.

    See also

    Select

    See also

    Unselect

    Returns: | Whether this SceneTreeItem is currently marked as selected.

  inline virtual HPS::Type `ObjectType`() const

    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.

  bool `operator!=`(SceneTreeItem const &in_that) const

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

    Parameters: | in_that – The source SceneTreeItem to compare to this SceneTreeItem.
    Returns: | true if the objects reference different impls, false otherwise.

  SceneTreeItem &`operator=`(SceneTreeItem &&in_that)

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

    Parameters: | in_that – An rvalue reference to a SceneTreeItem to take the underlying object from.
    Returns: | A reference to this SceneTreeItem.

  SceneTreeItem &`operator=`(SceneTreeItem const &in_that)

    Share the underlying smart-pointer of the SceneTreeItem source.

    Parameters: | in_that – The SceneTreeItem source of the assignment.
    Returns: | A reference to this SceneTreeItem.

  bool `operator==`(SceneTreeItem const &in_that) const

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

    Parameters: | in_that – The source SceneTreeItem to compare to this SceneTreeItem.
    Returns: | true if the objects reference the same impl, false otherwise.

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

  `SceneTreeItem`()

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

  `SceneTreeItem`(SceneTreeItem &&in_that)

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

    Parameters: | in_that – An rvalue reference to a SceneTreeItem to take the underlying object from.

  `SceneTreeItem`(SceneTreeItem const &in_that)

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

    Parameters: | in_that – The source SceneTreeItem to copy.

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

    See also

    SceneTree::SetRoot

    Parameters: | in_tree – The SceneTree with which to associate this new root SceneTreeItem. in_canvas – The Canvas for this root 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.

    See also

    AddChild

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

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

    See also

    SceneTree::SetRoot

    Parameters: | in_tree – The SceneTree with which to associate this new root SceneTreeItem. in_layout – The Layout for this root 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.

    See also

    SceneTree::SetRoot

    Parameters: | in_tree – The SceneTree with which to associate this new root SceneTreeItem. in_model – The Model for this root 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.

    See also

    SceneTree::SetRoot

    Parameters: | in_tree – The SceneTree with which to associate this new root SceneTreeItem. in_view – The View for this root SceneTreeItem.

  virtual void `Select`()

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

    See also

    Unselect

    Parameters: | in_higlight_options_index – The index in the highlight options array held by the associated SceneTree. Defaults to 0.

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

    See also

    Unselect

    Parameters: | in_higlight_options_index – The index in the highlight options array held by the associated SceneTree. Defaults to 0.

  virtual void `Unselect`()

    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.

  virtual `~SceneTreeItem`()

  Public Static Attributes

  static const HPS::Type `staticType` = HPS::Type::SceneTreeItem

Hello I'm HOOPSY!

HOOPSY BETA

Hello I am HOOPSY! your Docs generative AI assistant.

Ask me anything about HOOPS Visualize HPS or choose a sample question below to start a conversation:

Additional info

HOOPSY may store chats to provide and maintain the service according to OpenAI's data policy.

This feature is currently experimental. While we are continually enhancing its performance and quality, the underlying AI model may generate inaccurate or fabricated responses, especially if prompted to do so.

New Conversation
Continue generating