svn merge -r 30566:30717 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / blender / makesdna / DNA_curve_types.h
1 /**
2  * blenlib/DNA_curve_types.h (mar-2001 nzc)
3  *
4  * Curve stuff.
5  *
6  * $Id$ 
7  *
8  * ***** BEGIN GPL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL LICENSE BLOCK *****
32  */
33 #ifndef DNA_CURVE_TYPES_H
34 #define DNA_CURVE_TYPES_H
35
36 #include "DNA_listBase.h"
37 #include "DNA_vec_types.h"
38 #include "DNA_ID.h"
39
40 #define MAXTEXTBOX 256  /* used in readfile.c and editfont.c */
41
42 struct BoundBox;
43 struct Object;
44 struct Ipo;
45 struct Key;
46 struct Material;
47 struct VFont;
48 struct AnimData;
49 struct SelBox;
50 struct EditFont;
51 struct GHash;
52
53 /* These two Lines with # tell makesdna this struct can be excluded. */
54 #
55 #
56 typedef struct PathPoint {
57         float vec[4]; /* grr, cant get rid of tilt yet */
58         float quat[4];
59         float radius, weight;
60 } PathPoint;
61
62 /* These two Lines with # tell makesdna this struct can be excluded. */
63 #
64 #
65 typedef struct Path {
66         int len;
67         struct PathPoint *data;
68         float totdist;
69 } Path;
70
71 /* These two Lines with # tell makesdna this struct can be excluded. */
72 #
73 #
74 typedef struct BevList {
75         struct BevList *next, *prev;
76         int nr, dupe_nr;
77         short poly, hole;
78 } BevList;
79
80 /* These two Lines with # tell makesdna this struct can be excluded. */
81 #
82 #
83 typedef struct BevPoint {
84         float vec[3], alfa, radius, weight;
85         float sina, cosa;                               /* 2D Only */
86         float dir[3], tan[3], quat[4];  /* 3D Only */
87         short split_tag, dupe_tag;
88 } BevPoint;
89
90 /* Keyframes on F-Curves (allows code reuse of Bezier eval code) and 
91  * Points on Bezier Curves/Paths are generally BezTriples 
92  */
93 /* note: alfa location in struct is abused by Key system */
94 /* vec in BezTriple looks like this:
95         vec[0][0]=x location of handle 1
96         vec[0][1]=y location of handle 1
97         vec[0][2]=z location of handle 1 (not used for FCurve Points(2d))
98         vec[1][0]=x location of control point
99         vec[1][1]=y location of control point
100         vec[1][2]=z location of control point
101         vec[2][0]=x location of handle 2
102         vec[2][1]=y location of handle 2
103         vec[2][2]=z location of handle 2 (not used for FCurve Points(2d))
104 */
105 typedef struct BezTriple {
106         float vec[3][3];
107         float alfa, weight, radius;     /* alfa: tilt in 3D View, weight: used for softbody goal weight, radius: for bevel tapering */
108         short ipo;                                      /* ipo: interpolation mode for segment from this BezTriple to the next */
109         char h1, h2;                            /* h1, h2: the handle type of the two handles */
110         char f1, f2, f3;                        /* f1, f2, f3: used for selection status */
111         char hide;                                      /* hide: used to indicate whether BezTriple is hidden (3D), type of keyframe (eBezTriple_KeyframeTypes) */
112 } BezTriple;
113
114 /* note; alfa location in struct is abused by Key system */
115 typedef struct BPoint {
116         float vec[4];
117         float alfa, weight;             /* alfa: tilt in 3D View, weight: used for softbody goal weight */
118         short f1, hide;                 /* f1: selection status,  hide: is point hidden or not */
119         float radius, pad;              /* user-set radius per point for bevelling etc */
120 } BPoint;
121
122 typedef struct Nurb {
123         struct Nurb *next, *prev;       /* multiple nurbs per curve object are allowed */
124         short type;
125         short mat_nr;           /* index into material list */
126         short hide, flag;
127         short pntsu, pntsv;             /* number of points in the U or V directions */
128         short resolu, resolv;   /* tesselation resolution in the U or V directions */
129         short orderu, orderv;
130         short flagu, flagv;
131         
132         float *knotsu, *knotsv;
133         BPoint *bp;
134         BezTriple *bezt;
135
136         short tilt_interp;      /* KEY_LINEAR, KEY_CARDINAL, KEY_BSPLINE */
137         short radius_interp;
138         
139         int charidx;
140 } Nurb;
141
142 typedef struct CharInfo {
143         short kern;
144         short mat_nr;
145         char flag;
146         char pad;
147         short pad2;
148 } CharInfo;
149
150 typedef struct TextBox {
151         float x, y, w, h;
152 } TextBox;
153
154 typedef struct EditNurb {
155         /* base of nurbs' list (old Curve->editnurb) */
156         ListBase nurbs;
157
158         /* index data for shape keys */
159         struct GHash *keyindex;
160 } EditNurb;
161
162 typedef struct Curve {
163         ID id;
164         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
165         
166         struct BoundBox *bb;
167         
168         ListBase nurb;          /* actual data, called splines in rna */
169         ListBase disp;
170         
171         EditNurb *editnurb;     /* edited data, not in file, use pointer so we can check for it */
172         
173         struct Object *bevobj, *taperobj, *textoncurve;
174         struct Ipo *ipo;        // XXX depreceated... old animation system
175         Path *path;
176         struct Key *key;
177         struct Material **mat;
178         
179         ListBase bev;
180         
181         /* texture space, copied as one block in editobject.c */
182         float loc[3];
183         float size[3];
184         float rot[3];
185
186         short texflag, pad1; /* keep a short because of give_obdata_texspace() */
187
188         short drawflag, twist_mode,  pad[2];
189         float twist_smooth, smallcaps_scale;
190
191         short pathlen, totcol;
192         short flag, bevresol;
193         float width, ext1, ext2;
194         
195         /* default */
196         short resolu, resolv;
197         short resolu_ren, resolv_ren;
198
199         /* edit, index in nurb list */
200         int actnu;
201         /* edit, last selected point */
202         void *lastsel;
203         
204         /* font part */
205         short len, lines, pos, spacemode;
206         float spacing, linedist, shear, fsize, wordspace, ulpos, ulheight;
207         float xof, yof;
208         float linewidth;
209
210         char *str;
211         struct SelBox *selboxes;
212         struct EditFont *editfont;
213         
214         char family[24];
215         struct VFont *vfont;
216         struct VFont *vfontb;
217         struct VFont *vfonti;
218         struct VFont *vfontbi;
219
220         int sepchar;
221         
222         float ctime;                    /* current evaltime - for use by Objects parented to curves */
223         int totbox, actbox;
224         struct TextBox *tb;     
225         
226         int selstart, selend;   
227         
228         struct CharInfo *strinfo;       
229         struct CharInfo curinfo;
230 } Curve;
231
232 /* **************** CURVE ********************* */
233
234 /* texflag */
235 #define CU_AUTOSPACE    1
236
237 /* drawflag */
238 #define CU_HIDE_HANDLES (1 << 0)
239 #define CU_HIDE_NORMALS (1 << 1)
240
241 /* flag */
242 #define CU_3D                   1
243 #define CU_FRONT                2
244 #define CU_BACK                 4
245 #define CU_PATH                 8
246 #define CU_FOLLOW               16
247 #define CU_UV_ORCO              32
248 #define CU_NOPUNOFLIP   64
249 #define CU_STRETCH              128
250 #define CU_OFFS_PATHDIST        256
251 #define CU_FAST                 512 /* Font: no filling inside editmode */
252 #define CU_RETOPO               1024
253 #define CU_DS_EXPAND    2048
254 #define CU_PATH_RADIUS  4096 /* make use of the path radius if this is enabled (default for new curves) */
255 #define CU_DEFORM_FILL  8192 /* fill 2d curve after deformation */
256
257 /* twist mode */
258 #define CU_TWIST_Z_UP                   0
259 // #define CU_TWIST_Y_UP                        1 // not used yet
260 // #define CU_TWIST_X_UP                        2
261 #define CU_TWIST_MINIMUM                3
262 #define CU_TWIST_TANGENT                4
263
264 /* spacemode */
265 #define CU_LEFT                 0
266 #define CU_MIDDLE               1
267 #define CU_RIGHT                2
268 #define CU_JUSTIFY              3
269 #define CU_FLUSH                4
270
271 /* flag (nurb) */
272 #define CU_SMOOTH               1
273 #define CU_2D                   8 /* moved from type since 2.4x */
274
275 /* type (nurb) */
276 #define CU_POLY                 0
277 #define CU_BEZIER               1
278 #define CU_BSPLINE              2
279 #define CU_CARDINAL             3
280 #define CU_NURBS                4
281 #define CU_TYPE                 (CU_POLY|CU_BEZIER|CU_BSPLINE|CU_CARDINAL|CU_NURBS)
282
283                 /* only for adding */
284 #define CU_PRIMITIVE    0xF00
285
286                 /* 2 or 4 points */
287 #define CU_PRIM_CURVE   0x100
288                 /* 8 points circle */
289 #define CU_PRIM_CIRCLE  0x200
290                 /* 4x4 patch Nurb */
291 #define CU_PRIM_PATCH   0x300
292 #define CU_PRIM_TUBE    0x400
293 #define CU_PRIM_SPHERE  0x500
294 #define CU_PRIM_DONUT   0x600
295                 /* 5 points,  5th order straight line (for anim path) */
296 #define CU_PRIM_PATH    0x700
297
298
299 /* flagu flagv (nurb) */
300 #define CU_NURB_CYCLIC          1
301 #define CU_NURB_ENDPOINT        2
302 #define CU_NURB_BEZIER          4
303
304 /* *************** BEZTRIPLE **************** */
305
306 /* h1 h2 (beztriple) */
307 typedef enum eBezTriple_Handle {
308         HD_FREE = 0,
309         HD_AUTO,
310         HD_VECT,
311         HD_ALIGN,
312         HD_AUTO_ANIM,   /* not real handle type, but is just used as dummy item for anim code */
313 } eBezTriple_Handle;
314
315 /* interpolation modes (used only for BezTriple->ipo) */
316 typedef enum eBezTriple_Interpolation {
317         BEZT_IPO_CONST = 0,     /* constant interpolation */
318         BEZT_IPO_LIN,           /* linear interpolation */
319         BEZT_IPO_BEZ,           /* bezier interpolation */
320 } eBezTriple_Interpolation;
321
322 /* types of keyframe (used only for BezTriple->hide when BezTriple is used in F-Curves) */
323 typedef enum eBezTriple_KeyframeType {
324         BEZT_KEYTYPE_KEYFRAME = 0,      /* default - 'proper' Keyframe */
325         BEZT_KEYTYPE_EXTREME,           /* 'extreme' keyframe */
326         BEZT_KEYTYPE_BREAKDOWN,         /* 'breakdown' keyframe */
327 } eBezTriple_KeyframeType;
328
329 /* checks if the given BezTriple is selected */
330 #define BEZSELECTED(bezt) (((bezt)->f2 & SELECT) || ((bezt)->f1 & SELECT) || ((bezt)->f3 & SELECT))
331 #define BEZSELECTED_HIDDENHANDLES(cu, bezt)   (((cu)->drawflag & CU_HIDE_HANDLES) ? (bezt)->f2 & SELECT : BEZSELECTED(bezt))
332
333 /* *************** CHARINFO **************** */
334
335 /* flag */
336 /* note: CU_CHINFO_WRAP and CU_CHINFO_SMALLCAPS_TEST are set dynamically */
337 #define CU_CHINFO_BOLD                  (1<<0)
338 #define CU_CHINFO_ITALIC                (1<<1)
339 #define CU_CHINFO_UNDERLINE     (1<<2)
340 #define CU_CHINFO_WRAP                  (1<<3)  /* wordwrap occurred here */
341 #define CU_CHINFO_SMALLCAPS     (1<<4)
342 #define CU_CHINFO_SMALLCAPS_CHECK (1<<5) /* set at runtime, checks if case switching is needed */
343
344 #endif
345