Blender V4.5
Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
blender::ed::greasepencil::LayerGroup Class Reference

#include <BKE_grease_pencil.hh>

Inherits GreasePencilLayerTreeGroup.

Public Member Functions

 LayerGroup ()
 LayerGroup (StringRef name)
 LayerGroup (const LayerGroup &other)
 ~LayerGroup ()
LayerGroup & operator= (const LayerGroup &other)
const TreeNode & as_node () const
TreeNode & as_node ()
bool is_empty () const
int64_t num_direct_nodes () const
int64_t num_nodes_total () const
Span< const TreeNode * > nodes () const
Span< TreeNode * > nodes_for_write ()
Span< const Layer * > layers () const
Span< Layer * > layers_for_write ()
Span< const LayerGroup * > groups () const
Span< LayerGroup * > groups_for_write ()
const TreeNode * find_node_by_name (StringRef name) const
TreeNode * find_node_by_name (StringRef name)
bool is_expanded () const
void set_expanded (bool expanded)
void print_nodes (StringRef header) const
void prepare_for_dna_write ()
void update_from_dna_read ()

Public Attributes

 TREENODE_COMMON_METHODS
Public Attributes inherited from GreasePencilLayerTreeGroup
GreasePencilLayerTreeNode base
ListBase children
int8_t color_tag
char _pad [7]
GreasePencilLayerGroupRuntimeHandle * runtime

Protected Member Functions

TreeNode & add_node (TreeNode &node)
void add_node_before (TreeNode &node, TreeNode &link)
void add_node_after (TreeNode &node, TreeNode &link)
void move_node_up (TreeNode &node, int step=1)
void move_node_down (TreeNode &node, int step=1)
void move_node_top (TreeNode &node)
void move_node_bottom (TreeNode &node)
bool unlink_node (TreeNode &link, bool keep_children=false)

Friends

struct ::GreasePencil

Detailed Description

A LayerGroup is a grouping of zero or more Layers.

Definition at line 665 of file BKE_grease_pencil.hh.

Constructor & Destructor Documentation

◆ LayerGroup() [1/3]

blender::bke::greasepencil::LayerGroup::LayerGroup ( )

Definition at line 1618 of file grease_pencil.cc.

◆ LayerGroup() [2/3]

blender::bke::greasepencil::LayerGroup::LayerGroup ( StringRef name)
explicit

Definition at line 1628 of file grease_pencil.cc.

◆ LayerGroup() [3/3]

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

Definition at line 1633 of file grease_pencil.cc.

◆ ~LayerGroup()

blender::bke::greasepencil::LayerGroup::~LayerGroup ( )

Definition at line 1657 of file grease_pencil.cc.

Member Function Documentation

◆ add_node()

TreeNode & blender::bke::greasepencil::LayerGroup::add_node ( TreeNode & node)
protected

Adds an existing node at the end of this group.

Definition at line 1697 of file grease_pencil.cc.

◆ add_node_after()

void blender::bke::greasepencil::LayerGroup::add_node_after ( TreeNode & node,
TreeNode & link )
protected

Adds an existing node after link of this group.

Definition at line 1711 of file grease_pencil.cc.

◆ add_node_before()

void blender::bke::greasepencil::LayerGroup::add_node_before ( TreeNode & node,
TreeNode & link )
protected

Adds an existing node before link of this group.

Definition at line 1704 of file grease_pencil.cc.

◆ as_node() [1/2]

TreeNode & blender::bke::greasepencil::LayerGroup::as_node ( )
inline

Definition at line 879 of file BKE_grease_pencil.hh.

◆ as_node() [2/2]

const TreeNode & blender::bke::greasepencil::LayerGroup::as_node ( ) const
inline
Returns
the group as a TreeNode.

Definition at line 875 of file BKE_grease_pencil.hh.

◆ find_node_by_name() [1/2]

TreeNode * blender::bke::greasepencil::LayerGroup::find_node_by_name ( StringRef name)

Definition at line 1851 of file grease_pencil.cc.

◆ find_node_by_name() [2/2]

const TreeNode * blender::bke::greasepencil::LayerGroup::find_node_by_name ( StringRef name) const

Returns a pointer to the node with name. If no such node was found, returns nullptr.

Definition at line 1841 of file grease_pencil.cc.

◆ groups()

Span< const LayerGroup * > blender::bke::greasepencil::LayerGroup::groups ( ) const

Returns a Span of pointers to all the LayerGroupss in this group.

Definition at line 1829 of file grease_pencil.cc.

◆ groups_for_write()

Span< LayerGroup * > blender::bke::greasepencil::LayerGroup::groups_for_write ( )

Definition at line 1835 of file grease_pencil.cc.

◆ is_empty()

bool blender::bke::greasepencil::LayerGroup::is_empty ( ) const

Returns true if the group is empty.

Definition at line 1692 of file grease_pencil.cc.

◆ is_expanded()

bool blender::bke::greasepencil::LayerGroup::is_expanded ( ) const

Returns true if the group is expanded in the UI.

Definition at line 1861 of file grease_pencil.cc.

◆ layers()

Span< const Layer * > blender::bke::greasepencil::LayerGroup::layers ( ) const

Returns a Span of pointers to all the Layers in this group.

Definition at line 1817 of file grease_pencil.cc.

◆ layers_for_write()

Span< Layer * > blender::bke::greasepencil::LayerGroup::layers_for_write ( )

Definition at line 1823 of file grease_pencil.cc.

◆ move_node_bottom()

void blender::bke::greasepencil::LayerGroup::move_node_bottom ( TreeNode & node)
protected

Definition at line 1735 of file grease_pencil.cc.

◆ move_node_down()

void blender::bke::greasepencil::LayerGroup::move_node_down ( TreeNode & node,
int step = 1 )
protected

Definition at line 1724 of file grease_pencil.cc.

◆ move_node_top()

void blender::bke::greasepencil::LayerGroup::move_node_top ( TreeNode & node)
protected

Move child node to the top/bottom.

Definition at line 1729 of file grease_pencil.cc.

◆ move_node_up()

void blender::bke::greasepencil::LayerGroup::move_node_up ( TreeNode & node,
int step = 1 )
protected

Move child node up/down by step.

Definition at line 1719 of file grease_pencil.cc.

◆ nodes()

Span< const TreeNode * > blender::bke::greasepencil::LayerGroup::nodes ( ) const

Returns a Span of pointers to all the TreeNodes in this group.

Definition at line 1805 of file grease_pencil.cc.

◆ nodes_for_write()

Span< TreeNode * > blender::bke::greasepencil::LayerGroup::nodes_for_write ( )

Definition at line 1811 of file grease_pencil.cc.

◆ num_direct_nodes()

int64_t blender::bke::greasepencil::LayerGroup::num_direct_nodes ( ) const

Returns the number of direct nodes in this group.

Definition at line 1742 of file grease_pencil.cc.

◆ num_nodes_total()

int64_t blender::bke::greasepencil::LayerGroup::num_nodes_total ( ) const

Returns the total number of nodes in this group.

Definition at line 1747 of file grease_pencil.cc.

◆ operator=()

LayerGroup & blender::bke::greasepencil::LayerGroup::operator= ( const LayerGroup & other)

Definition at line 1680 of file grease_pencil.cc.

◆ prepare_for_dna_write()

void blender::bke::greasepencil::LayerGroup::prepare_for_dna_write ( )

Prepare the DNA GreasePencilLayerTreeGroup data before blend-file writing.

Definition at line 1940 of file grease_pencil.cc.

◆ print_nodes()

void blender::bke::greasepencil::LayerGroup::print_nodes ( StringRef header) const

Print the nodes. For debugging purposes.

Definition at line 1871 of file grease_pencil.cc.

◆ set_expanded()

void blender::bke::greasepencil::LayerGroup::set_expanded ( bool expanded)

Expand/collapse the group in the UI.

Definition at line 1866 of file grease_pencil.cc.

◆ unlink_node()

bool blender::bke::greasepencil::LayerGroup::unlink_node ( TreeNode & link,
bool keep_children = false )
protected

Unlink the node from the list of nodes in this group.

Returns
true, if the node was successfully unlinked.

Definition at line 1753 of file grease_pencil.cc.

◆ update_from_dna_read()

void blender::bke::greasepencil::LayerGroup::update_from_dna_read ( )

Update from DNA GreasePencilLayerTreeGroup data after blend-file reading.

Definition at line 1956 of file grease_pencil.cc.

◆ ::GreasePencil

friend struct ::GreasePencil
friend

Definition at line 666 of file BKE_grease_pencil.hh.

Member Data Documentation

◆ TREENODE_COMMON_METHODS

blender::bke::greasepencil::LayerGroup::TREENODE_COMMON_METHODS

Definition at line 678 of file BKE_grease_pencil.hh.

The documentation for this class was generated from the following files:
Generated on for Blender by  doxygen 1.16.1