Cleanup: remove redundant, invalid info from headers
[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 ED_transform.h
21  *  \ingroup editors
22  */
23
24 #ifndef __ED_TRANSFORM_H__
25 #define __ED_TRANSFORM_H__
26
27 /* ******************* Registration Function ********************** */
28
29 struct ARegion;
30 struct ListBase;
31 struct Main;
32 struct Object;
33 struct SnapObjectContext;
34 struct SnapObjectParams;
35 struct View3D;
36 struct bContext;
37 struct wmEvent;
38 struct wmKeyConfig;
39 struct wmKeyMap;
40 struct wmOperatorType;
41
42 void transform_keymap_for_space(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap, int spaceid);
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 };
84
85 /* TRANSFORM CONTEXTS */
86 #define CTX_NONE            0
87 #define CTX_TEXTURE         (1 << 0)
88 #define CTX_EDGE            (1 << 1)
89 #define CTX_NO_PET          (1 << 2)
90 #define CTX_NO_MIRROR       (1 << 3)
91 #define CTX_AUTOCONFIRM     (1 << 4)
92 #define CTX_MOVIECLIP       (1 << 6)
93 #define CTX_MASK            (1 << 7)
94 #define CTX_PAINT_CURVE     (1 << 8)
95 #define CTX_GPENCIL_STROKES (1 << 9)
96
97 /* Standalone call to get the transformation center corresponding to the current situation
98  * returns 1 if successful, 0 otherwise (usually means there's no selection)
99  * (if 0 is returns, *vec is unmodified)
100  * */
101 bool calculateTransformCenter(struct bContext *C, int centerMode, float cent3d[3], float cent2d[2]);
102
103 struct Base;
104 struct Object;
105 struct Scene;
106 struct TransInfo;
107 struct wmOperator;
108
109 /* UNUSED */
110 // int BIF_snappingSupported(struct Object *obedit);
111
112 struct ReportList;
113 struct TransformOrientation;
114 struct bContext;
115
116 void BIF_clearTransformOrientation(struct bContext *C);
117 void BIF_removeTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
118 void BIF_removeTransformOrientationIndex(struct bContext *C, int index);
119 void BIF_createTransformOrientation(struct bContext *C, struct ReportList *reports,
120                                     const char *name, const bool use_view,
121                                     const bool activate, const bool overwrite);
122 void BIF_selectTransformOrientation(struct bContext *C, struct TransformOrientation *ts);
123 void BIF_selectTransformOrientationValue(struct bContext *C, int orientation);
124
125 void ED_getTransformOrientationMatrix(const struct bContext *C, float orientation_mat[3][3], const short around);
126
127 int BIF_countTransformOrientation(const struct bContext *C);
128
129 /* to be able to add operator properties to other operators */
130
131 #define P_MIRROR        (1 << 0)
132 #define P_MIRROR_DUMMY  (P_MIRROR | (1 << 9))
133 #define P_PROPORTIONAL  (1 << 1)
134 #define P_AXIS          (1 << 2)
135 #define P_SNAP          (1 << 3)
136 #define P_GEO_SNAP      (P_SNAP | (1 << 4))
137 #define P_ALIGN_SNAP    (P_GEO_SNAP | (1 << 5))
138 #define P_CONSTRAINT    (1 << 6)
139 #define P_OPTIONS       (1 << 7)
140 #define P_CORRECT_UV    (1 << 8)
141 #define P_NO_DEFAULTS   (1 << 10)
142 #define P_NO_TEXSPACE   (1 << 11)
143 #define P_CENTER        (1 << 12)
144 #define P_GPENCIL_EDIT  (1 << 13)
145
146 void Transform_Properties(struct wmOperatorType *ot, int flags);
147
148 /* view3d manipulators */
149
150 int BIF_do_manipulator(struct bContext *C, const struct wmEvent *event, struct wmOperator *op);
151 void BIF_draw_manipulator(const struct bContext *C);
152
153 /* Snapping */
154
155 #define SNAP_MIN_DISTANCE 30
156
157 bool peelObjectsTransform(
158         struct TransInfo *t,
159         const float mval[2],
160         const bool use_peel_object,
161         /* return args */
162         float r_loc[3], float r_no[3], float *r_thickness);
163 bool peelObjectsSnapContext(
164         struct SnapObjectContext *sctx,
165         const float mval[2],
166         const struct SnapObjectParams *params,
167         const bool use_peel_object,
168         /* return args */
169         float r_loc[3], float r_no[3], float *r_thickness);
170
171 bool snapObjectsTransform(
172         struct TransInfo *t, const float mval[2],
173         float *dist_px,
174         /* return args */
175         float r_loc[3], float r_no[3]);
176 bool snapNodesTransform(
177         struct TransInfo *t, const int mval[2],
178         /* return args */
179         float r_loc[2], float *r_dist_px, char *r_node_border);
180
181 #endif  /* __ED_TRANSFORM_H__ */