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