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