1bd8782bb12026b858c0c8c077080e77183d075f
[blender.git] / source / blender / editors / include / ED_transform.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup editors
22  */
23
24 #ifndef __ED_TRANSFORM_H__
25 #define __ED_TRANSFORM_H__
26
27 /* ******************* Registration Function ********************** */
28
29 struct ARegion;
30 struct ListBase;
31 struct Main;
32 struct Object;
33 struct SnapObjectContext;
34 struct SnapObjectParams;
35 struct View3D;
36 struct WorkSpace;
37 struct bContext;
38 struct wmEvent;
39 struct wmKeyConfig;
40 struct wmKeyMap;
41 struct wmOperatorType;
42
43 void ED_keymap_transform(struct wmKeyConfig *keyconf);
44 void transform_operatortypes(void);
45
46 /* ******************** Macros & Prototypes *********************** */
47
48 /* MODE AND NUMINPUT FLAGS */
49 enum TfmMode {
50         TFM_INIT = -1,
51         TFM_DUMMY,
52         TFM_TRANSLATION,
53         TFM_ROTATION,
54         TFM_RESIZE,
55         TFM_SKIN_RESIZE,
56         TFM_TOSPHERE,
57         TFM_SHEAR,
58         TFM_BEND,
59         TFM_SHRINKFATTEN,
60         TFM_TILT,
61         TFM_TRACKBALL,
62         TFM_PUSHPULL,
63         TFM_CREASE,
64         TFM_MIRROR,
65         TFM_BONESIZE,
66         TFM_BONE_ENVELOPE,
67         TFM_CURVE_SHRINKFATTEN,
68         TFM_MASK_SHRINKFATTEN,
69         TFM_GPENCIL_SHRINKFATTEN,
70         TFM_BONE_ROLL,
71         TFM_TIME_TRANSLATE,
72         TFM_TIME_SLIDE,
73         TFM_TIME_SCALE,
74         TFM_TIME_EXTEND,
75         TFM_TIME_DUPLICATE,
76         TFM_BAKE_TIME,
77         TFM_DEPRECATED,  /* was BEVEL */
78         TFM_BWEIGHT,
79         TFM_ALIGN,
80         TFM_EDGE_SLIDE,
81         TFM_VERT_SLIDE,
82         TFM_SEQ_SLIDE,
83         TFM_BONE_ENVELOPE_DIST,
84         TFM_NORMAL_ROTATION,
85 };
86
87 /* TRANSFORM CONTEXTS */
88 #define CTX_NONE            0
89 #define CTX_TEXTURE         (1 << 0)
90 #define CTX_EDGE            (1 << 1)
91 #define CTX_NO_PET          (1 << 2)
92 #define CTX_NO_MIRROR       (1 << 3)
93 #define CTX_AUTOCONFIRM     (1 << 4)
94 #define CTX_MOVIECLIP       (1 << 6)
95 #define CTX_MASK            (1 << 7)
96 #define CTX_PAINT_CURVE     (1 << 8)
97 #define CTX_GPENCIL_STROKES (1 << 9)
98 #define CTX_CURSOR          (1 << 10)
99
100 /* Standalone call to get the transformation center corresponding to the current situation
101  * returns 1 if successful, 0 otherwise (usually means there's no selection)
102  * (if 0 is returns, *vec is unmodified)
103  * */
104 bool calculateTransformCenter(struct bContext *C, int centerMode, float cent3d[3], float cent2d[2]);
105
106 struct Object;
107 struct Scene;
108 struct TransInfo;
109 struct wmGizmoGroup;
110 struct wmGizmoGroupType;
111 struct wmOperator;
112
113 /* UNUSED */
114 // int BIF_snappingSupported(struct Object *obedit);
115
116 struct ReportList;
117 struct TransformOrientation;
118 struct bContext;
119
120 void BIF_clearTransformOrientation(struct bContext *C);
121 void BIF_removeTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
122 void BIF_removeTransformOrientationIndex(struct bContext *C, int index);
123 void BIF_createTransformOrientation(struct bContext *C, struct ReportList *reports,
124                                     const char *name, const bool use_view,
125                                     const bool activate, const bool overwrite);
126 void BIF_selectTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
127
128 void ED_getTransformOrientationMatrix(const struct bContext *C, float orientation_mat[3][3], const short around);
129
130 int BIF_countTransformOrientation(const struct bContext *C);
131
132 /* to be able to add operator properties to other operators */
133
134 #define P_MIRROR        (1 << 0)
135 #define P_MIRROR_DUMMY  (P_MIRROR | (1 << 9))
136 #define P_PROPORTIONAL  (1 << 1)
137 #define P_ORIENT_AXIS (1 << 2)
138 #define P_ORIENT_AXIS_ORTHO (1 << 16)
139 #define P_ORIENT_MATRIX (1 << 17)
140 #define P_SNAP          (1 << 3)
141 #define P_GEO_SNAP      (P_SNAP | (1 << 4))
142 #define P_ALIGN_SNAP    (P_GEO_SNAP | (1 << 5))
143 #define P_CONSTRAINT    (1 << 6)
144 #define P_OPTIONS       (1 << 7)
145 #define P_CORRECT_UV    (1 << 8)
146 #define P_NO_DEFAULTS   (1 << 10)
147 #define P_NO_TEXSPACE   (1 << 11)
148 #define P_CENTER        (1 << 12)
149 #define P_GPENCIL_EDIT  (1 << 13)
150 #define P_CURSOR_EDIT   (1 << 14)
151 #define P_CLNOR_INVALIDATE (1 << 15)
152
153 void Transform_Properties(struct wmOperatorType *ot, int flags);
154
155 /* transform gizmos */
156
157 void TRANSFORM_GGT_gizmo(struct wmGizmoGroupType *gzgt);
158 void VIEW3D_GGT_xform_cage(struct wmGizmoGroupType *gzgt);
159 void VIEW3D_GGT_xform_shear(struct wmGizmoGroupType *gzgt);
160
161 /* *** transform_gizmo_extrude_3d.c *** */
162 void VIEW3D_GGT_xform_extrude(struct wmGizmoGroupType *gzgt);
163
164 bool ED_widgetgroup_gizmo2d_poll(const struct bContext *C, struct wmGizmoGroupType *gzgt);
165 void ED_widgetgroup_gizmo2d_setup(const struct bContext *C, struct wmGizmoGroup *gzgroup);
166 void ED_widgetgroup_gizmo2d_refresh(const struct bContext *C, struct wmGizmoGroup *gzgroup);
167 void ED_widgetgroup_gizmo2d_draw_prepare(const struct bContext *C, struct wmGizmoGroup *gzgroup);
168
169
170 /* Snapping */
171
172 #define SNAP_MIN_DISTANCE 30
173 #define SNAP_INCREMENTAL_ANGLE DEG2RAD(5.0)
174
175 bool peelObjectsTransform(
176         struct TransInfo *t,
177         const float mval[2],
178         const bool use_peel_object,
179         /* return args */
180         float r_loc[3], float r_no[3], float *r_thickness);
181 bool peelObjectsSnapContext(
182         struct SnapObjectContext *sctx,
183         const float mval[2],
184         const struct SnapObjectParams *params,
185         const bool use_peel_object,
186         /* return args */
187         float r_loc[3], float r_no[3], float *r_thickness);
188
189 bool snapObjectsTransform(
190         struct TransInfo *t, const float mval[2],
191         float *dist_px,
192         /* return args */
193         float r_loc[3], float r_no[3]);
194 bool snapNodesTransform(
195         struct TransInfo *t, const int mval[2],
196         /* return args */
197         float r_loc[2], float *r_dist_px, char *r_node_border);
198
199 void ED_transform_calc_orientation_from_type(
200         const struct bContext *C, float r_mat[3][3]);
201  void ED_transform_calc_orientation_from_type_ex(
202          const struct bContext *C, float r_mat[3][3],
203          /* extra args */
204          struct Scene *scene, struct RegionView3D *rv3d, struct Object *ob, struct Object *obedit,
205          const short orientation_type, int orientation_index_custom,
206          const int pivot_point);
207
208 struct TransformBounds {
209         float center[3];                /* Center for transform widget. */
210         float min[3], max[3];   /* Boundbox of selection for transform widget. */
211
212         /* Normalized axis */
213         float axis[3][3];
214         float axis_min[3], axis_max[3];
215 };
216
217 struct TransformCalcParams {
218         uint use_only_center : 1;
219         uint use_local_axis : 1;
220         /* Use 'Scene.orientation_type' when zero, otherwise subtract one and use. */
221         ushort orientation_type;
222         ushort orientation_index_custom;
223 };
224 int ED_transform_calc_gizmo_stats(
225         const struct bContext *C,
226         const struct TransformCalcParams *params,
227         struct TransformBounds *tbounds);
228
229 #endif  /* __ED_TRANSFORM_H__ */