Merged changes in the trunk up to revision 51126.
[blender.git] / source / blender / makesdna / DNA_curve_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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_curve_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_CURVE_TYPES_H__
33 #define __DNA_CURVE_TYPES_H__
34
35 #include "DNA_defs.h"
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         struct PathPoint *data;
67         int len;
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         int 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 /**
91  * Keyframes on F-Curves (allows code reuse of Bezier eval code) and
92  * Points on Bezier Curves/Paths are generally BezTriples 
93  *
94  * \note alfa location in struct is abused by Key system
95  *
96  * \note vec in BezTriple looks like this:
97  * - vec[0][0] = x location of handle 1
98  * - vec[0][1] = y location of handle 1
99  * - vec[0][2] = z location of handle 1 (not used for FCurve Points(2d))
100  * - vec[1][0] = x location of control point
101  * - vec[1][1] = y location of control point
102  * - vec[1][2] = z location of control point
103  * - vec[2][0] = x location of handle 2
104  * - vec[2][1] = y location of handle 2
105  * - vec[2][2] = z location of handle 2 (not used for FCurve Points(2d))
106  */
107 typedef struct BezTriple {
108         float vec[3][3];
109         float alfa, weight, radius;     /* alfa: tilt in 3D View, weight: used for softbody goal weight, radius: for bevel tapering */
110         short ipo;                                      /* ipo: interpolation mode for segment from this BezTriple to the next */
111         char h1, h2;                            /* h1, h2: the handle type of the two handles */
112         char f1, f2, f3;                        /* f1, f2, f3: used for selection status */
113         char hide;                                      /* hide: used to indicate whether BezTriple is hidden (3D), type of keyframe (eBezTriple_KeyframeTypes) */
114 } BezTriple;
115
116 /* note; alfa location in struct is abused by Key system */
117 typedef struct BPoint {
118         float vec[4];
119         float alfa, weight;             /* alfa: tilt in 3D View, weight: used for softbody goal weight */
120         short f1, hide;                 /* f1: selection status,  hide: is point hidden or not */
121         float radius, pad;              /* user-set radius per point for beveling etc */
122 } BPoint;
123
124 /**
125  * \note Nurb name is misleading, since it can be used for polygons too,
126  * also, it should be NURBS (Nurb isn't the singular of Nurbs).
127  */
128 typedef struct Nurb {
129         struct Nurb *next, *prev;       /* multiple nurbs per curve object are allowed */
130         short type;
131         short mat_nr;           /* index into material list */
132         short hide, flag;
133         short pntsu, pntsv;             /* number of points in the U or V directions */
134         short resolu, resolv;   /* tessellation resolution in the U or V directions */
135         short orderu, orderv;
136         short flagu, flagv;
137         
138         float *knotsu, *knotsv;
139         BPoint *bp;
140         BezTriple *bezt;
141
142         short tilt_interp;      /* KEY_LINEAR, KEY_CARDINAL, KEY_BSPLINE */
143         short radius_interp;
144         
145         int charidx;
146 } Nurb;
147
148 typedef struct CharInfo {
149         short kern;
150         short mat_nr; /* index start at 1, unlike mesh & nurbs */
151         char flag;
152         char pad;
153         short pad2;
154 } CharInfo;
155
156 typedef struct TextBox {
157         float x, y, w, h;
158 } TextBox;
159
160 typedef struct EditNurb {
161         /* base of nurbs' list (old Curve->editnurb) */
162         ListBase nurbs;
163
164         /* index data for shape keys */
165         struct GHash *keyindex;
166
167         /* shape key being edited */
168         int shapenr;
169
170         char pad[4];
171 } EditNurb;
172
173 typedef struct Curve {
174         ID id;
175         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
176         
177         struct BoundBox *bb;
178         
179         ListBase nurb;          /* actual data, called splines in rna */
180         ListBase disp;          /* undeformed display list, used mostly for texture space calculation */
181         
182         EditNurb *editnurb;     /* edited data, not in file, use pointer so we can check for it */
183         
184         struct Object *bevobj, *taperobj, *textoncurve;
185         struct Ipo *ipo    DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
186         Path *path;
187         struct Key *key;
188         struct Material **mat;
189         
190         ListBase bev;
191         
192         /* texture space, copied as one block in editobject.c */
193         float loc[3];
194         float size[3];
195         float rot[3];
196
197         short type;     /* creation-time type of curve datablock */
198
199         short texflag; /* keep a short because of BKE_object_obdata_texspace_get() */
200         short drawflag, twist_mode;
201         float twist_smooth, smallcaps_scale;
202
203         int pathlen;
204         short pad, totcol;
205         short flag, bevresol;
206         float width, ext1, ext2;
207         
208         /* default */
209         short resolu, resolv;
210         short resolu_ren, resolv_ren;
211
212         /* edit, index in nurb list */
213         int actnu;
214         /* edit, last selected point */
215         void *lastsel;
216         
217         /* font part */
218         short len, lines, pos, spacemode;
219         float spacing, linedist, shear, fsize, wordspace, ulpos, ulheight;
220         float xof, yof;
221         float linewidth;
222
223         char *str;
224         struct SelBox *selboxes;
225         struct EditFont *editfont;
226         
227         char family[24];
228         struct VFont *vfont;
229         struct VFont *vfontb;
230         struct VFont *vfonti;
231         struct VFont *vfontbi;
232
233         int sepchar;
234         
235         float ctime;                    /* current evaltime - for use by Objects parented to curves */
236         int totbox, actbox;
237         struct TextBox *tb;     
238         
239         int selstart, selend;   
240         
241         struct CharInfo *strinfo;       
242         struct CharInfo curinfo;
243
244         float bevfac1, bevfac2;
245 } Curve;
246
247 /* **************** CURVE ********************* */
248
249 /* texflag */
250 #define CU_AUTOSPACE    1
251
252 /* drawflag */
253 #define CU_HIDE_HANDLES (1 << 0)
254 #define CU_HIDE_NORMALS (1 << 1)
255
256 /* flag */
257 #define CU_3D                   1
258 #define CU_FRONT                2
259 #define CU_BACK                 4
260 #define CU_PATH                 8
261 #define CU_FOLLOW               16
262 #define CU_UV_ORCO              32
263 #define CU_DEFORM_BOUNDS_OFF 64 
264 #define CU_STRETCH              128
265 #define CU_OFFS_PATHDIST        256
266 #define CU_FAST                 512 /* Font: no filling inside editmode */
267 /* #define CU_RETOPO               1024 */ /* DEPRECATED */
268 #define CU_DS_EXPAND    2048
269 #define CU_PATH_RADIUS  4096 /* make use of the path radius if this is enabled (default for new curves) */
270 #define CU_DEFORM_FILL  8192 /* fill 2d curve after deformation */
271 #define CU_FILL_CAPS    16384 /* fill bevel caps */
272
273 /* twist mode */
274 #define CU_TWIST_Z_UP                   0
275 // #define CU_TWIST_Y_UP                        1 // not used yet
276 // #define CU_TWIST_X_UP                        2
277 #define CU_TWIST_MINIMUM                3
278 #define CU_TWIST_TANGENT                4
279
280 /* spacemode */
281 #define CU_LEFT                 0
282 #define CU_MIDDLE               1
283 #define CU_RIGHT                2
284 #define CU_JUSTIFY              3
285 #define CU_FLUSH                4
286
287 /* flag (nurb) */
288 #define CU_SMOOTH               1
289 #define CU_2D                   8 /* moved from type since 2.4x */
290
291 /* type (nurb) */
292 #define CU_POLY                 0
293 #define CU_BEZIER               1
294 #define CU_BSPLINE              2
295 #define CU_CARDINAL             3
296 #define CU_NURBS                4
297 #define CU_TYPE                 (CU_POLY|CU_BEZIER|CU_BSPLINE|CU_CARDINAL|CU_NURBS)
298
299                 /* only for adding */
300 #define CU_PRIMITIVE    0xF00
301
302                 /* 2 or 4 points */
303 #define CU_PRIM_CURVE   0x100
304                 /* 8 points circle */
305 #define CU_PRIM_CIRCLE  0x200
306                 /* 4x4 patch Nurb */
307 #define CU_PRIM_PATCH   0x300
308 #define CU_PRIM_TUBE    0x400
309 #define CU_PRIM_SPHERE  0x500
310 #define CU_PRIM_DONUT   0x600
311                 /* 5 points,  5th order straight line (for anim path) */
312 #define CU_PRIM_PATH    0x700
313
314
315 /* flagu flagv (nurb) */
316 #define CU_NURB_CYCLIC          1
317 #define CU_NURB_ENDPOINT        2
318 #define CU_NURB_BEZIER          4
319
320 /* *************** BEZTRIPLE **************** */
321
322 /* h1 h2 (beztriple) */
323 typedef enum eBezTriple_Handle {
324         HD_FREE = 0,
325         HD_AUTO = 1,
326         HD_VECT = 2,
327         HD_ALIGN = 3,
328         HD_AUTO_ANIM = 4        /* auto-clamped handles for animation */
329 } eBezTriple_Handle;
330
331 /* interpolation modes (used only for BezTriple->ipo) */
332 typedef enum eBezTriple_Interpolation {
333         BEZT_IPO_CONST = 0,     /* constant interpolation */
334         BEZT_IPO_LIN = 1,       /* linear interpolation */
335         BEZT_IPO_BEZ = 2        /* bezier interpolation */
336 } eBezTriple_Interpolation;
337
338 /* types of keyframe (used only for BezTriple->hide when BezTriple is used in F-Curves) */
339 typedef enum eBezTriple_KeyframeType {
340         BEZT_KEYTYPE_KEYFRAME = 0,      /* default - 'proper' Keyframe */
341         BEZT_KEYTYPE_EXTREME = 1,       /* 'extreme' keyframe */
342         BEZT_KEYTYPE_BREAKDOWN = 2,     /* 'breakdown' keyframe */
343         BEZT_KEYTYPE_JITTER = 3,        /* 'jitter' keyframe (for adding 'filler' secondary motion) */
344 } eBezTriple_KeyframeType;
345
346 /* checks if the given BezTriple is selected */
347 #define BEZSELECTED(bezt) (((bezt)->f2 & SELECT) || ((bezt)->f1 & SELECT) || ((bezt)->f3 & SELECT))
348 #define BEZSELECTED_HIDDENHANDLES(cu, bezt)   (((cu)->drawflag & CU_HIDE_HANDLES) ? (bezt)->f2 & SELECT : BEZSELECTED(bezt))
349
350 /* *************** CHARINFO **************** */
351
352 /* flag */
353 /* note: CU_CHINFO_WRAP and CU_CHINFO_SMALLCAPS_TEST are set dynamically */
354 #define CU_CHINFO_BOLD                  (1<<0)
355 #define CU_CHINFO_ITALIC                (1<<1)
356 #define CU_CHINFO_UNDERLINE     (1<<2)
357 #define CU_CHINFO_WRAP                  (1<<3)  /* wordwrap occurred here */
358 #define CU_CHINFO_SMALLCAPS     (1<<4)
359 #define CU_CHINFO_SMALLCAPS_CHECK (1<<5) /* set at runtime, checks if case switching is needed */
360
361 /* mixed with KEY_LINEAR but define here since only curve supports */
362 #define KEY_CU_EASE                     3
363
364
365 #endif
366