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