Blender V5.3
transform.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_enum_flags.hh"
12#include "BLI_function_ref.hh"
14
15#include "ED_numinput.hh"
16#include "ED_transform.hh"
17#include "ED_view3d.hh"
18
19#include "DNA_curve_enums.h"
20#include "DNA_listBase.h"
22
23#include "DEG_depsgraph.hh"
24
25namespace blender {
26
27struct Depsgraph;
28
29/* -------------------------------------------------------------------- */
32
33#define T_ALL_RESTRICTIONS (T_NO_CONSTRAINT | T_NULL_ONE)
34#define T_PROP_EDIT_ALL (T_PROP_EDIT | T_PROP_CONNECTED | T_PROP_PROJECTED)
35
36/* Hard min/max for proportional size. */
37#define T_PROP_SIZE_MIN 1e-6f
38#define T_PROP_SIZE_MAX 1e12f
39
40#define TRANSFORM_SNAP_MAX_PX 100.0f
41#define TRANSFORM_DIST_INVALID -FLT_MAX
42
43#define TRANS_DATA_CONTAINER_FIRST_OK(t) (&(t)->data_container[0])
44/* For cases we _know_ there is only one handle. */
45#define TRANS_DATA_CONTAINER_FIRST_SINGLE(t) \
46 (BLI_assert((t)->data_container_len == 1), (&(t)->data_container[0]))
47
48#define FOREACH_TRANS_DATA_CONTAINER(t, th) \
49 for (TransDataContainer *tc = (t)->data_container, \
50 *tc_end = (t)->data_container + (t)->data_container_len; \
51 th != tc_end; \
52 th++)
53
54#define FOREACH_TRANS_DATA_CONTAINER_INDEX(t, th, i) \
55 for (TransDataContainer *tc = ((i = 0), (t)->data_container), \
56 *tc_end = (t)->data_container + (t)->data_container_len; \
57 th != tc_end; \
58 th++, i++)
59
61
62/* -------------------------------------------------------------------- */
65
66struct ARegion;
67struct bConstraint;
68struct NumInput;
69struct Object;
70struct RNG;
71struct ReportList;
72struct Scene;
73struct ScrArea;
74struct ViewLayer;
75struct ViewOpsData;
76struct bContext;
77struct wmEvent;
78struct wmKeyConfig;
79struct wmKeyMap;
80struct wmMsgBus;
81struct wmOperator;
82struct wmTimer;
83
85
86/* -------------------------------------------------------------------- */
89
90namespace ed::transform {
91
92struct TransSnap;
93struct TransConvertTypeInfo;
94struct TransDataContainer;
95struct TransInfo;
96struct TransModeInfo;
97struct TransSeqSnapData;
98struct SnapObjectContext;
99
103
104 /* These are similar to TransInfo::data_type. */
105 CTX_CAMERA = (1 << 0),
106 CTX_CURSOR = (1 << 1),
107 CTX_EDGE_DATA = (1 << 2),
109 CTX_MASK = (1 << 4),
110 CTX_MOVIECLIP = (1 << 5),
111 CTX_OBJECT = (1 << 6),
112 CTX_PAINT_CURVE = (1 << 7),
113 CTX_POSE_BONE = (1 << 8),
116
117 CTX_NO_PET = (1 << 11),
118 CTX_AUTOCONFIRM = (1 << 12),
125};
127
128
129enum eTFlag {
131 T_EDIT = 1 << 0,
133 T_POINTS = 1 << 1,
136 T_NULL_ONE = 1 << 3,
137
138 T_PROP_EDIT = 1 << 4,
141
142 T_V3D_ALIGN = 1 << 7,
144 T_2D_EDIT = 1 << 8,
145 T_CLIP_UV = 1 << 9,
146
148 T_AUTOIK = 1 << 10,
149
151 T_NO_MIRROR = 1 << 11,
152
156
158 T_MODAL = 1 << 13,
159
161 T_NO_PROJECT = 1 << 14,
162
164
167
170
172
174
176 T_AUTOMERGE = 1 << 20,
178 T_AUTOSPLIT = 1 << 21,
179
182
185
187 T_NO_GIZMO = 1 << 24,
188
190
193
195 T_ORIGIN = 1 << 27,
196
205};
207
222
223
224enum eTSnap {
227 /* Special flag for snap to grid. */
230};
232
233
235 DIR_GLOBAL_X = (1 << 0),
236 DIR_GLOBAL_Y = (1 << 1),
237 DIR_GLOBAL_Z = (1 << 2),
238};
240
241
244 CON_APPLY = 1 << 0,
246 CON_AXIS0 = 1 << 1,
247 CON_AXIS1 = 1 << 2,
248 CON_AXIS2 = 1 << 3,
249 CON_SELECT = 1 << 4,
250 CON_USER = 1 << 5,
251};
253
254
261
269
270
282
288
290
291/* -------------------------------------------------------------------- */
296
297enum {
315
316 /* 18 and 19 used by number-input, defined in `ED_numinput.hh`. */
317 // NUM_MODAL_INCREMENT_UP = 18,
318 // NUM_MODAL_INCREMENT_DOWN = 19,
319
324
327
332
335
337
341
344
346
348
350
355};
356
358
359/* -------------------------------------------------------------------- */
362
364enum {
365 TD_SELECTED = 1 << 0,
366 TD_USEQUAT = 1 << 1,
367 /* TD_NOTCONNECTED = 1 << 2, */
372 TD_NOCENTER = 1 << 5,
374 TD_NO_EXT = 1 << 6,
376 TD_SKIP = 1 << 7,
381 TD_BEZTRIPLE = 1 << 8,
383 TD_NO_LOC = 1 << 9,
385 TD_NOTIMESNAP = 1 << 10,
390 TD_INTVALUES = 1 << 11,
392 TD_MIRROR_X = 1 << 12,
393 TD_MIRROR_Y = 1 << 13,
394 TD_MIRROR_Z = 1 << 14,
395#define TD_MIRROR_EDGE_AXIS_SHIFT 12
401 TD_MOVEHANDLE1 = 1 << 15,
402 TD_MOVEHANDLE2 = 1 << 16,
410 /* Grease pencil layer frames. */
412};
413
417 void *extra;
419 float *loc;
421 float iloc[3];
423 float center[3];
425 float *val;
427 float ival;
429 int flag;
430};
431
434 float *loc_src;
435};
436
440 float drot[3];
441#if 0 /* TODO: not yet implemented. */
442 /* Initial object `drotAngle`. */
443 float drotAngle;
444 /* Initial object `drotAxis`. */
445 float drotAxis[3];
446#endif
448 float dquat[4];
450 float dscale[3];
452 float *rot;
454 float irot[3];
456 float *quat;
458 float iquat[4];
460 float *rotAngle;
464 float *rotAxis;
466 float irotAxis[4];
471 float *scale;
473 float iscale[3];
475 float obmat[4][4];
477 float axismtx_gimbal[3][3];
480 float l_smtx[3][3];
486 float r_mtx[3][3];
488 float r_smtx[3][3];
492 float oloc[3], orot[3], oquat[4], orotAxis[3], orotAngle;
493
499};
500
503 float loc[3];
504 union {
506 float *loc2d;
507 int *loc2d_i;
508 };
509
510 float *h1, *h2;
511 float ih1[2], ih2[2];
512};
513
522
523struct TransData : public TransDataBasic {
525 float dist;
527 float rdist;
529 float factor;
531 float mtx[3][3];
533 float smtx[3][3];
535 float axismtx[3][3];
542};
543
545
546/* -------------------------------------------------------------------- */
549
552 float co[3];
553};
554
555struct TransSnap {
556 /* Snapping options stored as flags. */
558 /* Method(s) used for snapping source to target. */
560 /* Part of source to snap to target. */
562 /* Determines which objects are possible target. */
566 /* Snapped Element Type (currently for objects only). */
569 /* For independent snapping in different directions (currently used only by VSE preview). */
572 float snap_source[3];
574 float snap_target[3];
575 float snapNormal[3];
576 ListBaseT<TransSnapPoint> points;
578 double last;
579 void (*snap_target_fn)(TransInfo *, float *);
581
589};
590
591struct TransCon {
593 char text[50];
595 float pmtx[3][3];
598 void (*drawExtra)(TransInfo *t);
599
600 /* NOTE: if 'tc' is NULL, 'td' must also be NULL.
601 * For constraints that needs to draw differently from the other
602 * uses this instead of the generic draw function. */
603
606 void (*applyVec)(const TransInfo *t,
607 const TransDataContainer *tc,
608 const TransData *td,
609 const float in[3],
610 float r_out[3]);
612 void (*applySize)(const TransInfo *t,
613 const TransDataContainer *tc,
614 const TransData *td,
615 float r_smat[3][3]);
617 void (*applyRot)(const TransInfo *t,
618 const TransDataContainer *tc,
619 const TransData *td,
620 float r_axis[3]);
621};
622
624 void (*apply)(TransInfo *t, MouseInput *mi, const double mval[2], float output[3]);
625 void (*post)(TransInfo *t, float values[3]);
626
630 float factor;
633
635 void *data;
636
650};
651
653 void *data;
657 unsigned int use_free : 1;
658};
659
674#define TRANS_CUSTOM_DATA_ELEM_MAX (sizeof(TransCustomDataContainer) / sizeof(TransCustomData))
675
699
706
708
709 float mat[4][4];
710 float imat[4][4];
712 float mat3[3][3];
713 float imat3[3][3];
714
716 float mat3_unit[3][3];
717
720
722 float center_local[3];
723
729
736
737 /* True if the mirror modifier's clipping boundary has been hit. */
739
741 union {
742 struct {
746 };
747 /* For easy checking. */
749 };
750
752
771
784 bool foreach_index(FunctionRef<bool(int)> fn) const
785 {
786 if (this->sorted_index_map) {
787 for (const int i : Span(this->sorted_index_map, this->data_len)) {
788 if (!fn(i)) {
789 return false;
790 }
791 }
792 }
793 else {
794 for (const int i : IndexRange(this->data_len)) {
795 if (!fn(i)) {
796 return false;
797 }
798 }
799 }
800 return true;
801 }
802
811 void foreach_index_selected(FunctionRef<void(int)> fn) const
812 {
813 this->foreach_index([&](const int i) {
814 const bool is_selected = (this->data[i].flag & TD_SELECTED);
815 if (!is_selected) {
816 /* Selected items are sorted first. Either this is trivially true
817 * (proportional editing off, so the only transformed data is the
818 * selected data) or it's handled by `sorted_index_map`. */
819 return false;
820 }
821 fn(i);
822 return true;
823 });
824 }
825};
826
827struct TransInfo {
830
834
837
842
855
858
861
864
867
871 char proptext[20];
876 float aspect[3];
880 float center2d[2];
882 short idx_max;
887 float snap_spatial[3];
895
897 float viewmat[4][4];
899 float viewinv[4][4];
901 float persmat[4][4];
902 float persinv[4][4];
903 short persp;
904 short around;
909
911 float vec[3];
913 float mat[3][3];
914
916 float spacemtx[3][3];
917 float spacemtx_inv[3][3];
919 char spacename[/*MAX_NAME*/ 64];
920
921 /*************** NEW STUFF *********************/
929
931
932 struct {
933 short type;
934 float matrix[3][3];
935 } orient[3];
936
938
944
946
948 float values[4];
949
952
956 float values_final[4];
957
960
961 /* Axis members for modes that use an axis separate from the orientation (rotate & shear). */
962
967
970
971 void *view;
977 Depsgraph *depsgraph;
990 float zfac;
994
997
999
1002
1003 /* Needed for sculpt transform. */
1004 const char *undo_name;
1005};
1006
1008
1009/* -------------------------------------------------------------------- */
1012
1018bool initTransform(bContext *C, TransInfo *t, wmOperator *op, const wmEvent *event, int mode);
1026
1028void setTransformViewAspect(TransInfo *t, float r_aspect[3]);
1029void convertViewVec(TransInfo *t, float r_vec[3], double dx, double dy);
1033void projectFloatViewCenterFallback(TransInfo *t, float adr[2]);
1034void projectIntViewEx(TransInfo *t, const float vec[3], int adr[2], eV3DProjTest flag);
1035void projectIntView(TransInfo *t, const float vec[3], int adr[2]);
1036void projectFloatViewEx(TransInfo *t, const float vec[3], float adr[2], eV3DProjTest flag);
1037void projectFloatView(TransInfo *t, const float vec[3], float adr[2]);
1038
1039void applyAspectRatio(TransInfo *t, float vec[2]);
1040void removeAspectRatio(TransInfo *t, float vec[2]);
1041
1046
1050bool transform_apply_matrix(TransInfo *t, float mat[4][4]);
1051void transform_final_value_get(const TransInfo *t, float *value, int value_num);
1052void view_vector_calc(const TransInfo *t, const float focus[3], float r_vec[3]);
1053
1055
1056/* -------------------------------------------------------------------- */
1059
1061void transform_view_vector_calc(const TransInfo *t, const float focus[3], float r_vec[3]);
1062bool transdata_check_local_islands(TransInfo *t, short around);
1063
1065
1066/* -------------------------------------------------------------------- */
1069
1088
1089void initMouseInput(
1090 TransInfo *t, MouseInput *mi, const float2 &center, const float2 &mval, bool precision);
1091void initMouseInputMode(TransInfo *t, MouseInput *mi, MouseInputMode mode);
1092void applyMouseInput(TransInfo *t, MouseInput *mi, const float2 &mval, float output[3]);
1093void transform_input_update(TransInfo *t, const float fac);
1094void transform_input_virtual_mval_reset(TransInfo *t);
1095void transform_input_reset(TransInfo *t, const float2 &mval);
1096
1097void setCustomPoints(TransInfo *t, MouseInput *mi, const int mval_start[2], const int mval_end[2]);
1098void setCustomPointsFromDirection(TransInfo *t, MouseInput *mi, const float2 &dir);
1099void setInputPostFct(MouseInput *mi, void (*post)(TransInfo *t, float values[3]));
1100
1102
1103/* -------------------------------------------------------------------- */
1106
1114void initTransInfo(bContext *C, TransInfo *t, wmOperator *op, const wmEvent *event);
1118void freeTransCustomDataForMode(TransInfo *t);
1123void postTrans(bContext *C, TransInfo *t);
1127void resetTransModal(TransInfo *t);
1128void resetTransRestrictions(TransInfo *t);
1129
1130void restoreTransObjects(TransInfo *t);
1131
1132void calculateCenter2D(TransInfo *t);
1133void calculateCenterLocal(TransInfo *t, const float center_global[3]);
1134
1135void calculateCenter(TransInfo *t);
1140void transformViewUpdate(TransInfo *t);
1141
1142/* API functions for getting center points. */
1143void calculateCenterBound(TransInfo *t, float r_center[3]);
1144void calculateCenterMedian(TransInfo *t, float r_center[3]);
1145void calculateCenterCursor(TransInfo *t, float r_center[3]);
1146void calculateCenterCursor2D(TransInfo *t, float r_center[2]);
1147void calculateCenterCursorGraph2D(TransInfo *t, float r_center[2]);
1151bool calculateCenterActive(TransInfo *t, bool select_only, float r_center[3]);
1152
1153void calculatePropRatio(TransInfo *t);
1154
1160void transform_data_ext_rotate(TransData *td,
1161 TransDataExtension *td_ext,
1162 float mat[3][3],
1163 bool use_drot);
1164
1166
1167void freeCustomNormalArray(TransInfo *t, TransDataContainer *tc, TransCustomData *custom_data);
1168
1169/* TODO: move to: `transform_query.c`. */
1170bool checkUseAxisMatrix(TransInfo *t);
1171
1173std::optional<float3> mouse_delta_to_world_dir(const TransInfo *t, const float2 &delta);
1174
1176
1177} // namespace ed::transform
1178} // namespace blender
These structs are the foundation for all linked lists in the library system.
#define C
Definition RandGen.cpp:29
#define output
Definition scene.h:133
constexpr IndexRange()=default
constexpr Span()=default
void calculateCenter(TransInfo *t)
void calculateCenterLocal(TransInfo *t, const float center_global[3])
void transformApply(bContext *C, TransInfo *t)
void initMouseInputMode(TransInfo *t, MouseInput *mi, MouseInputMode mode)
void setTransformViewMatrices(TransInfo *t)
void resetTransRestrictions(TransInfo *t)
wmKeyMap * transform_modal_keymap(wmKeyConfig *keyconf)
void calculateCenterMedian(TransInfo *t, float r_center[3])
bool calculateCenterActive(TransInfo *t, bool select_only, float r_center[3])
void calculateCenter2D(TransInfo *t)
void transform_input_virtual_mval_reset(TransInfo *t)
void setCustomPointsFromDirection(TransInfo *t, MouseInput *mi, const float2 &dir)
void projectFloatView(TransInfo *t, const float vec[3], float adr[2])
void calculateCenterBound(TransInfo *t, float r_center[3])
void view_vector_calc(const TransInfo *t, const float focus[3], float r_vec[3])
void transform_input_reset(TransInfo *t, const float2 &mval)
void initMouseInput(TransInfo *t, MouseInput *mi, const float2 &center, const float2 &mval, bool precision)
void convertViewVec(TransInfo *t, float r_vec[3], double dx, double dy)
void setCustomPoints(TransInfo *t, MouseInput *mi, const int mval_start[2], const int mval_end[2])
void restoreTransObjects(TransInfo *t)
void setInputPostFct(MouseInput *mi, void(*post)(TransInfo *t, float values[3]))
void freeTransCustomDataForMode(TransInfo *t)
Object * transform_object_deform_pose_armature_get(const TransInfo *t, Object *ob)
void freeCustomNormalArray(TransInfo *t, TransDataContainer *tc, TransCustomData *custom_data)
void saveTransform(bContext *C, TransInfo *t, wmOperator *op)
void resetTransModal(TransInfo *t)
void transform_view_vector_calc(const TransInfo *t, const float focus[3], float r_vec[3])
void projectFloatViewEx(TransInfo *t, const float vec[3], float adr[2], const eV3DProjTest flag)
void applyMouseInput(TransInfo *t, MouseInput *mi, const float2 &mval, float output[3])
void projectIntView(TransInfo *t, const float vec[3], int adr[2])
void setTransformViewAspect(TransInfo *t, float r_aspect[3])
void projectFloatViewCenterFallback(TransInfo *t, float adr[2])
void transformViewUpdate(TransInfo *t)
void calculateCenterCursor2D(TransInfo *t, float r_center[2])
wmOperatorStatus transformEvent(TransInfo *t, wmOperator *op, const wmEvent *event)
void initTransInfo(bContext *C, TransInfo *t, wmOperator *op, const wmEvent *event)
void removeAspectRatio(TransInfo *t, float vec[2])
void projectIntViewEx(TransInfo *t, const float vec[3], int adr[2], const eV3DProjTest flag)
void calculateCenterCursorGraph2D(TransInfo *t, float r_center[2])
void transform_input_update(TransInfo *t, const float fac)
void transform_data_ext_rotate(TransData *td, TransDataExtension *td_ext, float mat[3][3], bool use_drot)
void transform_final_value_get(const TransInfo *t, float *value, const int value_num)
wmOperatorStatus transformEnd(bContext *C, TransInfo *t)
void calculateCenterCursor(TransInfo *t, float r_center[3])
void calculatePropRatio(TransInfo *t)
bool initTransform(bContext *C, TransInfo *t, wmOperator *op, const wmEvent *event, int mode)
void postTrans(bContext *C, TransInfo *t)
std::optional< float3 > mouse_delta_to_world_dir(const TransInfo *t, const float2 &delta)
bool transform_apply_matrix(TransInfo *t, float mat[4][4])
void applyAspectRatio(TransInfo *t, float vec[2])
bool transdata_check_local_islands(TransInfo *t, short around)
ENUM_OPERATORS(AxisMutable)
BMesh Iterators.
unsigned int uint
Definition BKE_text.h:55
VecBase< double, 2 > double2
VecBase< float, 2 > float2
VecBase< float, 3 > float3
void(*) post(TransInfo *t, float values[3])
Definition transform.hh:625
void(*) apply(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
Definition transform.hh:624
struct blender::ed::transform::MouseInput::@010363217010073026234025274315031014173306050225 virtual_mval
void(*) drawExtra(TransInfo *t)
Definition transform.hh:598
void(*) applySize(const TransInfo *t, const TransDataContainer *tc, const TransData *td, float r_smat[3][3])
Definition transform.hh:612
void(*) applyRot(const TransInfo *t, const TransDataContainer *tc, const TransData *td, float r_axis[3])
Definition transform.hh:617
void(*) applyVec(const TransInfo *t, const TransDataContainer *tc, const TransData *td, const float in[3], float r_out[3])
Definition transform.hh:606
void(*) free_cb(TransInfo *, TransDataContainer *tc, TransCustomData *custom_data)
Definition transform.hh:655
bool foreach_index(FunctionRef< bool(int)> fn) const
Definition transform.hh:784
void foreach_index_selected(FunctionRef< void(int)> fn) const
Definition transform.hh:811
TransDataCurveHandleFlags * hdata
Definition transform.hh:539
struct blender::ed::transform::TransInfo::@074260112357037217233016050204226071352346123342 orient[3]
TransConvertTypeInfo * data_type
Definition transform.hh:836
TransCustomDataContainer custom
TransDataContainer * data_container
Definition transform.hh:828
ListBaseT< TransSnapPoint > points
Definition transform.hh:576
void(*) snap_source_fn(TransInfo *)
Definition transform.hh:580
void(*) snap_target_fn(TransInfo *, float *)
Definition transform.hh:579