626242c1a8d8ce3891d767ec95e7929b8da36de8
[blender.git] / source / blender / makesdna / DNA_mask_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2012 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Blender Foundation,
24  *                 Sergey Sharybin
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file DNA_mask_types.h
30  *  \ingroup DNA
31  *  \since march-2012
32  *  \author Sergey Sharybin
33  */
34
35 #ifndef __DNA_MASK_TYPES_H__
36 #define __DNA_MASK_TYPES_H__
37
38 #include "DNA_defs.h"
39 #include "DNA_ID.h"
40 #include "DNA_listBase.h"
41 #include "DNA_curve_types.h"
42
43 typedef struct Mask {
44         ID id;
45         struct AnimData *adt;
46         ListBase masklayers;  /* mask layers */
47         int masklay_act;      /* index of active mask layer (-1 == None) */
48         int masklay_tot;      /* total number of mask layers */
49
50         int sfra, efra;       /* frames, used by the sequencer */
51 } Mask;
52
53 typedef struct MaskParent {
54         int flag;             /* parenting flags */
55         int id_type;          /* type of parenting */
56         ID *id;               /* ID block of entity to which mask/spline is parented to
57                                * in case of parenting to movie tracking data set to MovieClip datablock */
58         char parent[64];      /* entity of parent to which parenting happened
59                                * in case of parenting to movie tracking data contains name of layer */
60         char sub_parent[64];  /* sub-entity of parent to which parenting happened
61                                * in case of parenting to movie tracking data contains name of track */
62         float parent_orig[2]; /* track location at the moment of parenting */
63 } MaskParent;
64
65 typedef struct MaskSplinePointUW {
66         float u, w;            /* u coordinate along spline segment and weight of this point */
67         int flag;              /* different flags of this point */
68 } MaskSplinePointUW;
69
70 typedef struct MaskSplinePoint {
71         BezTriple bezt;        /* actual point coordinates and it's handles  */
72         int pad;
73         int tot_uw;            /* number of uv feather values */
74         MaskSplinePointUW *uw; /* feather UV values */
75         MaskParent parent;     /* parenting information of particular spline point */
76 } MaskSplinePoint;
77
78 typedef struct MaskSpline {
79         struct MaskSpline *next, *prev;
80
81         int flag;                /* defferent spline flag (closed, ...) */
82         int tot_point;           /* total number of points */
83         MaskSplinePoint *points; /* points which defines spline itself */
84         MaskParent parent;       /* parenting information of the whole spline */
85
86         int weight_interp, pad;  /* weight interpolation */
87
88         MaskSplinePoint *points_deform; /* deformed copy of 'points' BezTriple data - not saved */
89 } MaskSpline;
90
91 /* one per frame */
92 typedef struct MaskLayerShape {
93         struct MaskLayerShape *next, *prev;
94
95         float *data;             /* u coordinate along spline segment and weight of this point */
96         int    tot_vert;         /* to ensure no buffer overruns's: alloc size is (tot_vert * MASK_OBJECT_SHAPE_ELEM_SIZE) */
97         int    frame;            /* different flags of this point */
98         char   flag;
99         char   pad[7];
100 } MaskLayerShape;
101
102 /* cast to this for convenience, not saved */
103 #define MASK_OBJECT_SHAPE_ELEM_SIZE 8 /* 3x 2D points + weight + radius == 8 */
104
105 #
106 #
107 typedef struct MaskLayerShapeElem {
108         float value[MASK_OBJECT_SHAPE_ELEM_SIZE];
109 } MaskLayerShapeElem;
110
111 typedef struct MaskLayer {
112         struct MaskLayer *next, *prev;
113
114         char name[64];                     /* name of the mask layer (64 = MAD_ID_NAME - 2) */
115
116         ListBase splines;                  /* list of splines which defines this mask layer */
117         ListBase splines_shapes;
118
119         struct MaskSpline *act_spline;     /* active spline */
120         struct MaskSplinePoint *act_point; /* active point */
121
122         /* blending options */
123         float  alpha;
124         char   blend;
125         char   blend_flag;
126
127         //char   flag;             /* not used yet */
128         char   restrictflag;     /* matching 'Object' flag of the same name - eventually use in the outliner  */
129         char   pad[1];
130 } MaskLayer;
131
132 /* MaskParent->flag */
133 #define MASK_PARENT_ACTIVE  (1 << 0)
134
135 /* MaskSpline->flag */
136 /* reserve (1 << 0) for SELECT */
137 #define MASK_SPLINE_CYCLIC  (1 << 1)
138
139 /* MaskSpline->weight_interp */
140 #define MASK_SPLINE_INTERP_LINEAR   1
141 #define MASK_SPLINE_INTERP_EASE     2
142
143 /* ob->restrictflag */
144 #define MASK_RESTRICT_VIEW      1
145 #define MASK_RESTRICT_SELECT    2
146 #define MASK_RESTRICT_RENDER    4
147
148 /* SpaceClip->mask_draw_flag */
149 #define MASK_DRAWFLAG_SMOOTH    1
150
151 /* copy of eSpaceImage_UVDT */
152 /* SpaceClip->mask_draw_type */
153 enum {
154         MASK_DT_OUTLINE = 0,
155         MASK_DT_DASH,
156         MASK_DT_BLACK,
157         MASK_DT_WHITE
158 };
159
160 /* masklay->blend */
161 enum {
162         MASK_BLEND_ADD      = 0,
163         MASK_BLEND_SUBTRACT = 1
164 };
165
166 /* masklay->blend_flag */
167 enum {
168         MASK_BLENDFLAG_INVERT = (1 << 0)
169 };
170
171 #endif // __DNA_MASK_TYPES_H__