Merged revision(s) 57908-57978 from trunk/blender into soc-2013-dingto.
[blender.git] / source / blender / editors / include / ED_mesh.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ED_mesh.h
28  *  \ingroup editors
29  */
30
31 #ifndef __ED_MESH_H__
32 #define __ED_MESH_H__
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 struct ID;
39 struct View3D;
40 struct ARegion;
41 struct bContext;
42 struct wmOperator;
43 struct wmWindowManager;
44 struct wmKeyConfig;
45 struct ReportList;
46 struct EditSelection;
47 struct ViewContext;
48 struct bDeformGroup;
49 struct MDeformWeight;
50 struct MDeformVert;
51 struct Scene;
52 struct Mesh;
53 struct MFace;
54 struct MEdge;
55 struct MVert;
56 struct MCol;
57 struct UvVertMap;
58 struct UvMapVert;
59 struct CustomData;
60 struct BMEditMesh;
61 struct BMEditSelection;
62 struct BMesh;
63 struct BMVert;
64 struct BMLoop;
65 struct BMBVHTree;
66 struct MLoopCol;
67 struct BMEdge;
68 struct BMFace;
69 struct UvVertMap;
70 struct UvMapVert;
71 struct ToolSettings;
72 struct Material;
73 struct Object;
74 struct rcti;
75 struct MeshStatVis;
76
77 /* editmesh_utils.c */
78 void           EDBM_verts_mirror_cache_begin_ex(struct BMEditMesh *em, const int axis,
79                                                 const bool use_self, const bool use_select,
80                                                 const bool use_topology, float maxdist, int *r_index);
81 void           EDBM_verts_mirror_cache_begin(struct BMEditMesh *em, const int axis,
82                                              const bool use_self, const bool use_select, const bool use_toplogy);
83 void           EDBM_verts_mirror_apply(struct BMEditMesh *em, const int sel_from, const int sel_to);
84 struct BMVert *EDBM_verts_mirror_get(struct BMEditMesh *em, struct BMVert *v);
85 struct BMEdge *EDBM_verts_mirror_get_edge(struct BMEditMesh *em, struct BMEdge *e);
86 struct BMFace *EDBM_verts_mirror_get_face(struct BMEditMesh *em, struct BMFace *f);
87 void           EDBM_verts_mirror_cache_clear(struct BMEditMesh *em, struct BMVert *v);
88 void           EDBM_verts_mirror_cache_end(struct BMEditMesh *em);
89
90 void EDBM_mesh_ensure_valid_dm_hack(struct Scene *scene, struct BMEditMesh *em);
91 void EDBM_mesh_normals_update(struct BMEditMesh *em);
92 void EDBM_mesh_clear(struct BMEditMesh *em);
93
94 void EDBM_selectmode_to_scene(struct bContext *C);
95 void EDBM_mesh_make(struct ToolSettings *ts, struct Scene *scene, struct Object *ob);
96 void EDBM_mesh_free(struct BMEditMesh *em);
97 void EDBM_mesh_load(struct Object *ob);
98
99 void           EDBM_index_arrays_ensure(struct BMEditMesh *em, const char htype);
100 void           EDBM_index_arrays_init(struct BMEditMesh *em, const char htype);
101 void           EDBM_index_arrays_free(struct BMEditMesh *em);
102 #ifndef NDEBUG
103 bool           EDBM_index_arrays_check(struct BMEditMesh *em);
104 #endif
105 struct BMVert *EDBM_vert_at_index(struct BMEditMesh *em, int index);
106 struct BMEdge *EDBM_edge_at_index(struct BMEditMesh *em, int index);
107 struct BMFace *EDBM_face_at_index(struct BMEditMesh *em, int index);
108
109 /* flushes based on the current select mode.  if in vertex select mode,
110  * verts select/deselect edges and faces, if in edge select mode,
111  * edges select/deselect faces and vertices, and in face select mode faces select/deselect
112  * edges and vertices.*/
113 void EDBM_select_more(struct BMEditMesh *em);
114 void EDBM_select_less(struct BMEditMesh *em);
115
116 void EDBM_selectmode_flush_ex(struct BMEditMesh *em, const short selectmode);
117 void EDBM_selectmode_flush(struct BMEditMesh *em);
118
119 void EDBM_deselect_flush(struct BMEditMesh *em);
120 void EDBM_select_flush(struct BMEditMesh *em);
121
122 void undo_push_mesh(struct bContext *C, const char *name);
123
124 bool EDBM_vert_color_check(struct BMEditMesh *em);
125
126 void EDBM_mesh_hide(struct BMEditMesh *em, bool swap);
127 void EDBM_mesh_reveal(struct BMEditMesh *em);
128
129 void EDBM_update_generic(struct BMEditMesh *em, const bool do_tessface, const bool is_destructive);
130
131 struct UvElementMap *EDBM_uv_element_map_create(struct BMEditMesh *em, const bool selected, const bool do_islands);
132 void                 EDBM_uv_element_map_free(struct UvElementMap *vmap);
133 struct UvElement *ED_uv_element_get(struct UvElementMap *map, struct BMFace *efa, struct BMLoop *l);
134
135 bool             EDBM_mtexpoly_check(struct BMEditMesh *em);
136 struct MTexPoly *EDBM_mtexpoly_active_get(struct BMEditMesh *em, struct BMFace **r_act_efa, const bool sloppy, const bool selected);
137
138 void              EDBM_uv_vert_map_free(struct UvVertMap *vmap);
139 struct UvMapVert *EDBM_uv_vert_map_at_index(struct UvVertMap *vmap, unsigned int v);
140 struct UvVertMap *EDBM_uv_vert_map_create(struct BMEditMesh *em, bool use_select, const float limit[2]);
141
142 void EDBM_flag_enable_all(struct BMEditMesh *em, const char hflag);
143 void EDBM_flag_disable_all(struct BMEditMesh *em, const char hflag);
144
145 bool BMBVH_EdgeVisible(struct BMBVHTree *tree, struct BMEdge *e,
146                        struct ARegion *ar, struct View3D *v3d, struct Object *obedit);
147
148 /* editmesh_select.c */
149 void EDBM_select_mirrored(struct BMEditMesh *em, bool extend,
150                           int *r_totmirr, int *r_totfail);
151 void EDBM_automerge(struct Scene *scene, struct Object *ob, bool update, const char hflag);
152
153 bool EDBM_backbuf_border_init(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
154 int  EDBM_backbuf_check(unsigned int index);
155 void EDBM_backbuf_free(void);
156
157 bool EDBM_backbuf_border_mask_init(struct ViewContext *vc, const int mcords[][2], short tot,
158                                    short xmin, short ymin, short xmax, short ymax);
159 bool EDBM_backbuf_circle_init(struct ViewContext *vc, short xs, short ys, short rads);
160
161 struct BMVert *EDBM_vert_find_nearest(struct ViewContext *vc, float *r_dist, const bool sel, const bool strict);
162 struct BMEdge *EDBM_edge_find_nearest(struct ViewContext *vc, float *r_dist);
163 struct BMFace *EDBM_face_find_nearest(struct ViewContext *vc, float *r_dist);
164
165 bool EDBM_select_pick(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
166
167 void EDBM_selectmode_set(struct BMEditMesh *em);
168 void EDBM_selectmode_convert(struct BMEditMesh *em, const short selectmode_old, const short selectmode_new);
169
170 /* user access this */
171 bool EDBM_selectmode_toggle(struct bContext *C, const short selectmode_new,
172                             const int action, const bool use_extend, const bool use_expand);
173
174 bool EDBM_selectmode_disable(struct Scene *scene, struct BMEditMesh *em,
175                              const short selectmode_disable,
176                              const short selectmode_fallback);
177
178 void EDBM_deselect_by_material(struct BMEditMesh *em, const short index, const short select);
179
180 void EDBM_select_toggle_all(struct BMEditMesh *em);
181
182 void EDBM_select_swap(struct BMEditMesh *em); /* exported for UV */
183 bool EDBM_select_interior_faces(struct BMEditMesh *em);
184 void em_setup_viewcontext(struct bContext *C, struct ViewContext *vc);  /* rename? */
185
186 /* editmesh_statvis.c */
187 void EDBM_statvis_calc(struct BMEditMesh *em, struct MeshStatVis *statvis,
188                        unsigned char (*r_face_colors)[4]);
189
190
191 extern unsigned int bm_vertoffs, bm_solidoffs, bm_wireoffs;
192
193 /* mesh_ops.c */
194 void        ED_operatortypes_mesh(void);
195 void        ED_operatormacros_mesh(void);
196 void        ED_keymap_mesh(struct wmKeyConfig *keyconf);
197
198 /* editmesh_tools.c (could be moved) */
199 void EMBM_project_snap_verts(struct bContext *C, struct ARegion *ar, struct BMEditMesh *em);
200
201
202 /* editface.c */
203 void paintface_flush_flags(struct Object *ob);
204 bool paintface_mouse_select(struct bContext *C, struct Object *ob, const int mval[2], bool extend, bool deselect, bool toggle);
205 int  do_paintface_box_select(struct ViewContext *vc, struct rcti *rect, bool select, bool extend);
206 void paintface_deselect_all_visible(struct Object *ob, int action, bool flush_flags);
207 void paintface_select_linked(struct bContext *C, struct Object *ob, const int mval[2], const bool select);
208 bool paintface_minmax(struct Object *ob, float r_min[3], float r_max[3]);
209
210 void paintface_hide(struct Object *ob, const bool unselected);
211 void paintface_reveal(struct Object *ob);
212
213 void paintvert_deselect_all_visible(struct Object *ob, int action, bool flush_flags);
214 void paintvert_select_ungrouped(struct Object *ob, bool extend, bool flush_flags);
215 void paintvert_flush_flags(struct Object *ob);
216
217 /* mirrtopo */
218 typedef struct MirrTopoStore_t {
219         intptr_t *index_lookup;
220         int prev_vert_tot;
221         int prev_edge_tot;
222         int prev_ob_mode;
223 } MirrTopoStore_t;
224
225 bool ED_mesh_mirrtopo_recalc_check(struct Mesh *me, const int ob_mode, MirrTopoStore_t *mesh_topo_store);
226 void ED_mesh_mirrtopo_init(struct Mesh *me, const int ob_mode, MirrTopoStore_t *mesh_topo_store,
227                            const bool skip_em_vert_array_init);
228 void ED_mesh_mirrtopo_free(MirrTopoStore_t *mesh_topo_store);
229
230
231 /* object_vgroup.c */
232 #define WEIGHT_REPLACE 1
233 #define WEIGHT_ADD 2
234 #define WEIGHT_SUBTRACT 3
235
236 struct bDeformGroup *ED_vgroup_add(struct Object *ob);
237 struct bDeformGroup *ED_vgroup_add_name(struct Object *ob, const char *name);
238 void                 ED_vgroup_delete(struct Object *ob, struct bDeformGroup *defgroup);
239 void                 ED_vgroup_clear(struct Object *ob);
240 void                 ED_vgroup_select_by_name(struct Object *ob, const char *name);
241 bool                 ED_vgroup_data_create(struct ID *id);
242 void                 ED_vgroup_data_clamp_range(struct ID *id, const int total);
243 bool                 ED_vgroup_give_array(struct ID *id, struct MDeformVert **dvert_arr, int *dvert_tot);
244 bool                 ED_vgroup_copy_array(struct Object *ob, struct Object *ob_from);
245 void                 ED_vgroup_mirror(struct Object *ob,
246                                       const bool mirror_weights, const bool flip_vgroups,
247                                       const bool all_vgroups, const bool use_topology,
248                                       int *r_totmirr, int *r_totfail);
249
250 bool                 ED_vgroup_object_is_edit_mode(struct Object *ob);
251
252 void                 ED_vgroup_vert_add(struct Object *ob, struct bDeformGroup *dg, int vertnum,  float weight, int assignmode);
253 void                 ED_vgroup_vert_remove(struct Object *ob, struct bDeformGroup *dg, int vertnum);
254 float                ED_vgroup_vert_weight(struct Object *ob, struct bDeformGroup *dg, int vertnum);
255 void                 ED_vgroup_vert_active_mirror(struct Object *ob, int def_nr);
256
257
258 /* mesh_data.c */
259 // void ED_mesh_geometry_add(struct Mesh *mesh, struct ReportList *reports, int verts, int edges, int faces);
260 void ED_mesh_polys_add(struct Mesh *mesh, struct ReportList *reports, int count);
261 void ED_mesh_tessfaces_add(struct Mesh *mesh, struct ReportList *reports, int count);
262 void ED_mesh_edges_add(struct Mesh *mesh, struct ReportList *reports, int count);
263 void ED_mesh_loops_add(struct Mesh *mesh, struct ReportList *reports, int count);
264 void ED_mesh_vertices_add(struct Mesh *mesh, struct ReportList *reports, int count);
265
266 void ED_mesh_faces_remove(struct Mesh *mesh, struct ReportList *reports, int count);
267 void ED_mesh_edges_remove(struct Mesh *mesh, struct ReportList *reports, int count);
268 void ED_mesh_vertices_remove(struct Mesh *mesh, struct ReportList *reports, int count);
269
270 void ED_mesh_transform(struct Mesh *me, float *mat);
271 void ED_mesh_calc_tessface(struct Mesh *mesh);
272 void ED_mesh_update(struct Mesh *mesh, struct bContext *C, int calc_edges, int calc_tessface);
273
274 int  ED_mesh_uv_texture_add(struct Mesh *me, const char *name, const bool active_set);
275 bool ED_mesh_uv_texture_remove_index(struct Mesh *me, const int n);
276 bool ED_mesh_uv_texture_remove_active(struct Mesh *me);
277 bool ED_mesh_uv_texture_remove_named(struct Mesh *me, const char *name);
278 void ED_mesh_uv_loop_reset(struct bContext *C, struct Mesh *me);
279 void ED_mesh_uv_loop_reset_ex(struct Mesh *me, const int layernum);
280 int  ED_mesh_color_add(struct Mesh *me, const char *name, const bool active_set);
281 bool ED_mesh_color_remove_index(struct Mesh *me, const int n);
282 bool ED_mesh_color_remove_active(struct Mesh *me);
283 bool ED_mesh_color_remove_named(struct Mesh *me, const char *name);
284
285 void ED_mesh_report_mirror(struct wmOperator *op, int totmirr, int totfail);
286 void ED_mesh_report_mirror_ex(struct wmOperator *op, int totmirr, int totfail,
287                               char selectmode);
288
289 /* mesh backup */
290 typedef struct BMBackup {
291         struct BMesh *bmcopy;
292 } BMBackup;
293
294 /* save a copy of the bmesh for restoring later */
295 struct BMBackup EDBM_redo_state_store(struct BMEditMesh *em);
296 /* restore a bmesh from backup */
297 void EDBM_redo_state_restore(struct BMBackup, struct BMEditMesh *em, int recalctess);
298 /* delete the backup, optionally flushing it to an editmesh */
299 void EDBM_redo_state_free(struct BMBackup *, struct BMEditMesh *em, int recalctess);
300
301
302 /* *** meshtools.c *** */
303 int         join_mesh_exec(struct bContext *C, struct wmOperator *op);
304 int         join_mesh_shapes_exec(struct bContext *C, struct wmOperator *op);
305
306 intptr_t    mesh_octree_table(struct Object *ob, struct BMEditMesh *em, const float co[3], char mode);
307 int         mesh_mirrtopo_table(struct Object *ob, char mode);
308
309 /* retrieves mirrored cache vert, or NULL if there isn't one.
310  * note: calling this without ensuring the mirror cache state
311  * is bad.*/
312 int            mesh_get_x_mirror_vert(struct Object *ob, int index, const bool use_topology);
313 struct BMVert *editbmesh_get_x_mirror_vert(struct Object *ob, struct BMEditMesh *em,
314                                            struct BMVert *eve, const float co[3],
315                                            int index, const bool use_topology);
316 int           *mesh_get_x_mirror_faces(struct Object *ob, struct BMEditMesh *em);
317
318 bool ED_mesh_pick_vert(struct bContext *C,      struct Object *ob, const int mval[2], unsigned int *index, int size, bool use_zbuf);
319 bool ED_mesh_pick_face(struct bContext *C,      struct Object *ob, const int mval[2], unsigned int *index, int size);
320 bool ED_mesh_pick_face_vert(struct bContext *C, struct Object *ob, const int mval[2], unsigned int *index, int size);
321
322
323 struct MDeformVert *ED_mesh_active_dvert_get_em(struct Object *ob, struct BMVert **r_eve);
324 struct MDeformVert *ED_mesh_active_dvert_get_ob(struct Object *ob, int *r_index);
325 struct MDeformVert *ED_mesh_active_dvert_get_only(struct Object *ob);
326
327 #define ED_MESH_PICK_DEFAULT_VERT_SIZE 50
328 #define ED_MESH_PICK_DEFAULT_FACE_SIZE 3
329
330 #define USE_LOOPSLIDE_HACK
331
332 #ifdef __cplusplus
333 }
334 #endif
335
336 #endif /* __ED_MESH_H__ */