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