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