Blender: blender::bke::greasepencil::TreeNode Class Reference

Blender V4.3

#include <BKE_grease_pencil.hh>

Inherits GreasePencilLayerTreeNode.

Public Member Functions
	TreeNode ()

	TreeNode (GreasePencilLayerTreeNodeType type)

	TreeNode (GreasePencilLayerTreeNodeType type, StringRefNull name)

	TreeNode (const TreeNode &other)

	~TreeNode ()

bool	is_group () const

bool	is_layer () const

const Layer &	as_layer () const

Layer &	as_layer ()

const LayerGroup &	as_group () const

LayerGroup &	as_group ()

const LayerGroup *	parent_group () const

LayerGroup *	parent_group ()

const TreeNode *	parent_node () const

TreeNode *	parent_node ()

int64_t	depth () const

Public Attributes
	TREENODE_COMMON_METHODS

Public Attributes inherited from GreasePencilLayerTreeNode
struct GreasePencilLayerTreeNode *	next

struct GreasePencilLayerTreeNode *	prev

struct GreasePencilLayerTreeGroup *	parent

char *	name

int8_t	type

uint8_t	color [3]

uint32_t	flag

Detailed Description

A TreeNode represents one node in the layer tree. It can either be a layer or a group. The node has zero children if it is a layer or zero or more children if it is a group.

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 286 of file BKE_grease_pencil.hh.

Constructor & Destructor Documentation

◆ TreeNode() [1/4]

blender::bke::greasepencil::TreeNode::TreeNode ( )

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 937 of file grease_pencil.cc.

References flag, GreasePencilLayerTreeNode::name, and next.

◆ TreeNode() [2/4]

blender::bke::greasepencil::TreeNode::TreeNode ( GreasePencilLayerTreeNodeType type )

explicit

Definition at line 947 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::type.

◆ TreeNode() [3/4]

blender::bke::greasepencil::TreeNode::TreeNode	(	GreasePencilLayerTreeNodeType	type,
		StringRefNull	name )

explicit

Definition at line 952 of file grease_pencil.cc.

References BLI_strdup(), blender::StringRefNull::c_str(), GreasePencilLayerTreeNode::name, and GreasePencilLayerTreeNode::type.

◆ TreeNode() [4/4]

blender::bke::greasepencil::TreeNode::TreeNode ( const TreeNode & other )

Definition at line 958 of file grease_pencil.cc.

References BLI_strdup_null(), copy_v3_v3_uchar(), GreasePencilLayerTreeNode::flag, and GreasePencilLayerTreeNode::name.

◆ ~TreeNode()

blender::bke::greasepencil::TreeNode::~TreeNode ( )

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 965 of file grease_pencil.cc.

References MEM_SAFE_FREE, and GreasePencilLayerTreeNode::name.

Member Function Documentation

◆ as_group() [1/2]

LayerGroup & blender::bke::greasepencil::TreeNode::as_group ( )

Definition at line 986 of file grease_pencil.cc.

◆ as_group() [2/2]

const LayerGroup & blender::bke::greasepencil::TreeNode::as_group ( ) const

Returns: this node as a #LayerGroup.

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 976 of file grease_pencil.cc.

Referenced by blender::ed::outliner::TreeElementGreasePencilNode::expand(), blender::ui::greasepencil::LayerNodeDropTarget::on_drop(), and blender::bke::greasepencil::LayerGroup::unlink_node().

◆ as_layer() [1/2]

Layer & blender::bke::greasepencil::TreeNode::as_layer ( )

Definition at line 991 of file grease_pencil.cc.

◆ as_layer() [2/2]

const Layer & blender::bke::greasepencil::TreeNode::as_layer ( ) const

Returns: this node as a #Layer.

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 981 of file grease_pencil.cc.

Referenced by blender::ed::greasepencil::grease_pencil_move_to_layer_exec(), and blender::io::grease_pencil::SVGImporter::read().

◆ depth()

int64_t blender::bke::greasepencil::TreeNode::depth ( ) const

Returns: the number of non-null parents of the node.

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1013 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::parent, and parent_group().

◆ is_group()

bool blender::bke::greasepencil::TreeNode::is_group ( ) const

inline

Returns: true if this node is a #LayerGroup.

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 779 of file BKE_grease_pencil.hh.

References GP_LAYER_TREE_GROUP.

Referenced by blender::ed::outliner::TreeElementGreasePencilNode::expand(), blender::ui::greasepencil::LayerNodeDropTarget::on_drop(), blender::bke::greasepencil::tests::TEST(), and blender::bke::greasepencil::LayerGroup::unlink_node().

◆ is_layer()

bool blender::bke::greasepencil::TreeNode::is_layer ( ) const

inline

Returns: true if this node is a #Layer.

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 783 of file BKE_grease_pencil.hh.

References GP_LAYER_TREE_LEAF.

Referenced by blender::ui::greasepencil::LayerNodeDropTarget::drop_tooltip(), blender::ui::greasepencil::LayerViewItemDragController::get_drag_type(), blender::ed::greasepencil::grease_pencil_layer_reorder_exec(), blender::ed::greasepencil::grease_pencil_move_to_layer_exec(), blender::ui::greasepencil::LayerNodeDropTarget::on_drop(), blender::io::grease_pencil::SVGImporter::read(), and blender::bke::greasepencil::tests::TEST().

◆ parent_group() [1/2]

LayerGroup * blender::bke::greasepencil::TreeNode::parent_group ( )

Definition at line 1000 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::parent.

◆ parent_group() [2/2]

const LayerGroup * blender::bke::greasepencil::TreeNode::parent_group ( ) const

Returns: the parent layer group or nullptr for the root group.

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 996 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::parent.

Referenced by depth(), blender::ed::greasepencil::grease_pencil_layer_move_poll(), blender::ui::greasepencil::LayerNodeDropTarget::on_drop(), blender::bke::greasepencil::Layer::parent_group(), blender::bke::greasepencil::Layer::parent_group(), parent_node(), and parent_node().

◆ parent_node() [1/2]

TreeNode * blender::bke::greasepencil::TreeNode::parent_node ( )

Definition at line 1008 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::parent, and parent_group().

◆ parent_node() [2/2]

const TreeNode * blender::bke::greasepencil::TreeNode::parent_node ( ) const

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1004 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::parent, and parent_group().

Member Data Documentation

◆ TREENODE_COMMON_METHODS

blender::bke::greasepencil::TreeNode::TREENODE_COMMON_METHODS

Examples: /usr/src/RPM/BUILD/blender-4.3.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 296 of file BKE_grease_pencil.hh.

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