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