DNA_grease_pencil_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_attribute_types.h"
#include "DNA_curve_types.h"
#include "DNA_curves_types.h"
#include "DNA_listBase.h"
 
#ifdef __cplusplus
#  include "BLI_bounds_types.hh"
#  include "BLI_function_ref.hh"
#  include "BLI_index_mask_fwd.hh"
#  include "BLI_map.hh"
#  include "BLI_math_vector_types.hh"
#  include "BLI_memory_counter_fwd.hh"
#  include "BLI_span.hh"
namespace blender::bke {
class AttributeAccessor;
class MutableAttributeAccessor;
class GreasePencilRuntime;
class GreasePencilDrawingRuntime;
namespace greasepencil {
class DrawingRuntime;
class Drawing;
class DrawingReference;
class TreeNode;
class Layer;
class LayerRuntime;
class LayerGroup;
class LayerGroupRuntime;
}  // namespace greasepencil
}  // namespace blender::bke
using GreasePencilRuntimeHandle = blender::bke::GreasePencilRuntime;
using GreasePencilDrawingRuntimeHandle = blender::bke::greasepencil::DrawingRuntime;
using GreasePencilLayerRuntimeHandle = blender::bke::greasepencil::LayerRuntime;
using GreasePencilLayerGroupRuntimeHandle = blender::bke::greasepencil::LayerGroupRuntime;
#else
typedef struct GreasePencilRuntimeHandle GreasePencilRuntimeHandle;
typedef struct GreasePencilDrawingRuntimeHandle GreasePencilDrawingRuntimeHandle;
typedef struct GreasePencilLayerRuntimeHandle GreasePencilLayerRuntimeHandle;
typedef struct GreasePencilLayerGroupRuntimeHandle GreasePencilLayerGroupRuntimeHandle;
#endif
 
struct Main;
struct GreasePencil;
struct Object;
 
typedef enum GreasePencilStrokeCapType {
  GP_STROKE_CAP_TYPE_ROUND = 0,
  GP_STROKE_CAP_TYPE_FLAT = 1,
  /* Keep last. */
  GP_STROKE_CAP_TYPE_MAX,
} GreasePencilStrokeCapType;

typedef enum GreasePencilDrawingType {
  GP_DRAWING = 0,
  GP_DRAWING_REFERENCE = 1,
} GreasePencilDrawingType;

typedef enum GreasePencilDrawingBaseFlag {
  /* TODO */
  GreasePencilDrawingBaseFlag_TODO
} GreasePencilDrawingBaseFlag;

typedef struct GreasePencilDrawingBase {
  int8_t type;
  char _pad[3];
  uint32_t flag;
} GreasePencilDrawingBase;

typedef struct GreasePencilDrawing {
  GreasePencilDrawingBase base;
  CurvesGeometry geometry;
  GreasePencilDrawingRuntimeHandle *runtime;
#ifdef __cplusplus
  blender::bke::greasepencil::Drawing &wrap();
  const blender::bke::greasepencil::Drawing &wrap() const;
#endif
} GreasePencilDrawing;
 
typedef struct GreasePencilDrawingReference {
  GreasePencilDrawingBase base;
  struct GreasePencil *id_reference;
#ifdef __cplusplus
  blender::bke::greasepencil::DrawingReference &wrap();
  const blender::bke::greasepencil::DrawingReference &wrap() const;
#endif
} GreasePencilDrawingReference;

typedef enum GreasePencilFrameFlag {
  GP_FRAME_SELECTED = (1 << 0),
  /* When set, the frame is implicitly held until the next frame. E.g. it doesn't have a fixed
   * duration. */
  GP_FRAME_IMPLICIT_HOLD = (1 << 1),
} GreasePencilFrameFlag;

typedef struct GreasePencilFrame {
  int drawing_index;
  uint32_t flag;
  int8_t type;
  char _pad[3];
#ifdef __cplusplus
  static GreasePencilFrame end();
  bool is_end() const;
  bool is_implicit_hold() const;
  bool is_selected() const;
#endif
} GreasePencilFrame;
 
typedef enum GreasePencilLayerFramesMapStorageFlag {
  GP_LAYER_FRAMES_STORAGE_DIRTY = (1 << 0),
} GreasePencilLayerFramesMapStorageFlag;

typedef struct GreasePencilLayerFramesMapStorage {
  /* Array of `frames` keys (sorted in ascending order). */
  int *keys;
  /* Array of `frames` values (order matches the keys array). */
  GreasePencilFrame *values;
  /* Size of the map (number of key-value pairs). */
  int num;
  /* Flag for the status of the storage. */
  int flag;
} GreasePencilLayerFramesMapStorage;

typedef enum GreasePencilLayerMaskFlag {
  GP_LAYER_MASK_HIDE = (1 << 0),
  GP_LAYER_MASK_INVERT = (1 << 1),
} GreasePencilLayerMaskFlag;

typedef struct GreasePencilLayerMask {
  struct GreasePencilLayerMask *next, *prev;
  char *layer_name;
  uint16_t flag;
  char _pad[6];
} GreasePencilLayerMask;

typedef enum GreasePencilLayerBlendMode {
  GP_LAYER_BLEND_NONE = 0,
  GP_LAYER_BLEND_HARDLIGHT = 1,
  GP_LAYER_BLEND_ADD = 2,
  GP_LAYER_BLEND_SUBTRACT = 3,
  GP_LAYER_BLEND_MULTIPLY = 4,
  GP_LAYER_BLEND_DIVIDE = 5,
} GreasePencilLayerBlendMode;

typedef enum GreasePencilLayerTreeNodeType {
  GP_LAYER_TREE_LEAF = 0,
  GP_LAYER_TREE_GROUP = 1,
} GreasePencilLayerTreeNodeType;

typedef enum GreasePencilLayerTreeNodeFlag {
  GP_LAYER_TREE_NODE_HIDE = (1 << 0),
  GP_LAYER_TREE_NODE_LOCKED = (1 << 1),
  GP_LAYER_TREE_NODE_SELECT = (1 << 2),
  GP_LAYER_TREE_NODE_MUTE = (1 << 3),
  GP_LAYER_TREE_NODE_USE_LIGHTS = (1 << 4),
  GP_LAYER_TREE_NODE_HIDE_ONION_SKINNING = (1 << 5),
  GP_LAYER_TREE_NODE_EXPANDED = (1 << 6),
  GP_LAYER_TREE_NODE_HIDE_MASKS = (1 << 7),
  GP_LAYER_TREE_NODE_DISABLE_MASKS_IN_VIEWLAYER = (1 << 8),
  GP_LAYER_TREE_NODE_IGNORE_LOCKED_MATERIALS = (1 << 9),
} GreasePencilLayerTreeNodeFlag;
 
struct GreasePencilLayerTreeGroup;
typedef struct GreasePencilLayerTreeNode {
  /* ListBase pointers. */
  struct GreasePencilLayerTreeNode *next, *prev;
  /* Parent pointer. Can be null. */
  struct GreasePencilLayerTreeGroup *parent;
  char *name;
  int8_t type;
  char _pad[7];
  float color[3];
  uint32_t flag;
#ifdef __cplusplus
  blender::bke::greasepencil::TreeNode &wrap();
  const blender::bke::greasepencil::TreeNode &wrap() const;
#endif
} GreasePencilLayerTreeNode;

typedef struct GreasePencilLayer {
  GreasePencilLayerTreeNode base;
  /* Only used for storage in the .blend file. */
  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], rotation[3], scale[3];
  char _pad3[4];
  char *viewlayername;
  GreasePencilLayerRuntimeHandle *runtime;
#ifdef __cplusplus
  blender::bke::greasepencil::Layer &wrap();
  const blender::bke::greasepencil::Layer &wrap() const;
#endif
} GreasePencilLayer;
 
typedef enum GroupColorTag {
  LAYERGROUP_COLOR_NONE = -1,
  LAYERGROUP_COLOR_01,
  LAYERGROUP_COLOR_02,
  LAYERGROUP_COLOR_03,
  LAYERGROUP_COLOR_04,
  LAYERGROUP_COLOR_05,
  LAYERGROUP_COLOR_06,
  LAYERGROUP_COLOR_07,
  LAYERGROUP_COLOR_08,
} GroupColorTag;
 
typedef struct GreasePencilLayerTreeGroup {
  GreasePencilLayerTreeNode base;
  ListBase children;
  int8_t color_tag;
  char _pad[7];
  GreasePencilLayerGroupRuntimeHandle *runtime;
#ifdef __cplusplus
  blender::bke::greasepencil::LayerGroup &wrap();
  const blender::bke::greasepencil::LayerGroup &wrap() const;
#endif
} GreasePencilLayerTreeGroup;

typedef enum GreasePencilFlag {
  GREASE_PENCIL_ANIM_CHANNEL_EXPANDED = (1 << 0),
  GREASE_PENCIL_AUTOLOCK_LAYERS = (1 << 1),
  GREASE_PENCIL_STROKE_ORDER_3D = (1 << 2),
} GreasePencilFlag;

typedef enum GreasePencilOnionSkinningMode {
  GP_ONION_SKINNING_MODE_ABSOLUTE = 0,
  GP_ONION_SKINNING_MODE_RELATIVE = 1,
  GP_ONION_SKINNING_MODE_SELECTED = 2,
} GreasePencilOnionSkinningMode;
 
typedef enum GreasePencilOnionSkinningFlag {
  /* Use custom colors (per object-data) for onion skinning. */
  GP_ONION_SKINNING_USE_CUSTOM_COLORS = (1 << 0),
  /* Fade the opacity of ghost frames further away from the current frame. */
  GP_ONION_SKINNING_USE_FADE = (1 << 1),
  /* Show looping frames in onion skinning. */
  GP_ONION_SKINNING_SHOW_LOOP = (1 << 2),
} GreasePencilOnionSkinningFlag;

typedef enum GreasePencilOnionSkinningFilter {
  GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME = (1 << 0),
  GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME = (1 << 1),
  GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN = (1 << 2),
  GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER = (1 << 3),
  GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD = (1 << 4),
} GreasePencilOnionSkinningFilter;
 
#define GREASE_PENCIL_ONION_SKINNING_FILTER_ALL \
  (GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME | GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME | \
   GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN | GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER | \
   GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD)

typedef struct GreasePencilOnionSkinningSettings {
  float opacity;
  /* #GreasePencilOnionSkinningMode. */
  int8_t mode;
  /* #GreasePencilOnionSkinningFlag. */
  uint8_t flag;
  /* #GreasePencilOnionSkinningFilter. */
  uint8_t filter;
  char _pad[1];
  int16_t num_frames_before;
  int16_t num_frames_after;
  float color_before[3];
  float color_after[3];
  char _pad2[4];
} GreasePencilOnionSkinningSettings;

typedef struct GreasePencil {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_GP;
#endif
 
  ID id;
  struct AnimData *adt;

  GreasePencilDrawingBase **drawing_array;
  int drawing_array_num;
  char _pad[4];
 
  /* Root group of the layer tree. */
  GreasePencilLayerTreeGroup *root_group_ptr;

  CustomData layers_data;

  struct AttributeStorage attribute_storage;

  int attributes_active_index;
  char _pad2[4];

  GreasePencilLayerTreeNode *active_node;

  struct Material **material_array;
  short material_array_num;
  char _pad3[2];
  uint32_t flag;
 
  ListBase vertex_group_names;
  int vertex_group_active_index;
  char _pad4[4];

  GreasePencilOnionSkinningSettings onion_skinning_settings;
  GreasePencilRuntimeHandle *runtime;
#ifdef __cplusplus
  /* Root group. */
  const blender::bke::greasepencil::LayerGroup &root_group() const;
  blender::bke::greasepencil::LayerGroup &root_group();
 
  /* Drawings read/write access. */
  blender::Span<const GreasePencilDrawingBase *> drawings() const;
  blender::MutableSpan<GreasePencilDrawingBase *> drawings();
  const GreasePencilDrawingBase *drawing(int64_t index) const;
  GreasePencilDrawingBase *drawing(int64_t index);
 
  /* Layers, layer groups and nodes read/write access. */
  blender::Span<const blender::bke::greasepencil::Layer *> layers() const;
  blender::Span<blender::bke::greasepencil::Layer *> layers_for_write();
  const blender::bke::greasepencil::Layer &layer(int64_t index) const;
  blender::bke::greasepencil::Layer &layer(int64_t index);
 
  blender::Span<const blender::bke::greasepencil::LayerGroup *> layer_groups() const;
  blender::Span<blender::bke::greasepencil::LayerGroup *> layer_groups_for_write();
 
  blender::Span<const blender::bke::greasepencil::TreeNode *> nodes() const;
  blender::Span<blender::bke::greasepencil::TreeNode *> nodes_for_write();
 
  /* Return the index of the layer if it's found, otherwise `std::nullopt`. */
  std::optional<int> get_layer_index(const blender::bke::greasepencil::Layer &layer) const;
 
  /* Active layer functions. */
  bool has_active_layer() const;
  const blender::bke::greasepencil::Layer *get_active_layer() const;
  blender::bke::greasepencil::Layer *get_active_layer();
  void set_active_layer(blender::bke::greasepencil::Layer *layer);
  bool is_layer_active(const blender::bke::greasepencil::Layer *layer) const;
  void autolock_inactive_layers();
 
  /* Active group functions. */
  bool has_active_group() const;
  const blender::bke::greasepencil::LayerGroup *get_active_group() const;
  blender::bke::greasepencil::LayerGroup *get_active_group();
 
  /* Active node functions. */
  const blender::bke::greasepencil::TreeNode *get_active_node() const;
  blender::bke::greasepencil::TreeNode *get_active_node();
  void set_active_node(blender::bke::greasepencil::TreeNode *node);
 
  /* Adding layers and layer groups. */
  blender::bke::greasepencil::Layer &add_layer(blender::StringRef name,
                                               bool check_name_is_unique = true);
  blender::bke::greasepencil::Layer &add_layer(
      blender::bke::greasepencil::LayerGroup &parent_group,
      blender::StringRef name,
      bool check_name_is_unique = true);
  blender::bke::greasepencil::Layer &duplicate_layer(
      const blender::bke::greasepencil::Layer &duplicate_layer);
  blender::bke::greasepencil::Layer &duplicate_layer(
      blender::bke::greasepencil::LayerGroup &parent_group,
      const blender::bke::greasepencil::Layer &duplicate_layer);
  blender::bke::greasepencil::LayerGroup &add_layer_group(blender::StringRef name,
                                                          bool check_name_is_unique = true);
  blender::bke::greasepencil::LayerGroup &add_layer_group(
      blender::bke::greasepencil::LayerGroup &parent_group,
      blender::StringRef name,
      bool check_name_is_unique = true);

  void add_layers_for_eval(int num_new_layers);
 
  /* Moving nodes. */
  void move_node_up(blender::bke::greasepencil::TreeNode &node, int step = 1);
  void move_node_down(blender::bke::greasepencil::TreeNode &node, int step = 1);
  void move_node_top(blender::bke::greasepencil::TreeNode &node);
  void move_node_bottom(blender::bke::greasepencil::TreeNode &node);
 
  void move_node_after(blender::bke::greasepencil::TreeNode &node,
                       blender::bke::greasepencil::TreeNode &target_node);
  void move_node_before(blender::bke::greasepencil::TreeNode &node,
                        blender::bke::greasepencil::TreeNode &target_node);
  void move_node_into(blender::bke::greasepencil::TreeNode &node,
                      blender::bke::greasepencil::LayerGroup &parent_group);
 
  /* Search functions. */
  const blender::bke::greasepencil::TreeNode *find_node_by_name(blender::StringRef name) const;
  blender::bke::greasepencil::TreeNode *find_node_by_name(blender::StringRef name);
  blender::IndexMask layer_selection_by_name(blender::StringRef name,
                                             blender::IndexMaskMemory &memory) const;
 
  void rename_node(Main &bmain,
                   blender::bke::greasepencil::TreeNode &node,
                   blender::StringRef new_name);
 
  void remove_layer(blender::bke::greasepencil::Layer &layer);
  void remove_group(blender::bke::greasepencil::LayerGroup &group, bool keep_children = false);
 
  std::string unique_layer_name(blender::StringRef name);
 
  /* Frames API functions. */

  blender::bke::greasepencil::Drawing *insert_frame(
      blender::bke::greasepencil::Layer &layer,
      int frame_number,
      int duration = 0,
      eBezTriple_KeyframeType keytype = BEZT_KEYTYPE_KEYFRAME);

  void insert_frames(blender::Span<blender::bke::greasepencil::Layer *> layers,
                     int frame_number,
                     int duration = 0,
                     eBezTriple_KeyframeType keytype = BEZT_KEYTYPE_KEYFRAME);
  bool remove_frames(blender::bke::greasepencil::Layer &layer, blender::Span<int> frame_numbers);
 
  void copy_frames_from_layer(blender::bke::greasepencil::Layer &dst_layer,
                              const GreasePencil &src_grease_pencil,
                              const blender::bke::greasepencil::Layer &src_layer,
                              const std::optional<int> frame_select = std::nullopt);
  void add_layers_with_empty_drawings_for_eval(int num);

  void resize_drawings(int new_num);
  void add_empty_drawings(int add_num);
  void add_duplicate_drawings(int duplicate_num,
                              const blender::bke::greasepencil::Drawing &drawing);
  bool insert_duplicate_frame(blender::bke::greasepencil::Layer &layer,
                              int src_frame_number,
                              int dst_frame_number,
                              bool do_instance);

  void move_frames(blender::bke::greasepencil::Layer &layer,
                   const blender::Map<int, int> &frame_number_destinations);

  void move_duplicate_frames(blender::bke::greasepencil::Layer &layer,
                             const blender::Map<int, int> &frame_number_destinations,
                             const blender::Map<int, GreasePencilFrame> &duplicate_frames);

  void remove_drawings_with_no_users();
  void update_drawing_users_for_layer(const blender::bke::greasepencil::Layer &layer);

  const blender::bke::greasepencil::Drawing *get_drawing_at(
      const blender::bke::greasepencil::Layer &layer, int frame_number) const;
  blender::bke::greasepencil::Drawing *get_drawing_at(
      const blender::bke::greasepencil::Layer &layer, int frame_number);
  blender::bke::greasepencil::Drawing *get_editable_drawing_at(
      const blender::bke::greasepencil::Layer &layer, int frame_number);

  const blender::bke::greasepencil::Drawing *get_eval_drawing(
      const blender::bke::greasepencil::Layer &layer) const;
  blender::bke::greasepencil::Drawing *get_eval_drawing(
      const blender::bke::greasepencil::Layer &layer);
 
  std::optional<blender::Bounds<blender::float3>> bounds_min_max(int frame,
                                                                 bool use_radius = true) const;
  std::optional<blender::Bounds<blender::float3>> bounds_min_max_eval(
      bool use_radius = true) const;
 
  blender::bke::AttributeAccessor attributes() const;
  blender::bke::MutableAttributeAccessor attributes_for_write();

  std::optional<int> material_index_max() const;
 
  void count_memory(blender::MemoryCounter &memory) const;
 
  /* For debugging purposes. */
  void print_layer_tree();
#endif
} GreasePencil;