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

#include <tree_element_driver.hh>

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

Public Member Functions

 TreeElementDriverBase (TreeElement &legacy_te, AnimData &anim_data)
void expand (SpaceOutliner &space_outliner) 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 const void * persistent_ptr (AnimData &anim_data)
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_DRIVER_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 21 of file tree_element_driver.hh.

Constructor & Destructor Documentation

◆ TreeElementDriverBase()

Member Function Documentation

◆ expand()

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

◆ get_icon()

std::optional< BIFIconID > blender::ed::outliner::TreeElementDriverBase::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 37 of file tree_element_driver.hh.

◆ persistent_ptr()

const void * blender::ed::outliner::TreeElementDriverBase::persistent_ptr ( AnimData & anim_data)
inlinestatic

Driver bases have no owner ID, identify them by the animation data.

Definition at line 30 of file tree_element_driver.hh.

Member Data Documentation

◆ element_type

eTreeStoreElemType blender::ed::outliner::TreeElementDriverBase::element_type = TSE_DRIVER_BASE
staticconstexpr

Definition at line 25 of file tree_element_driver.hh.


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