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