remaining mask files from tomato. these wont get svn history carried over.
[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 } Mask;
50
51 typedef struct MaskParent {
52         int flag;             /* parenting flags */
53         int id_type;          /* type of parenting */
54         ID *id;               /* ID block of entity to which mask/spline is parented to
55                                * in case of parenting to movie tracking data set to MovieClip datablock */
56         char parent[64];      /* entity of parent to which parenting happened
57                                * in case of parenting to movie tracking data contains name of layer */
58         char sub_parent[64];  /* sub-entity of parent to which parenting happened
59                                * in case of parenting to movie tracking data contains name of track */
60         float parent_orig[2]; /* track location at the moment of parenting */
61 } MaskParent;
62
63 typedef struct MaskSplinePointUW {
64         float u, w;            /* u coordinate along spline segment and weight of this point */
65         int flag;              /* different flags of this point */
66 } MaskSplinePointUW;
67
68 typedef struct MaskSplinePoint {
69         BezTriple bezt;        /* actual point coordinates and it's handles  */
70         int pad;
71         int tot_uw;            /* number of uv feather values */
72         MaskSplinePointUW *uw; /* feather UV values */
73         MaskParent parent;     /* parenting information of particular spline point */
74 } MaskSplinePoint;
75
76 typedef struct MaskSpline {
77         struct MaskSpline *next, *prev;
78
79         int flag;                /* defferent spline flag (closed, ...) */
80         int tot_point;           /* total number of points */
81         MaskSplinePoint *points; /* points which defines spline itself */
82         MaskParent parent;       /* parenting information of the whole spline */
83
84         int weight_interp, pad;  /* weight interpolation */
85
86         MaskSplinePoint *points_deform; /* deformed copy of 'points' BezTriple data - not saved */
87 } MaskSpline;
88
89 /* one per frame */
90 typedef struct MaskLayerShape {
91         struct MaskLayerShape *next, *prev;
92
93         float *data;             /* u coordinate along spline segment and weight of this point */
94         int    tot_vert;         /* to ensure no buffer overruns's: alloc size is (tot_vert * MASK_OBJECT_SHAPE_ELEM_SIZE) */
95         int    frame;            /* different flags of this point */
96         char   flag;
97         char   pad[7];
98 } MaskLayerShape;
99
100 typedef struct MaskLayer {
101         struct MaskLayer *next, *prev;
102
103         char name[64];                     /* name of the mask layer (64 = MAD_ID_NAME - 2) */
104
105         ListBase splines;                  /* list of splines which defines this mask layer */
106         ListBase splines_shapes;
107
108         struct MaskSpline *act_spline;     /* active spline */
109         struct MaskSplinePoint *act_point; /* active point */
110
111         /* blending options */
112         float  alpha;
113         char   blend;
114         char   blend_flag;
115
116         //char   flag;             /* not used yet */
117         char   restrictflag;     /* matching 'Object' flag of the same name - eventually use in the outliner  */
118         char   pad[1];
119 } MaskLayer;
120
121 /* MaskParent->flag */
122 #define MASK_PARENT_ACTIVE  (1 << 0)
123
124 /* MaskSpline->flag */
125 /* reserve (1 << 0) for SELECT */
126 #define MASK_SPLINE_CYCLIC  (1 << 1)
127
128 /* MaskSpline->weight_interp */
129 #define MASK_SPLINE_INTERP_LINEAR   1
130 #define MASK_SPLINE_INTERP_EASE     2
131
132 #define MASK_OBJECT_SHAPE_ELEM_SIZE 8 /* 3x 2D points + weight + radius == 8 */
133
134 /* ob->restrictflag */
135 #define MASK_RESTRICT_VIEW      1
136 #define MASK_RESTRICT_SELECT    2
137 #define MASK_RESTRICT_RENDER    4
138
139 /* SpaceClip->mask_draw_flag */
140 #define MASK_DRAWFLAG_SMOOTH    1
141
142 /* copy of eSpaceImage_UVDT */
143 /* SpaceClip->mask_draw_type */
144 enum {
145         MASK_DT_OUTLINE = 0,
146         MASK_DT_DASH,
147         MASK_DT_BLACK,
148         MASK_DT_WHITE
149 };
150
151 /* masklay->blend */
152 enum {
153         MASK_BLEND_ADD      = 0,
154         MASK_BLEND_SUBTRACT = 1
155 };
156
157 /* masklay->blend_flag */
158 enum {
159         MASK_BLENDFLAG_INVERT = (1 << 0)
160 };
161
162
163 #endif // __DNA_MASK_TYPES_H__