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