4e6eaa7150c5571fc34c08421ba9b7c13825c89b
[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 NumInput;
43 struct Object;
44
45 typedef struct NumInput {
46     short  idx;
47     short  idx_max;
48     short  flag;        /* Different flags to indicate different behaviors                                */
49     float  val[3];       /* Direct value of the input                                                      */
50     short  ctrl[3];      /* Control to indicate what to do with the numbers that are typed                 */
51 } NumInput ;
52
53 /*
54         The ctrl value has different meaning:
55                 0                       : No value has been typed
56                 
57                 otherwise, |value| - 1 is where the cursor is located after the period
58                 Positive        : number is positive
59                 Negative        : number is negative
60 */
61
62 typedef struct TransCon {
63     char  text[50];      /* Description of the Constraint for header_print                            */
64     float mtx[3][3];     /* Matrix of the Constraint space                                            */
65     float imtx[3][3];    /* Inverse Matrix of the Constraint space                                    */
66     float pmtx[3][3];    /* Projection Constraint Matrix (same as imtx with some axis == 0)           */
67     float center[3];     /* transformation centre to define where to draw the view widget             
68                             ALWAYS in global space. Unlike the transformation center                  */
69         short imval[2];      /* initial mouse value for visual calculation                                */
70                              /* the one in TransInfo is not garanty to stay the same (Rotates change it)  */
71     int   mode;          /* Mode flags of the Constraint                                              */
72         void  (*drawExtra)(struct TransInfo *);
73                                                  /* For constraints that needs to draw differently from the other
74                                                         uses this instead of the generic draw function                                                    */
75     void  (*applyVec)(struct TransInfo *, struct TransData *, float *, float *, float *);
76                          /* Apply function pointer for linear vectorial transformation                */
77                          /* The last three parameters are pointers to the in/out/printable vectors    */
78     void  (*applySize)(struct TransInfo *, struct TransData *, float [3][3]);
79                          /* Apply function pointer for rotation transformation (prototype will change */
80     void  (*applyRot)(struct TransInfo *, struct TransData *, float [3]);
81                          /* Apply function pointer for rotation transformation (prototype will change */
82 } TransCon;
83
84 typedef struct TransDataIpokey {
85         int flag;                                       /* which keys */
86         float *locx, *locy, *locz;      /* channel pointers */
87         float *rotx, *roty, *rotz;
88         float *quatx, *quaty, *quatz, *quatw;
89         float *sizex, *sizey, *sizez;
90         float oldloc[9];                        /* storage old values */
91         float oldrot[9];
92         float oldsize[9];
93         float oldquat[12];
94 } TransDataIpokey;
95
96 typedef struct TransDataExtension {
97         float drot[3];           /* Initial object drot */
98         float dsize[3];          /* Initial object dsize */
99     float *rot;          /* Rotation of the data to transform (Faculative)                                 */
100     float  irot[3];      /* Initial rotation                                                               */
101     float *quat;         /* Rotation quaternion of the data to transform (Faculative)                      */
102     float  iquat[4];     /* Initial rotation quaternion                                                    */
103     float *size;         /* Size of the data to transform (Faculative)                                     */
104     float  isize[3];     /* Initial size                                                                   */
105         float  obmat[3][3];      /* Object matrix */  
106 } TransDataExtension;
107
108 typedef struct TransData {
109         float  dist;         /* Distance needed to affect element (for Proportionnal Editing)                  */
110         float  rdist;        /* Distance to the nearest element (for Proportionnal Editing)                    */
111         float  factor;       /* Factor of the transformation (for Proportionnal Editing)                       */
112     float *loc;          /* Location of the data to transform                                              */
113     float  iloc[3];      /* Initial location                                                               */
114         float *val;          /* Value pointer for special transforms */
115         float  ival;         /* Old value*/
116     float  center[3];    /* Individual data center                                                         */
117     float  mtx[3][3];    /* Transformation matrix from data space to global space                          */
118     float  smtx[3][3];   /* Transformation matrix from global space to data space                          */
119         float  axismtx[3][3];/* Axis orientation matrix of the data                                            */
120         struct Object *ob;
121         TransDataExtension *ext;        /* for objects, poses. 1 single malloc per TransInfo! */
122         TransDataIpokey *tdi;           /* for objects, ipo keys. per transdata a malloc */
123     int    flag;         /* Various flags */
124 } TransData;
125
126 typedef struct TransInfo {
127     int         mode;           /* current mode                         */
128     int         flag;           /* generic flags for special behaviors  */
129         short           state;                  /* current state (running, canceled,...)*/
130     int         context;        /* current context                      */
131     float       val;            /* init value for some transformations (and rotation angle)  */
132     float       fac;            /* factor for distance based transform  */
133     int       (*transform)(struct TransInfo *, short *);
134                                 /* transform function pointer           */
135     int         total;          /* total number of transformed data     */
136     TransData  *data;           /* transformed data (array)             */
137         TransDataExtension *ext;        /* transformed data extension (array)   */
138     TransCon    con;            /* transformed constraint               */
139     NumInput    num;            /* numerical input                      */
140     char        redraw;         /* redraw flag                          */
141         float           propsize;               /* proportional circle radius           */
142         char            proptext[20];   /* proportional falloff text                    */
143     float       center[3];      /* center of transformation             */
144     int         center2d[2];    /* center in screen coordinates         */
145     short       imval[2];       /* initial mouse position               */
146         short           shiftmval[2];   /* mouse position when shift was pressed */
147         short       idx_max;            /* maximum index on the input vector    */
148         float           snap[3];                /* Snapping Gears                                               */
149         
150         float           viewmat[4][4];  /* copy from G.vd, prevents feedback    */
151         float           viewinv[4][4];
152         float           persinv[4][4];
153         
154         float           vec[3];                 /* translation, to show for widget      */
155         float           mat[3][3];              /* rot/rescale, to show for widget      */
156         
157         char            *undostr;               /* if set, uses this string for undo            */
158         float           spacemtx[3][3]; /* orientation matrix of the current space      */
159         char            spacename[32];  /* name of the current space                            */
160         
161         struct Object *poseobj;         /* if t->flag & T_POSE, this denotes pose object */
162 } TransInfo;
163
164
165 /* ******************** Macros & Prototypes *********************** */
166
167 /* NUMINPUT FLAGS */
168 #define NUM_NULL_ONE            2
169 #define NUM_NO_NEGATIVE         4
170 #define NUM_NO_ZERO                     8
171 #define NUM_NO_FRACTION         16
172 #define NUM_AFFECT_ALL          32
173
174 /* transinfo->state */
175 #define TRANS_RUNNING   0
176 #define TRANS_CONFIRM   1
177 #define TRANS_CANCEL    2
178
179 /* transinfo->flag */
180 #define T_OBJECT                1
181 #define T_EDIT                  2
182 #define T_POSE                  4
183 #define T_TEXTURE               8
184 #define T_CAMERA                16
185                 // when shift pressed, higher resolution transform. cannot rely on G.qual, need event!
186 #define T_SHIFT_MOD             32
187                 // for manipulator exceptions, like scaling using center point, drawing help lines
188 #define T_USES_MANIPULATOR      128
189
190 /* restrictions flags */
191 #define T_ALL_RESTRICTIONS      (256|512|1024)
192 #define T_NO_CONSTRAINT         256
193 #define T_NULL_ONE                      512
194 #define T_NO_ZERO                       1024
195
196 #define T_PROP_EDIT              2048
197 #define T_PROP_CONNECTED 4096
198
199 /* if MMB is pressed or not */
200 #define T_MMB_PRESSED   8192
201
202 /* transinfo->con->mode */
203 #define CON_APPLY               1
204 #define CON_AXIS0               2
205 #define CON_AXIS1               4
206 #define CON_AXIS2               8
207 #define CON_SELECT              16
208 #define CON_NOFLIP              32      /* does not reorient vector to face viewport when on */
209 #define CON_LOCAL               64
210 #define CON_USER                128
211
212 /* transdata->flag */
213 #define TD_SELECTED                     1
214 #define TD_NOACTION                     2
215 #define TD_USEQUAT                      4
216 #define TD_NOTCONNECTED         8
217 #define TD_SINGLESIZE           16      /* used for scaling of MetaElem->rad */
218
219 void checkFirstTime(void);
220
221 void initWarp(TransInfo *t);
222 int Warp(TransInfo *t, short mval[2]);
223
224 void initShear(TransInfo *t);
225 int Shear(TransInfo *t, short mval[2]);
226
227 void initResize(TransInfo *t);
228 int Resize(TransInfo *t, short mval[2]);
229
230 void initTranslation(TransInfo *t);
231 int Translation(TransInfo *t, short mval[2]);
232
233 void initToSphere(TransInfo *t);
234 int ToSphere(TransInfo *t, short mval[2]);
235
236 void initRotation(TransInfo *t);
237 int Rotation(TransInfo *t, short mval[2]);
238
239 void initShrinkFatten(TransInfo *t);
240 int ShrinkFatten(TransInfo *t, short mval[2]);
241
242 void initTilt(TransInfo *t);
243 int Tilt(TransInfo *t, short mval[2]);
244
245 void initTrackball(TransInfo *t);
246 int Trackball(TransInfo *t, short mval[2]);
247
248 void initPushPull(TransInfo *t);
249 int PushPull(TransInfo *t, short mval[2]);
250
251 void initCrease(TransInfo *t);
252 int Crease(TransInfo *t, short mval[2]);
253
254 void initBoneSize(TransInfo *t);
255 int BoneSize(TransInfo *t, short mval[2]);
256
257 void initBoneEnvelope(TransInfo *t);
258 int BoneEnvelope(TransInfo *t, short mval[2]);
259
260 /*********************** transform_conversions.c ********** */
261 struct ListBase;
262 void count_bone_select(TransInfo *t, struct ListBase *lb, int do_it);
263
264 /*********************** exported from transform_manipulator.c ********** */
265 struct ScrArea;
266 void draw_manipulator_ext(struct ScrArea *sa, int type, char axis, int col, float vec[3], float mat[][3]);
267 int calc_manipulator_stats(struct ScrArea *sa);
268
269 /*********************** TransData Creation and General Handling *********** */
270 void createTransData(TransInfo *t);
271 void sort_trans_data_dist(TransInfo *t);
272 void add_tdi_poin(float *poin, float *old, float delta);
273 void special_aftertrans_update(TransInfo *t);
274
275 /*********************** Constraints *****************************/
276
277 void getConstraintMatrix(TransInfo *t);
278 void setConstraint(TransInfo *t, float space[3][3], int mode, const char text[]);
279 void setLocalConstraint(TransInfo *t, int mode, const char text[]);
280 void setUserConstraint(TransInfo *t, int mode, const char text[]);
281
282 void constraintNumInput(TransInfo *t, float vec[3]);
283
284 void getConstraintMatrix(TransInfo *t);
285 int isLockConstraint(TransInfo *t);
286 int getConstraintSpaceDimension(TransInfo *t);
287 char constraintModeToChar(TransInfo *t);
288
289 void startConstraint(TransInfo *t);
290 void stopConstraint(TransInfo *t);
291
292 void initSelectConstraint(TransInfo *t, float mtx[3][3]);
293 void selectConstraint(TransInfo *t);
294 void postSelectConstraint(TransInfo *t);
295
296 void setNearestAxis(TransInfo *t);
297
298 /*********************** Generics ********************************/
299
300 void initTrans(TransInfo *t);
301 void initTransModeFlags(TransInfo *t, int mode);
302 void postTrans (TransInfo *t);
303
304 void drawLine(float *center, float *dir, char axis, short options);
305
306 /* DRAWLINE options flags */
307 #define DRAWLIGHT       1
308 #define DRAWDASHED      2
309 #define DRAWBOLD        4
310
311 void applyTransObjects(TransInfo *t);
312 void restoreTransObjects(TransInfo *t);
313 void recalcData(TransInfo *t);
314
315 void calculateCenter(TransInfo *t);
316 void calculateCenterBound(TransInfo *t);
317 void calculateCenterMedian(TransInfo *t);
318 void calculateCenterCursor(TransInfo *t);
319
320 void calculatePropRatio(TransInfo *t);
321
322 void snapGrid(TransInfo *t, float *val);
323
324 void getViewVector(float coord[3], float vec[3]);
325
326 TransInfo * BIF_GetTransInfo(void);
327
328 /*********************** NumInput ********************************/
329
330 void outputNumInput(NumInput *n, char *str);
331 short hasNumInput(NumInput *n);
332 void applyNumInput(NumInput *n, float *vec);
333 char handleNumInput(NumInput *n, unsigned short event);
334
335 #endif
336