#include <tree_element_overrides.hh>

Inherits blender::ed::outliner::TreeElementOverridesProperty.

Overridden Property Operation
See TreeElementOverridesPropertyOperation.
	TreeElementOverridesPropertyOperation (TreeElement &legacy_te, TreeElementOverridesData &override_data)

StringRefNull	get_override_operation_label () const

std::optional< BIFIconID >	get_icon () const override

Additional Inherited Members
Public Member Functions inherited from blender::ed::outliner::TreeElementOverridesProperty
	TreeElementOverridesProperty (TreeElement &legacy_te, TreeElementOverridesData &override_data)

StringRefNull	get_warning () 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 ()

void	print_path ()

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)

Public Attributes inherited from blender::ed::outliner::TreeElementOverridesProperty
PointerRNA	override_rna_ptr

PropertyRNA &	override_rna_prop

StringRefNull	rna_path

bool	is_rna_path_valid

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

Protected Attributes inherited from blender::ed::outliner::AbstractTreeElement
TreeElement &	legacy_te_

AbstractTreeDisplay *	display_

Detailed Description

Represent a single operation within an overridden property. While usually a single override property represents a single operation (changing the value), a single overridden collection property may have multiple operations, e.g. to insert or remove collection items.

Inherits from the override property class since it should look/behave mostly the same.

Definition at line 75 of file tree_element_overrides.hh.

Constructor & Destructor Documentation

◆ TreeElementOverridesPropertyOperation()

blender::ed::outliner::TreeElementOverridesPropertyOperation::TreeElementOverridesPropertyOperation	(	TreeElement &	legacy_te,
		TreeElementOverridesData &	override_data )

Definition at line 204 of file tree_element_overrides.cc.

References BLI_assert, BLI_assert_msg, blender::ed::outliner::TreeElement::flag, blender::ed::outliner::TreeElement::name, blender::ed::outliner::TreeElementOverridesData::operation, blender::ed::outliner::TreeElementOverridesProperty::override_rna_prop, PROP_COLLECTION, RNA_property_type(), RNA_struct_name_get_alloc(), RNA_struct_ui_name(), blender::ed::outliner::TreeElement::store_elem, blender::ed::outliner::TE_FREE_NAME, TSE_LIBRARY_OVERRIDE_OPERATION, and TreeStoreElem::type.

Member Function Documentation

◆ get_icon()

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

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 258 of file tree_element_overrides.cc.

References RNA_struct_ui_icon().

◆ get_override_operation_label()

StringRefNull blender::ed::outliner::TreeElementOverridesPropertyOperation::get_override_operation_label ( ) const

Return a short string to display in the right column of the properties mode, indicating what the override operation did (e.g. added or removed a collection item).

Definition at line 233 of file tree_element_overrides.cc.

References BLI_assert_unreachable, LIBOVERRIDE_OP_ADD, LIBOVERRIDE_OP_INSERT_AFTER, LIBOVERRIDE_OP_INSERT_BEFORE, LIBOVERRIDE_OP_MULTIPLY, LIBOVERRIDE_OP_NOOP, LIBOVERRIDE_OP_REPLACE, LIBOVERRIDE_OP_SUBTRACT, and RPT_.

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