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