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

Blender V5.0

#include <BKE_grease_pencil.hh>

Inherits GreasePencilLayerTreeNode.

Public Member Functions
	TreeNode ()
	TreeNode (GreasePencilLayerTreeNodeType type)
	TreeNode (GreasePencilLayerTreeNodeType type, StringRef 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
char	_pad [7]
float	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/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 291 of file BKE_grease_pencil.hh.

Constructor & Destructor Documentation

◆ TreeNode() [1/4]

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

Examples: /usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1033 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::color, GreasePencilLayerTreeNode::flag, GreasePencilLayerTreeNode::name, GreasePencilLayerTreeNode::next, GreasePencilLayerTreeNode::parent, and GreasePencilLayerTreeNode::prev.

Referenced by parent_node(), parent_node(), TreeNode(), TreeNode(), and TreeNode().

◆ TreeNode() [2/4]

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

explicit

Definition at line 1043 of file grease_pencil.cc.

References TreeNode(), and GreasePencilLayerTreeNode::type.

◆ TreeNode() [3/4]

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

explicit

Definition at line 1048 of file grease_pencil.cc.

References BLI_strdupn(), GreasePencilLayerTreeNode::name, TreeNode(), and GreasePencilLayerTreeNode::type.

◆ TreeNode() [4/4]

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

Definition at line 1054 of file grease_pencil.cc.

References BLI_strdup_null(), GreasePencilLayerTreeNode::color, copy_v3_v3(), GreasePencilLayerTreeNode::flag, GreasePencilLayerTreeNode::name, TreeNode(), and GreasePencilLayerTreeNode::type.

◆ ~TreeNode()

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

Examples: /usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1061 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 1082 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/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1072 of file grease_pencil.cc.

Referenced by animdata_filter_grease_pencil_layer_node_recursive(), grease_pencil_layer_group_to_keylist(), blender::ed::greasepencil::grease_pencil_layer_hide_exec(), blender::ed::outliner::outliner_draw_hierarchy_lines_recursive(), blender::ed::greasepencil::select_frames_at(), blender::ed::greasepencil::select_frames_range(), blender::ed::greasepencil::select_frames_region(), blender::bke::greasepencil::tests::TEST(), blender::ed::outliner::tree_element_get_icon(), and blender::bke::greasepencil::LayerGroup::unlink_node().

◆ as_layer() [1/2]

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

Definition at line 1087 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/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1077 of file grease_pencil.cc.

Referenced by animdata_filter_grease_pencil_layer_node_recursive(), blender::ed::greasepencil::apply_eval_grease_pencil_data(), bake_strokes(), clear_strokes(), grease_pencil_layer_group_to_keylist(), blender::ed::greasepencil::grease_pencil_merge_layer_exec(), blender::ed::greasepencil::grease_pencil_move_to_layer_exec(), blender::ed::greasepencil::grease_pencil_paste_strokes_exec(), blender::ed::greasepencil::grease_pencil_separate_selected(), lineart_gpencil_clear_strokes_exec_common(), blender::io::grease_pencil::SVGImporter::read(), blender::ed::greasepencil::select_frames_at(), blender::ed::greasepencil::select_frames_range(), blender::ed::greasepencil::select_frames_region(), blender::bke::greasepencil::tests::TEST(), blender::ed::greasepencil::tests::TEST(), and blender::ed::outliner::tree_element_grease_pencil_node_state_get().

◆ depth()

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

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

Examples: /usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1109 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/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 813 of file BKE_grease_pencil.hh.

References GP_LAYER_TREE_GROUP, and GreasePencilLayerTreeNode::type.

Referenced by animdata_filter_grease_pencil_layer_node_recursive(), grease_pencil_layer_group_to_keylist(), blender::ed::greasepencil::grease_pencil_layer_hide_exec(), blender::ui::greasepencil::LayerNodeDropTarget::on_drop(), blender::ed::outliner::outliner_draw_hierarchy_lines_recursive(), blender::ed::outliner::outliner_draw_restrictbuts(), blender::ed::greasepencil::select_frames_at(), blender::ed::greasepencil::select_frames_range(), blender::ed::greasepencil::select_frames_region(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::ed::outliner::tree_element_get_icon(), blender::ed::outliner::tree_element_grease_pencil_node_activate(), 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/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 817 of file BKE_grease_pencil.hh.

References GP_LAYER_TREE_LEAF, and GreasePencilLayerTreeNode::type.

Referenced by animdata_filter_grease_pencil_layer_node_recursive(), blender::ed::greasepencil::apply_eval_grease_pencil_data(), bake_strokes(), clear_strokes(), blender::ui::greasepencil::LayerNodeDropTarget::drop_tooltip(), grease_pencil_layer_group_to_keylist(), blender::ed::greasepencil::grease_pencil_merge_layer_exec(), blender::ed::greasepencil::grease_pencil_move_to_layer_exec(), blender::ed::greasepencil::grease_pencil_paste_strokes_exec(), blender::ed::greasepencil::grease_pencil_separate_selected(), lineart_gpencil_clear_strokes_exec_common(), blender::ui::greasepencil::LayerNodeDropTarget::on_drop(), blender::ed::outliner::outliner_draw_restrictbuts(), blender::io::grease_pencil::SVGImporter::read(), blender::ed::greasepencil::select_frames_at(), blender::ed::greasepencil::select_frames_range(), blender::ed::greasepencil::select_frames_region(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::ed::greasepencil::tests::TEST(), blender::ed::outliner::tree_element_get_icon(), blender::ed::outliner::tree_element_grease_pencil_node_activate(), and blender::ed::outliner::tree_element_grease_pencil_node_state_get().

◆ parent_group() [1/2]

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

Definition at line 1096 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/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1092 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::parent.

Referenced by depth(), blender::ed::greasepencil::get_sorted_layer_parents(), blender::ed::greasepencil::grease_pencil_layer_move_poll(), grease_pencil_set_runtime_visibilities(), blender::ed::outliner::outliner_draw_restrictbuts(), blender::bke::greasepencil::Layer::parent_group(), blender::bke::greasepencil::Layer::parent_group(), parent_node(), parent_node(), and blender::ed::greasepencil::tests::TEST().

◆ parent_node() [1/2]

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

Definition at line 1104 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::parent, parent_group(), and TreeNode().

◆ parent_node() [2/2]

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

Examples: /usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1100 of file grease_pencil.cc.

References GreasePencilLayerTreeNode::parent, parent_group(), and TreeNode().

Referenced by blender::ed::greasepencil::get_sorted_layer_parents().

Member Data Documentation

◆ TREENODE_COMMON_METHODS

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

Examples: /usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 301 of file BKE_grease_pencil.hh.

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