|
Blender V5.3
|
#include <BKE_grease_pencil.hh>
Inherits blender::GreasePencilLayer.
Public Types | |
| using | SortedKeysIterator = const int * |
Public Attributes | |
| TREENODE_COMMON_METHODS | |
| Public Attributes inherited from blender::GreasePencilLayer | |
| GreasePencilLayerTreeNode | base |
| GreasePencilLayerFramesMapStorage | frames_storage |
| GreasePencilLayerBlendMode | blend_mode = GP_LAYER_BLEND_NONE |
| char | _pad [3] = {} |
| float | opacity = 0 |
| ListBaseT< GreasePencilLayerMask > | masks = {nullptr, nullptr} |
| int | active_mask_index = 0 |
| char | _pad2 [4] = {} |
| struct Object * | parent = nullptr |
| char * | parsubstr = nullptr |
| float | parentinv [4][4] = {} |
| float | translation [3] = {} |
| float | rotation [3] = {} |
| float | scale [3] = {1.0f, 1.0f, 1.0f} |
| char | _pad3 [4] = {} |
| char * | viewlayername = nullptr |
| bke::greasepencil::LayerRuntime * | runtime = nullptr |
A layer maps drawings to scene frames. It can be thought of as one independent channel in the timeline.
Definition at line 521 of file BKE_grease_pencil.hh.
| using blender::bke::greasepencil::Layer::SortedKeysIterator = const int * |
Definition at line 523 of file BKE_grease_pencil.hh.
| blender::bke::greasepencil::Layer::Layer | ( | ) |
Definition at line 1613 of file grease_pencil.cc.
References blender::GreasePencilLayer::active_mask_index, blender::GreasePencilLayer::base, blender::GreasePencilLayer::blend_mode, blender::copy_v3_fl(), blender::GreasePencilLayerFramesMapStorage::flag, blender::GreasePencilLayer::frames_storage, blender::GP_LAYER_BLEND_NONE, blender::GP_LAYER_TREE_LEAF, blender::GreasePencilLayerFramesMapStorage::keys, blender::GreasePencilLayer::masks, blender::GreasePencilLayerFramesMapStorage::num, blender::GreasePencilLayer::opacity, blender::GreasePencilLayer::parent, blender::GreasePencilLayer::parentinv, blender::GreasePencilLayer::parsubstr, blender::GreasePencilLayer::rotation, blender::GreasePencilLayer::runtime, blender::GreasePencilLayer::scale, blender::GreasePencilLayer::translation, blender::bke::greasepencil::TreeNode::TreeNode(), blender::unit_m4(), blender::GreasePencilLayerFramesMapStorage::values, blender::GreasePencilLayer::viewlayername, and blender::zero_v3().
|
explicit |
Definition at line 1641 of file grease_pencil.cc.
References blender::GreasePencilLayer::base, blender::GP_LAYER_TREE_LEAF, Layer(), and blender::bke::greasepencil::TreeNode::TreeNode().
| blender::bke::greasepencil::Layer::Layer | ( | const Layer & | other | ) |
Definition at line 1646 of file grease_pencil.cc.
References blender::GreasePencilLayer::active_mask_index, blender::GreasePencilLayer::base, blender::GreasePencilLayer::blend_mode, blender::BLI_addtail(), blender::copy_m4_m4(), blender::copy_v3_v3(), blender::bke::greasepencil::LayerRuntime::frames_, Layer(), blender::GreasePencilLayer::masks, blender::GreasePencilLayer::opacity, blender::bke::greasepencil::LayerRuntime::orig_layer_index_, blender::GreasePencilLayer::parent, blender::GreasePencilLayer::parentinv, blender::GreasePencilLayer::parsubstr, blender::GreasePencilLayer::rotation, blender::GreasePencilLayer::runtime, blender::GreasePencilLayer::scale, set_parent_bone_name(), set_view_layer_name(), blender::bke::greasepencil::LayerRuntime::sorted_keys_cache_, tag_frames_map_changed(), blender::GreasePencilLayer::translation, blender::bke::greasepencil::TreeNode::TreeNode(), and blender::GreasePencilLayer::viewlayername.
| blender::bke::greasepencil::Layer::~Layer | ( | ) |
Definition at line 1682 of file grease_pencil.cc.
References blender::GreasePencilLayer::base, blender::GreasePencilLayer::frames_storage, blender::GreasePencilLayerFramesMapStorage::keys, blender::GreasePencilLayer::masks, blender::GreasePencilLayer::parsubstr, blender::GreasePencilLayer::runtime, blender::GreasePencilLayerFramesMapStorage::values, and blender::GreasePencilLayer::viewlayername.
| 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.
Definition at line 1741 of file grease_pencil.cc.
References blender::Span< T >::begin(), blender::BLI_assert(), blender::Span< T >::end(), blender::GreasePencilFrame::flag, frames_for_write(), blender::GP_FRAME_IMPLICIT_HOLD, sorted_keys(), and tag_frames_map_keys_changed().
Referenced by blender::bke::greasepencil::tests::TEST_F(), blender::bke::greasepencil::tests::TEST_F(), blender::bke::greasepencil::tests::TEST_F(), blender::bke::greasepencil::tests::TEST_F(), and blender::bke::greasepencil::tests::TEST_F().
|
inline |
Definition at line 959 of file BKE_grease_pencil.hh.
|
inline |
Definition at line 955 of file BKE_grease_pencil.hh.
Referenced by blender::ed::greasepencil::apply_eval_grease_pencil_data(), blender::BKE_grease_pencil_copy_layer_parameters(), blender::ed::greasepencil::grease_pencil_layer_add_exec(), blender::ed::greasepencil::grease_pencil_layer_duplicate_exec(), blender::ed::greasepencil::grease_pencil_merge_layer_exec(), blender::bke::greasepencil::LayerGroup::LayerGroup(), parent_group(), and parent_group().
| int blender::bke::greasepencil::Layer::drawing_index_at | ( | const int | frame_number | ) | const |
Definition at line 1916 of file grease_pencil.cc.
References blender::GreasePencilFrame::drawing_index, and frame_at().
Referenced by blender::ed::greasepencil::merge_layers(), blender::bke::greasepencil::tests::TEST_F(), and blender::bke::greasepencil::tests::TEST_F().
| GreasePencilFrame * blender::bke::greasepencil::Layer::frame_at | ( | const int | frame_number | ) |
Definition at line 1896 of file grease_pencil.cc.
References frames_for_write().
| const GreasePencilFrame * blender::bke::greasepencil::Layer::frame_at | ( | const int | frame_number | ) | const |
Definition at line 1876 of file grease_pencil.cc.
References frames().
Referenced by blender::bke::compare_geometry::compare_grease_pencil_layer(), drawing_index_at(), blender::ed::greasepencil::grease_pencil_delete_breakdown_frames_exec(), has_drawing_at(), and blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil().
| const Map< int, GreasePencilFrame > & blender::bke::greasepencil::Layer::frames | ( | ) | const |
Definition at line 1701 of file grease_pencil.cc.
References blender::bke::greasepencil::LayerRuntime::frames_, and blender::GreasePencilLayer::runtime.
Referenced by blender::bke::compare_geometry::compare_grease_pencil_layer(), blender::ed::greasepencil::copy_layer(), blender::ed::sculpt_paint::ensure_editable_drawings(), frame_at(), get_frame_duration_at(), blender::ed::greasepencil::grease_pencil_join_fills_exec(), blender::ed::greasepencil::grease_pencil_move_to_layer_exec(), is_empty(), blender::ed::greasepencil::merge_layers(), prepare_for_dna_write(), remove_frame(), sorted_keys(), start_frame_at(), blender::bke::greasepencil::tests::TEST_F(), blender::bke::greasepencil::tests::TEST_F(), blender::bke::greasepencil::tests::TEST_F(), blender::bke::greasepencil::tests::TEST_F(), blender::bke::greasepencil::tests::TEST_F(), and update_from_dna_read().
| Map< int, GreasePencilFrame > & blender::bke::greasepencil::Layer::frames_for_write | ( | ) |
Definition at line 1706 of file grease_pencil.cc.
References blender::bke::greasepencil::LayerRuntime::frames_, and blender::GreasePencilLayer::runtime.
Referenced by add_frame(), blender::ed::greasepencil::copy_layer(), frame_at(), blender::ed::greasepencil::merge_layers(), remove_frame(), and update_from_dna_read().
| int blender::bke::greasepencil::Layer::get_frame_duration_at | ( | const int | frame_number | ) | const |
Definition at line 1927 of file grease_pencil.cc.
References blender::math::distance(), frames(), sorted_keys(), and sorted_keys_iterator_at().
Referenced by blender::bke::greasepencil::tests::TEST_F().
| bool blender::bke::greasepencil::Layer::has_drawing_at | ( | const int | frame_number | ) | const |
Definition at line 1922 of file grease_pencil.cc.
References frame_at().
|
inline |
Definition at line 965 of file BKE_grease_pencil.hh.
References frames(), and is_empty().
Referenced by is_empty().
| float4x4 blender::bke::greasepencil::Layer::local_transform | ( | ) | const |
The local transform of the layer (in layer space, not object space).
Definition at line 2057 of file grease_pencil.cc.
References blender::math::from_loc_rot_scale(), blender::GreasePencilLayer::rotation, blender::GreasePencilLayer::scale, and blender::GreasePencilLayer::translation.
Referenced by blender::ed::greasepencil::apply_eval_grease_pencil_data(), blender::geometry::execute_realize_grease_pencil_task(), blender::ed::greasepencil::merge_layers(), to_object_space(), and to_world_space().
| 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.
Definition at line 2023 of file grease_pencil.cc.
References blender::GreasePencilLayer::parsubstr, and blender::StringRefNull::StringRefNull().
|
inline |
Definition at line 973 of file BKE_grease_pencil.hh.
References as_node(), and blender::bke::greasepencil::TreeNode::parent_group().
|
inline |
Definition at line 969 of file BKE_grease_pencil.hh.
References as_node(), and blender::bke::greasepencil::TreeNode::parent_group().
| float4x4 blender::bke::greasepencil::Layer::parent_inverse | ( | ) | const |
Definition at line 2052 of file grease_pencil.cc.
References blender::GreasePencilLayer::parentinv.
Referenced by to_object_space(), and to_world_space().
| void blender::bke::greasepencil::Layer::prepare_for_dna_write | ( | ) |
Prepare the DNA GreasePencilLayer data before blend-file writing.
Definition at line 1963 of file grease_pencil.cc.
References blender::GreasePencilLayerFramesMapStorage::flag, frames(), blender::GreasePencilLayer::frames_storage, blender::GP_LAYER_FRAMES_STORAGE_DIRTY, blender::Span< T >::index_range(), blender::GreasePencilLayerFramesMapStorage::keys, blender::GreasePencilLayerFramesMapStorage::num, sorted_keys(), and blender::GreasePencilLayerFramesMapStorage::values.
Referenced by blender::bke::greasepencil::LayerGroup::prepare_for_dna_write(), blender::bke::greasepencil::tests::TEST_F(), blender::bke::greasepencil::tests::TEST_F(), and blender::bke::greasepencil::tests::TEST_F().
| 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.
Definition at line 1772 of file grease_pencil.cc.
References blender::Span< T >::begin(), blender::Span< T >::end(), frames(), frames_for_write(), sorted_keys(), tag_frames_map_changed(), and tag_frames_map_keys_changed().
| void blender::bke::greasepencil::Layer::set_local_transform | ( | const float4x4 & | transform | ) |
Updates the local transform of the layer based on the matrix.
Definition at line 2063 of file grease_pencil.cc.
References blender::GreasePencilLayer::rotation, blender::GreasePencilLayer::scale, blender::math::to_loc_rot_scale_safe(), and blender::GreasePencilLayer::translation.
Referenced by blender::ed::greasepencil::apply_eval_grease_pencil_data(), and blender::geometry::execute_realize_grease_pencil_task().
| void blender::bke::greasepencil::Layer::set_parent_bone_name | ( | StringRef | new_name | ) |
Definition at line 2028 of file grease_pencil.cc.
References blender::BLI_strdupn(), blender::blender::StringRefBase::data(), blender::blender::StringRefBase::is_empty(), blender::GreasePencilLayer::parsubstr, and blender::blender::StringRefBase::size().
Referenced by blender::BKE_grease_pencil_copy_layer_parameters(), Layer(), and blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil().
| void blender::bke::greasepencil::Layer::set_view_layer_name | ( | StringRef | new_name | ) |
Definition at line 2076 of file grease_pencil.cc.
References blender::BLI_strdupn(), blender::blender::StringRefBase::data(), blender::blender::StringRefBase::is_empty(), blender::blender::StringRefBase::size(), and blender::GreasePencilLayer::viewlayername.
Referenced by blender::BKE_grease_pencil_copy_layer_parameters(), Layer(), and blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil().
| Span< FramesMapKeyT > blender::bke::greasepencil::Layer::sorted_keys | ( | ) | const |
Returns the sorted keys (start frame numbers) of the frames of this layer.
Definition at line 1812 of file grease_pencil.cc.
References frames(), blender::Vector< T, InlineBufferCapacity, Allocator >::reinitialize(), blender::GreasePencilLayer::runtime, and blender::bke::greasepencil::LayerRuntime::sorted_keys_cache_.
Referenced by add_frame(), blender::bke::compare_geometry::compare_grease_pencil_layer(), get_frame_duration_at(), blender::ed::greasepencil::grease_pencil_delete_breakdown_frames_exec(), blender::ed::greasepencil::merge_layers(), prepare_for_dna_write(), remove_frame(), sorted_keys_index_at(), and sorted_keys_iterator_at().
| int blender::bke::greasepencil::Layer::sorted_keys_index_at | ( | int | frame_number | ) | const |
Definition at line 1867 of file grease_pencil.cc.
References blender::begin(), sorted_keys(), and sorted_keys_iterator_at().
| Layer::SortedKeysIterator blender::bke::greasepencil::Layer::sorted_keys_iterator_at | ( | int | frame_number | ) | const |
Definition at line 1825 of file grease_pencil.cc.
References blender::Span< T >::begin(), blender::Span< T >::end(), blender::Span< T >::first(), blender::Span< T >::is_empty(), blender::Span< T >::last(), and sorted_keys().
Referenced by get_frame_duration_at(), and sorted_keys_index_at().
| std::optional< int > blender::bke::greasepencil::Layer::start_frame_at | ( | int | frame_number | ) | const |
Definition at line 1857 of file grease_pencil.cc.
References frames().
Referenced by blender::ed::transform::greasepencil::createTransGreasePencilVerts(), blender::ed::sculpt_paint::ensure_editable_drawings(), blender::ed::greasepencil::grease_pencil_active_frame_delete_exec(), blender::ed::greasepencil::grease_pencil_delete_breakdown_frames_exec(), and blender::ed::greasepencil::grease_pencil_frame_duplicate_exec().
| void blender::bke::greasepencil::Layer::tag_frames_map_changed | ( | ) |
Definition at line 1952 of file grease_pencil.cc.
References blender::GreasePencilLayerFramesMapStorage::flag, blender::GreasePencilLayer::frames_storage, and blender::GP_LAYER_FRAMES_STORAGE_DIRTY.
Referenced by blender::ed::greasepencil::copy_layer(), Layer(), blender::ed::greasepencil::merge_layers(), remove_frame(), and 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.
Definition at line 1957 of file grease_pencil.cc.
References blender::GreasePencilLayer::runtime, blender::bke::greasepencil::LayerRuntime::sorted_keys_cache_, and tag_frames_map_changed().
Referenced by add_frame(), and remove_frame().
Returns the transformation from layer space to object space.
Definition at line 2013 of file grease_pencil.cc.
References local_transform(), blender::GreasePencilLayer::parent, and parent_inverse().
Referenced by blender::ed::greasepencil::grease_pencil_paste_strokes_exec(), and blender::ed::sculpt_paint::greasepencil::CloneOperation::on_stroke_begin().
Returns the transformation from layer space to world space.
Definition at line 2004 of file grease_pencil.cc.
References local_transform(), blender::GreasePencilLayer::parent, and parent_inverse().
Referenced by blender::ed::greasepencil::grease_pencil_primitive_exit(), blender::ed::sculpt_paint::greasepencil::CloneOperation::on_stroke_begin(), blender::ed::sculpt_paint::greasepencil::PaintOperation::on_stroke_done(), blender::ed::sculpt_paint::greasepencil::view_positions_from_curve_mask(), blender::ed::sculpt_paint::greasepencil::view_positions_from_point_mask(), blender::ed::sculpt_paint::greasepencil::view_positions_left_from_point_mask(), blender::ed::sculpt_paint::greasepencil::view_positions_right_from_point_mask(), and blender::ed::sculpt_paint::greasepencil::view_radii_from_point_selection().
| void blender::bke::greasepencil::Layer::update_from_dna_read | ( | ) |
Update from DNA GreasePencilLayer data after blend-file reading.
Definition at line 1987 of file grease_pencil.cc.
References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_new(), blender::bke::greasepencil::LayerRuntime::clear(), frames(), frames_for_write(), blender::GreasePencilLayer::frames_storage, blender::GreasePencilLayerFramesMapStorage::keys, blender::GreasePencilLayerFramesMapStorage::num, blender::GreasePencilLayer::runtime, and blender::GreasePencilLayerFramesMapStorage::values.
Referenced by blender::bke::greasepencil::LayerGroup::update_from_dna_read().
| 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.
Definition at line 2071 of file grease_pencil.cc.
References blender::StringRefNull::StringRefNull(), and blender::GreasePencilLayer::viewlayername.
| blender::bke::greasepencil::Layer::TREENODE_COMMON_METHODS |
Definition at line 531 of file BKE_grease_pencil.hh.