code cleanup: unused functions
[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 MLoopCol;
66 struct BMEdge;
67 struct BMFace;
68 struct UvVertMap;
69 struct UvMapVert;
70 struct ToolSettings;
71 struct Material;
72 struct Object;
73 struct rcti;
74
75
76 /* editmesh_utils.c */
77 void           EDBM_verts_mirror_cache_begin(struct BMEditMesh *em, const bool use_select); /* note, replaces EM_cache_x_mirror_vert in trunk */
78 void           EDBM_verts_mirror_apply(struct BMEditMesh *em, const int sel_from, const int sel_to);
79 struct BMVert *EDBM_verts_mirror_get(struct BMEditMesh *em, struct BMVert *v);
80 void           EDBM_verts_mirror_cache_clear(struct BMEditMesh *em, struct BMVert *v);
81 void           EDBM_verts_mirror_cache_end(struct BMEditMesh *em);
82
83 void EDBM_mesh_ensure_valid_dm_hack(struct Scene *scene, struct BMEditMesh *em);
84 void EDBM_mesh_normals_update(struct BMEditMesh *em);
85 void EDBM_mesh_clear(struct BMEditMesh *em);
86
87 void EDBM_selectmode_to_scene(struct bContext *C);
88 void EDBM_mesh_make(struct ToolSettings *ts, struct Scene *scene, struct Object *ob);
89 void EDBM_mesh_free(struct BMEditMesh *em);
90 void EDBM_mesh_load(struct Object *ob);
91
92 void           EDBM_index_arrays_ensure(struct BMEditMesh *em, const char htype);
93 void           EDBM_index_arrays_init(struct BMEditMesh *em, const char htype);
94 void           EDBM_index_arrays_free(struct BMEditMesh *em);
95 #ifndef NDEBUG
96 bool           EDBM_index_arrays_check(struct BMEditMesh *em);
97 #endif
98 struct BMVert *EDBM_vert_at_index(struct BMEditMesh *em, int index);
99 struct BMEdge *EDBM_edge_at_index(struct BMEditMesh *em, int index);
100 struct BMFace *EDBM_face_at_index(struct BMEditMesh *em, int index);
101
102 /* flushes based on the current select mode.  if in vertex select mode,
103  * verts select/deselect edges and faces, if in edge select mode,
104  * edges select/deselect faces and vertices, and in face select mode faces select/deselect
105  * edges and vertices.*/
106 void EDBM_select_more(struct BMEditMesh *em);
107 void EDBM_select_less(struct BMEditMesh *em);
108
109 void EDBM_selectmode_flush_ex(struct BMEditMesh *em, const short selectmode);
110 void EDBM_selectmode_flush(struct BMEditMesh *em);
111
112 void EDBM_deselect_flush(struct BMEditMesh *em);
113 void EDBM_select_flush(struct BMEditMesh *em);
114
115 void undo_push_mesh(struct bContext *C, const char *name);
116
117 int  EDBM_vert_color_check(struct BMEditMesh *em);
118
119 void EDBM_mesh_hide(struct BMEditMesh *em, int swap);
120 void EDBM_mesh_reveal(struct BMEditMesh *em);
121
122 void EDBM_update_generic(struct BMEditMesh *em, const bool do_tessface, const bool is_destructive);
123
124 struct UvElementMap *EDBM_uv_element_map_create(struct BMEditMesh *em, int selected, int doIslands);
125 void                 EDBM_uv_element_map_free(struct UvElementMap *vmap);
126 struct UvElement *ED_uv_element_get(struct UvElementMap *map, struct BMFace *efa, struct BMLoop *l);
127
128 int              EDBM_mtexpoly_check(struct BMEditMesh *em);
129 struct MTexPoly *EDBM_mtexpoly_active_get(struct BMEditMesh *em, struct BMFace **r_act_efa, int sloppy, int selected);
130
131 void              EDBM_uv_vert_map_free(struct UvVertMap *vmap);
132 struct UvMapVert *EDBM_uv_vert_map_at_index(struct UvVertMap *vmap, unsigned int v);
133 struct UvVertMap *EDBM_uv_vert_map_create(struct BMEditMesh *em, bool use_select, const float limit[2]);
134
135 void EDBM_flag_enable_all(struct BMEditMesh *em, const char hflag);
136 void EDBM_flag_disable_all(struct BMEditMesh *em, const char hflag);
137
138
139 /* editmesh_select.c */
140 void EDBM_select_mirrored(struct Object *obedit, struct BMEditMesh *em, bool extend);
141 void EDBM_automerge(struct Scene *scene, struct Object *ob, int update);
142
143 bool EDBM_backbuf_border_init(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
144 int  EDBM_backbuf_check(unsigned int index);
145 void EDBM_backbuf_free(void);
146
147 bool EDBM_backbuf_border_mask_init(struct ViewContext *vc, const int mcords[][2], short tot,
148                                    short xmin, short ymin, short xmax, short ymax);
149 bool EDBM_backbuf_circle_init(struct ViewContext *vc, short xs, short ys, short rads);
150
151 struct BMVert *EDBM_vert_find_nearest(struct ViewContext *vc, float *r_dist, const bool sel, const bool strict);
152 struct BMEdge *EDBM_edge_find_nearest(struct ViewContext *vc, float *r_dist);
153 struct BMFace *EDBM_face_find_nearest(struct ViewContext *vc, float *r_dist);
154
155 bool EDBM_select_pick(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
156
157 void EDBM_selectmode_set(struct BMEditMesh *em);
158 void EDBM_selectmode_convert(struct BMEditMesh *em, const short selectmode_old, const short selectmode_new);
159
160 /* user access this */
161 bool EDBM_selectmode_toggle(struct bContext *C, const short selectmode_new,
162                             const int action, const bool use_extend, const bool use_expand);
163
164 bool EDBM_selectmode_disable(struct Scene *scene, struct BMEditMesh *em,
165                              const short selectmode_disable,
166                              const short selectmode_fallback);
167
168 void EDBM_deselect_by_material(struct BMEditMesh *em, const short index, const short select);
169
170 void EDBM_select_toggle_all(struct BMEditMesh *em);
171
172 void EDBM_select_swap(struct BMEditMesh *em); /* exported for UV */
173 int  EDBM_select_interior_faces(struct BMEditMesh *em);
174 void em_setup_viewcontext(struct bContext *C, struct ViewContext *vc);  /* rename? */
175
176 extern unsigned int bm_vertoffs, bm_solidoffs, bm_wireoffs;
177
178 /* mesh_ops.c */
179 void        ED_operatortypes_mesh(void);
180 void        ED_operatormacros_mesh(void);
181 void        ED_keymap_mesh(struct wmKeyConfig *keyconf);
182
183 /* editmesh_tools.c (could be moved) */
184 void EMBM_project_snap_verts(struct bContext *C, struct ARegion *ar, struct BMEditMesh *em);
185
186
187 /* editface.c */
188 void paintface_flush_flags(struct Object *ob);
189 bool paintface_mouse_select(struct bContext *C, struct Object *ob, const int mval[2], bool extend, bool deselect, bool toggle);
190 int  do_paintface_box_select(struct ViewContext *vc, struct rcti *rect, bool select, bool extend);
191 void paintface_deselect_all_visible(struct Object *ob, int action, bool flush_flags);
192 void paintface_select_linked(struct bContext *C, struct Object *ob, const int mval[2], int mode);
193 bool paintface_minmax(struct Object *ob, float r_min[3], float r_max[3]);
194
195 void paintface_hide(struct Object *ob, const int unselected);
196 void paintface_reveal(struct Object *ob);
197
198 void paintvert_deselect_all_visible(struct Object *ob, int action, bool flush_flags);
199 void paintvert_select_ungrouped(struct Object *ob, bool extend, bool flush_flags);
200 void paintvert_flush_flags(struct Object *ob);
201
202 /* mirrtopo */
203 typedef struct MirrTopoStore_t {
204         intptr_t *index_lookup;
205         int prev_vert_tot;
206         int prev_edge_tot;
207         int prev_ob_mode;
208 } MirrTopoStore_t;
209
210 bool ED_mesh_mirrtopo_recalc_check(struct Mesh *me, const int ob_mode, MirrTopoStore_t *mesh_topo_store);
211 void ED_mesh_mirrtopo_init(struct Mesh *me, const int ob_mode, MirrTopoStore_t *mesh_topo_store,
212                            const bool skip_em_vert_array_init);
213 void ED_mesh_mirrtopo_free(MirrTopoStore_t *mesh_topo_store);
214
215
216 /* object_vgroup.c */
217 #define WEIGHT_REPLACE 1
218 #define WEIGHT_ADD 2
219 #define WEIGHT_SUBTRACT 3
220
221 struct bDeformGroup *ED_vgroup_add(struct Object *ob);
222 struct bDeformGroup *ED_vgroup_add_name(struct Object *ob, const char *name);
223 void                 ED_vgroup_delete(struct Object *ob, struct bDeformGroup *defgroup);
224 void                 ED_vgroup_clear(struct Object *ob);
225 void                 ED_vgroup_select_by_name(struct Object *ob, const char *name);
226 int                  ED_vgroup_data_create(struct ID *id);
227 void                 ED_vgroup_data_clamp_range(struct ID *id, const int total);
228 int                  ED_vgroup_give_array(struct ID *id, struct MDeformVert **dvert_arr, int *dvert_tot);
229 int                  ED_vgroup_copy_array(struct Object *ob, struct Object *ob_from);
230 void                 ED_vgroup_mirror(struct Object *ob, const short mirror_weights, const short flip_vgroups, const short all_vgroups);
231
232 int                  ED_vgroup_object_is_edit_mode(struct Object *ob);
233
234 void                 ED_vgroup_vert_add(struct Object *ob, struct bDeformGroup *dg, int vertnum,  float weight, int assignmode);
235 void                 ED_vgroup_vert_remove(struct Object *ob, struct bDeformGroup *dg, int vertnum);
236 float                ED_vgroup_vert_weight(struct Object *ob, struct bDeformGroup *dg, int vertnum);
237
238
239 /* mesh_data.c */
240 // void ED_mesh_geometry_add(struct Mesh *mesh, struct ReportList *reports, int verts, int edges, int faces);
241 void ED_mesh_polys_add(struct Mesh *mesh, struct ReportList *reports, int count);
242 void ED_mesh_tessfaces_add(struct Mesh *mesh, struct ReportList *reports, int count);
243 void ED_mesh_edges_add(struct Mesh *mesh, struct ReportList *reports, int count);
244 void ED_mesh_loops_add(struct Mesh *mesh, struct ReportList *reports, int count);
245 void ED_mesh_vertices_add(struct Mesh *mesh, struct ReportList *reports, int count);
246
247 void ED_mesh_faces_remove(struct Mesh *mesh, struct ReportList *reports, int count);
248 void ED_mesh_edges_remove(struct Mesh *mesh, struct ReportList *reports, int count);
249 void ED_mesh_vertices_remove(struct Mesh *mesh, struct ReportList *reports, int count);
250
251 void ED_mesh_transform(struct Mesh *me, float *mat);
252 void ED_mesh_calc_normals(struct Mesh *me);
253 void ED_mesh_calc_tessface(struct Mesh *mesh);
254 void ED_mesh_update(struct Mesh *mesh, struct bContext *C, int calc_edges, int calc_tessface);
255
256 int ED_mesh_uv_texture_add(struct Mesh *me, const char *name, const bool active_set);
257 bool ED_mesh_uv_texture_remove_index(struct Mesh *me, const int n);
258 bool ED_mesh_uv_texture_remove_active(struct Mesh *me);
259 bool ED_mesh_uv_texture_remove_named(struct Mesh *me, const char *name);
260 int ED_mesh_uv_loop_reset(struct bContext *C, struct Mesh *me);
261 int ED_mesh_uv_loop_reset_ex(struct Mesh *me, const int layernum);
262 int ED_mesh_color_add(struct Mesh *me, const char *name, const bool active_set);
263 bool ED_mesh_color_remove_index(struct Mesh *me, const int n);
264 bool ED_mesh_color_remove_active(struct Mesh *me);
265 bool ED_mesh_color_remove_named(struct Mesh *me, const char *name);
266
267 /* mesh backup */
268 typedef struct BMBackup {
269         struct BMesh *bmcopy;
270 } BMBackup;
271
272 /* save a copy of the bmesh for restoring later */
273 struct BMBackup EDBM_redo_state_store(struct BMEditMesh *em);
274 /* restore a bmesh from backup */
275 void EDBM_redo_state_restore(struct BMBackup, struct BMEditMesh *em, int recalctess);
276 /* delete the backup, optionally flushing it to an editmesh */
277 void EDBM_redo_state_free(struct BMBackup *, struct BMEditMesh *em, int recalctess);
278
279
280 /* *** meshtools.c *** */
281 int         join_mesh_exec(struct bContext *C, struct wmOperator *op);
282 int         join_mesh_shapes_exec(struct bContext *C, struct wmOperator *op);
283
284 intptr_t    mesh_octree_table(struct Object *ob, struct BMEditMesh *em, const float co[3], char mode);
285 int         mesh_mirrtopo_table(struct Object *ob, char mode);
286
287 /* retrieves mirrored cache vert, or NULL if there isn't one.
288  * note: calling this without ensuring the mirror cache state
289  * is bad.*/
290 int            mesh_get_x_mirror_vert(struct Object *ob, int index);
291 struct BMVert *editbmesh_get_x_mirror_vert(struct Object *ob, struct BMEditMesh *em, struct BMVert *eve, const float co[3], int index);
292 int           *mesh_get_x_mirror_faces(struct Object *ob, struct BMEditMesh *em);
293
294 bool ED_mesh_pick_vert(struct bContext *C,      struct Object *ob, const int mval[2], unsigned int *index, int size, bool use_zbuf);
295 bool ED_mesh_pick_face(struct bContext *C,      struct Object *ob, const int mval[2], unsigned int *index, int size);
296 bool ED_mesh_pick_face_vert(struct bContext *C, struct Object *ob, const int mval[2], unsigned int *index, int size);
297
298 #define ED_MESH_PICK_DEFAULT_VERT_SIZE 50
299 #define ED_MESH_PICK_DEFAULT_FACE_SIZE 3
300
301 #include "../mesh/editmesh_bvh.h"
302
303 #ifdef __cplusplus
304 }
305 #endif
306
307 #endif /* __ED_MESH_H__ */