2.5: code consistency
[blender-staging.git] / source / blender / editors / include / ED_transform.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef ED_TRANSFORM_H
31 #define ED_TRANSFORM_H
32
33 /* ******************* Registration Function ********************** */
34
35 struct wmWindowManager;
36 struct ListBase;
37 struct wmEvent;
38 struct bContext;
39 struct Object;
40 struct uiLayout;
41
42 void transform_keymap_for_space(struct wmWindowManager *wm, struct ListBase *keymap, int spaceid);
43 void transform_operatortypes(void);
44
45 /* ******************** Macros & Prototypes *********************** */
46
47 /* MODE AND NUMINPUT FLAGS */
48 enum {
49         TFM_INIT = -1,
50         TFM_DUMMY,
51         TFM_TRANSLATION,
52         TFM_ROTATION,
53         TFM_RESIZE,
54         TFM_TOSPHERE,
55         TFM_SHEAR,
56         TFM_WARP,
57         TFM_SHRINKFATTEN,
58         TFM_TILT,
59         TFM_TRACKBALL,
60         TFM_PUSHPULL,
61         TFM_CREASE,
62         TFM_MIRROR,
63         TFM_BONESIZE,
64         TFM_BONE_ENVELOPE,
65         TFM_CURVE_SHRINKFATTEN,
66         TFM_BONE_ROLL,
67         TFM_TIME_TRANSLATE,
68         TFM_TIME_SLIDE,
69         TFM_TIME_SCALE,
70         TFM_TIME_EXTEND,
71         TFM_BAKE_TIME,
72         TFM_BEVEL,
73         TFM_BWEIGHT,
74         TFM_ALIGN
75 } TfmMode;
76
77 /* TRANSFORM CONTEXTS */
78 #define CTX_NONE                        0
79 #define CTX_TEXTURE                     1
80 #define CTX_EDGE                        2
81 #define CTX_NO_PET                      4
82 #define CTX_TWEAK                       8
83 #define CTX_NO_MIRROR           16
84 #define CTX_AUTOCONFIRM         32
85 #define CTX_BMESH                       64
86 #define CTX_NDOF                        128
87
88 /* Standalone call to get the transformation center corresponding to the current situation
89  * returns 1 if successful, 0 otherwise (usually means there's no selection)
90  * (if 0 is returns, *vec is unmodified) 
91  * */
92 int calculateTransformCenter(struct bContext *C, struct wmEvent *event, int centerMode, float *vec);
93
94 struct TransInfo;
95 struct ScrArea;
96 struct Base;
97 struct Scene;
98 struct Object;
99
100 void BIF_setSingleAxisConstraint(float vec[3], char *text);
101 void BIF_setDualAxisConstraint(float vec1[3], float vec2[3], char *text);
102 void BIF_setLocalAxisConstraint(char axis, char *text);
103 void BIF_setLocalLockConstraint(char axis, char *text);
104
105 int BIF_snappingSupported(struct Object *obedit);
106
107 struct TransformOrientation;
108 struct bContext;
109
110 void BIF_clearTransformOrientation(struct bContext *C);
111 void BIF_removeTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
112 void BIF_manageTransformOrientation(struct bContext *C, int confirm, int set);
113 int BIF_menuselectTransformOrientation(void);
114 void BIF_selectTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
115 void BIF_selectTransformOrientationValue(struct bContext *C, int orientation);
116
117 void BIF_menuTransformOrientation(struct bContext *C, struct uiLayout *layout, void *arg);
118 char * BIF_menustringTransformOrientation(const struct bContext *C, char *title); /* the returned value was allocated and needs to be freed after use */
119 int BIF_countTransformOrientation(const struct bContext *C);
120
121 void BIF_getPropCenter(float *center);
122
123 void BIF_TransformSetUndo(char *str);
124
125 void BIF_selectOrientation(void);
126
127 /* view3d manipulators */
128 void initManipulator(int mode);
129 void ManipulatorTransform();
130
131 int BIF_do_manipulator(struct bContext *C, short mval[2]);
132 void BIF_draw_manipulator(const struct bContext *C);
133
134 /* Snapping */
135
136
137 typedef struct DepthPeel
138 {
139         struct DepthPeel *next, *prev;
140         
141         float depth;
142         float p[3];
143         float no[3];
144         struct Object *ob;
145         int flag;
146 } DepthPeel;
147
148 struct ListBase;
149
150 typedef enum SnapMode
151 {
152         SNAP_ALL = 0,
153         SNAP_NOT_SELECTED = 1,
154         SNAP_NOT_OBEDIT = 2
155 } SnapMode;
156
157 #define SNAP_MIN_DISTANCE 30
158
159 int peelObjectsTransForm(struct TransInfo *t, struct ListBase *depth_peels, short mval[2]);
160 int peelObjectsContext(struct bContext *C, struct ListBase *depth_peels, short mval[2]);
161 int snapObjectsTransform(struct TransInfo *t, short mval[2], int *dist, float *loc, float *no, SnapMode mode);
162 int snapObjectsContext(struct bContext *C, short mval[2], int *dist, float *loc, float *no, SnapMode mode);
163
164 #endif
165