Blender V5.3
blender::ed::outliner::TreeElementModifierBase Class Referencefinal

#include <tree_element_modifier.hh>

Inherits blender::ed::outliner::AbstractTreeElement.

Public Member Functions

 TreeElementModifierBase (TreeElement &legacy_te, Object &object)
void expand (SpaceOutliner &) const override
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 Member Functions

static ID * owner_id (Object &object)
Static Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement
static void uncollapse_by_default (TreeElement *legacy_te)

Static Public Attributes

static constexpr eTreeStoreElemType element_type = TSE_MODIFIER_BASE

Additional Inherited Members

Protected Member Functions inherited from blender::ed::outliner::AbstractTreeElement
 AbstractTreeElement (TreeElement &legacy_te)
template<typename ElementType, typename... Args>
TreeElement * add_element (const TreeElementAddParams &params, Args &&...args) const
TreeElement * add_id_element (const TreeElementAddParams &params, ID *id) const
Protected Attributes inherited from blender::ed::outliner::AbstractTreeElement
TreeElement & legacy_te_
AbstractTreeDisplay * display_

Detailed Description

Definition at line 23 of file tree_element_modifier.hh.

Constructor & Destructor Documentation

◆ TreeElementModifierBase()

blender::ed::outliner::TreeElementModifierBase::TreeElementModifierBase ( TreeElement & legacy_te,
Object & object )

Member Function Documentation

◆ expand()

void blender::ed::outliner::TreeElementModifierBase::expand ( SpaceOutliner & ) const
overridevirtual

Let the type add its own children.

Reimplemented from blender::ed::outliner::AbstractTreeElement.

Definition at line 43 of file tree_element_modifier.cc.

References blender::ed::outliner::AbstractTreeElement::add_element().

◆ get_icon()

std::optional< BIFIconID > blender::ed::outliner::TreeElementModifierBase::get_icon ( ) const
inlineoverridevirtual

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 36 of file tree_element_modifier.hh.

◆ owner_id()

ID * blender::ed::outliner::TreeElementModifierBase::owner_id ( Object & object)
static

The ID identifying this element in the tree-store, see #AbstractTreeDisplay::add_element().

Definition at line 38 of file tree_element_modifier.cc.

Member Data Documentation

◆ element_type

eTreeStoreElemType blender::ed::outliner::TreeElementModifierBase::element_type = TSE_MODIFIER_BASE
staticconstexpr

Definition at line 27 of file tree_element_modifier.hh.


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