Cleanup: comment line length (editors)
[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         ListBase masklayers;  /* mask layers */
50         int masklay_act;      /* index of active mask layer (-1 == None) */
51         int masklay_tot;      /* total number of mask layers */
52
53         int sfra, efra;       /* frames, used by the sequencer */
54
55         int flag;  /* for anim info */
56         int pad;
57 } Mask;
58
59 typedef struct MaskParent {
60         // int flag;             /* parenting flags */ /* not used */
61         int id_type;          /* type of parenting */
62         int type;             /* type of parenting */
63         ID *id;               /* ID block of entity to which mask/spline is parented to
64                                * in case of parenting to movie tracking data set to MovieClip datablock */
65         char parent[64];      /* entity of parent to which parenting happened
66                                * in case of parenting to movie tracking data contains name of layer */
67         char sub_parent[64];  /* sub-entity of parent to which parenting happened
68                                * in case of parenting to movie tracking data contains name of track */
69         float parent_orig[2]; /* track location at the moment of parenting,
70                                * stored in mask space*/
71
72         float parent_corners_orig[4][2]; /* Original corners of plane track at the moment of parenting */
73 } MaskParent;
74
75 typedef struct MaskSplinePointUW {
76         float u, w;            /* u coordinate along spline segment and weight of this point */
77         int flag;              /* different flags of this point */
78 } MaskSplinePointUW;
79
80 typedef struct MaskSplinePoint {
81         BezTriple bezt;        /* actual point coordinates and it's handles  */
82         int pad;
83         int tot_uw;            /* number of uv feather values */
84         MaskSplinePointUW *uw; /* feather UV values */
85         MaskParent parent;     /* parenting information of particular spline point */
86 } MaskSplinePoint;
87
88 typedef struct MaskSpline {
89         struct MaskSpline *next, *prev;
90
91         short flag;              /* different spline flag (closed, ...) */
92         char offset_mode;        /* feather offset method */
93         char weight_interp;      /* weight interpolation */
94
95         int tot_point;           /* total number of points */
96         MaskSplinePoint *points; /* points which defines spline itself */
97         MaskParent parent;       /* parenting information of the whole spline */
98
99         MaskSplinePoint *points_deform; /* deformed copy of 'points' BezTriple data - not saved */
100 } MaskSpline;
101
102 /* one per frame */
103 typedef struct MaskLayerShape {
104         struct MaskLayerShape *next, *prev;
105
106         float *data;             /* u coordinate along spline segment and weight of this point */
107         int    tot_vert;         /* to ensure no buffer overruns's: alloc size is (tot_vert * MASK_OBJECT_SHAPE_ELEM_SIZE) */
108         int    frame;            /* different flags of this point */
109         char   flag;             /* animation flag */
110         char   pad[7];
111 } MaskLayerShape;
112
113 /* cast to this for convenience, not saved */
114 #define MASK_OBJECT_SHAPE_ELEM_SIZE 8 /* 3x 2D points + weight + radius == 8 */
115
116 #
117 #
118 typedef struct MaskLayerShapeElem {
119         float value[MASK_OBJECT_SHAPE_ELEM_SIZE];
120 } MaskLayerShapeElem;
121
122 typedef struct MaskLayer {
123         struct MaskLayer *next, *prev;
124
125         char name[64];                     /* name of the mask layer (64 = MAD_ID_NAME - 2) */
126
127         ListBase splines;                  /* list of splines which defines this mask layer */
128         ListBase splines_shapes;
129
130         struct MaskSpline *act_spline;     /* active spline */
131         struct MaskSplinePoint *act_point; /* active point */
132
133         /* blending options */
134         float  alpha;
135         char   blend;
136         char   blend_flag;
137         char   falloff;
138         char   pad[7];
139
140         char   flag;             /* for animation */
141         char   restrictflag;     /* matching 'Object' flag of the same name - eventually use in the outliner  */
142 } MaskLayer;
143
144 /* MaskParent->flag */
145 /* #define MASK_PARENT_ACTIVE  (1 << 0) */ /* UNUSED */
146
147 /* MaskParent->type */
148 enum {
149         MASK_PARENT_POINT_TRACK = 0, /* parenting happens to point track */
150         MASK_PARENT_PLANE_TRACK = 1, /* parenting happens to plane track */
151 };
152
153 /* MaskSpline->flag */
154 /* reserve (1 << 0) for SELECT */
155 enum {
156         MASK_SPLINE_CYCLIC  = (1 << 1),
157         MASK_SPLINE_NOFILL  = (1 << 2),
158         MASK_SPLINE_NOINTERSECT = (1 << 3)
159 };
160
161 /* MaskSpline->weight_interp */
162 enum {
163         MASK_SPLINE_INTERP_LINEAR  = 1,
164         MASK_SPLINE_INTERP_EASE    = 2
165 };
166
167 /* MaskSpline->offset_mode */
168 enum {
169         MASK_SPLINE_OFFSET_EVEN   = 0,
170         MASK_SPLINE_OFFSET_SMOOTH = 1
171 };
172
173
174 /* ob->restrictflag */
175 #define MASK_RESTRICT_VIEW      (1 << 0)
176 #define MASK_RESTRICT_SELECT    (1 << 1)
177 #define MASK_RESTRICT_RENDER    (1 << 2)
178
179 /* SpaceClip->mask_draw_flag */
180 #define MASK_DRAWFLAG_SMOOTH    (1 << 0)
181 #define MASK_DRAWFLAG_OVERLAY   (1 << 1)
182
183 /* copy of eSpaceImage_UVDT */
184 /* SpaceClip->mask_draw_type */
185 enum {
186         MASK_DT_OUTLINE = 0,
187         MASK_DT_DASH    = 1,
188         MASK_DT_BLACK   = 2,
189         MASK_DT_WHITE   = 3
190 };
191
192 /* MaskSpaceInfo->overlay_mode */
193 enum {
194         MASK_OVERLAY_ALPHACHANNEL = 0,
195         MASK_OVERLAY_COMBINED     = 1
196 };
197
198 /* masklay->blend */
199 enum {
200         MASK_BLEND_ADD             = 0,
201         MASK_BLEND_SUBTRACT        = 1,
202         MASK_BLEND_LIGHTEN         = 2,
203         MASK_BLEND_DARKEN          = 3,
204         MASK_BLEND_MUL             = 4,
205         MASK_BLEND_REPLACE         = 5,
206         MASK_BLEND_DIFFERENCE      = 6,
207         MASK_BLEND_MERGE_ADD       = 7,
208         MASK_BLEND_MERGE_SUBTRACT  = 8
209 };
210
211 /* masklay->blend_flag */
212 enum {
213         MASK_BLENDFLAG_INVERT = (1 << 0)
214 };
215
216 /* masklay->flag */
217 enum {
218         MASK_LAYERFLAG_LOCKED = (1 << 4),
219         MASK_LAYERFLAG_SELECT = (1 << 5),
220
221         /* no holes */
222         MASK_LAYERFLAG_FILL_DISCRETE = (1 << 6),
223         MASK_LAYERFLAG_FILL_OVERLAP  = (1 << 7),
224 };
225
226 /* masklay_shape->flag */
227 enum {
228         MASK_SHAPE_SELECT = (1 << 0)
229 };
230
231
232 /* mask->flag */
233 enum {
234         MASK_ANIMF_EXPAND = (1 << 4)
235 };
236
237 #endif  /* __DNA_MASK_TYPES_H__ */