Blender: blender::ed::outliner::TreeElementRNACommon Class Reference

Blender V5.0

#include <tree_element_rna.hh>

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

Inherited by blender::ed::outliner::TreeElementRNAArrayElement, blender::ed::outliner::TreeElementRNAProperty, and blender::ed::outliner::TreeElementRNAStruct.

Public Member Functions
	TreeElementRNACommon (TreeElement &legacy_te, PointerRNA &rna_ptr)
bool	expand_poll (const SpaceOutliner &) const override
const PointerRNA &	get_pointer_rna () const
virtual PropertyRNA *	get_property_rna () const
bool	is_rna_valid () const
Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement
virtual	~AbstractTreeElement ()=default
TreeElement &	get_legacy_element ()
virtual StringRefNull	get_warning () const
virtual std::optional< BIFIconID >	get_icon () const
void	print_path ()

Protected Attributes
PointerRNA	rna_ptr_
Protected Attributes inherited from blender::ed::outliner::AbstractTreeElement
TreeElement &	legacy_te_
AbstractTreeDisplay *	display_

Static Protected Attributes
static constexpr int	max_index = std::numeric_limits<short>::max()

Additional Inherited Members
Static Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement
static std::unique_ptr< AbstractTreeElement >	create_from_type (int type, TreeElement &legacy_te, ID owner_id, void create_data)
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
TreeElement *	add_element (ListBase lb, ID owner_id, void create_data, TreeElement parent, short type, short index, const bool expand=true) const

Detailed Description

Base class for common behavior of RNA tree elements.

Definition at line 24 of file tree_element_rna.hh.

Constructor & Destructor Documentation

◆ TreeElementRNACommon()

blender::ed::outliner::TreeElementRNACommon::TreeElementRNACommon	(	TreeElement &	legacy_te,
		PointerRNA &	rna_ptr )

Definition at line 34 of file tree_element_rna.cc.

References blender::ed::outliner::AbstractTreeElement::AbstractTreeElement(), IFACE_, is_rna_valid(), blender::ed::outliner::AbstractTreeElement::legacy_te_, rna_ptr_, and TreeElementRNACommon().

Referenced by blender::ed::outliner::TreeElementRNAArrayElement::TreeElementRNAArrayElement(), TreeElementRNACommon(), blender::ed::outliner::TreeElementRNAProperty::TreeElementRNAProperty(), and blender::ed::outliner::TreeElementRNAStruct::TreeElementRNAStruct().

Member Function Documentation

◆ expand_poll()

bool blender::ed::outliner::TreeElementRNACommon::expand_poll ( const SpaceOutliner & ) const

overridevirtual

Check if the type is expandable in current context.

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

Definition at line 49 of file tree_element_rna.cc.

References is_rna_valid().

◆ get_pointer_rna()

const PointerRNA & blender::ed::outliner::TreeElementRNACommon::get_pointer_rna ( ) const

Definition at line 54 of file tree_element_rna.cc.

References rna_ptr_.

Referenced by blender::ed::outliner::data_select_linked_fn(), blender::ed::outliner::do_outliner_drivers_editop(), blender::ed::outliner::do_outliner_keyingset_editop(), blender::ed::outliner::outliner_draw_tree_element(), blender::ed::outliner::outliner_find_id(), blender::ed::outliner::tree_element_get_icon(), and blender::ed::outliner::tree_element_to_path().

◆ get_property_rna()

PropertyRNA * blender::ed::outliner::TreeElementRNACommon::get_property_rna ( ) const

virtual

If this element represents a property or is part of a property (array element), this returns the property. Otherwise nullptr.

Reimplemented in blender::ed::outliner::TreeElementRNAArrayElement, and blender::ed::outliner::TreeElementRNAProperty.

Definition at line 59 of file tree_element_rna.cc.

Referenced by blender::ed::outliner::do_outliner_drivers_editop(), and blender::ed::outliner::do_outliner_keyingset_editop().

◆ is_rna_valid()

bool blender::ed::outliner::TreeElementRNACommon::is_rna_valid ( ) const

Definition at line 44 of file tree_element_rna.cc.

References rna_ptr_.

Referenced by expand_poll(), TreeElementRNACommon(), blender::ed::outliner::TreeElementRNAProperty::TreeElementRNAProperty(), and blender::ed::outliner::TreeElementRNAStruct::TreeElementRNAStruct().

Member Data Documentation

◆ max_index

int blender::ed::outliner::TreeElementRNACommon::max_index = std::numeric_limits<short>::max()

staticconstexprprotected

Definition at line 26 of file tree_element_rna.hh.

Referenced by blender::ed::outliner::TreeElementRNAProperty::expand(), and blender::ed::outliner::TreeElementRNAStruct::expand().

◆ rna_ptr_

PointerRNA blender::ed::outliner::TreeElementRNACommon::rna_ptr_

protected

Definition at line 27 of file tree_element_rna.hh.

Referenced by blender::ed::outliner::TreeElementRNAProperty::expand(), blender::ed::outliner::TreeElementRNAStruct::expand(), get_pointer_rna(), is_rna_valid(), and TreeElementRNACommon().

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