Cleanup: sort forward declarations of enum & struct
[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 Main;
40 struct Object;
41 struct SnapObjectContext;
42 struct SnapObjectParams;
43 struct View3D;
44 struct bContext;
45 struct wmEvent;
46 struct wmKeyConfig;
47 struct wmKeyMap;
48 struct wmOperatorType;
49
50 void transform_keymap_for_space(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap, int spaceid);
51 void transform_operatortypes(void);
52
53 /* ******************** Macros & Prototypes *********************** */
54
55 /* MODE AND NUMINPUT FLAGS */
56 enum TfmMode {
57         TFM_INIT = -1,
58         TFM_DUMMY,
59         TFM_TRANSLATION,
60         TFM_ROTATION,
61         TFM_RESIZE,
62         TFM_SKIN_RESIZE,
63         TFM_TOSPHERE,
64         TFM_SHEAR,
65         TFM_BEND,
66         TFM_SHRINKFATTEN,
67         TFM_TILT,
68         TFM_TRACKBALL,
69         TFM_PUSHPULL,
70         TFM_CREASE,
71         TFM_MIRROR,
72         TFM_BONESIZE,
73         TFM_BONE_ENVELOPE,
74         TFM_CURVE_SHRINKFATTEN,
75         TFM_MASK_SHRINKFATTEN,
76         TFM_GPENCIL_SHRINKFATTEN,
77         TFM_BONE_ROLL,
78         TFM_TIME_TRANSLATE,
79         TFM_TIME_SLIDE,
80         TFM_TIME_SCALE,
81         TFM_TIME_EXTEND,
82         TFM_TIME_DUPLICATE,
83         TFM_BAKE_TIME,
84         TFM_DEPRECATED,  /* was BEVEL */
85         TFM_BWEIGHT,
86         TFM_ALIGN,
87         TFM_EDGE_SLIDE,
88         TFM_VERT_SLIDE,
89         TFM_SEQ_SLIDE,
90         TFM_BONE_ENVELOPE_DIST,
91 };
92
93 /* TRANSFORM CONTEXTS */
94 #define CTX_NONE            0
95 #define CTX_TEXTURE         (1 << 0)
96 #define CTX_EDGE            (1 << 1)
97 #define CTX_NO_PET          (1 << 2)
98 #define CTX_NO_MIRROR       (1 << 3)
99 #define CTX_AUTOCONFIRM     (1 << 4)
100 #define CTX_MOVIECLIP       (1 << 6)
101 #define CTX_MASK            (1 << 7)
102 #define CTX_PAINT_CURVE     (1 << 8)
103 #define CTX_GPENCIL_STROKES (1 << 9)
104
105 /* Standalone call to get the transformation center corresponding to the current situation
106  * returns 1 if successful, 0 otherwise (usually means there's no selection)
107  * (if 0 is returns, *vec is unmodified)
108  * */
109 bool calculateTransformCenter(struct bContext *C, int centerMode, float cent3d[3], float cent2d[2]);
110
111 struct Base;
112 struct Object;
113 struct Scene;
114 struct TransInfo;
115 struct wmOperator;
116
117 /* UNUSED */
118 // int BIF_snappingSupported(struct Object *obedit);
119
120 struct ReportList;
121 struct TransformOrientation;
122 struct bContext;
123
124 void BIF_clearTransformOrientation(struct bContext *C);
125 void BIF_removeTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
126 void BIF_removeTransformOrientationIndex(struct bContext *C, int index);
127 void BIF_createTransformOrientation(struct bContext *C, struct ReportList *reports,
128                                     const char *name, const bool use_view,
129                                     const bool activate, const bool overwrite);
130 void BIF_selectTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
131 void BIF_selectTransformOrientationValue(struct bContext *C, int orientation);
132
133 void ED_getTransformOrientationMatrix(const struct bContext *C, float orientation_mat[3][3], const short around);
134
135 int BIF_countTransformOrientation(const struct bContext *C);
136
137 /* to be able to add operator properties to other operators */
138
139 #define P_MIRROR        (1 << 0)
140 #define P_MIRROR_DUMMY  (P_MIRROR | (1 << 9))
141 #define P_PROPORTIONAL  (1 << 1)
142 #define P_AXIS          (1 << 2)
143 #define P_SNAP          (1 << 3)
144 #define P_GEO_SNAP      (P_SNAP | (1 << 4))
145 #define P_ALIGN_SNAP    (P_GEO_SNAP | (1 << 5))
146 #define P_CONSTRAINT    (1 << 6)
147 #define P_OPTIONS       (1 << 7)
148 #define P_CORRECT_UV    (1 << 8)
149 #define P_NO_DEFAULTS   (1 << 10)
150 #define P_NO_TEXSPACE   (1 << 11)
151 #define P_CENTER        (1 << 12)
152 #define P_GPENCIL_EDIT  (1 << 13)
153
154 void Transform_Properties(struct wmOperatorType *ot, int flags);
155
156 /* view3d manipulators */
157
158 int BIF_do_manipulator(struct bContext *C, const struct wmEvent *event, struct wmOperator *op);
159 void BIF_draw_manipulator(const struct bContext *C);
160
161 /* Snapping */
162
163 #define SNAP_MIN_DISTANCE 30
164
165 bool peelObjectsTransform(
166         struct TransInfo *t,
167         const float mval[2],
168         const bool use_peel_object,
169         /* return args */
170         float r_loc[3], float r_no[3], float *r_thickness);
171 bool peelObjectsSnapContext(
172         struct SnapObjectContext *sctx,
173         const float mval[2],
174         const struct SnapObjectParams *params,
175         const bool use_peel_object,
176         /* return args */
177         float r_loc[3], float r_no[3], float *r_thickness);
178
179 bool snapObjectsTransform(
180         struct TransInfo *t, const float mval[2],
181         float *dist_px,
182         /* return args */
183         float r_loc[3], float r_no[3]);
184 bool snapNodesTransform(
185         struct TransInfo *t, const int mval[2],
186         /* return args */
187         float r_loc[2], float *r_dist_px, char *r_node_border);
188
189 #endif  /* __ED_TRANSFORM_H__ */