Merged 15170:15635 from trunk (no conflicts or even merges)
[blender.git] / source / blender / include / transform.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef TRANSFORM_H
31 #define TRANSFORM_H
32
33 #include "BIF_transform.h"
34
35 /* ************************** Types ***************************** */
36
37 struct TransInfo;
38 struct TransData;
39 struct TransSnap;
40 struct NumInput;
41 struct Object;
42 struct View3D;
43 struct ScrArea;
44 struct bPose;
45 struct bConstraint;
46 struct BezTriple;
47
48 typedef struct NDofInput {
49         int             flag;
50         int             axis;
51         float   fval[7];
52         float   factor[3];
53 } NDofInput;
54
55 typedef struct NumInput {
56     short  idx;
57     short  idx_max;
58     short  flag;        /* Different flags to indicate different behaviors                                */
59     float  val[3];       /* Direct value of the input                                                      */
60     int  ctrl[3];      /* Control to indicate what to do with the numbers that are typed                 */
61 } NumInput ;
62
63 /*
64         The ctrl value has different meaning:
65                 0                       : No value has been typed
66                 
67                 otherwise, |value| - 1 is where the cursor is located after the period
68                 Positive        : number is positive
69                 Negative        : number is negative
70 */
71
72 typedef struct TransSnap {
73         short   modePoint;
74         short   modeTarget;
75         int     status;
76         float   snapPoint[3];
77         float   snapTarget[3];
78         float   snapNormal[3];
79         float   snapTangent[3];
80         float   dist; // Distance from snapPoint to snapTarget
81         double  last;
82         void  (*applySnap)(struct TransInfo *, float *);
83         void  (*calcSnap)(struct TransInfo *, float *);
84         void  (*targetSnap)(struct TransInfo *);
85         float  (*distance)(struct TransInfo *, float p1[3], float p2[3]); // Get the transform distance between two points (used by Closest snap)
86 } TransSnap;
87
88 typedef struct TransCon {
89     char  text[50];      /* Description of the Constraint for header_print                            */
90     float mtx[3][3];     /* Matrix of the Constraint space                                            */
91     float imtx[3][3];    /* Inverse Matrix of the Constraint space                                    */
92     float pmtx[3][3];    /* Projection Constraint Matrix (same as imtx with some axis == 0)           */
93     float center[3];     /* transformation center to define where to draw the view widget             
94                             ALWAYS in global space. Unlike the transformation center                  */
95         short imval[2];      /* initial mouse value for visual calculation                                */
96                              /* the one in TransInfo is not garanty to stay the same (Rotates change it)  */
97     int   mode;          /* Mode flags of the Constraint                                              */
98         void  (*drawExtra)(struct TransInfo *);
99                                                  /* For constraints that needs to draw differently from the other
100                                                         uses this instead of the generic draw function                                                    */
101     void  (*applyVec)(struct TransInfo *, struct TransData *, float *, float *, float *);
102                          /* Apply function pointer for linear vectorial transformation                */
103                          /* The last three parameters are pointers to the in/out/printable vectors    */
104     void  (*applySize)(struct TransInfo *, struct TransData *, float [3][3]);
105                          /* Apply function pointer for size transformation */
106     void  (*applyRot)(struct TransInfo *, struct TransData *, float [3], float *);
107                          /* Apply function pointer for rotation transformation */
108 } TransCon;
109
110 typedef struct TransDataIpokey {
111         int flag;                                       /* which keys */
112         float *locx, *locy, *locz;      /* channel pointers */
113         float *rotx, *roty, *rotz;
114         float *quatx, *quaty, *quatz, *quatw;
115         float *sizex, *sizey, *sizez;
116         float oldloc[9];                        /* storage old values */
117         float oldrot[9];
118         float oldsize[9];
119         float oldquat[12];
120 } TransDataIpokey;
121
122 typedef struct TransDataExtension {
123         float drot[3];           /* Initial object drot */
124         float dsize[3];          /* Initial object dsize */
125     float *rot;          /* Rotation of the data to transform (Faculative)                                 */
126     float  irot[3];      /* Initial rotation                                                               */
127     float *quat;         /* Rotation quaternion of the data to transform (Faculative)                      */
128     float  iquat[4];     /* Initial rotation quaternion                                                    */
129     float *size;         /* Size of the data to transform (Faculative)                                     */
130     float  isize[3];     /* Initial size                                                                   */
131         float  obmat[4][4];      /* Object matrix */  
132 } TransDataExtension;
133
134 typedef struct TransData2D {
135         float loc[3];           /* Location of data used to transform (x,y,0) */
136         float *loc2d;           /* Pointer to real 2d location of data */
137 } TransData2D;
138
139 /* we need to store 2 handles for each transdata incase the other handle wasnt selected */
140 typedef struct TransDataCurveHandleFlags {
141         short ih1, ih2;
142         short *h1, *h2;
143 } TransDataCurveHandleFlags;
144
145
146 typedef struct TransData {
147         float  dist;         /* Distance needed to affect element (for Proportionnal Editing)                  */
148         float  rdist;        /* Distance to the nearest element (for Proportionnal Editing)                    */
149         float  factor;       /* Factor of the transformation (for Proportionnal Editing)                       */
150     float *loc;          /* Location of the data to transform                                              */
151     float  iloc[3];      /* Initial location                                                               */
152         float *val;          /* Value pointer for special transforms */
153         float  ival;         /* Old value*/
154     float  center[3];    /* Individual data center                                                         */
155     float  mtx[3][3];    /* Transformation matrix from data space to global space                          */
156     float  smtx[3][3];   /* Transformation matrix from global space to data space                          */
157         float  axismtx[3][3];/* Axis orientation matrix of the data                                            */
158         struct Object *ob;
159         struct bConstraint *con;        /* for objects/bones, the first constraint in its constraint stack */
160         TransDataExtension *ext;        /* for objects, poses. 1 single malloc per TransInfo! */
161         TransDataIpokey *tdi;           /* for objects, ipo keys. per transdata a malloc */
162         TransDataCurveHandleFlags *hdata; /* for curves, stores handle flags for modification/cancel */
163         void *tdmir;             /* mirrored element pointer, in editmode mesh to EditVert */
164     short  flag;         /* Various flags */
165         short  protectflag;      /* If set, copy of Object or PoseChannel protection */
166 /*#ifdef WITH_VERSE*/
167         void *verse;                    /* pointer at verse data struct (VerseVert, etc.) */
168 /*#endif*/
169 } TransData;
170
171 typedef struct TransInfo {
172     int         mode;           /* current mode                         */
173     int         flag;           /* generic flags for special behaviors  */
174         short           state;                  /* current state (running, canceled,...)*/
175     int         context;        /* current context                      */
176     float       val;            /* init value for some transformations (and rotation angle)  */
177     float       fac;            /* factor for distance based transform  */
178     int       (*transform)(struct TransInfo *, short *);
179                                 /* transform function pointer           */
180         int       (*handleEvent)(struct TransInfo *, unsigned short event, short val);
181                                                                 /* event handler function pointer  RETURN 1 if redraw is needed */
182     int         total;          /* total number of transformed data     */
183     TransData  *data;           /* transformed data (array)             */
184         TransDataExtension *ext;        /* transformed data extension (array)   */
185         TransData2D *data2d;            /* transformed data for 2d (array)      */
186     TransCon    con;            /* transformed constraint               */
187     TransSnap   tsnap;
188     NumInput    num;            /* numerical input                      */
189     NDofInput   ndof;           /* ndof input                           */
190     char        redraw;         /* redraw flag                          */
191         float           propsize;               /* proportional circle radius           */
192         char            proptext[20];   /* proportional falloff text                    */
193     float       center[3];      /* center of transformation             */
194     int         center2d[2];    /* center in screen coordinates         */
195     short       imval[2];       /* initial mouse position               */
196         short           shiftmval[2];   /* mouse position when shift was pressed */
197         short       idx_max;            /* maximum index on the input vector    */
198         float           snap[3];                /* Snapping Gears                                               */
199         
200         float           viewmat[4][4];  /* copy from G.vd, prevents feedback,   */
201         float           viewinv[4][4];  /* and to make sure we don't have to    */
202         float           persmat[4][4];  /* access G.vd from other space types   */
203         float           persinv[4][4];
204         short           persp;
205         short           around;
206         char            spacetype;              /* spacetype where transforming is      */
207         
208         float           vec[3];                 /* translation, to show for widget      */
209         float           mat[3][3];              /* rot/rescale, to show for widget      */
210         
211         char            *undostr;               /* if set, uses this string for undo            */
212         float           spacemtx[3][3]; /* orientation matrix of the current space      */
213         char            spacename[32];  /* name of the current space                            */
214         
215         struct Object *poseobj;         /* if t->flag & T_POSE, this denotes pose object */
216         
217         void       *customData;         /* Per Transform custom data */
218 } TransInfo;
219
220
221 /* ******************** Macros & Prototypes *********************** */
222
223 /* NUMINPUT FLAGS */
224 #define NUM_NULL_ONE            2
225 #define NUM_NO_NEGATIVE         4
226 #define NUM_NO_ZERO                     8
227 #define NUM_NO_FRACTION         16
228 #define NUM_AFFECT_ALL          32
229
230 /* NDOFINPUT FLAGS */
231 #define NDOF_INIT                       1
232
233 /* transinfo->state */
234 #define TRANS_RUNNING   0
235 #define TRANS_CONFIRM   1
236 #define TRANS_CANCEL    2
237
238 /* transinfo->flag */
239 #define T_OBJECT                (1 << 0)
240 #define T_EDIT                  (1 << 1)
241 #define T_POSE                  (1 << 2)
242 #define T_TEXTURE               (1 << 3)
243 #define T_CAMERA                (1 << 4)
244                 // when shift pressed, higher resolution transform. cannot rely on G.qual, need event!
245 #define T_SHIFT_MOD             (1 << 5)
246                 // trans on points, having no rotation/scale 
247 #define T_POINTS                (1 << 6)
248                 // for manipulator exceptions, like scaling using center point, drawing help lines
249 #define T_USES_MANIPULATOR      (1 << 7)
250
251         /* restrictions flags */
252 #define T_ALL_RESTRICTIONS      ((1 << 8)|(1 << 9)|(1 << 10))
253 #define T_NO_CONSTRAINT         (1 << 8)
254 #define T_NULL_ONE                      (1 << 9)
255 #define T_NO_ZERO                       (1 << 10)
256
257 #define T_PROP_EDIT                     (1 << 11)
258 #define T_PROP_CONNECTED        (1 << 12)
259
260         /* if MMB is pressed or not */
261 #define T_MMB_PRESSED           (1 << 13)
262
263 #define T_V3D_ALIGN                     (1 << 14)
264         /* for 2d views like uv or ipo */
265 #define T_2D_EDIT                       (1 << 15) 
266 #define T_CLIP_UV                       (1 << 16)
267
268 #define T_FREE_CUSTOMDATA       (1 << 17)
269         /* auto-ik is on */
270 #define T_AUTOIK                        (1 << 18)
271
272 /* ******************************************************************************** */
273
274 /* transinfo->con->mode */
275 #define CON_APPLY               1
276 #define CON_AXIS0               2
277 #define CON_AXIS1               4
278 #define CON_AXIS2               8
279 #define CON_SELECT              16
280 #define CON_NOFLIP              32      /* does not reorient vector to face viewport when on */
281 #define CON_LOCAL               64
282 #define CON_USER                128
283
284 /* transdata->flag */
285 #define TD_SELECTED                     1
286 #define TD_ACTIVE                       (1 << 1)
287 #define TD_NOACTION                     (1 << 2)
288 #define TD_USEQUAT                      (1 << 3)
289 #define TD_NOTCONNECTED         (1 << 4)
290 #define TD_SINGLESIZE           (1 << 5)        /* used for scaling of MetaElem->rad */
291 #ifdef WITH_VERSE
292         #define TD_VERSE_OBJECT         (1 << 6)
293         #define TD_VERSE_VERT           (1 << 7)
294 #endif
295 #define TD_TIMEONLY                     (1 << 8)
296 #define TD_NOCENTER                     (1 << 9)
297 #define TD_NO_EXT                       (1 << 10)       /* ext abused for particle key timing */
298 #define TD_SKIP                         (1 << 11)       /* don't transform this data */
299 #define TD_BEZTRIPLE            (1 << 12)       /* if this is a bez triple, we need to restore the handles, if this is set transdata->misc.hdata needs freeing */
300
301 /* transsnap->status */
302 #define SNAP_ON                 1
303 #define TARGET_INIT             2
304 #define POINT_INIT              4
305
306 /* transsnap->modePoint */
307 #define SNAP_GRID                       0
308 #define SNAP_GEO                        1
309
310 /* transsnap->modeTarget */
311 #define SNAP_CLOSEST            0
312 #define SNAP_CENTER                     1
313 #define SNAP_MEDIAN                     2
314 #define SNAP_ACTIVE                     3
315
316 void checkFirstTime(void);
317
318 void setTransformViewMatrices(TransInfo *t);
319 void convertViewVec(TransInfo *t, float *vec, short dx, short dy);
320 void projectIntView(TransInfo *t, float *vec, int *adr);
321 void projectFloatView(TransInfo *t, float *vec, float *adr);
322
323 void convertVecToDisplayNum(float *vec, float *num);
324 void convertDisplayNumToVec(float *num, float *vec);
325
326 void initWarp(TransInfo *t);
327 int handleEventWarp(TransInfo *t, unsigned short event, short val);
328 int Warp(TransInfo *t, short mval[2]);
329
330 void initShear(TransInfo *t);
331 int handleEventShear(TransInfo *t, unsigned short evenl, short val);
332 int Shear(TransInfo *t, short mval[2]);
333
334 void initResize(TransInfo *t);
335 int Resize(TransInfo *t, short mval[2]);
336
337 void initTranslation(TransInfo *t);
338 int Translation(TransInfo *t, short mval[2]);
339
340 void initToSphere(TransInfo *t);
341 int ToSphere(TransInfo *t, short mval[2]);
342
343 void initRotation(TransInfo *t);
344 int Rotation(TransInfo *t, short mval[2]);
345
346 void initShrinkFatten(TransInfo *t);
347 int ShrinkFatten(TransInfo *t, short mval[2]);
348
349 void initTilt(TransInfo *t);
350 int Tilt(TransInfo *t, short mval[2]);
351
352 void initCurveShrinkFatten(TransInfo *t);
353 int CurveShrinkFatten(TransInfo *t, short mval[2]);
354
355 void initTrackball(TransInfo *t);
356 int Trackball(TransInfo *t, short mval[2]);
357
358 void initPushPull(TransInfo *t);
359 int PushPull(TransInfo *t, short mval[2]);
360
361 void initBevel(TransInfo *t);
362 int handleEventBevel(TransInfo *t, unsigned short evenl, short val);
363 int Bevel(TransInfo *t, short mval[2]);
364
365 void initBevelWeight(TransInfo *t);
366 int BevelWeight(TransInfo *t, short mval[2]);
367
368 void initCrease(TransInfo *t);
369 int Crease(TransInfo *t, short mval[2]);
370
371 void initBoneSize(TransInfo *t);
372 int BoneSize(TransInfo *t, short mval[2]);
373
374 void initBoneEnvelope(TransInfo *t);
375 int BoneEnvelope(TransInfo *t, short mval[2]);
376
377 void initBoneRoll(TransInfo *t);
378 int BoneRoll(TransInfo *t, short mval[2]);
379
380 void initTimeTranslate(TransInfo *t);
381 int TimeTranslate(TransInfo *t, short mval[2]);
382
383 void initTimeSlide(TransInfo *t);
384 int TimeSlide(TransInfo *t, short mval[2]);
385
386 void initTimeScale(TransInfo *t);
387 int TimeScale(TransInfo *t, short mval[2]);
388
389 void initBakeTime(TransInfo *t);
390 int BakeTime(TransInfo *t, short mval[2]);
391
392 void initMirror(TransInfo *t);
393 int Mirror(TransInfo *t, short mval[2]);
394
395 void initAlign(TransInfo *t);
396 int Align(TransInfo *t, short mval[2]);
397
398 /*********************** transform_conversions.c ********** */
399 struct ListBase;
400 void flushTransIpoData(TransInfo *t);
401 void flushTransUVs(TransInfo *t);
402 void flushTransParticles(TransInfo *t);
403 int clipUVTransform(TransInfo *t, float *vec, int resize);
404
405 /*********************** exported from transform_manipulator.c ********** */
406 void draw_manipulator_ext(struct ScrArea *sa, int type, char axis, int col, float vec[3], float mat[][3]);
407 int calc_manipulator_stats(struct ScrArea *sa);
408 float get_drawsize(struct View3D *v3d, float *co);
409
410 /*********************** TransData Creation and General Handling *********** */
411 void createTransData(TransInfo *t);
412 void sort_trans_data_dist(TransInfo *t);
413 void add_tdi_poin(float *poin, float *old, float delta);
414 void special_aftertrans_update(TransInfo *t);
415
416 void transform_autoik_update(TransInfo *t, short mode);
417
418 /* auto-keying stuff used by special_aftertrans_update */
419 short autokeyframe_cfra_can_key(struct Object *ob);
420 void autokeyframe_ob_cb_func(struct Object *ob, int tmode);
421 void autokeyframe_pose_cb_func(struct Object *ob, int tmode, short targetless_ik);
422
423 /*********************** Constraints *****************************/
424
425 void getConstraintMatrix(TransInfo *t);
426 void setConstraint(TransInfo *t, float space[3][3], int mode, const char text[]);
427 void setLocalConstraint(TransInfo *t, int mode, const char text[]);
428 void setUserConstraint(TransInfo *t, int mode, const char text[]);
429
430 void constraintNumInput(TransInfo *t, float vec[3]);
431
432 void getConstraintMatrix(TransInfo *t);
433 int isLockConstraint(TransInfo *t);
434 int getConstraintSpaceDimension(TransInfo *t);
435 char constraintModeToChar(TransInfo *t);
436
437 void startConstraint(TransInfo *t);
438 void stopConstraint(TransInfo *t);
439
440 void initSelectConstraint(TransInfo *t, float mtx[3][3]);
441 void selectConstraint(TransInfo *t);
442 void postSelectConstraint(TransInfo *t);
443
444 void setNearestAxis(TransInfo *t);
445
446 /*********************** Snapping ********************************/
447
448 typedef enum {
449         NO_GEARS        = 0,
450         BIG_GEARS       = 1,
451         SMALL_GEARS     = 2
452 } GearsType;
453
454 void snapGrid(TransInfo *t, float *val);
455 void snapGridAction(TransInfo *t, float *val, GearsType action);
456
457 void initSnapping(struct TransInfo *t);
458 void applySnapping(TransInfo *t, float *vec);
459 void resetSnapping(TransInfo *t);
460 int  handleSnapping(TransInfo *t, int event);
461 void drawSnapping(TransInfo *t);
462 int usingSnappingNormal(TransInfo *t);
463 int validSnappingNormal(TransInfo *t);
464
465 /*********************** Generics ********************************/
466
467 void initTrans(TransInfo *t);
468 void initTransModeFlags(TransInfo *t, int mode);
469 void postTrans (TransInfo *t);
470
471 void drawLine(float *center, float *dir, char axis, short options);
472
473 TransDataCurveHandleFlags *initTransDataCurveHandes(TransData *td, struct BezTriple *bezt);
474
475 /* DRAWLINE options flags */
476 #define DRAWLIGHT       1
477 #define DRAWDASHED      2
478 #define DRAWBOLD        4
479
480 void applyTransObjects(TransInfo *t);
481 void restoreTransObjects(TransInfo *t);
482 void recalcData(TransInfo *t);
483
484 void calculateCenter(TransInfo *t);
485 void calculateCenter2D(TransInfo *t);
486 void calculateCenterBound(TransInfo *t);
487 void calculateCenterMedian(TransInfo *t);
488 void calculateCenterCursor(TransInfo *t);
489
490 void calculateCenterCursor2D(TransInfo *t);
491 void calculatePropRatio(TransInfo *t);
492
493 void getViewVector(float coord[3], float vec[3]);
494 void getViewRay(short mval[2], float p[3], float d[3]);
495
496 TransInfo * BIF_GetTransInfo(void);
497
498 /*********************** NumInput ********************************/
499
500 void outputNumInput(NumInput *n, char *str);
501 short hasNumInput(NumInput *n);
502 void applyNumInput(NumInput *n, float *vec);
503 char handleNumInput(NumInput *n, unsigned short event);
504
505 /*********************** NDofInput ********************************/
506
507 void initNDofInput(NDofInput *n);
508 int hasNDofInput(NDofInput *n);
509 void applyNDofInput(NDofInput *n, float *vec);
510 int handleNDofInput(NDofInput *n, unsigned short event, short val);
511
512 /* handleNDofInput return values */
513 #define NDOF_REFRESH    1
514 #define NDOF_NOMOVE             2
515 #define NDOF_CONFIRM    3
516 #define NDOF_CANCEL             4
517
518
519 /*********************** TransSpace ******************************/
520
521 int manageObjectSpace(int confirm, int set);
522 int manageMeshSpace(int confirm, int set);
523 int manageBoneSpace(int confirm, int set);
524
525 /* Those two fill in mat and return non-zero on success */
526 int createSpaceNormal(float mat[3][3], float normal[3]);
527 int createSpaceNormalTangent(float mat[3][3], float normal[3], float tangent[3]);
528
529 int addMatrixSpace(float mat[3][3], char name[]);
530 int addObjectSpace(struct Object *ob);
531 void applyTransformOrientation(void);
532
533
534 #define ORIENTATION_NONE        0
535 #define ORIENTATION_NORMAL      1
536 #define ORIENTATION_VERT        2
537 #define ORIENTATION_EDGE        3
538 #define ORIENTATION_FACE        4
539
540 int getTransformOrientation(float normal[3], float plane[3], int activeOnly);
541 int createSpaceNormal(float mat[3][3], float normal[3]);
542 int createSpaceNormalTangent(float mat[3][3], float normal[3], float tangent[3]);
543
544 #endif
545
546