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