1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file DNA_curve_types.h
* \ingroup DNA
*/
#ifndef __DNA_CURVE_TYPES_H__
#define __DNA_CURVE_TYPES_H__
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_vec_types.h"
#include "DNA_ID.h"
#define MAXTEXTBOX 256 /* used in readfile.c and editfont.c */
struct BoundBox;
struct Object;
struct Ipo;
struct Key;
struct Material;
struct VFont;
struct AnimData;
struct EditFont;
struct GHash;
/* These two Lines with # tell makesdna this struct can be excluded. */
#
#
typedef struct PathPoint {
float vec[4]; /* grr, cant get rid of tilt yet */
float quat[4];
float radius, weight;
} PathPoint;
/* These two Lines with # tell makesdna this struct can be excluded. */
#
#
typedef struct Path {
struct PathPoint *data;
int len;
float totdist;
} Path;
/* These two Lines with # tell makesdna this struct can be excluded. */
#
#
typedef struct BevPoint {
float vec[3], alfa, radius, weight, offset;
float sina, cosa; /* 2D Only */
float dir[3], tan[3], quat[4]; /* 3D Only */
short split_tag, dupe_tag;
} BevPoint;
/* These two Lines with # tell makesdna this struct can be excluded. */
#
#
typedef struct BevList {
struct BevList *next, *prev;
int nr, dupe_nr;
int poly, hole;
int charidx;
int *segbevcount;
float *seglen;
BevPoint *bevpoints;
} BevList;
/**
* Keyframes on F-Curves (allows code reuse of Bezier eval code) and
* Points on Bezier Curves/Paths are generally BezTriples
*
* \note alfa location in struct is abused by Key system
*
* \note vec in BezTriple looks like this:
* - vec[0][0] = x location of handle 1
* - vec[0][1] = y location of handle 1
* - vec[0][2] = z location of handle 1 (not used for FCurve Points(2d))
* - vec[1][0] = x location of control point
* - vec[1][1] = y location of control point
* - vec[1][2] = z location of control point
* - vec[2][0] = x location of handle 2
* - vec[2][1] = y location of handle 2
* - vec[2][2] = z location of handle 2 (not used for FCurve Points(2d))
*/
typedef struct BezTriple {
float vec[3][3];
float alfa, weight, radius; /* alfa: tilt in 3D View, weight: used for softbody goal weight, radius: for bevel tapering */
char ipo; /* ipo: interpolation mode for segment from this BezTriple to the next */
char h1, h2; /* h1, h2: the handle type of the two handles */
char f1, f2, f3; /* f1, f2, f3: used for selection status */
char hide; /* hide: used to indicate whether BezTriple is hidden (3D), type of keyframe (eBezTriple_KeyframeType) */
char easing; /* easing: easing type for interpolation mode (eBezTriple_Easing) */
float back; /* BEZT_IPO_BACK */
float amplitude, period; /* BEZT_IPO_ELASTIC */
char f5; /* f5: used for auto handle to distinguish between normal handle and exception (extrema) */
char pad[3];
} BezTriple;
/* note; alfa location in struct is abused by Key system */
typedef struct BPoint {
float vec[4];
float alfa, weight; /* alfa: tilt in 3D View, weight: used for softbody goal weight */
short f1, hide; /* f1: selection status, hide: is point hidden or not */
float radius, pad; /* user-set radius per point for beveling etc */
} BPoint;
/**
* \note Nurb name is misleading, since it can be used for polygons too,
* also, it should be NURBS (Nurb isn't the singular of Nurbs).
*/
typedef struct Nurb {
struct Nurb *next, *prev; /* multiple nurbs per curve object are allowed */
short type;
short mat_nr; /* index into material list */
short hide, flag;
int pntsu, pntsv; /* number of points in the U or V directions */
short pad[2];
short resolu, resolv; /* tessellation resolution in the U or V directions */
short orderu, orderv;
short flagu, flagv;
float *knotsu, *knotsv;
BPoint *bp;
BezTriple *bezt;
short tilt_interp; /* KEY_LINEAR, KEY_CARDINAL, KEY_BSPLINE */
short radius_interp;
/* only used for dynamically generated Nurbs created from OB_FONT's */
int charidx;
} Nurb;
typedef struct CharInfo {
short kern;
short mat_nr; /* index start at 1, unlike mesh & nurbs */
char flag;
char pad;
short pad2;
} CharInfo;
typedef struct TextBox {
float x, y, w, h;
} TextBox;
typedef struct EditNurb {
/* base of nurbs' list (old Curve->editnurb) */
ListBase nurbs;
/* index data for shape keys */
struct GHash *keyindex;
/* shape key being edited */
int shapenr;
char pad[4];
} EditNurb;
typedef struct Curve {
ID id;
struct AnimData *adt; /* animation data (must be immediately after id for utilities to use it) */
struct BoundBox *bb;
ListBase nurb; /* actual data, called splines in rna */
EditNurb *editnurb; /* edited data, not in file, use pointer so we can check for it */
struct Object *bevobj, *taperobj, *textoncurve;
struct Ipo *ipo DNA_DEPRECATED; /* old animation system, deprecated for 2.5 */
struct Key *key;
struct Material **mat;
/* texture space, copied as one block in editobject.c */
float loc[3];
float size[3];
float rot[3];
short type; /* creation-time type of curve datablock */
short texflag; /* keep a short because of BKE_object_obdata_texspace_get() */
short drawflag, twist_mode;
float twist_smooth, smallcaps_scale;
int pathlen;
short bevresol, totcol;
int flag;
float width, ext1, ext2;
/* default */
short resolu, resolv;
short resolu_ren, resolv_ren;
/* edit, index in nurb list */
int actnu;
/* edit, index in active nurb (BPoint or BezTriple) */
int actvert;
char pad[4];
/* font part */
short lines;
char spacemode, align_y;
float spacing, linedist, shear, fsize, wordspace, ulpos, ulheight;
float xof, yof;
float linewidth;
/* copy of EditFont vars (wchar_t aligned),
* warning! don't use in editmode (storage only) */
int pos;
int selstart, selend;
/* text data */
int len_wchar; /* number of characters (strinfo) */
int len; /* number of bytes (str - utf8) */
char *str;
struct EditFont *editfont;
char family[64];
struct VFont *vfont;
struct VFont *vfontb;
struct VFont *vfonti;
struct VFont *vfontbi;
struct TextBox *tb;
int totbox, actbox;
struct CharInfo *strinfo;
struct CharInfo curinfo;
/* font part end */
float ctime; /* current evaltime - for use by Objects parented to curves */
float bevfac1, bevfac2;
char bevfac1_mapping, bevfac2_mapping;
char pad2[2];
} Curve;
#define CURVE_VFONT_ANY(cu) \
((cu)->vfont), ((cu)->vfontb), ((cu)->vfonti), ((cu)->vfontbi)
/* **************** CURVE ********************* */
/* Curve.texflag */
enum {
CU_AUTOSPACE = 1,
};
/* Curve.drawflag */
enum {
CU_HIDE_HANDLES = 1 << 0,
CU_HIDE_NORMALS = 1 << 1,
};
/* Curve.flag */
enum {
CU_3D = 1 << 0,
CU_FRONT = 1 << 1,
CU_BACK = 1 << 2,
CU_PATH = 1 << 3,
CU_FOLLOW = 1 << 4,
CU_UV_ORCO = 1 << 5,
CU_DEFORM_BOUNDS_OFF = 1 << 6,
CU_STRETCH = 1 << 7,
/* CU_OFFS_PATHDIST = 1 << 8, */ /* DEPRECATED */
CU_FAST = 1 << 9, /* Font: no filling inside editmode */
/* CU_RETOPO = 1 << 10, */ /* DEPRECATED */
CU_DS_EXPAND = 1 << 11,
/** make use of the path radius if this is enabled (default for new curves) */
CU_PATH_RADIUS = 1 << 12,
/** fill 2d curve after deformation */
CU_DEFORM_FILL = 1 << 13,
/** fill bevel caps */
CU_FILL_CAPS = 1 << 14,
/** map taper object to beveled area */
CU_MAP_TAPER = 1 << 15,
};
/* Curve.twist_mode */
enum {
CU_TWIST_Z_UP = 0,
/* CU_TWIST_Y_UP = 1, */ /* not used yet */
/* CU_TWIST_X_UP = 2, */
CU_TWIST_MINIMUM = 3,
CU_TWIST_TANGENT = 4,
};
/* Curve.bevfac1_mapping, Curve.bevfac2_mapping, bevel factor mapping */
enum {
CU_BEVFAC_MAP_RESOLU = 0,
CU_BEVFAC_MAP_SEGMENT = 1,
CU_BEVFAC_MAP_SPLINE = 2,
};
/* Curve.spacemode */
enum {
CU_ALIGN_X_LEFT = 0,
CU_ALIGN_X_MIDDLE = 1,
CU_ALIGN_X_RIGHT = 2,
CU_ALIGN_X_JUSTIFY = 3,
CU_ALIGN_X_FLUSH = 4,
};
/* Curve.align_y */
enum {
CU_ALIGN_Y_TOP_BASELINE = 0,
CU_ALIGN_Y_TOP = 1,
CU_ALIGN_Y_CENTER = 2,
CU_ALIGN_Y_BOTTOM = 3,
};
/* Nurb.flag */
enum {
CU_SMOOTH = 1 << 0,
CU_2D = 1 << 3, /* moved from type since 2.4x */
};
/* Nurb.type */
enum {
CU_POLY = 0,
CU_BEZIER = 1,
CU_BSPLINE = 2,
CU_CARDINAL = 3,
CU_NURBS = 4,
CU_TYPE = (CU_POLY | CU_BEZIER | CU_BSPLINE | CU_CARDINAL | CU_NURBS),
/* only for adding */
CU_PRIMITIVE = 0xF00,
/* 2 or 4 points */
CU_PRIM_CURVE = 0x100,
/* 8 points circle */
CU_PRIM_CIRCLE = 0x200,
/* 4x4 patch Nurb */
CU_PRIM_PATCH = 0x300,
CU_PRIM_TUBE = 0x400,
CU_PRIM_SPHERE = 0x500,
CU_PRIM_DONUT = 0x600,
/* 5 points, 5th order straight line (for anim path) */
CU_PRIM_PATH = 0x700,
};
/* Nurb.flagu, Nurb.flagv */
enum {
CU_NURB_CYCLIC = 1 << 0,
CU_NURB_ENDPOINT = 1 << 1,
CU_NURB_BEZIER = 1 << 2,
};
#define CU_ACT_NONE -1
/* *************** BEZTRIPLE **************** */
/* BezTriple.f1,2,3 */
typedef enum eBezTriple_Flag {
/* SELECT */
BEZT_FLAG_TEMP_TAG = (1 << 1), /* always clear. */
} eBezTriple_Flag;
/* h1 h2 (beztriple) */
typedef enum eBezTriple_Handle {
HD_FREE = 0,
HD_AUTO = 1,
HD_VECT = 2,
HD_ALIGN = 3,
HD_AUTO_ANIM = 4, /* auto-clamped handles for animation */
HD_ALIGN_DOUBLESIDE = 5, /* align handles, displayed both of them. used for masks */
} eBezTriple_Handle;
/* f5 (beztriple) */
typedef enum eBezTriple_Auto_Type {
HD_AUTOTYPE_NORMAL = 0,
HD_AUTOTYPE_SPECIAL = 1
} eBezTriple_Auto_Type;
/* interpolation modes (used only for BezTriple->ipo) */
typedef enum eBezTriple_Interpolation {
/* traditional interpolation */
BEZT_IPO_CONST = 0, /* constant interpolation */
BEZT_IPO_LIN = 1, /* linear interpolation */
BEZT_IPO_BEZ = 2, /* bezier interpolation */
/* easing equations */
BEZT_IPO_BACK = 3,
BEZT_IPO_BOUNCE = 4,
BEZT_IPO_CIRC = 5,
BEZT_IPO_CUBIC = 6,
BEZT_IPO_ELASTIC = 7,
BEZT_IPO_EXPO = 8,
BEZT_IPO_QUAD = 9,
BEZT_IPO_QUART = 10,
BEZT_IPO_QUINT = 11,
BEZT_IPO_SINE = 12,
} eBezTriple_Interpolation;
/* easing modes (used only for Keyframes - BezTriple->easing) */
typedef enum eBezTriple_Easing {
BEZT_IPO_EASE_AUTO = 0,
BEZT_IPO_EASE_IN = 1,
BEZT_IPO_EASE_OUT = 2,
BEZT_IPO_EASE_IN_OUT = 3,
} eBezTriple_Easing;
/* types of keyframe (used only for BezTriple->hide when BezTriple is used in F-Curves) */
typedef enum eBezTriple_KeyframeType {
BEZT_KEYTYPE_KEYFRAME = 0, /* default - 'proper' Keyframe */
BEZT_KEYTYPE_EXTREME = 1, /* 'extreme' keyframe */
BEZT_KEYTYPE_BREAKDOWN = 2, /* 'breakdown' keyframe */
BEZT_KEYTYPE_JITTER = 3, /* 'jitter' keyframe (for adding 'filler' secondary motion) */
BEZT_KEYTYPE_MOVEHOLD = 4, /* one end of a 'moving hold' */
} eBezTriple_KeyframeType;
/* checks if the given BezTriple is selected */
#define BEZT_ISSEL_ANY(bezt) \
(((bezt)->f2 & SELECT) || ((bezt)->f1 & SELECT) || ((bezt)->f3 & SELECT))
#define BEZT_ISSEL_ANY_HIDDENHANDLES(cu, bezt) \
(((cu)->drawflag & CU_HIDE_HANDLES) ? (bezt)->f2 & SELECT : BEZT_ISSEL_ANY(bezt))
#define BEZT_SEL_ALL(bezt) { (bezt)->f1 |= SELECT; (bezt)->f2 |= SELECT; (bezt)->f3 |= SELECT; } ((void)0)
#define BEZT_DESEL_ALL(bezt) { (bezt)->f1 &= ~SELECT; (bezt)->f2 &= ~SELECT; (bezt)->f3 &= ~SELECT; } ((void)0)
#define BEZT_IS_AUTOH(bezt) (ELEM((bezt)->h1, HD_AUTO, HD_AUTO_ANIM) && ELEM((bezt)->h2, HD_AUTO, HD_AUTO_ANIM))
/* *************** CHARINFO **************** */
/* CharInfo.flag */
enum {
/* note: CU_CHINFO_WRAP and CU_CHINFO_SMALLCAPS_TEST are set dynamically */
CU_CHINFO_BOLD = 1 << 0,
CU_CHINFO_ITALIC = 1 << 1,
CU_CHINFO_UNDERLINE = 1 << 2,
/** wordwrap occurred here */
CU_CHINFO_WRAP = 1 << 3,
CU_CHINFO_SMALLCAPS = 1 << 4,
CU_CHINFO_SMALLCAPS_CHECK = 1 << 5, /* set at runtime, checks if case switching is needed */
};
/* mixed with KEY_LINEAR but define here since only curve supports */
#define KEY_CU_EASE 3
/* indicates point has been seen during surface duplication */
#define SURF_SEEN 4
#endif
|