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