Blender V4.5
Public Types | Public Member Functions | Public Attributes | List of all members
blender::bke::greasepencil::Layer Class Reference

#include <BKE_grease_pencil.hh>

Inherits GreasePencilLayer.

Public Types

using SortedKeysIterator = const int *

Public Member Functions

 Layer ()
 Layer (StringRef 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 (StringRef new_name)
StringRefNull view_layer_name () const
void set_view_layer_name (StringRef 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 450 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 452 of file BKE_grease_pencil.hh.

Constructor & Destructor Documentation

◆ Layer() [1/3]

blender::bke::greasepencil::Layer::Layer ( )
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1154 of file grease_pencil.cc.

References GreasePencilLayer::active_mask_index, GreasePencilLayer::base, GreasePencilLayer::blend_mode, BLI_listbase_clear(), copy_v3_fl(), GreasePencilLayer::frames_storage, GP_LAYER_BLEND_NONE, GP_LAYER_TREE_LEAF, GreasePencilLayer::masks, GreasePencilLayer::opacity, GreasePencilLayer::parent, GreasePencilLayer::parentinv, GreasePencilLayer::parsubstr, GreasePencilLayer::rotation, GreasePencilLayer::runtime, GreasePencilLayer::scale, GreasePencilLayer::translation, unit_m4(), GreasePencilLayer::viewlayername, and zero_v3().

Referenced by Layer(), and Layer().

◆ Layer() [2/3]

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

Definition at line 1182 of file grease_pencil.cc.

References GreasePencilLayer::base, GP_LAYER_TREE_LEAF, and Layer().

◆ Layer() [3/3]

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

Definition at line 1187 of file grease_pencil.cc.

References GreasePencilLayer::active_mask_index, GreasePencilLayer::base, GreasePencilLayer::blend_mode, BLI_addtail(), copy_m4_m4(), copy_v3_v3(), Layer(), LISTBASE_FOREACH, GreasePencilLayer::masks, GreasePencilLayer::opacity, GreasePencilLayer::parent, GreasePencilLayer::parentinv, GreasePencilLayer::parsubstr, GreasePencilLayer::rotation, GreasePencilLayer::runtime, GreasePencilLayer::scale, 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1219 of file grease_pencil.cc.

References GreasePencilLayer::base, BLI_listbase_clear(), GreasePencilLayer::frames_storage, LISTBASE_FOREACH_MUTABLE, mask(), GreasePencilLayer::masks, MEM_SAFE_FREE, GreasePencilLayer::parsubstr, GreasePencilLayer::runtime, 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1278 of file grease_pencil.cc.

References 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().

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

◆ as_node() [1/2]

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

Definition at line 887 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 883 of file BKE_grease_pencil.hh.

Referenced by blender::ed::greasepencil::apply_eval_grease_pencil_data(), BKE_grease_pencil_copy_layer_parameters(), blender::ed::greasepencil::get_sorted_layer_parents(), blender::ed::greasepencil::grease_pencil_layer_duplicate_exec(), blender::ed::greasepencil::grease_pencil_merge_layer_exec(), blender::bke::greasepencil::LayerGroup::LayerGroup(), parent_group(), parent_group(), and blender::io::grease_pencil::SVGImporter::read().

◆ 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1451 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(), 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 1431 of file grease_pencil.cc.

References frames_for_write(), and 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1411 of file grease_pencil.cc.

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

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

◆ frames()

const Map< int, GreasePencilFrame > & blender::bke::greasepencil::Layer::frames ( ) const
Returns
the frames mapping.
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1238 of file grease_pencil.cc.

References GreasePencilLayer::runtime.

Referenced by blender::ed::object::apply_grease_pencil_for_modifier_all_keyframes(), blender::ed::object::apply_objects_internal(), BKE_grease_pencil_point_coords_apply(), BKE_grease_pencil_point_coords_apply_with_mat4(), BKE_grease_pencil_point_coords_get(), BKE_grease_pencil_stroke_point_count(), blender::ed::greasepencil::copy_layer(), blender::ed::transform::count_grease_pencil_frames(), blender::ed::greasepencil::create_keyframe_edit_data_selected_frames_list(), blender::ed::transform::createTransActionData(), blender::ed::greasepencil::duplicate_layer_and_frames(), blender::ed::sculpt_paint::ensure_editable_drawings(), frame_at(), blender::ed::greasepencil::get_editable_frames_for_layer(), get_frame_duration_at(), get_keyframe_extents(), blender::ed::greasepencil::get_selected_frame_number_bounds(), blender::ed::greasepencil::get_visible_frames_for_layer(), grease_pencil_cels_to_keylist(), blender::ed::greasepencil::grease_pencil_copy_keyframes(), blender::ed::greasepencil::grease_pencil_layer_duplicate_exec(), blender::ed::transform::grease_pencil_layer_initialize_trans_data(), blender::ed::greasepencil::grease_pencil_move_to_layer_exec(), blender::ed::greasepencil::grease_pencil_paste_keyframes(), blender::ed::greasepencil::grease_pencil_remove_fill_guides_exec(), blender::ed::transform::GreasePencilLayerToTransData(), blender::ed::greasepencil::has_any_frame_selected(), is_empty(), blender::ed::greasepencil::merge_layers(), blender::ed::greasepencil::mirror_selected_frames(), blender::modify_geometry_set(), blender::ed::object::object_origin_set_exec(), prepare_for_dna_write(), blender::ed::greasepencil::remove_all_selected_frames(), remove_frame(), blender::ed::greasepencil::retrieve_editable_drawings_grouped_per_frame(), blender::ed::greasepencil::snap_selected_frames(), sorted_keys(), start_frame_at(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::ed::greasepencil::tests::TEST(), and update_from_dna_read().

◆ frames_for_write()

Map< int, GreasePencilFrame > & blender::bke::greasepencil::Layer::frames_for_write ( )
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1243 of file grease_pencil.cc.

References GreasePencilLayer::runtime.

Referenced by add_frame(), blender::ed::greasepencil::copy_layer(), blender::ed::greasepencil::duplicate_layer_and_frames(), blender::ed::greasepencil::duplicate_selected_frames(), frame_at(), blender::ed::transform::grease_pencil_layer_apply_trans_data(), blender::ed::greasepencil::grease_pencil_layer_duplicate_exec(), blender::ed::transform::grease_pencil_layer_update_trans_data(), blender::ed::greasepencil::join_object_with_active(), blender::ed::greasepencil::merge_layers(), blender::modify_geometry_set(), remove_frame(), blender::ed::greasepencil::select_all_frames(), blender::ed::greasepencil::select_frame_at(), blender::ed::greasepencil::select_frames_range(), blender::ed::greasepencil::select_frames_region(), blender::ed::greasepencil::set_selected_frames_type(), 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1462 of file grease_pencil.cc.

References blender::math::distance(), frames(), 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_copy_keyframes(), blender::ed::greasepencil::grease_pencil_layer_duplicate_exec(), blender::ed::transform::grease_pencil_layer_initialize_trans_data(), 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1457 of file grease_pencil.cc.

References frame_at().

Referenced by blender::ed::greasepencil::ensure_active_keyframe(), blender::ed::sculpt_paint::greasepencil::find_curve_mapping_from_index(), and blender::ed::sculpt_paint::get_current_drawing_or_duplicate_for_autokey().

◆ 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 893 of file BKE_grease_pencil.hh.

References frames(), and is_empty().

Referenced by animdata_filter_grease_pencil_layer(), blender::ed::greasepencil::ensure_active_keyframe(), is_empty(), and blender::animrig::move_slot().

◆ 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1588 of file grease_pencil.cc.

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

Referenced by blender::ed::greasepencil::apply_eval_grease_pencil_data(), BKE_grease_pencil_point_coords_apply(), BKE_grease_pencil_point_coords_apply_with_mat4(), BKE_grease_pencil_point_coords_get(), blender::geometry::execute_realize_grease_pencil_task(), blender::ed::greasepencil::merge_layers(), blender::geometry::merge_layers(), blender::nodes::node_geo_grease_pencil_to_curves_cc::node_geo_exec(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), blender::ed::object::object_origin_set_exec(), to_object_space(), to_world_space(), blender::geometry::transform_greasepencil(), and blender::geometry::translate_greasepencil().

◆ 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1554 of file grease_pencil.cc.

References GreasePencilLayer::parsubstr.

◆ parent_group() [1/2]

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

Definition at line 901 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 897 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1583 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.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1494 of file grease_pencil.cc.

References frames(), GreasePencilLayer::frames_storage, GP_LAYER_FRAMES_STORAGE_DIRTY, i, blender::Span< T >::index_range(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), MEM_calloc_arrayN(), MEM_SAFE_FREE, size(), and sorted_keys().

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.

Returns
true on success.
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1308 of file grease_pencil.cc.

References frames(), frames_for_write(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove_contained(), size(), sorted_keys(), tag_frames_map_changed(), and tag_frames_map_keys_changed().

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

◆ set_local_transform()

void blender::bke::greasepencil::Layer::set_local_transform ( const float4x4 & transform)

Updates the local transform of the layer based on the matrix.

Note
The matrix is decomposed into location, rotation and scale, so any skew is lost.
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1594 of file grease_pencil.cc.

References GreasePencilLayer::rotation, GreasePencilLayer::scale, blender::math::to_loc_rot_scale_safe(), transform(), and GreasePencilLayer::translation.

Referenced by blender::ed::greasepencil::apply_eval_grease_pencil_data(), blender::nodes::node_geo_curves_to_grease_pencil_cc::curve_instances_to_grease_pencil_layers(), blender::geometry::execute_realize_grease_pencil_task(), blender::geometry::merge_layers(), blender::geometry::transform_greasepencil(), blender::geometry::translate_greasepencil(), and blender::bke::bake::try_load_grease_pencil().

◆ set_parent_bone_name()

void blender::bke::greasepencil::Layer::set_parent_bone_name ( StringRef new_name)
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1559 of file grease_pencil.cc.

References BLI_strdupn(), blender::StringRefBase::data(), blender::StringRefBase::is_empty(), MEM_freeN(), GreasePencilLayer::parsubstr, and blender::StringRefBase::size().

Referenced by BKE_grease_pencil_copy_layer_parameters(), Layer(), and blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil().

◆ set_view_layer_name()

void blender::bke::greasepencil::Layer::set_view_layer_name ( StringRef new_name)
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1607 of file grease_pencil.cc.

References BLI_strdupn(), blender::StringRefBase::data(), blender::StringRefBase::is_empty(), MEM_freeN(), blender::StringRefBase::size(), and GreasePencilLayer::viewlayername.

Referenced by BKE_grease_pencil_copy_layer_parameters(), Layer(), and blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil().

◆ sorted_keys()

Span< FramesMapKeyT > blender::bke::greasepencil::Layer::sorted_keys ( ) const

Returns the sorted keys (start frame numbers) of the frames of this layer.

Note
This will cache the keys lazily.
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1347 of file grease_pencil.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::begin(), blender::Vector< T, InlineBufferCapacity, Allocator >::end(), frames(), i, blender::Vector< T, InlineBufferCapacity, Allocator >::reinitialize(), GreasePencilLayer::runtime, and size().

Referenced by add_frame(), blender::ed::greasepencil::ensure_active_keyframe(), blender::ed::sculpt_paint::greasepencil::find_frames_interval(), blender::ed::greasepencil::get_visible_frames_for_layer(), blender::ed::greasepencil::grease_pencil_delete_breakdown_frames_exec(), lineart_gpencil_clear_strokes_exec_common(), blender::ed::greasepencil::merge_layers(), blender::modify_geometry_set(), blender::modify_geometry_set(), prepare_for_dna_write(), remove_frame(), sorted_keys_index_at(), sorted_keys_iterator_at(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), and blender::ed::greasepencil::tests::TEST().

◆ sorted_keys_index_at()

int blender::bke::greasepencil::Layer::sorted_keys_index_at ( int frame_number) const
Returns
the index of the key of the active frame in sorted_keys or -1 if no such frame exists.
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1402 of file grease_pencil.cc.

References begin(), sorted_keys(), and sorted_keys_iterator_at().

Referenced by blender::ed::greasepencil::get_visible_frames_for_layer(), and blender::modify_geometry_set().

◆ sorted_keys_iterator_at()

Layer::SortedKeysIterator blender::bke::greasepencil::Layer::sorted_keys_iterator_at ( int frame_number) const
Returns
an iterator into the sorted_keys span to the frame at frame_number or nullptr if no such frame exists.
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1360 of file grease_pencil.cc.

References blender::Span< T >::is_empty(), and sorted_keys().

Referenced by blender::ed::sculpt_paint::greasepencil::find_frames_interval(), get_frame_duration_at(), and sorted_keys_index_at().

◆ start_frame_at()

std::optional< int > blender::bke::greasepencil::Layer::start_frame_at ( int frame_number) const
Returns
the start frame number of the active frame at frame_number or #std::nullopt if no such frame exists.
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1392 of file grease_pencil.cc.

References frames().

Referenced by bake_strokes(), clear_strokes(), blender::ed::transform::greasepencil::createTransGreasePencilVerts(), blender::ed::greasepencil::ensure_active_keyframe(), blender::ed::sculpt_paint::ensure_editable_drawings(), blender::ed::greasepencil::get_active_frame_for_falloff(), blender::ed::sculpt_paint::get_current_drawing_or_duplicate_for_autokey(), blender::ed::sculpt_paint::greasepencil::get_drawing_at_exact_frame(), blender::modifier::greasepencil::get_drawing_infos_by_frame(), blender::ed::greasepencil::get_visible_frames_for_layer(), blender::ed::greasepencil::grease_pencil_active_frame_delete_exec(), blender::ed::greasepencil::grease_pencil_delete_breakdown_frames_exec(), blender::ed::greasepencil::grease_pencil_delete_frame_exec(), blender::ed::greasepencil::grease_pencil_frame_duplicate_exec(), and blender::modify_geometry_set().

◆ tag_frames_map_changed()

void blender::bke::greasepencil::Layer::tag_frames_map_changed ( )
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1483 of file grease_pencil.cc.

References GreasePencilLayer::frames_storage, and GP_LAYER_FRAMES_STORAGE_DIRTY.

Referenced by blender::ed::greasepencil::copy_layer(), blender::ed::greasepencil::duplicate_selected_frames(), Layer(), blender::ed::greasepencil::merge_layers(), remove_frame(), blender::ed::greasepencil::select_all_frames(), blender::ed::greasepencil::select_frame_at(), blender::ed::greasepencil::select_frames_range(), blender::ed::greasepencil::select_frames_region(), blender::ed::greasepencil::set_selected_frames_type(), and tag_frames_map_keys_changed().

◆ tag_frames_map_keys_changed()

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

Should be called whenever the keys in the frames map have changed. E.g. when new keys were added, removed or updated.

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

Definition at line 1488 of file grease_pencil.cc.

References GreasePencilLayer::runtime, and tag_frames_map_changed().

Referenced by add_frame(), blender::ed::transform::grease_pencil_layer_apply_trans_data(), blender::ed::transform::grease_pencil_layer_update_trans_data(), blender::modify_geometry_set(), and remove_frame().

◆ to_object_space()

float4x4 blender::bke::greasepencil::Layer::to_object_space ( const Object & object) const

Returns the transformation from layer space to object space.

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

Definition at line 1544 of file grease_pencil.cc.

References local_transform(), GreasePencilLayer::parent, and parent_inverse().

Referenced by blender::ed::object::apply_objects_internal(), blender::ed::object::convert_grease_pencil_to_mesh(), blender::draw::grease_pencil_edit_batch_ensure(), blender::draw::grease_pencil_geom_batch_ensure(), blender::ed::greasepencil::grease_pencil_paste_strokes_exec(), blender::draw::grease_pencil_weight_batch_ensure(), and blender::ed::sculpt_paint::greasepencil::PaintOperation::on_stroke_begin().

◆ to_world_space()

float4x4 blender::bke::greasepencil::Layer::to_world_space ( const Object & object) const

Returns the transformation from layer space to world space.

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

Definition at line 1535 of file grease_pencil.cc.

References local_transform(), GreasePencilLayer::parent, and parent_inverse().

Referenced by blender::ed::greasepencil::add_armature_automatic_weights(), blender::ed::greasepencil::add_armature_envelope_weights(), blender::ed::greasepencil::build_curves_2d_bvh_from_visible(), blender::ed::transform::greasepencil::createTransGreasePencilVerts(), do_grease_pencil_box_select(), do_lasso_select_grease_pencil(), blender::ed::greasepencil::DrawingPlacement::DrawingPlacement(), blender::ed::greasepencil::DrawingPlacement::DrawingPlacement(), ed_grease_pencil_select_pick(), ED_view3d_minmax_verts(), blender::io::grease_pencil::PDFExporter::export_grease_pencil_layer(), blender::io::grease_pencil::SVGExporter::export_grease_pencil_layer(), blender::io::grease_pencil::GreasePencilExporter::foreach_stroke_in_layer(), blender::ed::greasepencil::get_boundary_bounds(), blender::ed::sculpt_paint::greasepencil::get_screen_projection_fn(), grease_pencil_circle_select(), blender::ed::sculpt_paint::grease_pencil_fill_extension_cut(), blender::ed::greasepencil::grease_pencil_outline_exec(), blender::ed::greasepencil::grease_pencil_primitive_exit(), blender::ed::greasepencil::grease_pencil_reproject_exec(), blender::ed::greasepencil::grease_pencil_snap_compute_centroid(), blender::ed::greasepencil::grease_pencil_snap_to_cursor_exec(), blender::ed::greasepencil::grease_pencil_snap_to_grid_exec(), blender::ed::greasepencil::grease_pencil_texture_gradient_exec(), blender::ed::greasepencil::join_object_with_active(), blender::modify_geometry_set(), blender::ed::sculpt_paint::greasepencil::TintOperation::on_stroke_begin(), blender::ed::sculpt_paint::greasepencil::PaintOperation::on_stroke_done(), blender::ed::greasepencil::render_strokes(), blender::ed::greasepencil::stroke_trim_execute(), and blender::ed::greasepencil::weight_sample_invoke().

◆ update_from_dna_read()

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

Update from DNA GreasePencilLayer data after blend-file reading.

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

Definition at line 1518 of file grease_pencil.cc.

References frames(), frames_for_write(), GreasePencilLayer::frames_storage, i, and GreasePencilLayer::runtime.

◆ view_layer_name()

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

Returns the view layer name that this layer should be rendered in or an empty StringRefNull if no such name is set.

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

Definition at line 1602 of file grease_pencil.cc.

References GreasePencilLayer::viewlayername.

Referenced by blender::draw::gpencil::grease_pencil_layer_cache_add().

Member Data Documentation

◆ TREENODE_COMMON_METHODS

blender::bke::greasepencil::Layer::TREENODE_COMMON_METHODS
Examples
/usr/src/RPM/BUILD/blender-4.5.8/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 460 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