Transform: re-revert new user-axis-first behavior
[blender.git] / source / blender / editors / transform / transform.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/transform/transform.h
29  *  \ingroup edtransform
30  */
31
32
33 #ifndef __TRANSFORM_H__
34 #define __TRANSFORM_H__
35
36 #include "ED_transform.h"
37 #include "ED_numinput.h"
38 #include "ED_view3d.h"
39
40 #include "RE_engine.h"
41
42 #include "DNA_listBase.h"
43
44 #include "DEG_depsgraph.h"
45
46 /* ************************** Types ***************************** */
47
48 struct Depsgraph;
49 struct TransInfo;
50 struct TransDataContainer;
51 struct TransData;
52 struct TransformOrientation;
53 struct TransSnap;
54 struct NumInput;
55 struct Object;
56 struct View3D;
57 struct ScrArea;
58 struct Scene;
59 struct ViewLayer;
60 struct bConstraint;
61 struct wmKeyMap;
62 struct wmKeyConfig;
63 struct bContext;
64 struct wmEvent;
65 struct wmTimer;
66 struct ARegion;
67 struct ReportList;
68 struct RNG;
69 struct EditBone;
70 struct RenderEngineType;
71 struct SnapObjectContext;
72
73 #include "DNA_object_enums.h"
74
75 /* transinfo->redraw */
76 typedef enum {
77         TREDRAW_NOTHING   = 0,
78         TREDRAW_HARD      = 1,
79         TREDRAW_SOFT      = 2,
80 } eRedrawFlag;
81
82 typedef struct TransSnapPoint {
83         struct TransSnapPoint *next, *prev;
84         float co[3];
85 } TransSnapPoint;
86
87 typedef struct TransSnap {
88         short   mode;
89         short   target;
90         short   modePoint;
91         short   modeSelect;
92         bool    align;
93         bool    project;
94         bool    snap_self;
95         bool    peel;
96         bool    snap_spatial_grid;
97         short   status;
98         float   snapPoint[3]; /* snapping from this point (in global-space)*/
99         float   snapTarget[3]; /* to this point (in global-space)*/
100         float   snapNormal[3];
101         char    snapNodeBorder;
102         ListBase points;
103         TransSnapPoint  *selectedPoint;
104         double  last;
105         void  (*applySnap)(struct TransInfo *, float *);
106         void  (*calcSnap)(struct TransInfo *, float *);
107         void  (*targetSnap)(struct TransInfo *);
108         /**
109          * Get the transform distance between two points (used by Closest snap)
110          *
111          * \note Return value can be anything,
112          * where the smallest absolute value defines whats closest.
113          */
114         float  (*distance)(struct TransInfo *t, const float p1[3], const float p2[3]);
115
116         /**
117          * Re-usable snap context data.
118          */
119         struct SnapObjectContext *object_context;
120 } TransSnap;
121
122 typedef struct TransCon {
123         short orientation;       /**/
124         char  text[50];      /* Description of the Constraint for header_print                            */
125         float mtx[3][3];     /* Matrix of the Constraint space                                            */
126         float imtx[3][3];    /* Inverse Matrix of the Constraint space                                    */
127         float pmtx[3][3];    /* Projection Constraint Matrix (same as imtx with some axis == 0)           */
128         int   imval[2];      /* initial mouse value for visual calculation                                */
129                              /* the one in TransInfo is not guarantee to stay the same (Rotates change it)  */
130         int   mode;          /* Mode flags of the Constraint                                              */
131         void  (*drawExtra)(struct TransInfo *t);
132
133                              /* Note: if 'tc' is NULL, 'td' must also be NULL. */
134                              /* For constraints that needs to draw differently from the other
135                               * uses this instead of the generic draw function                            */
136         void  (*applyVec)(struct TransInfo *t, struct TransDataContainer *tc, struct TransData *td, const float in[3], float out[3], float pvec[3]);
137                              /* Apply function pointer for linear vectorial transformation                */
138                              /* The last three parameters are pointers to the in/out/printable vectors    */
139         void  (*applySize)(struct TransInfo *t, struct TransDataContainer *tc, struct TransData *td, float smat[3][3]);
140                              /* Apply function pointer for size transformation */
141         void  (*applyRot)(struct TransInfo *t, struct TransDataContainer *tc, struct TransData *td, float vec[3], float *angle);
142                              /* Apply function pointer for rotation transformation */
143 } TransCon;
144
145 typedef struct TransDataExtension {
146         float drot[3];           /* Initial object drot */
147         // float drotAngle;      /* Initial object drotAngle,    TODO: not yet implemented */
148         // float drotAxis[3];    /* Initial object drotAxis, TODO: not yet implemented */
149         float dquat[4];          /* Initial object dquat */
150         float dscale[3];     /* Initial object dscale */
151         float *rot;          /* Rotation of the data to transform                                              */
152         float  irot[3];      /* Initial rotation                                                               */
153         float *quat;         /* Rotation quaternion of the data to transform                                   */
154         float  iquat[4];         /* Initial rotation quaternion                                                    */
155         float *rotAngle;         /* Rotation angle of the data to transform                                        */
156         float  irotAngle;        /* Initial rotation angle                                                         */
157         float *rotAxis;          /* Rotation axis of the data to transform                                         */
158         float  irotAxis[4];      /* Initial rotation axis                                                          */
159         float *size;         /* Size of the data to transform                                                  */
160         float  isize[3];         /* Initial size                                                                   */
161         float  obmat[4][4];      /* Object matrix */
162         float  l_smtx[3][3]; /* use instead of td->smtx, It is the same but without the 'bone->bone_mat', see TD_PBONE_LOCAL_MTX_C */
163         float  r_mtx[3][3];  /* The rotscale matrix of pose bone, to allow using snap-align in translation mode,
164                               * when td->mtx is the loc pose bone matrix (and hence can't be used to apply rotation in some cases,
165                               * namely when a bone is in "NoLocal" or "Hinge" mode)... */
166         float  r_smtx[3][3]; /* Inverse of previous one. */
167         int    rotOrder;        /* rotation mode,  as defined in eRotationModes (DNA_action_types.h) */
168         float oloc[3], orot[3], oquat[4], orotAxis[3], orotAngle; /* Original object transformation used for rigid bodies */
169 } TransDataExtension;
170
171 typedef struct TransData2D {
172         float loc[3];           /* Location of data used to transform (x,y,0) */
173         float *loc2d;           /* Pointer to real 2d location of data */
174
175         float *h1, *h2;     /* Pointer to handle locations, if handles aren't being moved independently */
176         float ih1[2], ih2[2];
177 } TransData2D;
178
179 /* we need to store 2 handles for each transdata in case the other handle wasn't selected */
180 typedef struct TransDataCurveHandleFlags {
181         char ih1, ih2;
182         char *h1, *h2;
183 } TransDataCurveHandleFlags;
184
185 /* for sequencer transform */
186 typedef struct TransDataSeq {
187         struct Sequence *seq;
188         int flag;               /* a copy of seq->flag that may be modified for nested strips */
189         int start_offset; /* use this so we can have transform data at the strips start, but apply correctly to the start frame  */
190         short sel_flag; /* one of SELECT, SEQ_LEFTSEL and SEQ_RIGHTSEL */
191
192 } TransDataSeq;
193
194 typedef struct TransSeq {
195         TransDataSeq *tdseq;
196         int min;
197         int max;
198         bool snap_left;
199 } TransSeq;
200
201 /* for NLA transform (stored in td->extra pointer) */
202 typedef struct TransDataNla {
203         ID *id;                                         /* ID-block NLA-data is attached to */
204
205         struct NlaTrack *oldTrack;      /* Original NLA-Track that the strip belongs to */
206         struct NlaTrack *nlt;           /* Current NLA-Track that the strip belongs to */
207
208         struct NlaStrip *strip;         /* NLA-strip this data represents */
209
210         /* dummy values for transform to write in - must have 3 elements... */
211         float h1[3];                            /* start handle */
212         float h2[3];                            /* end handle */
213
214         int trackIndex;                         /* index of track that strip is currently in */
215         int handle;                                     /* handle-index: 0 for dummy entry, -1 for start, 1 for end, 2 for both ends */
216 } TransDataNla;
217
218 struct LinkNode;
219 struct GHash;
220
221 /* header of TransDataEdgeSlideVert, TransDataEdgeSlideEdge */
222 typedef struct TransDataGenericSlideVert {
223         struct BMVert *v;
224         struct LinkNode **cd_loop_groups;
225         float co_orig_3d[3];
226 } TransDataGenericSlideVert;
227
228 typedef struct TransDataEdgeSlideVert {
229         /* TransDataGenericSlideVert */
230         struct BMVert *v;
231         struct LinkNode **cd_loop_groups;
232         float v_co_orig[3];
233         /* end generic */
234
235         float edge_len;
236
237         struct BMVert *v_side[2];
238
239         /* add origvert.co to get the original locations */
240         float dir_side[2][3];
241
242         int loop_nr;
243 } TransDataEdgeSlideVert;
244
245
246 /* store original data so we can correct UV's and similar when sliding */
247 typedef struct SlideOrigData {
248         /* flag that is set when origfaces is initialized */
249         bool use_origfaces;
250         int cd_loop_mdisp_offset;
251
252         struct GHash    *origverts;  /* map {BMVert: TransDataGenericSlideVert} */
253         struct GHash    *origfaces;
254         struct BMesh *bm_origfaces;
255
256         struct MemArena *arena;
257         /* number of math BMLoop layers */
258         int  layer_math_map_num;
259         /* array size of 'layer_math_map_num'
260          * maps TransDataVertSlideVert.cd_group index to absolute CustomData layer index */
261         int *layer_math_map;
262
263         /* array of slide vert data especially for mirror verts */
264         TransDataGenericSlideVert *sv_mirror;
265         int totsv_mirror;
266 } SlideOrigData;
267
268 typedef struct EdgeSlideData {
269         TransDataEdgeSlideVert *sv;
270         int totsv;
271
272         int mval_start[2], mval_end[2];
273         struct BMEditMesh *em;
274
275         SlideOrigData orig_data;
276
277
278         int curr_sv_index;
279
280         /** when un-clamped - use this index: #TransDataEdgeSlideVert.dir_side */
281         int curr_side_unclamp;
282 } EdgeSlideData;
283
284 typedef struct EdgeSlideParams {
285         float perc;
286
287         bool use_even;
288         bool flipped;
289 } EdgeSlideParams;
290
291 typedef struct TransDataVertSlideVert {
292         /* TransDataGenericSlideVert */
293         struct BMVert *v;
294         struct LinkNode **cd_loop_groups;
295         float   co_orig_3d[3];
296         /* end generic */
297
298         float (*co_link_orig_3d)[3];
299         int     co_link_tot;
300         int     co_link_curr;
301 } TransDataVertSlideVert;
302
303 typedef struct VertSlideData {
304         TransDataVertSlideVert *sv;
305         int totsv;
306
307         struct BMEditMesh *em;
308
309         SlideOrigData orig_data;
310
311         int curr_sv_index;
312
313         /* result of ED_view3d_ob_project_mat_get */
314         float proj_mat[4][4];
315 } VertSlideData;
316
317 typedef struct VertSlideParams {
318         float perc;
319
320         bool use_even;
321         bool flipped;
322 } VertSlideParams;
323
324 typedef struct BoneInitData {
325         struct EditBone *bone;
326         float tail[3];
327         float rad_tail;
328         float roll;
329         float head[3];
330         float dist;
331         float xwidth;
332         float zwidth;
333 } BoneInitData;
334
335 typedef struct TransData {
336         float  dist;         /* Distance needed to affect element (for Proportionnal Editing)                  */
337         float  rdist;        /* Distance to the nearest element (for Proportionnal Editing)                    */
338         float  factor;       /* Factor of the transformation (for Proportionnal Editing)                       */
339         float *loc;          /* Location of the data to transform                                              */
340         float  iloc[3];      /* Initial location                                                               */
341         float *val;          /* Value pointer for special transforms */
342         float  ival;         /* Old value*/
343         float  center[3];        /* Individual data center                                                         */
344         float  mtx[3][3];    /* Transformation matrix from data space to global space                          */
345         float  smtx[3][3];   /* Transformation matrix from global space to data space                          */
346         float  axismtx[3][3];/* Axis orientation matrix of the data                                            */
347         struct Object *ob;
348         struct bConstraint *con;        /* for objects/bones, the first constraint in its constraint stack */
349         TransDataExtension *ext;        /* for objects, poses. 1 single malloc per TransInfo! */
350         TransDataCurveHandleFlags *hdata; /* for curves, stores handle flags for modification/cancel */
351         void  *extra;            /* extra data (mirrored element pointer, in editmode mesh to BMVert) (editbone for roll fixing) (...) */
352         int  flag;           /* Various flags */
353         short  protectflag;      /* If set, copy of Object or PoseChannel protection */
354 } TransData;
355
356 typedef struct MouseInput {
357         void    (*apply)(struct TransInfo *t, struct MouseInput *mi, const double mval[2], float output[3]);
358         void    (*post)(struct TransInfo *t, float values[3]);
359
360         int     imval[2];               /* initial mouse position                */
361         bool    precision;
362         float   precision_factor;
363         float   center[2];
364         float   factor;
365         void    *data; /* additional data, if needed by the particular function */
366
367         /**
368          * Use virtual cursor, which takes precision into account
369          * keeping track of the cursors 'virtual' location,
370          * to avoid jumping values when its toggled.
371          *
372          * This works well for scaling drag motion,
373          * but not for rotating around a point (rotaton needs its own custom accumulator)
374          */
375         bool use_virtual_mval;
376         struct {
377                 double prev[2];
378                 double accum[2];
379         } virtual_mval;
380 } MouseInput;
381
382 typedef struct TransCustomData {
383         void       *data;
384         void      (*free_cb)(struct TransInfo *, struct TransDataContainer *tc, struct TransCustomData *custom_data);
385         unsigned int use_free : 1;
386 } TransCustomData;
387
388 typedef struct TransCenterData {
389         float global[3];
390         unsigned int is_set : 1;
391 } TransCenterData;
392
393 /**
394  * Rule of thumb for choosing between mode/type:
395  * - If transform mode uses the data, assign to `mode`
396  *   (typically in transform.c).
397  * - If conversion uses the data as an extension to the #TransData, assign to `type`
398  *   (typically in transform_conversion.c).
399  */
400 typedef struct TransCustomDataContainer {
401         /** Owned by the mode (grab, scale, bend... ).*/
402         union {
403                 TransCustomData mode, first_elem;
404         };
405         TransCustomData type;
406 } TransCustomDataContainer;
407 #define TRANS_CUSTOM_DATA_ELEM_MAX (sizeof(TransCustomDataContainer) / sizeof(TransCustomData))
408
409 typedef struct TransDataContainer {
410         /**
411          * Use for cases we care about the active, eg: active vert of active mesh.
412          * if set this will _always_ be the first item in the array.
413          */
414         bool is_active;
415
416         /** Transformed data (array). */
417         TransData *data;
418         /** Total number of transformed data. */
419         int data_len;
420
421         /** Transformed data extension (array). */
422         TransDataExtension *data_ext;
423         /** Transformed data for 2d (array). */
424         TransData2D *data_2d;
425
426         struct Object *obedit;
427
428         /**
429          * Use when #T_LOCAL_MATRIX is set.
430          * Typically: 'obedit->obmat' or 'poseobj->obmat', but may be used elsewhere too.
431          */
432         bool use_local_mat;
433         float  mat[4][4];
434         float imat[4][4];
435         /** 3x3 copies of matrices above. */
436         float  mat3[3][3];
437         float imat3[3][3];
438
439         /** Normalized 'mat3' */
440         float  mat3_unit[3][3];
441
442         /** if 't->flag & T_POSE', this denotes pose object */
443         struct Object *poseobj;
444
445         /** Center of transformation (in local-space), Calculated from #TransInfo.center_global. */
446         float center_local[3];
447
448         TransCustomDataContainer custom;
449 } TransDataContainer;
450
451 typedef struct TransInfo {
452         TransDataContainer *data_container;
453         int                 data_container_len;
454         /** Combine length of all #TransDataContainer.data_len
455          * Use to check if nothing is selected or if we have a single selection. */
456         int data_len_all;
457
458         int         mode;           /* current mode                         */
459         int             flag;           /* generic flags for special behaviors  */
460         int                     modifiers;              /* special modifiers, by function, not key */
461         short           state;                  /* current state (running, canceled,...)*/
462         int         options;        /* current context/options for transform                      */
463         float       val;            /* init value for some transformations (and rotation angle)  */
464         void      (*transform)(struct TransInfo *, const int[2]);
465                                                                 /* transform function pointer           */
466         eRedrawFlag (*handleEvent)(struct TransInfo *, const struct wmEvent *);
467                                                                 /* event handler function pointer  RETURN 1 if redraw is needed */
468         TransCon    con;            /* transformed constraint               */
469         TransSnap       tsnap;
470         NumInput    num;            /* numerical input                      */
471         MouseInput      mouse;                  /* mouse input                          */
472         eRedrawFlag redraw;         /* redraw flag                          */
473         float           prop_size;              /* proportional circle radius           */
474         char            proptext[20];   /* proportional falloff text                    */
475         float       aspect[3];      /* spaces using non 1:1 aspect, (uv's, f-curve, movie-clip... etc)
476                                      * use for conversion and snapping. */
477         float       center_global[3];  /* center of transformation (in global-space) */
478         float       center2d[2];    /* center in screen coordinates         */
479         /* Lazy initialize center data for when we need other center values.
480          * V3D_AROUND_ACTIVE + 1 (static assert checks this) */
481         TransCenterData center_cache[5];
482         short       idx_max;            /* maximum index on the input vector    */
483         float           snap[3];                /* Snapping Gears                                               */
484         float           snap_spatial[3]; /* Spatial snapping gears(even when rotating, scaling... etc) */
485         char            frame_side;             /* Mouse side of the cfra, 'L', 'R' or 'B' */
486
487         float           viewmat[4][4];  /* copy from G.vd, prevents feedback,   */
488         float           viewinv[4][4];  /* and to make sure we don't have to    */
489         float           persmat[4][4];  /* access G.vd from other space types   */
490         float           persinv[4][4];
491         short           persp;
492         short           around;
493         char            spacetype;              /* spacetype where transforming is      */
494         char            helpline;               /* Choice of custom cursor with or without a help line from the gizmo to the mouse position. */
495         short           obedit_type;    /* Avoid looking inside TransDataContainer obedit. */
496
497         float           vec[3];                 /* translation, to show for widget      */
498         float           mat[3][3];              /* rot/rescale, to show for widget      */
499
500         float           spacemtx[3][3]; /* orientation matrix of the current space      */
501         char            spacename[64];  /* name of the current space, MAX_NAME          */
502
503         /*************** NEW STUFF *********************/
504         short           launch_event;   /* event type used to launch transform */
505
506         struct {
507                 short           user;
508                 /* Used when user is global. */
509                 short           user_alt;
510                 short           index;
511                 short           *types[2];
512                 /* this gets used when current_orientation is V3D_MANIP_CUSTOM */
513                 TransformOrientation *custom;
514         } orientation;
515         short           gizmo_flag;                     /* backup from view3d, to restore on end */
516
517         short           prop_mode;
518
519         short           mirror;
520
521         float           values[4];
522         float           values_modal_offset[4];  /* Offset applied ontop of modal input. */
523         float           auto_values[4];
524         float           axis[3];
525         float           axis_orig[3];   /* TransCon can change 'axis', store the original value here */
526         float           axis_ortho[3];
527
528         bool            remove_on_cancel; /* remove elements if operator is canceled */
529
530         void            *view;
531         struct bContext *context; /* Only valid (non null) during an operator called function. */
532         struct ScrArea  *sa;
533         struct ARegion  *ar;
534         struct Depsgraph *depsgraph;
535         struct Scene    *scene;
536         struct ViewLayer *view_layer;
537         struct ToolSettings *settings;
538         struct wmTimer *animtimer;
539         struct wmKeyMap *keymap;  /* so we can do lookups for header text */
540         struct ReportList *reports;  /* assign from the operator, or can be NULL */
541         int         mval[2];        /* current mouse position               */
542         float       zfac;           /* use for 3d view */
543         void            *draw_handle_apply;
544         void            *draw_handle_view;
545         void            *draw_handle_pixel;
546         void            *draw_handle_cursor;
547
548         /** Currently only used for random curve of proportional editing. */
549         struct RNG *rng;
550
551         /** Typically for mode settings. */
552         TransCustomDataContainer custom;
553 } TransInfo;
554
555
556 /* ******************** Macros & Prototypes *********************** */
557
558 /* transinfo->state */
559 #define TRANS_STARTING  0
560 #define TRANS_RUNNING   1
561 #define TRANS_CONFIRM   2
562 #define TRANS_CANCEL    3
563
564 /* transinfo->flag */
565 #define T_OBJECT                (1 << 0)
566 /** \note We could remove 'T_EDIT' and use 'obedit_type', for now ensure they're in sync. */
567 #define T_EDIT                  (1 << 1)
568 #define T_POSE                  (1 << 2)
569 #define T_TEXTURE               (1 << 3)
570         /* transforming the camera while in camera view */
571 #define T_CAMERA                (1 << 4)
572         /* transforming the 3D cursor. */
573 #define T_CURSOR                (1 << 5)
574                  // trans on points, having no rotation/scale
575 #define T_POINTS                (1 << 6)
576 /**
577  * Apply matrix #TransDataContainer.matrix, this avoids having to have duplicate check all over
578  * that happen to apply to spesiifc modes (edit & pose for eg). */
579 #define T_LOCAL_MATRIX (1 << 7)
580
581         /* restrictions flags */
582 #define T_ALL_RESTRICTIONS      ((1 << 8)|(1 << 9)|(1 << 10))
583 #define T_NO_CONSTRAINT         (1 << 8)
584 #define T_NULL_ONE                      (1 << 9)
585 #define T_NO_ZERO                       (1 << 10)
586
587 #define T_PROP_EDIT                     (1 << 11)
588 #define T_PROP_CONNECTED        (1 << 12)
589 #define T_PROP_PROJECTED        (1 << 25)
590 #define T_PROP_EDIT_ALL         (T_PROP_EDIT | T_PROP_CONNECTED | T_PROP_PROJECTED)
591
592 #define T_V3D_ALIGN                     (1 << 14)
593         /* for 2d views like uv or ipo */
594 #define T_2D_EDIT                       (1 << 15)
595 #define T_CLIP_UV                       (1 << 16)
596
597         /* auto-ik is on */
598 #define T_AUTOIK                        (1 << 18)
599
600 #define T_MIRROR                        (1 << 19)
601
602 #define T_AUTOVALUES            (1 << 20)
603
604         /* to specify if we save back settings at the end */
605 #define T_MODAL                         (1 << 21)
606
607         /* no retopo */
608 #define T_NO_PROJECT            (1 << 22)
609
610 #define T_RELEASE_CONFIRM       (1 << 23)
611
612         /* alternative transformation. used to add offset to tracking markers */
613 #define T_ALT_TRANSFORM         (1 << 24)
614
615         /** #TransInfo.center has been set, don't change it. */
616 #define T_OVERRIDE_CENTER       (1 << 25)
617
618 #define T_MODAL_CURSOR_SET      (1 << 26)
619
620 #define T_CLNOR_REBUILD         (1 << 27)
621
622 /* TransInfo->modifiers */
623 #define MOD_CONSTRAINT_SELECT   0x01
624 #define MOD_PRECISION                   0x02
625 #define MOD_SNAP                                0x04
626 #define MOD_SNAP_INVERT                 0x08
627 #define MOD_CONSTRAINT_PLANE    0x10
628
629 /* use node center for transform instead of upper-left corner.
630  * disabled since it makes absolute snapping not work so nicely
631  */
632 // #define USE_NODE_CENTER
633
634
635 /* ******************************************************************************** */
636
637 /* transinfo->helpline */
638 #define HLP_NONE                0
639 #define HLP_SPRING              1
640 #define HLP_ANGLE               2
641 #define HLP_HARROW              3
642 #define HLP_VARROW              4
643 #define HLP_CARROW              5
644 #define HLP_TRACKBALL   6
645
646 /* transinfo->con->mode */
647 #define CON_APPLY               1
648 #define CON_AXIS0               2
649 #define CON_AXIS1               4
650 #define CON_AXIS2               8
651 #define CON_SELECT              16
652 #define CON_NOFLIP              32      /* does not reorient vector to face viewport when on */
653 #define CON_USER                64
654
655 /* transdata->flag */
656 #define TD_SELECTED                     1
657 #define TD_NOACTION                     (1 << 2)
658 #define TD_USEQUAT                      (1 << 3)
659 #define TD_NOTCONNECTED         (1 << 4)
660 #define TD_SINGLESIZE           (1 << 5)        /* used for scaling of MetaElem->rad */
661 #define TD_INDIVIDUAL_SCALE     (1 << 8) /* Scale relative to individual element center */
662 #define TD_NOCENTER                     (1 << 9)
663 #define TD_NO_EXT                       (1 << 10)       /* ext abused for particle key timing */
664 #define TD_SKIP                         (1 << 11)       /* don't transform this data */
665 #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 */
666 #define TD_NO_LOC                       (1 << 13)       /* when this is set, don't apply translation changes to this element */
667 #define TD_NOTIMESNAP           (1 << 14)       /* for Graph Editor autosnap, indicates that point should not undergo autosnapping */
668 #define TD_INTVALUES            (1 << 15)       /* for Graph Editor - curves that can only have int-values need their keyframes tagged with this */
669 #define TD_MIRROR_EDGE          (1 << 16)       /* For editmode mirror, clamp to x = 0 */
670 #define TD_MOVEHANDLE1          (1 << 17)       /* For fcurve handles, move them along with their keyframes */
671 #define TD_MOVEHANDLE2          (1 << 18)
672 #define TD_PBONE_LOCAL_MTX_P (1 << 19)  /* exceptional case with pose bone rotating when a parent bone has 'Local Location' option enabled and rotating also transforms it. */
673 #define TD_PBONE_LOCAL_MTX_C (1 << 20)  /* same as above but for a child bone */
674
675 /* transsnap->status */
676 #define SNAP_FORCED             1
677 #define TARGET_INIT             2
678 #define POINT_INIT              4
679 #define MULTI_POINTS    8
680
681 /* Hard min/max for proportional size. */
682 #define T_PROP_SIZE_MIN 1e-6f
683 #define T_PROP_SIZE_MAX 1e12f
684
685 bool initTransform(struct bContext *C, struct TransInfo *t, struct wmOperator *op, const struct wmEvent *event, int mode);
686 void saveTransform(struct bContext *C, struct TransInfo *t, struct wmOperator *op);
687 int  transformEvent(TransInfo *t, const struct wmEvent *event);
688 void transformApply(struct bContext *C, TransInfo *t);
689 int  transformEnd(struct bContext *C, TransInfo *t);
690
691 void setTransformViewMatrices(TransInfo *t);
692 void setTransformViewAspect(TransInfo *t, float r_aspect[3]);
693 void convertViewVec(TransInfo *t, float r_vec[3], double dx, double dy);
694 void projectIntViewEx(TransInfo *t, const float vec[3], int adr[2], const eV3DProjTest flag);
695 void projectIntView(TransInfo *t, const float vec[3], int adr[2]);
696 void projectFloatViewEx(TransInfo *t, const float vec[3], float adr[2], const eV3DProjTest flag);
697 void projectFloatView(TransInfo *t, const float vec[3], float adr[2]);
698
699 void applyAspectRatio(TransInfo *t, float vec[2]);
700 void removeAspectRatio(TransInfo *t, float vec[2]);
701
702 void drawPropCircle(const struct bContext *C, TransInfo *t);
703
704 struct wmKeyMap *transform_modal_keymap(struct wmKeyConfig *keyconf);
705
706
707 /*********************** transform_conversions.c ********** */
708 struct ListBase;
709
710 void flushTransIntFrameActionData(TransInfo *t);
711 void flushTransGraphData(TransInfo *t);
712 void remake_graph_transdata(TransInfo *t, struct ListBase *anim_data);
713 void flushTransUVs(TransInfo *t);
714 void flushTransParticles(TransInfo *t);
715 bool clipUVTransform(TransInfo *t, float vec[2], const bool resize);
716 void clipUVData(TransInfo *t);
717 void flushTransNodes(TransInfo *t);
718 void flushTransSeq(TransInfo *t);
719 void flushTransTracking(TransInfo *t);
720 void flushTransMasking(TransInfo *t);
721 void flushTransPaintCurve(TransInfo *t);
722 void restoreBones(TransDataContainer *tc);
723
724 /*********************** transform_gizmo.c ********** */
725
726 #define GIZMO_AXIS_LINE_WIDTH 2.0f
727
728 /* return 0 when no gimbal for selection */
729 bool gimbal_axis(struct Object *ob, float gmat[3][3]);
730 void drawDial3d(const TransInfo *t);
731
732 /*********************** TransData Creation and General Handling *********** */
733 void createTransData(struct bContext *C, TransInfo *t);
734 void sort_trans_data_dist(TransInfo *t);
735 void special_aftertrans_update(struct bContext *C, TransInfo *t);
736 int  special_transform_moving(TransInfo *t);
737
738 void transform_autoik_update(TransInfo *t, short mode);
739 bool transdata_check_local_islands(TransInfo *t, short around);
740
741 int count_set_pose_transflags(struct Object *ob, const int mode, const short around, bool has_translate_rotate[2]);
742
743 /* Auto-keyframe applied after transform, returns true if motion paths need to be updated. */
744 void autokeyframe_object(
745         struct bContext *C, struct Scene *scene, struct ViewLayer *view_layer, struct Object *ob, int tmode);
746 void autokeyframe_pose(
747         struct bContext *C, struct Scene *scene, struct Object *ob, int tmode, short targetless_ik);
748
749 /* Test if we need to update motion paths for a given object. */
750 bool motionpath_need_update_object(struct Scene *scene, struct Object *ob);
751 bool motionpath_need_update_pose(struct Scene *scene, struct Object *ob);
752
753 /*********************** Constraints *****************************/
754
755 void drawConstraint(TransInfo *t);
756
757 void getConstraintMatrix(TransInfo *t);
758 void setConstraint(TransInfo *t, float space[3][3], int mode, const char text[]);
759 void setAxisMatrixConstraint(TransInfo *t, int mode, const char text[]);
760 void setLocalConstraint(TransInfo *t, int mode, const char text[]);
761 void setUserConstraint(TransInfo *t, short orientation, int mode, const char text[]);
762
763 void constraintNumInput(TransInfo *t, float vec[3]);
764
765 bool isLockConstraint(TransInfo *t);
766 int  getConstraintSpaceDimension(TransInfo *t);
767 char constraintModeToChar(TransInfo *t);
768
769 void startConstraint(TransInfo *t);
770 void stopConstraint(TransInfo *t);
771
772 void initSelectConstraint(TransInfo *t, float mtx[3][3]);
773 void selectConstraint(TransInfo *t);
774 void postSelectConstraint(TransInfo *t);
775
776 void setNearestAxis(TransInfo *t);
777
778 /*********************** Snapping ********************************/
779
780 typedef enum {
781         NO_GEARS        = 0,
782         BIG_GEARS       = 1,
783         SMALL_GEARS     = 2
784 } GearsType;
785
786 void snapGridIncrement(TransInfo *t, float *val);
787 void snapGridIncrementAction(TransInfo *t, float *val, GearsType action);
788
789 void snapSequenceBounds(TransInfo *t, const int mval[2]);
790
791 bool activeSnap(const TransInfo *t);
792 bool validSnap(const TransInfo *t);
793
794 void initSnapping(struct TransInfo *t, struct wmOperator *op);
795 void freeSnapping(struct TransInfo *t);
796 void applyProject(TransInfo *t);
797 void applyGridAbsolute(TransInfo *t);
798 void applySnapping(TransInfo *t, float *vec);
799 void resetSnapping(TransInfo *t);
800 eRedrawFlag handleSnapping(TransInfo *t, const struct wmEvent *event);
801 void drawSnapping(const struct bContext *C, TransInfo *t);
802 bool usingSnappingNormal(const TransInfo *t);
803 bool validSnappingNormal(const TransInfo *t);
804
805 void getSnapPoint(const TransInfo *t, float vec[3]);
806 void addSnapPoint(TransInfo *t);
807 eRedrawFlag updateSelectedSnapPoint(TransInfo *t);
808 void removeSnapPoint(TransInfo *t);
809
810 /********************** Mouse Input ******************************/
811
812 typedef enum {
813         INPUT_NONE,
814         INPUT_VECTOR,
815         INPUT_SPRING,
816         INPUT_SPRING_FLIP,
817         INPUT_SPRING_DELTA,
818         INPUT_ANGLE,
819         INPUT_ANGLE_SPRING,
820         INPUT_TRACKBALL,
821         INPUT_HORIZONTAL_RATIO,
822         INPUT_HORIZONTAL_ABSOLUTE,
823         INPUT_VERTICAL_RATIO,
824         INPUT_VERTICAL_ABSOLUTE,
825         INPUT_CUSTOM_RATIO,
826         INPUT_CUSTOM_RATIO_FLIP,
827 } MouseInputMode;
828
829 void initMouseInput(TransInfo *t, MouseInput *mi, const float center[2], const int mval[2], const bool precision);
830 void initMouseInputMode(TransInfo *t, MouseInput *mi, MouseInputMode mode);
831 eRedrawFlag handleMouseInput(struct TransInfo *t, struct MouseInput *mi, const struct wmEvent *event);
832 void applyMouseInput(struct TransInfo *t, struct MouseInput *mi, const int mval[2], float output[3]);
833
834 void setCustomPoints(TransInfo *t, MouseInput *mi, const int start[2], const int end[2]);
835 void setCustomPointsFromDirection(TransInfo *t, MouseInput *mi, const float dir[2]);
836 void setInputPostFct(MouseInput *mi, void       (*post)(struct TransInfo *t, float values[3]));
837
838 /*********************** Generics ********************************/
839
840 void initTransDataContainers_FromObjectData(TransInfo *t, struct Object *obact, struct Object **objects, uint objects_len);
841 void initTransInfo(struct bContext *C, TransInfo *t, struct wmOperator *op, const struct wmEvent *event);
842 void freeTransCustomDataForMode(TransInfo *t);
843 void postTrans(struct bContext *C, TransInfo *t);
844 void resetTransModal(TransInfo *t);
845 void resetTransRestrictions(TransInfo *t);
846
847 void drawLine(TransInfo *t, const float center[3], const float dir[3], char axis, short options);
848
849 /* DRAWLINE options flags */
850 #define DRAWLIGHT       1
851
852 void applyTransObjects(TransInfo *t);
853 void restoreTransObjects(TransInfo *t);
854 void recalcData(TransInfo *t);
855
856 void calculateCenter2D(TransInfo *t);
857 void calculateCenterLocal(TransInfo *t, const float center_global[3]);
858
859 const TransCenterData *transformCenter_from_type(TransInfo *t, int around);
860 void calculateCenter(TransInfo *t);
861
862 /* API functions for getting center points */
863 void calculateCenterBound(TransInfo *t, float r_center[3]);
864 void calculateCenterMedian(TransInfo *t, float r_center[3]);
865 void calculateCenterCursor(TransInfo *t, float r_center[3]);
866 void calculateCenterCursor2D(TransInfo *t, float r_center[2]);
867 void calculateCenterCursorGraph2D(TransInfo *t, float r_center[2]);
868 bool calculateCenterActive(TransInfo *t, bool select_only, float r_center[3]);
869
870 void calculatePropRatio(TransInfo *t);
871
872 void getViewVector(const TransInfo *t, const float coord[3], float vec[3]);
873
874 void transform_data_ext_rotate(TransData *td, float mat[3][3], bool use_drot);
875
876 /*********************** Transform Orientations ******************************/
877
878 void initTransformOrientation(struct bContext *C, TransInfo *t);
879
880 /* Those two fill in mat and return non-zero on success */
881 bool createSpaceNormal(float mat[3][3], const float normal[3]);
882 bool createSpaceNormalTangent(float mat[3][3], const float normal[3], const float tangent[3]);
883
884 struct TransformOrientation *addMatrixSpace(struct bContext *C, float mat[3][3],
885                                             const char *name, const bool overwrite);
886 bool applyTransformOrientation(const struct TransformOrientation *ts, float r_mat[3][3], char r_name[64]);
887
888 #define ORIENTATION_NONE        0
889 #define ORIENTATION_NORMAL      1
890 #define ORIENTATION_VERT        2
891 #define ORIENTATION_EDGE        3
892 #define ORIENTATION_FACE        4
893 #define ORIENTATION_USE_PLANE(ty) \
894         ELEM(ty, ORIENTATION_NORMAL, ORIENTATION_EDGE, ORIENTATION_FACE)
895
896 int getTransformOrientation_ex(const struct bContext *C, float normal[3], float plane[3], const short around);
897 int getTransformOrientation(const struct bContext *C, float normal[3], float plane[3]);
898
899 void freeCustomNormalArray(TransInfo *t, TransDataContainer *tc, TransCustomData *custom_data);
900
901 void freeEdgeSlideTempFaces(EdgeSlideData *sld);
902 void freeEdgeSlideVerts(TransInfo *t, TransDataContainer *tc, TransCustomData *custom_data);
903 void projectEdgeSlideData(TransInfo *t, bool is_final);
904
905 void freeVertSlideTempFaces(VertSlideData *sld);
906 void freeVertSlideVerts(TransInfo *t, TransDataContainer *tc, TransCustomData *custom_data);
907 void projectVertSlideData(TransInfo *t, bool is_final);
908
909
910 /* TODO. transform_query.c */
911 bool checkUseAxisMatrix(TransInfo *t);
912
913 #define TRANSFORM_SNAP_MAX_PX 100.0f
914 #define TRANSFORM_DIST_INVALID -FLT_MAX
915
916 /* Temp macros. */
917
918 #define TRANS_DATA_CONTAINER_FIRST_OK(t) (&(t)->data_container[0])
919 /* For cases we _know_ there is only one handle. */
920 #define TRANS_DATA_CONTAINER_FIRST_SINGLE(t) (BLI_assert((t)->data_container_len == 1), (&(t)->data_container[0]))
921
922 #define FOREACH_TRANS_DATA_CONTAINER(t, th) \
923         for (TransDataContainer *tc = t->data_container, *tc_end = t->data_container + t->data_container_len; \
924              th != tc_end; \
925              th++)
926
927 #define FOREACH_TRANS_DATA_CONTAINER_INDEX(t, th, i) \
928         for (TransDataContainer *tc = ((i = 0), t->data_container), *tc_end = t->data_container + t->data_container_len; \
929              th != tc_end; \
930              th++, i++)
931
932 #endif