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