DNA_mask_types.h

Go to the documentation of this file.

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

 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_curve_types.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
 
typedef struct Mask_Runtime {
  /* The Depsgraph::update_count when this ID was last updated. Covers any IDRecalcFlag. */
  uint64_t last_update;
} Mask_Runtime;
 
typedef struct Mask {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_MSK;
#endif
 
  ID id;
  struct AnimData *adt;
  ListBase masklayers;
  int masklay_act;
  int masklay_tot;

  int sfra, efra;

  int flag;
  char _pad[4];
 
  Mask_Runtime runtime;
} Mask;
 
typedef struct MaskParent {
  //* /* Parenting flags */ /* not used. */
  // int flag;
  int id_type;
  int type;
  ID *id;
  char parent[64];
  char sub_parent[64];
  float parent_orig[2];

  float parent_corners_orig[4][2];
} MaskParent;
 
typedef struct MaskSplinePointUW {
  float u, w;
  int flag;
} MaskSplinePointUW;
 
typedef struct MaskSplinePoint {
  BezTriple bezt;
  char _pad[4];
  int tot_uw;
  MaskSplinePointUW *uw;
  MaskParent parent;
} MaskSplinePoint;
 
typedef struct MaskSpline {
  struct MaskSpline *next, *prev;

  short flag;
  char offset_mode;
  char weight_interp;

  int tot_point;
  MaskSplinePoint *points;
  MaskParent parent;

  MaskSplinePoint *points_deform;
} MaskSpline;
 
/* one per frame */
typedef struct MaskLayerShape {
  struct MaskLayerShape *next, *prev;

  float *data;
  int tot_vert;
  int frame;
  char flag;
  char _pad[7];
} MaskLayerShape;
 
/* cast to this for convenience, not saved */
#define MASK_OBJECT_SHAPE_ELEM_SIZE 8 /* 3x 2D points + weight + radius == 8 */
 
#
#
typedef struct MaskLayerShapeElem {
  float value[MASK_OBJECT_SHAPE_ELEM_SIZE];
} MaskLayerShapeElem;
 
typedef struct MaskLayer {
  struct MaskLayer *next, *prev;

  char name[/*MAX_NAME*/ 64];

  ListBase splines;
  ListBase splines_shapes;

  struct MaskSpline *act_spline;
  struct MaskSplinePoint *act_point;
 
  /* blending options */
  float alpha;
  char blend;
  char blend_flag;
  char falloff;
  char _pad[7];

  char flag;
  char visibility_flag;
} MaskLayer;
 
// /** #MaskParent::flag */
// enum {
//   MASK_PARENT_ACTIVE = 1 << 0, /* UNUSED. */
// };
 
/* MaskParent->type */
enum {
  MASK_PARENT_POINT_TRACK = 0, /* parenting happens to point track */
  MASK_PARENT_PLANE_TRACK = 1, /* parenting happens to plane track */
};
 
/* MaskSpline->flag */
/* reserve (1 << 0) for SELECT */
enum {
  MASK_SPLINE_CYCLIC = (1 << 1),
  MASK_SPLINE_NOFILL = (1 << 2),
  MASK_SPLINE_NOINTERSECT = (1 << 3),
};
 
/* MaskSpline->weight_interp */
enum {
  MASK_SPLINE_INTERP_LINEAR = 1,
  MASK_SPLINE_INTERP_EASE = 2,
};
 
/* MaskSpline->offset_mode */
enum {
  MASK_SPLINE_OFFSET_EVEN = 0,
  MASK_SPLINE_OFFSET_SMOOTH = 1,
};
 
/* MaskLayer->visibility_flag */
enum {
  MASK_HIDE_VIEW = 1 << 0,
  MASK_HIDE_SELECT = 1 << 1,
  MASK_HIDE_RENDER = 1 << 2,
};
 
/* SpaceClip->mask_draw_flag */
enum {
  MASK_DRAWFLAG_SMOOTH_DEPRECATED = 1 << 0, /* Deprecated. */
  MASK_DRAWFLAG_OVERLAY = 1 << 1,
  MASK_DRAWFLAG_SPLINE = 1 << 2,
};
 
/* copy of eSpaceImage_UVDT */
/* SpaceClip->mask_draw_type */
enum {
  MASK_DT_OUTLINE = 0,
  MASK_DT_DASH = 1,
  MASK_DT_BLACK = 2,
  MASK_DT_WHITE = 3,
};
 
/* MaskSpaceInfo->overlay_mode */
typedef enum eMaskOverlayMode {
  MASK_OVERLAY_ALPHACHANNEL = 0,
  MASK_OVERLAY_COMBINED = 1,
} eMaskOverlayMode;
 
/* masklay->blend */
enum {
  MASK_BLEND_ADD = 0,
  MASK_BLEND_SUBTRACT = 1,
  MASK_BLEND_LIGHTEN = 2,
  MASK_BLEND_DARKEN = 3,
  MASK_BLEND_MUL = 4,
  MASK_BLEND_REPLACE = 5,
  MASK_BLEND_DIFFERENCE = 6,
  MASK_BLEND_MERGE_ADD = 7,
  MASK_BLEND_MERGE_SUBTRACT = 8,
};
 
/* masklay->blend_flag */
enum {
  MASK_BLENDFLAG_INVERT = (1 << 0),
};
 
/* masklay->flag */
enum {
  MASK_LAYERFLAG_LOCKED = (1 << 4),
  MASK_LAYERFLAG_SELECT = (1 << 5),
 
  /* no holes */
  MASK_LAYERFLAG_FILL_DISCRETE = (1 << 6),
  MASK_LAYERFLAG_FILL_OVERLAP = (1 << 7),
};
 
/* masklay_shape->flag */
enum {
  MASK_SHAPE_SELECT = (1 << 0),
};
 
/* mask->flag */
enum {
  MASK_ANIMF_EXPAND = (1 << 4),
};