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