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