#include <BKE_grease_pencil.hh>

Inherits GreasePencilLayer.

Public Types
using	SortedKeysIterator = const int *

Public Member Functions
	Layer ()

	Layer (StringRefNull name)

	Layer (const Layer &other)

	~Layer ()

const TreeNode &	as_node () const

TreeNode &	as_node ()

const LayerGroup &	parent_group () const

LayerGroup &	parent_group ()

const Map< FramesMapKeyT, GreasePencilFrame > &	frames () const

Map< FramesMapKeyT, GreasePencilFrame > &	frames_for_write ()

bool	is_empty () const

GreasePencilFrame *	add_frame (FramesMapKeyT key, int duration=0)

bool	remove_frame (FramesMapKeyT key)

Span< FramesMapKeyT >	sorted_keys () const

int	drawing_index_at (const int frame_number) const

bool	has_drawing_at (const int frame_number) const

std::optional< int >	start_frame_at (int frame_number) const

int	sorted_keys_index_at (int frame_number) const

SortedKeysIterator	sorted_keys_iterator_at (int frame_number) const

const GreasePencilFrame *	frame_at (const int frame_number) const

GreasePencilFrame *	frame_at (const int frame_number)

int	get_frame_duration_at (const int frame_number) const

void	tag_frames_map_changed ()

void	tag_frames_map_keys_changed ()

void	prepare_for_dna_write ()

void	update_from_dna_read ()

float4x4	parent_inverse () const

float4x4	local_transform () const

void	set_local_transform (const float4x4 &transform)

float4x4	to_object_space (const Object &object) const

float4x4	to_world_space (const Object &object) const

StringRefNull	parent_bone_name () const

void	set_parent_bone_name (const char *new_name)

StringRefNull	view_layer_name () const

void	set_view_layer_name (const char *new_name)

Public Attributes
	TREENODE_COMMON_METHODS

Public Attributes inherited from GreasePencilLayer
GreasePencilLayerTreeNode	base

GreasePencilLayerFramesMapStorage	frames_storage

int8_t	blend_mode

char	_pad [3]

float	opacity

ListBase	masks

int	active_mask_index

char	_pad2 [4]

struct Object *	parent

char *	parsubstr

float	parentinv [4][4]

float	translation [3]

float	rotation [3]

float	scale [3]

char	_pad3 [4]

char *	viewlayername

GreasePencilLayerRuntimeHandle *	runtime

Detailed Description

A layer maps drawings to scene frames. It can be thought of as one independent channel in the timeline.

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

Definition at line 437 of file BKE_grease_pencil.hh.

Member Typedef Documentation

◆ SortedKeysIterator

using blender::bke::greasepencil::Layer::SortedKeysIterator = const int *

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

Definition at line 439 of file BKE_grease_pencil.hh.

Constructor & Destructor Documentation

◆ Layer() [1/3]

blender::bke::greasepencil::Layer::Layer ( )

◆ Layer() [2/3]

blender::bke::greasepencil::Layer::Layer ( StringRefNull name )

explicit

Definition at line 1083 of file grease_pencil.cc.

References GreasePencilLayer::base, and GP_LAYER_TREE_LEAF.

◆ Layer() [3/3]

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

Definition at line 1088 of file grease_pencil.cc.

References GreasePencilLayer::active_mask_index, GreasePencilLayer::base, GreasePencilLayer::blend_mode, BLI_addtail(), copy_m4_m4(), copy_v3_v3(), LISTBASE_FOREACH, GreasePencilLayer::opacity, GreasePencilLayer::parent, GreasePencilLayer::parentinv, GreasePencilLayer::parsubstr, GreasePencilLayer::runtime, set_parent_bone_name(), set_view_layer_name(), tag_frames_map_changed(), GreasePencilLayer::translation, and GreasePencilLayer::viewlayername.

◆ ~Layer()

blender::bke::greasepencil::Layer::~Layer ( )

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

Definition at line 1120 of file grease_pencil.cc.

References GreasePencilLayer::base, BLI_listbase_clear(), GreasePencilLayer::frames_storage, GreasePencilLayerFramesMapStorage::keys, LISTBASE_FOREACH_MUTABLE, MEM_SAFE_FREE, GreasePencilLayer::parsubstr, GreasePencilLayer::runtime, GreasePencilLayerFramesMapStorage::values, and GreasePencilLayer::viewlayername.

Member Function Documentation

◆ add_frame()

GreasePencilFrame * blender::bke::greasepencil::Layer::add_frame	(	FramesMapKeyT	key,
		int	duration = 0 )

Adds a new frame into the layer frames map. Fails if there already exists a frame at key that is not an end-frame. End-frame at key and subsequent end-frames are removed.

If duration is 0, the frame is marked as an implicit hold (see GP_FRAME_IMPLICIT_HOLD). Otherwise adds an additional end-frame at key + duration, if necessary, to indicate the end of the added frame.

Returns: a pointer to the added frame on success, otherwise nullptr.

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

Definition at line 1179 of file grease_pencil.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_new(), BLI_assert, GreasePencilFrame::flag, frames_for_write(), GP_FRAME_IMPLICIT_HOLD, sorted_keys(), and tag_frames_map_keys_changed().

◆ as_node() [1/2]

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

inline

Definition at line 864 of file BKE_grease_pencil.hh.

◆ as_node() [2/2]

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

inline

Returns: the layer as a TreeNode.

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

Definition at line 860 of file BKE_grease_pencil.hh.

Referenced by blender::ed::object::apply_eval_grease_pencil_data(), BKE_grease_pencil_copy_layer_parameters(), blender::ui::greasepencil::LayerViewItem::create_drop_target(), blender::ed::greasepencil::grease_pencil_layer_duplicate_exec(), blender::ed::greasepencil::grease_pencil_layer_reorder_exec(), blender::ed::greasepencil::grease_pencil_merge_layer_exec(), blender::bke::greasepencil::LayerGroup::LayerGroup(), parent_group(), and parent_group().

◆ drawing_index_at()

int blender::bke::greasepencil::Layer::drawing_index_at ( const int frame_number ) const

Returns: the index of the active drawing at frame frame_number or -1 if there is no drawing. TODO: This should be a private API!

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

Definition at line 1352 of file grease_pencil.cc.

References GreasePencilFrame::drawing_index, and frame_at().

Referenced by blender::ed::greasepencil::merge_layers(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), and blender::bke::greasepencil::tests::TEST().

◆ frame_at() [1/2]

GreasePencilFrame * blender::bke::greasepencil::Layer::frame_at ( const int frame_number )

Definition at line 1332 of file grease_pencil.cc.

References frames_for_write(), and blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr().

◆ frame_at() [2/2]

const GreasePencilFrame * blender::bke::greasepencil::Layer::frame_at ( const int frame_number ) const

Returns: a pointer to the active frame at frame_number or nullptr if there is no frame.

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

Definition at line 1312 of file grease_pencil.cc.

References frames(), and blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr().

Referenced by drawing_index_at(), blender::ed::greasepencil::duplicate_layer_and_frames(), has_drawing_at(), and blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil().

◆ frames()

const Map< int, GreasePencilFrame > & blender::bke::greasepencil::Layer::frames ( ) const

◆ frames_for_write()

Map< int, GreasePencilFrame > & blender::bke::greasepencil::Layer::frames_for_write ( )

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

Definition at line 1144 of file grease_pencil.cc.

References GreasePencilLayer::runtime.

Referenced by add_frame(), blender::ed::greasepencil::copy_layer(), blender::ed::greasepencil::duplicate_layer_and_frames(), frame_at(), blender::ed::greasepencil::grease_pencil_layer_duplicate_exec(), blender::ed::greasepencil::merge_layers(), remove_frame(), blender::bke::greasepencil::tests::TEST(), and update_from_dna_read().

◆ get_frame_duration_at()

int blender::bke::greasepencil::Layer::get_frame_duration_at ( const int frame_number ) const

Returns: the frame duration of the keyframe at frame_number. If there is no keyframe at frame_number; -1. If the keyframe is an implicit hold,; 0.

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

Definition at line 1363 of file grease_pencil.cc.

References blender::math::distance(), frames(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_ptr(), and sorted_keys_iterator_at().

Referenced by blender::ed::greasepencil::duplicate_layer_and_frames(), blender::ed::greasepencil::grease_pencil_layer_duplicate_exec(), blender::ed::greasepencil::merge_layers(), and blender::bke::greasepencil::tests::TEST().

◆ has_drawing_at()

bool blender::bke::greasepencil::Layer::has_drawing_at ( const int frame_number ) const

Returns: true if there is a drawing on this layer at frame_number.

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

Definition at line 1358 of file grease_pencil.cc.

References frame_at().

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

◆ is_empty()

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

inline

Returns: true, if the layer contains no keyframes.

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

Definition at line 870 of file BKE_grease_pencil.hh.

References frames(), and is_empty().

Referenced by is_empty().

◆ local_transform()

float4x4 blender::bke::greasepencil::Layer::local_transform ( ) const

The local transform of the layer (in layer space, not object space).

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

Definition at line 1486 of file grease_pencil.cc.

References blender::math::from_loc_rot_scale(), and GreasePencilLayer::translation.

Referenced by blender::ed::object::apply_eval_grease_pencil_data(), blender::geometry::execute_realize_grease_pencil_task(), blender::ed::greasepencil::merge_layers(), blender::geometry::merge_layers(), to_object_space(), and to_world_space().

◆ parent_bone_name()

StringRefNull blender::bke::greasepencil::Layer::parent_bone_name ( ) const

Returns the name of the parent bone. Should only be used in case the parent object is an armature.

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

Definition at line 1455 of file grease_pencil.cc.

References GreasePencilLayer::parsubstr.

◆ parent_group() [1/2]

LayerGroup & blender::bke::greasepencil::Layer::parent_group ( )

inline

Definition at line 878 of file BKE_grease_pencil.hh.

References as_node(), and blender::bke::greasepencil::TreeNode::parent_group().

◆ parent_group() [2/2]

const LayerGroup & blender::bke::greasepencil::Layer::parent_group ( ) const

inline

Returns: the parent #LayerGroup of this layer.

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

Definition at line 874 of file BKE_grease_pencil.hh.

References as_node(), and blender::bke::greasepencil::TreeNode::parent_group().

◆ parent_inverse()

float4x4 blender::bke::greasepencil::Layer::parent_inverse ( ) const

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

Definition at line 1481 of file grease_pencil.cc.

References GreasePencilLayer::parentinv.

Referenced by to_object_space(), and to_world_space().

◆ prepare_for_dna_write()

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

Prepare the DNA GreasePencilLayer data before blend-file writing.

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

Definition at line 1395 of file grease_pencil.cc.

References GreasePencilLayerFramesMapStorage::flag, frames(), GreasePencilLayer::frames_storage, GP_LAYER_FRAMES_STORAGE_DIRTY, blender::Span< T >::index_range(), int, GreasePencilLayerFramesMapStorage::keys, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), MEM_SAFE_FREE, GreasePencilLayerFramesMapStorage::num, size(), sorted_keys(), and GreasePencilLayerFramesMapStorage::values.

Referenced by blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), and blender::bke::greasepencil::tests::TEST().

◆ remove_frame()

bool blender::bke::greasepencil::Layer::remove_frame ( FramesMapKeyT key )

Removes a frame with key from the frames map.

Fails if the map does not contain a frame with key or in the specific case where the previous frame has a fixed duration (is not marked as an implicit hold) and the frame to remove is an end frame.

Will remove end frame(s) after the frame to remove.