Blender V5.3
DNA_grease_pencil_types.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "DNA_ID.h"
12#include "DNA_attribute_types.h"
13#include "DNA_curve_types.h"
14#include "DNA_curves_types.h"
15#include "DNA_listBase.h"
16
17#include "BLI_bounds_types.hh"
18#include "BLI_enum_flags.hh"
19#include "BLI_index_mask_fwd.hh"
20#include "BLI_map.hh"
23#include "BLI_span.hh"
24
25namespace blender {
26
27namespace bke {
31class GreasePencilDrawingRuntime;
32namespace greasepencil {
33class DrawingRuntime;
34class Drawing;
36class TreeNode;
37class Layer;
38class LayerMask;
39class LayerRuntime;
40class LayerGroup;
42} // namespace greasepencil
43} // namespace bke
44
45struct Main;
46struct GreasePencil;
47struct Object;
48
55
56#define GP_STROKE_MITER_ANGLE_ROUND 0.0f
57#define GP_STROKE_MITER_ANGLE_BEVEL DEG2RADF(180.0f)
58
68
77
78
83 /* When set, the frame is implicitly held until the next frame. E.g. it doesn't have a fixed
84 * duration. */
86};
88
93
94
102
103
114
124
141
153
163
164
172
174 /* Use custom colors (per object-data) for onion skinning. */
176 /* Fade the opacity of ghost frames further away from the current frame. */
178 /* Show looping frames in onion skinning. */
180};
182
183
196
197#define GREASE_PENCIL_ONION_SKINNING_FILTER_ALL \
198 (GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME | GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME | \
199 GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN | GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER | \
200 GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD)
201
216
236
250
268 char _pad[3] = {};
269#ifdef __cplusplus
270 static GreasePencilFrame end();
271 bool is_end() const;
272 bool is_implicit_hold() const;
273 bool is_selected() const;
274#endif
275};
276
282 /* Array of `frames` keys (sorted in ascending order). */
283 int *keys = nullptr;
284 /* Array of `frames` values (order matches the keys array). */
286 /* Size of the map (number of key-value pairs). */
287 int num = 0;
288 /* Flag for the status of the storage. */
290};
291
296 struct GreasePencilLayerMask *next = nullptr, *prev = nullptr;
300 char *layer_name = nullptr;
305 char _pad[6] = {};
306#ifdef __cplusplus
308 const bke::greasepencil::LayerMask &wrap() const;
309#endif
310};
311
312struct GreasePencilLayerTreeGroup;
314 /* ListBaseT pointers. */
315 struct GreasePencilLayerTreeNode *next = nullptr, *prev = nullptr;
316 /* Parent pointer. Can be null. */
321 char *name = nullptr;
326 char _pad[7] = {};
330 float color[3] = {};
335#ifdef __cplusplus
337 const bke::greasepencil::TreeNode &wrap() const;
338#endif
339};
340
346 /* Only used for storage in the .blend file. */
352 char _pad[3] = {};
356 float opacity = 0;
357 ListBaseT<GreasePencilLayerMask> masks = {nullptr, nullptr};
359 char _pad2[4] = {};
363 struct Object *parent = nullptr;
364 char *parsubstr = nullptr;
369 float parentinv[4][4] = {};
374 float translation[3] = {}, rotation[3] = {}, scale[3] = {1.0f, 1.0f, 1.0f};
375 char _pad3[4] = {};
377 char *viewlayername = nullptr;
382#ifdef __cplusplus
384 const bke::greasepencil::Layer &wrap() const;
385#endif
386};
387
390 ListBaseT<GreasePencilLayerTreeNode> children = {nullptr, nullptr};
395 char _pad[7] = {};
400#ifdef __cplusplus
402 const bke::greasepencil::LayerGroup &wrap() const;
403#endif
404};
405
437
442#ifdef __cplusplus
444 static constexpr ID_Type id_type = ID_GP;
445#endif
446
449 struct AnimData *adt = nullptr;
450
458 char _pad[4] = {};
459
460 /* Root group of the layer tree. */
462
465
470
477 char _pad2[4] = {};
478
484
488 struct Material **material_array = nullptr;
490 char _pad3[2] = {};
495
496 ListBaseT<bDeformGroup> vertex_group_names = {nullptr, nullptr};
498 char _pad4[4] = {};
499
508#ifdef __cplusplus
509 /* Root group. */
510 const bke::greasepencil::LayerGroup &root_group() const;
511 bke::greasepencil::LayerGroup &root_group();
512
513 /* Drawings read/write access. */
516 const GreasePencilDrawingBase *drawing(int64_t index) const;
518
519 /* Layers, layer groups and nodes read/write access. */
521 Span<bke::greasepencil::Layer *> layers_for_write();
524
526 Span<bke::greasepencil::LayerGroup *> layer_groups_for_write();
527
529 Span<bke::greasepencil::TreeNode *> nodes_for_write();
530
531 /* Return the index of the layer if it's found, otherwise `std::nullopt`. */
532 std::optional<int> get_layer_index(const bke::greasepencil::Layer &layer) const;
533
534 /* Active layer functions. */
535 bool has_active_layer() const;
536 const bke::greasepencil::Layer *get_active_layer() const;
537 bke::greasepencil::Layer *get_active_layer();
538 void set_active_layer(bke::greasepencil::Layer *layer);
539 bool is_layer_active(const bke::greasepencil::Layer *layer) const;
540 void autolock_inactive_layers();
541
542 /* Active group functions. */
543 bool has_active_group() const;
544 const bke::greasepencil::LayerGroup *get_active_group() const;
545 bke::greasepencil::LayerGroup *get_active_group();
546
547 /* Active node functions. */
548 const bke::greasepencil::TreeNode *get_active_node() const;
549 bke::greasepencil::TreeNode *get_active_node();
550 void set_active_node(bke::greasepencil::TreeNode *node);
551
552 /* Adding layers and layer groups. */
554 bke::greasepencil::Layer &add_layer(StringRef name, bool check_name_is_unique = true);
557 StringRef name,
558 bool check_name_is_unique = true);
560 bke::greasepencil::Layer &duplicate_layer(const bke::greasepencil::Layer &duplicate_layer,
561 bool duplicate_frames = false,
562 bool duplicate_drawings = false);
564 bke::greasepencil::Layer &duplicate_layer(bke::greasepencil::LayerGroup &parent_group,
565 const bke::greasepencil::Layer &duplicate_layer,
566 bool duplicate_frames = false,
567 bool duplicate_drawings = false);
569 bke::greasepencil::LayerGroup &add_layer_group(StringRef name, bool check_name_is_unique = true);
571 StringRef name,
572 bool check_name_is_unique = true);
573
578 void add_layers_for_eval(int num_new_layers);
579
580 /* Moving nodes. */
581 void move_node_up(bke::greasepencil::TreeNode &node, int step = 1);
582 void move_node_down(bke::greasepencil::TreeNode &node, int step = 1);
583 void move_node_top(bke::greasepencil::TreeNode &node);
584 void move_node_bottom(bke::greasepencil::TreeNode &node);
585
586 void move_node_after(bke::greasepencil::TreeNode &node,
587 bke::greasepencil::TreeNode &target_node);
588 void move_node_before(bke::greasepencil::TreeNode &node,
589 bke::greasepencil::TreeNode &target_node);
590 void move_node_into(bke::greasepencil::TreeNode &node,
591 bke::greasepencil::LayerGroup &parent_group);
592
593 /* Search functions. */
594 const bke::greasepencil::TreeNode *find_node_by_name(StringRef name) const;
595 bke::greasepencil::TreeNode *find_node_by_name(StringRef name);
596 IndexMask layer_selection_by_name(StringRef name, IndexMaskMemory &memory) const;
597
598 void rename_node(Main &bmain, bke::greasepencil::TreeNode &node, StringRef new_name);
599
600 void remove_layer(bke::greasepencil::Layer &layer);
601 void remove_group(bke::greasepencil::LayerGroup &group, bool keep_children = false);
602
603 std::string unique_layer_name(StringRef name);
604
605 /* Frames API functions. */
606
617 bke::greasepencil::Drawing *insert_frame(
619 int frame_number,
620 int duration = 0,
622
627 void insert_frames(Span<bke::greasepencil::Layer *> layers,
628 int frame_number,
629 int duration = 0,
635 bool remove_frames(bke::greasepencil::Layer &layer, Span<int> frame_numbers);
636
637 void copy_frames_from_layer(bke::greasepencil::Layer &dst_layer,
638 const GreasePencil &src_grease_pencil,
639 const bke::greasepencil::Layer &src_layer,
640 const std::optional<int> frame_select = std::nullopt);
645 void add_layers_with_empty_drawings_for_eval(int num);
646
651 void resize_drawings(int new_num);
653 void add_empty_drawings(int add_num);
654 void add_duplicate_drawings(int duplicate_num, const bke::greasepencil::Drawing &drawing);
655 bool insert_duplicate_frame(bke::greasepencil::Layer &layer,
656 int src_frame_number,
657 int dst_frame_number,
658 bool do_instance);
659
669 void move_frames(bke::greasepencil::Layer &layer,
670 const Map<int, int> &frame_number_destinations);
671
684 void move_duplicate_frames(bke::greasepencil::Layer &layer,
685 const Map<int, int> &frame_number_destinations,
686 const Map<int, GreasePencilFrame> &duplicate_frames);
687
692 void remove_drawings_with_no_users();
696 void update_drawing_users_for_layer(const bke::greasepencil::Layer &layer);
697
702 const bke::greasepencil::Drawing *get_drawing_at(const bke::greasepencil::Layer &layer,
703 int frame_number) const;
705 int frame_number);
710 bke::greasepencil::Drawing *get_editable_drawing_at(const bke::greasepencil::Layer &layer,
711 int frame_number);
712
717 const bke::greasepencil::Drawing *get_eval_drawing(const bke::greasepencil::Layer &layer) const;
719
720 std::optional<Bounds<float3>> bounds_min_max(int frame, bool use_radius = true) const;
721 std::optional<Bounds<float3>> bounds_min_max_eval(bool use_radius = true) const;
722
723 bke::AttributeAccessor attributes() const;
724 bke::MutableAttributeAccessor attributes_for_write();
725
729 std::optional<int> material_index_max() const;
730
731 void count_memory(MemoryCounter &memory) const;
732
737 Array<int> count_frame_users_for_drawings() const;
738
739 /* For debugging purposes. */
740 void print_layer_tree();
741 void validate_drawing_user_counts();
742#endif
743};
744
745} // namespace blender
#define ENUM_OPERATORS(_enum_type)
ID and Library types, which are fundamental for SDNA.
#define GREASE_PENCIL_ONION_SKINNING_FILTER_ALL
These structs are the foundation for all linked lists in the library system.
#define layer
VecBase< float, D > step(VecOp< float, D >, VecOp< float, D >) RET
float3x3 scale(float3x3 mat, float2 scale)
BLI_INLINE Texture * wrap(MTLTexture *texture)
BMesh Iterators.
@ BEZT_KEYTYPE_KEYFRAME
@ GP_LAYER_TREE_NODE_HIDE_ONION_SKINNING
@ GP_LAYER_TREE_NODE_DISABLE_MASKS_IN_VIEWLAYER
@ GP_LAYER_TREE_NODE_IGNORE_LOCKED_MATERIALS
__int64 int64_t
Definition BKE_text.h:90
@ GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME
@ GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD
@ GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER
@ GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME
@ GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN
unsigned short uint16_t
Definition BKE_text.h:80
unsigned int uint32_t
Definition BKE_text.h:81
unsigned char uint8_t
Definition BKE_text.h:79
ATTR_WARN_UNUSED_RESULT const size_t num
signed char int8_t
Definition BKE_text.h:76
signed short int16_t
Definition BKE_text.h:77
bke::greasepencil::DrawingRuntime * runtime
GreasePencilLayerFramesMapStorageFlag flag
struct GreasePencilLayerMask * next
struct GreasePencilLayerMask * prev
bke::greasepencil::LayerGroupRuntime * runtime
ListBaseT< GreasePencilLayerTreeNode > children
struct GreasePencilLayerTreeNode * next
struct GreasePencilLayerTreeNode * prev
struct GreasePencilLayerTreeGroup * parent
GreasePencilLayerTreeNode base
ListBaseT< GreasePencilLayerMask > masks
GreasePencilLayerFramesMapStorage frames_storage
bke::greasepencil::LayerRuntime * runtime
GreasePencilLayerBlendMode blend_mode
struct AttributeStorage attribute_storage
struct Material ** material_array
GreasePencilOnionSkinningSettings onion_skinning_settings
GreasePencilDrawingBase ** drawing_array
GreasePencilLayerTreeNode * active_node
ListBaseT< bDeformGroup > vertex_group_names
bke::GreasePencilRuntime * runtime
GreasePencilLayerTreeGroup * root_group_ptr