81308dd84f211efdcff00589b39ea2dbfff8e17f
[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 EnumPropertyItem;
39 struct ListBase;
40 struct Object;
41 struct View3D;
42 struct bContext;
43 struct uiLayout;
44 struct wmEvent;
45 struct wmKeyConfig;
46 struct wmKeyMap;
47 struct wmOperatorType;
48 struct wmWindowManager;
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_WARP,
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_BONE_ROLL,
77         TFM_TIME_TRANSLATE,
78         TFM_TIME_SLIDE,
79         TFM_TIME_SCALE,
80         TFM_TIME_EXTEND,
81         TFM_TIME_DUPLICATE,
82         TFM_BAKE_TIME,
83         TFM_DEPRECATED,  /* was BEVEL */
84         TFM_BWEIGHT,
85         TFM_ALIGN,
86         TFM_EDGE_SLIDE,
87         TFM_VERT_SLIDE,
88         TFM_SEQ_SLIDE
89 };
90
91 /* TRANSFORM CONTEXTS */
92 #define CTX_NONE            0
93 #define CTX_TEXTURE         (1 << 0)
94 #define CTX_EDGE            (1 << 1)
95 #define CTX_NO_PET          (1 << 2)
96 #define CTX_NO_MIRROR       (1 << 3)
97 #define CTX_AUTOCONFIRM     (1 << 4)
98 #define CTX_NDOF            (1 << 5)
99 #define CTX_MOVIECLIP       (1 << 6)
100 #define CTX_MASK            (1 << 7)
101
102 /* Standalone call to get the transformation center corresponding to the current situation
103  * returns 1 if successful, 0 otherwise (usually means there's no selection)
104  * (if 0 is returns, *vec is unmodified)
105  * */
106 int calculateTransformCenter(struct bContext *C, int centerMode, float cent3d[3], int cent2d[2]);
107
108 struct TransInfo;
109 struct ScrArea;
110 struct Base;
111 struct Scene;
112 struct Object;
113
114 /* UNUSED */
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_view,
125                                     int use, int overwrite);
126 void BIF_selectTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
127 void BIF_selectTransformOrientationValue(struct bContext *C, int orientation);
128
129 void ED_getTransformOrientationMatrix(const struct bContext *C, float orientation_mat[3][3], const bool activeOnly);
130
131 int BIF_countTransformOrientation(const struct bContext *C);
132
133 void BIF_TransformSetUndo(const char *str);
134
135 /* to be able to add operator properties to other operators */
136
137 #define P_MIRROR        (1 << 0)
138 #define P_MIRROR_DUMMY  (P_MIRROR | (1 << 9))
139 #define P_PROPORTIONAL  (1 << 1)
140 #define P_AXIS          (1 << 2)
141 #define P_SNAP          (1 << 3)
142 #define P_GEO_SNAP      (P_SNAP | (1 << 4))
143 #define P_ALIGN_SNAP    (P_GEO_SNAP | (1 << 5))
144 #define P_CONSTRAINT    (1 << 6)
145 #define P_OPTIONS       (1 << 7)
146 #define P_CORRECT_UV    (1 << 8)
147 #define P_NO_DEFAULTS   (1 << 10)
148
149 void Transform_Properties(struct wmOperatorType *ot, int flags);
150
151 /* view3d manipulators */
152
153 int BIF_do_manipulator(struct bContext *C, const struct wmEvent *event, struct wmOperator *op);
154 void BIF_draw_manipulator(const struct bContext *C);
155
156 /* Snapping */
157
158
159 typedef struct DepthPeel {
160         struct DepthPeel *next, *prev;
161
162         float depth;
163         float p[3];
164         float no[3];
165         struct Object *ob;
166         int flag;
167 } DepthPeel;
168
169 struct ListBase;
170
171 typedef enum SnapMode {
172         SNAP_ALL = 0,
173         SNAP_NOT_SELECTED = 1,
174         SNAP_NOT_OBEDIT = 2
175 } SnapMode;
176
177 #define SNAP_MIN_DISTANCE 30
178 #define TRANSFORM_DIST_MAX_RAY (FLT_MAX / 2.0f)
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], float *r_dist_px, float r_loc[3], float r_no[3], SnapMode mode);
183 bool snapObjectsContext(struct bContext *C, const float mval[2], float *r_dist_px, float r_loc[3], float r_no[3], SnapMode mode);
184 /* taks args for all settings */
185 bool snapObjectsEx(struct Scene *scene, struct Base *base_act, struct View3D *v3d, struct ARegion *ar, struct Object *obedit, short snap_mode,
186                    const float mval[2], float *r_dist_px,
187                    float r_loc[3], float r_no[3], float *r_ray_dist, SnapMode mode);
188 bool snapObjectsRayEx(struct Scene *scene, struct Base *base_act, struct View3D *v3d, struct ARegion *ar, struct Object *obedit, short snap_mode,
189                       struct Object **r_ob, float r_obmat[4][4],
190                       const float ray_start[3], const float ray_normal[3], float *r_ray_dist,
191                       const float mval[2], float *r_dist_px, float r_loc[3], float r_no[3], SnapMode mode);
192
193 bool snapNodesTransform(struct TransInfo *t, const int mval[2], float *r_dist_px, float r_loc[2], char *r_node_border, SnapMode mode);
194 bool snapNodesContext(struct bContext *C, const int mval[2], float *r_dist_px, float r_loc[2], char *r_node_border, SnapMode mode);
195
196 #endif
197