merge with trunk at r27259 and commit of a patch by anthony jones to fix msvc (though...
[blender-staging.git] / source / blender / editors / include / ED_mesh.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef ED_MESH_H
29 #define ED_MESH_H
30
31 struct ID;
32 struct View3D;
33 struct ARegion;
34 struct EditMesh;
35 struct EditVert;
36 struct EditEdge;
37 struct EditFace;
38 struct bContext;
39 struct wmWindowManager;
40 struct wmKeyConfig;
41 struct ReportList;
42 struct EditSelection;
43 struct ViewContext;
44 struct bDeformGroup;
45 struct MDeformWeight;
46 struct MDeformVert;
47 struct Scene;
48 struct Mesh;
49 struct MCol;
50 struct UvVertMap;
51 struct UvMapVert;
52 struct CustomData;
53 struct BMEditSelection;
54 struct BMesh;
55 struct BMVert;
56 struct BMEdge;
57 struct BMFace;
58 struct UvVertMap;
59 struct UvMapVert;
60 struct Material;
61 struct Object;
62 struct rcti;
63
64 // edge and face flag both
65 #define EM_FGON         2
66 // face flag
67 #define EM_FGON_DRAW    1
68
69 /* editbutflag */
70 #define B_CLOCKWISE             1
71 #define B_KEEPORIG              2
72 #define B_BEAUTY                4
73 #define B_SMOOTH                8
74 #define B_BEAUTY_SHORT          16
75 #define B_AUTOFGON              32
76 #define B_KNIFE                 0x80
77 #define B_PERCENTSUBD           0x40
78 //#define B_MESH_X_MIRROR               0x100 // deprecated, use mesh
79 #define B_JOINTRIA_UV           0x200
80 #define B_JOINTRIA_VCOL         0X400
81 #define B_JOINTRIA_SHARP        0X800
82 #define B_JOINTRIA_MAT          0X1000
83 #define B_FRACTAL               0x2000
84 #define B_SPHERE                0x4000
85
86 /* bmeshutils.c */
87
88 void EDBM_RecalcNormals(struct BMEditMesh *em);
89
90 void EDBM_MakeEditBMesh(struct ToolSettings *ts, struct Scene *scene, struct Object *ob);
91 void EDBM_FreeEditBMesh(struct BMEditMesh *tm);
92 void EDBM_LoadEditBMesh(struct Scene *scene, struct Object *ob);
93
94 void EDBM_init_index_arrays(struct BMEditMesh *em, int forvert, int foredge, int forface);
95 void EDBM_free_index_arrays(struct BMEditMesh *em);
96 struct BMVert *EDBM_get_vert_for_index(struct BMEditMesh *em, int index);
97 struct BMEdge *EDBM_get_edge_for_index(struct BMEditMesh *em, int index);
98 struct BMFace *EDBM_get_face_for_index(struct BMEditMesh *em, int index);
99 struct BMFace *EDBM_get_actFace(struct BMEditMesh *em, int sloppy);
100
101 int EDBM_CallAndSelectOpf(struct BMEditMesh *em, struct wmOperator *op, 
102                                                   char *selectslot, char *fmt, ...);
103
104 /*flushes based on the current select mode.  if in vertex select mode,
105   verts select/deselect edges and faces, if in edge select mode,
106   edges select/deselect faces and vertices, and in face select mode faces select/deselect
107   edges and vertices.*/
108 void EDBM_selectmode_flush(struct BMEditMesh *em);
109
110 int EDBM_get_actSelection(struct BMEditMesh *em, struct BMEditSelection *ese);
111
112 /*exactly the same as EDBM_selectmode_flush, but you pass in the selectmode
113   instead of using the current one*/
114 void EDBM_select_flush(struct BMEditMesh *em, int selectmode);
115 void EDBM_deselect_flush(struct BMEditMesh *em);
116
117 void EDBM_selectmode_set(struct BMEditMesh *em);
118 void EDBM_convertsel(struct BMEditMesh *em, short oldmode, short selectmode);
119
120 void EDBM_editselection_center(struct BMEditMesh *em, float *center, struct BMEditSelection *ese);
121 void EDBM_editselection_plane(struct BMEditMesh *em, float *plane, struct BMEditSelection *ese);
122 void EDBM_editselection_normal(float *normal, struct BMEditSelection *ese);
123 int EDBM_vertColorCheck(struct BMEditMesh *em);
124
125 void EDBM_pin_mesh(struct BMEditMesh *em, int swap);
126 void EDBM_unpin_mesh(struct BMEditMesh *em, int swap);
127
128 void EDBM_hide_mesh(struct BMEditMesh *em, int swap);
129 void EDBM_reveal_mesh(struct BMEditMesh *em);
130
131 int                     EDBM_check_backbuf(unsigned int index);
132 int                     EDBM_mask_init_backbuf_border(struct ViewContext *vc, short mcords[][2], short tot, short xmin, short ymin, short xmax, short ymax);
133 void            EDBM_free_backbuf(void);
134 int                     EDBM_init_backbuf_border(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
135 int                     EDBM_init_backbuf_circle(struct ViewContext *vc, short xs, short ys, short rads);
136
137 void EDBM_select_swap(struct BMEditMesh *em); /* exported for UV */
138 void EDBM_set_actFace(struct BMEditMesh *em, struct BMFace *efa);
139
140 int EDBM_texFaceCheck(struct BMEditMesh *em);
141 struct MTexPoly *EDBM_get_active_mtexpoly(struct BMEditMesh *em, struct BMFace **act_efa, int sloppy);
142
143 void EDBM_free_uv_vert_map(struct UvVertMap *vmap);
144 struct UvMapVert *EDBM_get_uv_map_vert(struct UvVertMap *vmap, unsigned int v);
145 struct UvVertMap *EDBM_make_uv_vert_map(struct BMEditMesh *em, int selected, int do_face_idx_array, float *limit);
146
147 void EDBM_toggle_select_all(struct BMEditMesh *em);
148 void EDBM_set_flag_all(struct BMEditMesh *em, int flag);
149
150 /* meshtools.c */
151
152 /*these functinos are all deprecated, use stuff in editbmesh_bvh.h instead*/
153 intptr_t        mesh_octree_table(struct Object *ob, struct BMEditMesh *em, float *co, char mode);
154 struct BMVert   *editmesh_get_x_mirror_vert(struct Object *ob, struct BMEditMesh *em, float *co);
155 int                     mesh_get_x_mirror_vert(struct Object *ob, int index);
156 int                     *mesh_get_x_mirror_faces(struct Object *ob, struct BMEditMesh *em);
157
158 int                     join_mesh_exec(struct bContext *C, struct wmOperator *op);
159 int                     join_mesh_shapes_exec(struct bContext *C, struct wmOperator *op);
160
161 /* mesh_ops.c */
162 void            ED_operatortypes_mesh(void);
163 void            ED_operatormacros_mesh(void);
164 void            ED_keymap_mesh(struct wmKeyConfig *keyconf);
165
166
167 /* editmesh.c */
168
169 void            ED_spacetypes_init(void);
170 void            ED_keymap_mesh(struct wmKeyConfig *keyconf);
171
172 struct EditMesh *make_editMesh(struct Scene *scene, struct Object *ob);
173 void            load_editMesh(struct Scene *scene, struct Object *ob, struct EditMesh *em);
174 void            remake_editMesh(struct Scene *scene, struct Object *ob);
175 void            free_editMesh(struct EditMesh *em);
176
177 void            recalc_editnormals(struct EditMesh *em);
178
179 void            EM_init_index_arrays(struct EditMesh *em, int forVert, int forEdge, int forFace);
180 void            EM_free_index_arrays(void);
181 struct EditVert *EM_get_vert_for_index(int index);
182 struct EditEdge *EM_get_edge_for_index(int index);
183 struct EditFace *EM_get_face_for_index(int index);
184 int                     EM_texFaceCheck(struct EditMesh *em);
185 int                     EM_vertColorCheck(struct EditMesh *em);
186
187 void            undo_push_mesh(struct bContext *C, char *name);
188
189
190 /* editmesh_lib.c */
191
192 struct EditFace *EM_get_actFace(struct EditMesh *em, int sloppy);
193 void             EM_set_actFace(struct EditMesh *em, struct EditFace *efa);
194 float            EM_face_area(struct EditFace *efa);
195 void             EM_add_data_layer(struct EditMesh *em, struct CustomData *data, int type);
196
197 void            EM_select_edge(struct EditEdge *eed, int sel);
198 void            EM_select_face(struct EditFace *efa, int sel);
199 void            EM_select_face_fgon(struct EditMesh *em, struct EditFace *efa, int val);
200 void            EM_select_swap(struct EditMesh *em);
201 void            EM_toggle_select_all(struct EditMesh *em);
202 void            EM_select_all(struct EditMesh *em);
203 void            EM_deselect_all(struct EditMesh *em);
204 void            EM_selectmode_flush(struct EditMesh *em);
205 void            EM_deselect_flush(struct EditMesh *em);
206 void            EM_selectmode_set(struct EditMesh *em);
207 void            EM_select_flush(struct EditMesh *em);
208 void            EM_convertsel(struct EditMesh *em, short oldmode, short selectmode);
209 void            EM_validate_selections(struct EditMesh *em);
210 void            EM_selectmode_to_scene(struct Scene *scene, struct Object *obedit);
211
212                         /* exported to transform */
213 int                     EM_get_actSelection(struct EditMesh *em, struct EditSelection *ese);
214 void            EM_editselection_normal(float *normal, struct EditSelection *ese);
215 void            EM_editselection_plane(float *plane, struct EditSelection *ese);
216 void            EM_editselection_center(float *center, struct EditSelection *ese);                      
217
218 struct UvVertMap *EM_make_uv_vert_map(struct EditMesh *em, int selected, int do_face_idx_array, float *limit);
219 struct UvMapVert *EM_get_uv_map_vert(struct UvVertMap *vmap, unsigned int v);
220 void              EM_free_uv_vert_map(struct UvVertMap *vmap);
221
222 void            EM_make_hq_normals(struct EditMesh *em);
223 void            EM_solidify(struct EditMesh *em, float dist);
224
225 int                     EM_deselect_nth(struct EditMesh *em, int nth);
226
227 /* editmesh_mods.c */
228 extern unsigned int bm_vertoffs, bm_solidoffs, bm_wireoffs;
229
230 void            EM_cache_x_mirror_vert(struct Object *ob, struct EditMesh *em);
231 int                     mouse_mesh(struct bContext *C, short mval[2], short extend);
232 int                     EM_check_backbuf(unsigned int index);
233 int                     EM_mask_init_backbuf_border(struct ViewContext *vc, short mcords[][2], short tot, short xmin, short ymin, short xmax, short ymax);
234 void            EM_free_backbuf(void);
235 int                     EM_init_backbuf_border(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
236 int                     EM_init_backbuf_circle(struct ViewContext *vc, short xs, short ys, short rads);
237
238 void            EM_hide_mesh(struct EditMesh *em, int swap);
239 void            EM_reveal_mesh(struct EditMesh *em);
240
241 void            EM_automerge(struct Scene *scene, struct Object *obedit, int update);
242
243 /* editface.c */
244 struct MTFace   *EM_get_active_mtface(struct EditMesh *em, struct EditFace **act_efa, struct MCol **mcol, int sloppy);
245 int face_select(struct bContext *C, struct Object *ob, short mval[2], int extend);
246 void face_borderselect(struct bContext *C, struct Object *ob, struct rcti *rect, int select, int extend);
247 void selectall_tface(struct Object *ob, int action);
248 void select_linked_tfaces(struct bContext *C, struct Object *ob, short mval[2], int mode);
249 int minmax_tface(struct Object *ob, float *min, float *max);
250
251 /* object_vgroup.c */
252
253 #define WEIGHT_REPLACE 1
254 #define WEIGHT_ADD 2
255 #define WEIGHT_SUBTRACT 3
256
257 struct bDeformGroup             *ED_vgroup_add(struct Object *ob);
258 struct bDeformGroup             *ED_vgroup_add_name(struct Object *ob, char *name);
259 void                                    ED_vgroup_select_by_name(struct Object *ob, char *name);
260 void                                    ED_vgroup_data_create(struct ID *id);
261 int                                             ED_vgroup_give_array(struct ID *id, struct MDeformVert **dvert_arr, int *dvert_tot);
262 int                                             ED_vgroup_copy_array(struct Object *ob, struct Object *ob_from);
263 void                                    ED_vgroup_mirror(struct Object *ob, int mirror_weights, int flip_vgroups);
264
265 void            ED_vgroup_vert_add(struct Object *ob, struct bDeformGroup *dg, int vertnum,  float weight, int assignmode);
266 void            ED_vgroup_vert_remove(struct Object *ob, struct bDeformGroup *dg, int vertnum);
267 float           ED_vgroup_vert_weight(struct Object *ob, struct bDeformGroup *dg, int vertnum);
268
269 /**
270  * findnearestvert
271  * 
272  * dist (in/out): minimal distance to the nearest and at the end, actual distance
273  * sel: selection bias
274  *              if SELECT, selected vertice are given a 5 pixel bias to make them farter than unselect verts
275  *              if 0, unselected vertice are given the bias
276  * strict: if 1, the vertice corresponding to the sel parameter are ignored and not just biased 
277  */
278
279 struct BMVert *EDBM_findnearestvert(struct ViewContext *vc, int *dist, short sel, short strict);
280 struct BMEdge *EDBM_findnearestedge(struct ViewContext *vc, int *dist);
281 struct BMFace *EDBM_findnearestface(struct ViewContext *vc, int *dist);
282
283 /*needed by edge slide*/
284 struct EditVert *editedge_getOtherVert(struct EditEdge *eed, struct EditVert *eve);
285 struct EditVert *editedge_getSharedVert(struct EditEdge *eed, struct EditEdge *eed2);
286 int editedge_containsVert(struct EditEdge *eed, struct EditVert *eve);
287 int editface_containsVert(struct EditFace *efa, struct EditVert *eve);
288 int editface_containsEdge(struct EditFace *efa, struct EditEdge *eed);
289 short sharesFace(struct EditMesh *em, struct EditEdge *e1, struct EditEdge *e2);
290
291 /* mesh_data.c */
292
293 void ED_mesh_geometry_add(struct Mesh *mesh, struct ReportList *reports, int verts, int edges, int faces);
294 void ED_mesh_transform(struct Mesh *me, float *mat);
295 void ED_mesh_calc_normals(struct Mesh *me);
296 void ED_mesh_material_add(struct Mesh *me, struct Material *ma);
297 void ED_mesh_update(struct Mesh *mesh, struct bContext *C, int calc_edges);
298
299 int ED_mesh_uv_texture_add(struct bContext *C, struct Scene *scene, struct Object *ob, struct Mesh *me);
300 int ED_mesh_uv_texture_remove(struct bContext *C, struct Object *ob, struct Mesh *me);
301 int ED_mesh_color_add(struct bContext *C, struct Scene *scene, struct Object *ob, struct Mesh *me);
302 int ED_mesh_color_remove(struct bContext *C, struct Object *ob, struct Mesh *me);
303
304 #endif /* ED_MESH_H */