Preferences: remove author field
[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  * Mask data-blocks are collections of 2D curves to be used
35  * for image masking in the compositor and sequencer.
36  */
37
38 #ifndef __DNA_MASK_TYPES_H__
39 #define __DNA_MASK_TYPES_H__
40
41 #include "DNA_defs.h"
42 #include "DNA_ID.h"
43 #include "DNA_listBase.h"
44 #include "DNA_curve_types.h"
45
46 typedef struct Mask {
47         ID id;
48         struct AnimData *adt;
49         /** Mask layers. */
50         ListBase masklayers;
51         /** Index of active mask layer (-1 == None). */
52         int masklay_act;
53         /** Total number of mask layers. */
54         int masklay_tot;
55
56         /** Frames, used by the sequencer. */
57         int sfra, efra;
58
59         /** For anim info. */
60         int flag;
61         int pad;
62 } Mask;
63
64 typedef struct MaskParent {
65         //* /* Parenting flags */ /* not used. */
66         // int flag;
67         /** Type of parenting. */
68         int id_type;
69         /** Type of parenting. */
70         int type;
71         /**
72          * ID block of entity to which mask/spline is parented to
73          * in case of parenting to movie tracking data set to MovieClip datablock.
74          */
75         ID *id;
76         /**
77          * Entity of parent to which parenting happened
78          * in case of parenting to movie tracking data contains name of layer.
79          */
80         char parent[64];
81         /**
82          * Sub-entity of parent to which parenting happened
83          * in case of parenting to movie tracking data contains name of track.
84          */
85         char sub_parent[64];
86         /**
87          * Track location at the moment of parenting,
88          * stored in mask space.
89          */
90         float parent_orig[2];
91
92         /** Original corners of plane track at the moment of parenting. */
93         float parent_corners_orig[4][2];
94 } MaskParent;
95
96 typedef struct MaskSplinePointUW {
97         /** U coordinate along spline segment and weight of this point. */
98         float u, w;
99         /** Different flags of this point. */
100         int flag;
101 } MaskSplinePointUW;
102
103 typedef struct MaskSplinePoint {
104         /** Actual point coordinates and it's handles . */
105         BezTriple bezt;
106         int pad;
107         /** Number of uv feather values. */
108         int tot_uw;
109         /** Feather UV values. */
110         MaskSplinePointUW *uw;
111         /** Parenting information of particular spline point. */
112         MaskParent parent;
113 } MaskSplinePoint;
114
115 typedef struct MaskSpline {
116         struct MaskSpline *next, *prev;
117
118         /** Different spline flag (closed, ...). */
119         short flag;
120         /** Feather offset method. */
121         char offset_mode;
122         /** Weight interpolation. */
123         char weight_interp;
124
125         /** Total number of points. */
126         int tot_point;
127         /** Points which defines spline itself. */
128         MaskSplinePoint *points;
129         /** Parenting information of the whole spline. */
130         MaskParent parent;
131
132         /** Deformed copy of 'points' BezTriple data - not saved. */
133         MaskSplinePoint *points_deform;
134 } MaskSpline;
135
136 /* one per frame */
137 typedef struct MaskLayerShape {
138         struct MaskLayerShape *next, *prev;
139
140         /** U coordinate along spline segment and weight of this point. */
141         float *data;
142         /** To ensure no buffer overruns's: alloc size is (tot_vert * MASK_OBJECT_SHAPE_ELEM_SIZE). */
143         int    tot_vert;
144         /** Different flags of this point. */
145         int    frame;
146         /** Animation flag. */
147         char   flag;
148         char   pad[7];
149 } MaskLayerShape;
150
151 /* cast to this for convenience, not saved */
152 #define MASK_OBJECT_SHAPE_ELEM_SIZE 8 /* 3x 2D points + weight + radius == 8 */
153
154 #
155 #
156 typedef struct MaskLayerShapeElem {
157         float value[MASK_OBJECT_SHAPE_ELEM_SIZE];
158 } MaskLayerShapeElem;
159
160 typedef struct MaskLayer {
161         struct MaskLayer *next, *prev;
162
163         /** Name of the mask layer (64 = MAD_ID_NAME - 2). */
164         char name[64];
165
166         /** List of splines which defines this mask layer. */
167         ListBase splines;
168         ListBase splines_shapes;
169
170         /** Active spline. */
171         struct MaskSpline *act_spline;
172         /** Active point. */
173         struct MaskSplinePoint *act_point;
174
175         /* blending options */
176         float  alpha;
177         char   blend;
178         char   blend_flag;
179         char   falloff;
180         char   pad[7];
181
182         /** For animation. */
183         char   flag;
184         /** Matching 'Object' flag of the same name - eventually use in the outliner . */
185         char   restrictflag;
186 } MaskLayer;
187
188 /* MaskParent->flag */
189 /* #define MASK_PARENT_ACTIVE  (1 << 0) */ /* UNUSED */
190
191 /* MaskParent->type */
192 enum {
193         MASK_PARENT_POINT_TRACK = 0, /* parenting happens to point track */
194         MASK_PARENT_PLANE_TRACK = 1, /* parenting happens to plane track */
195 };
196
197 /* MaskSpline->flag */
198 /* reserve (1 << 0) for SELECT */
199 enum {
200         MASK_SPLINE_CYCLIC  = (1 << 1),
201         MASK_SPLINE_NOFILL  = (1 << 2),
202         MASK_SPLINE_NOINTERSECT = (1 << 3)
203 };
204
205 /* MaskSpline->weight_interp */
206 enum {
207         MASK_SPLINE_INTERP_LINEAR  = 1,
208         MASK_SPLINE_INTERP_EASE    = 2
209 };
210
211 /* MaskSpline->offset_mode */
212 enum {
213         MASK_SPLINE_OFFSET_EVEN   = 0,
214         MASK_SPLINE_OFFSET_SMOOTH = 1
215 };
216
217
218 /* ob->restrictflag */
219 #define MASK_RESTRICT_VIEW      (1 << 0)
220 #define MASK_RESTRICT_SELECT    (1 << 1)
221 #define MASK_RESTRICT_RENDER    (1 << 2)
222
223 /* SpaceClip->mask_draw_flag */
224 #define MASK_DRAWFLAG_SMOOTH    (1 << 0)
225 #define MASK_DRAWFLAG_OVERLAY   (1 << 1)
226
227 /* copy of eSpaceImage_UVDT */
228 /* SpaceClip->mask_draw_type */
229 enum {
230         MASK_DT_OUTLINE = 0,
231         MASK_DT_DASH    = 1,
232         MASK_DT_BLACK   = 2,
233         MASK_DT_WHITE   = 3
234 };
235
236 /* MaskSpaceInfo->overlay_mode */
237 enum {
238         MASK_OVERLAY_ALPHACHANNEL = 0,
239         MASK_OVERLAY_COMBINED     = 1
240 };
241
242 /* masklay->blend */
243 enum {
244         MASK_BLEND_ADD             = 0,
245         MASK_BLEND_SUBTRACT        = 1,
246         MASK_BLEND_LIGHTEN         = 2,
247         MASK_BLEND_DARKEN          = 3,
248         MASK_BLEND_MUL             = 4,
249         MASK_BLEND_REPLACE         = 5,
250         MASK_BLEND_DIFFERENCE      = 6,
251         MASK_BLEND_MERGE_ADD       = 7,
252         MASK_BLEND_MERGE_SUBTRACT  = 8
253 };
254
255 /* masklay->blend_flag */
256 enum {
257         MASK_BLENDFLAG_INVERT = (1 << 0)
258 };
259
260 /* masklay->flag */
261 enum {
262         MASK_LAYERFLAG_LOCKED = (1 << 4),
263         MASK_LAYERFLAG_SELECT = (1 << 5),
264
265         /* no holes */
266         MASK_LAYERFLAG_FILL_DISCRETE = (1 << 6),
267         MASK_LAYERFLAG_FILL_OVERLAP  = (1 << 7),
268 };
269
270 /* masklay_shape->flag */
271 enum {
272         MASK_SHAPE_SELECT = (1 << 0)
273 };
274
275
276 /* mask->flag */
277 enum {
278         MASK_ANIMF_EXPAND = (1 << 4)
279 };
280
281 #endif  /* __DNA_MASK_TYPES_H__ */