|
Blender V5.3
|
#include <tree_element_label.hh>
Inherits blender::ed::outliner::AbstractTreeElement.
Public Member Functions | |
| TreeElementLabel (TreeElement &legacy_te, const char *label) | |
| void | set_icon (BIFIconID icon) |
| std::optional< BIFIconID > | get_icon () const override |
| Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement | |
| virtual | ~AbstractTreeElement ()=default |
| virtual bool | expand_poll (const SpaceOutliner &) const |
| TreeElement & | get_legacy_element () |
| virtual StringRefNull | get_warning () const |
| void | print_path () |
Static Public Attributes | |
| static constexpr eTreeStoreElemType | element_type = TSE_GENERIC_LABEL |
| static constexpr bool | allow_null_identity = true |
Additional Inherited Members | |
| Static Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement | |
| static void | uncollapse_by_default (TreeElement *legacy_te) |
| Protected Member Functions inherited from blender::ed::outliner::AbstractTreeElement | |
| AbstractTreeElement (TreeElement &legacy_te) | |
| virtual void | expand (SpaceOutliner &) const |
| template<typename ElementType, typename... Args> | |
| TreeElement * | add_element (const TreeElementAddParams ¶ms, Args &&...args) const |
| TreeElement * | add_id_element (const TreeElementAddParams ¶ms, ID *id) const |
| Protected Attributes inherited from blender::ed::outliner::AbstractTreeElement | |
| TreeElement & | legacy_te_ |
| AbstractTreeDisplay * | display_ |
A basic, general purpose tree element to just display a label and an icon. Can be used to group together items underneath as well of course.
Make sure to give this a unique index, so the element can be identified uniquely. Otherwise glitches like multiple highlighted elements happen, that share all state (e.g. collapsed, selected, etc.).
Definition at line 27 of file tree_element_label.hh.
| blender::ed::outliner::TreeElementLabel::TreeElementLabel | ( | TreeElement & | legacy_te, |
| const char * | label ) |
Definition at line 17 of file tree_element_label.cc.
References blender::ed::outliner::AbstractTreeElement::AbstractTreeElement(), blender::BLI_assert(), blender::ed::outliner::AbstractTreeElement::legacy_te_, blender::ed::outliner::TreeElement::name, blender::ed::outliner::TreeElement::store_elem, blender::TSE_GENERIC_LABEL, and blender::TreeStoreElem::type.
|
overridevirtual |
Define the icon to be displayed for this element. If this returns an icon, this will be displayed. Otherwise, tree_element_get_icon() may still determine an icon. By default no value is returned (#std::nullopt).
All elements should be ported to use this over tree_element_get_icon().
Reimplemented from blender::ed::outliner::AbstractTreeElement.
Definition at line 31 of file tree_element_label.cc.
| void blender::ed::outliner::TreeElementLabel::set_icon | ( | BIFIconID | icon | ) |
Definition at line 26 of file tree_element_label.cc.
|
staticconstexpr |
A label represents no data, so there is nothing to identify it by.
Definition at line 34 of file tree_element_label.hh.
|
staticconstexpr |
Definition at line 32 of file tree_element_label.hh.