code cleanup: use const events for modal and invoke operators.
[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 wmWindowManager;
38 struct wmOperatorType;
39 struct ListBase;
40 struct wmEvent;
41 struct bContext;
42 struct Object;
43 struct uiLayout;
44 struct EnumPropertyItem;
45 struct wmOperatorType;
46 struct wmKeyMap;
47 struct wmKeyConfig;
48
49 void transform_keymap_for_space(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap, int spaceid);
50 void transform_operatortypes(void);
51
52 /* ******************** Macros & Prototypes *********************** */
53
54 /* MODE AND NUMINPUT FLAGS */
55 enum {
56         TFM_INIT = -1,
57         TFM_DUMMY,
58         TFM_TRANSLATION,
59         TFM_ROTATION,
60         TFM_RESIZE,
61         TFM_SKIN_RESIZE,
62         TFM_TOSPHERE,
63         TFM_SHEAR,
64         TFM_WARP,
65         TFM_SHRINKFATTEN,
66         TFM_TILT,
67         TFM_TRACKBALL,
68         TFM_PUSHPULL,
69         TFM_CREASE,
70         TFM_MIRROR,
71         TFM_BONESIZE,
72         TFM_BONE_ENVELOPE,
73         TFM_CURVE_SHRINKFATTEN,
74         TFM_MASK_SHRINKFATTEN,
75         TFM_BONE_ROLL,
76         TFM_TIME_TRANSLATE,
77         TFM_TIME_SLIDE,
78         TFM_TIME_SCALE,
79         TFM_TIME_EXTEND,
80         TFM_TIME_DUPLICATE,
81         TFM_BAKE_TIME,
82         TFM_BEVEL,
83         TFM_BWEIGHT,
84         TFM_ALIGN,
85         TFM_EDGE_SLIDE,
86         TFM_VERT_SLIDE,
87         TFM_SEQ_SLIDE
88 } TfmMode;
89
90 /* TRANSFORM CONTEXTS */
91 #define CTX_NONE            0
92 #define CTX_TEXTURE         1
93 #define CTX_EDGE            2
94 #define CTX_NO_PET          4
95 #define CTX_TWEAK           8
96 #define CTX_NO_MIRROR       16
97 #define CTX_AUTOCONFIRM     32
98 #define CTX_BMESH           64
99 #define CTX_NDOF            128
100 #define CTX_MOVIECLIP       256
101 #define CTX_MASK            512
102
103 /* Standalone call to get the transformation center corresponding to the current situation
104  * returns 1 if successful, 0 otherwise (usually means there's no selection)
105  * (if 0 is returns, *vec is unmodified)
106  * */
107 int calculateTransformCenter(struct bContext *C, int centerMode, float cent3d[3], int cent2d[2]);
108
109 struct TransInfo;
110 struct ScrArea;
111 struct Base;
112 struct Scene;
113 struct Object;
114
115 int BIF_snappingSupported(struct Object *obedit);
116
117 struct TransformOrientation;
118 struct bContext;
119 struct ReportList;
120
121 void BIF_clearTransformOrientation(struct bContext *C);
122 void BIF_removeTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
123 void BIF_removeTransformOrientationIndex(struct bContext *C, int index);
124 void BIF_createTransformOrientation(struct bContext *C, struct ReportList *reports, char *name, int use, int overwrite);
125 void BIF_selectTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
126 void BIF_selectTransformOrientationValue(struct bContext *C, int orientation);
127
128 void ED_getTransformOrientationMatrix(const struct bContext *C, float orientation_mat[3][3], int activeOnly);
129
130 struct EnumPropertyItem *BIF_enumTransformOrientation(struct bContext *C);
131 const char *BIF_menustringTransformOrientation(const struct bContext *C, const char *title);  /* the returned value was allocated and needs to be freed after use */
132 int BIF_countTransformOrientation(const struct bContext *C);
133
134 void BIF_TransformSetUndo(const char *str);
135
136 void BIF_selectOrientation(void);
137
138 /* to be able to add operator properties to other operators */
139
140 #define P_MIRROR        (1 << 0)
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
150 void Transform_Properties(struct wmOperatorType *ot, int flags);
151
152 /* view3d manipulators */
153
154 int BIF_do_manipulator(struct bContext *C, const struct wmEvent *event, struct wmOperator *op);
155 void BIF_draw_manipulator(const struct bContext *C);
156
157 /* Snapping */
158
159
160 typedef struct DepthPeel {
161         struct DepthPeel *next, *prev;
162
163         float depth;
164         float p[3];
165         float no[3];
166         struct Object *ob;
167         int flag;
168 } DepthPeel;
169
170 struct ListBase;
171
172 typedef enum SnapMode {
173         SNAP_ALL = 0,
174         SNAP_NOT_SELECTED = 1,
175         SNAP_NOT_OBEDIT = 2
176 } SnapMode;
177
178 #define SNAP_MIN_DISTANCE 30
179
180 bool peelObjectsTransForm(struct TransInfo *t, struct ListBase *depth_peels, const float mval[2], SnapMode mode);
181 bool peelObjectsContext(struct bContext *C, struct ListBase *depth_peels, const float mval[2], SnapMode mode);
182 bool snapObjectsTransform(struct TransInfo *t, const float mval[2], int *r_dist, float r_loc[3], float r_no[3], SnapMode mode);
183 bool snapObjectsContext(struct bContext *C, const float mval[2], int *r_dist, float r_loc[3], float r_no[3], SnapMode mode);
184 bool snapNodesTransform(struct TransInfo *t, const int mval[2], int *r_dist, float r_loc[2], char *r_node_border, SnapMode mode);
185 bool snapNodesContext(struct bContext *C, const int mval[2], int *r_dist, float r_loc[2], char *r_node_border, SnapMode mode);
186
187 #endif
188