doxygen: editor entry
[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
29 /** \file ED_mesh.h
30  *  \ingroup editors
31  */
32
33 #ifndef ED_MESH_H
34 #define ED_MESH_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct ID;
41 struct View3D;
42 struct ARegion;
43 struct EditMesh;
44 struct EditVert;
45 struct EditEdge;
46 struct EditFace;
47 struct bContext;
48 struct wmOperator;
49 struct wmWindowManager;
50 struct wmKeyConfig;
51 struct ReportList;
52 struct EditSelection;
53 struct ViewContext;
54 struct bDeformGroup;
55 struct MDeformWeight;
56 struct MDeformVert;
57 struct Scene;
58 struct Mesh;
59 struct MFace;
60 struct MEdge;
61 struct MVert;
62 struct MCol;
63 struct UvVertMap;
64 struct UvMapVert;
65 struct CustomData;
66 struct Material;
67 struct Object;
68 struct rcti;
69
70 #define EM_FGON_DRAW    1 // face flag
71 #define EM_FGON                 2 // edge and face flag both
72
73 /* editbutflag */
74 #define B_CLOCKWISE                     1
75 #define B_KEEPORIG                      2
76 #define B_BEAUTY                        4
77 #define B_SMOOTH                        8
78 #define B_BEAUTY_SHORT          0x10
79 #define B_AUTOFGON                      0x20
80 #define B_KNIFE                         0x80
81 #define B_PERCENTSUBD           0x40
82 //#define B_MESH_X_MIRROR               0x100 // deprecated, use mesh
83 #define B_JOINTRIA_UV           0x200
84 #define B_JOINTRIA_VCOL         0X400
85 #define B_JOINTRIA_SHARP        0X800
86 #define B_JOINTRIA_MAT          0X1000
87 #define B_FRACTAL                       0x2000
88 #define B_SPHERE                        0x4000
89
90 /* meshtools.c */
91
92 intptr_t        mesh_octree_table(struct Object *ob, struct EditMesh *em, float *co, char mode);
93 long            mesh_mirrtopo_table(struct Object *ob, char mode);
94
95 struct EditVert   *editmesh_get_x_mirror_vert(struct Object *ob, struct EditMesh *em, struct EditVert *eve, float *co, int index);
96 int                     mesh_get_x_mirror_vert(struct Object *ob, int index);
97 int                     *mesh_get_x_mirror_faces(struct Object *ob, struct EditMesh *em);
98
99 int                     join_mesh_exec(struct bContext *C, struct wmOperator *op);
100 int                     join_mesh_shapes_exec(struct bContext *C, struct wmOperator *op);
101
102 /* mesh_ops.c */
103 void            ED_operatortypes_mesh(void);
104 void            ED_operatormacros_mesh(void);
105 void            ED_keymap_mesh(struct wmKeyConfig *keyconf);
106
107
108 /* editmesh.c */
109 void            make_editMesh(struct Scene *scene, struct Object *ob);
110 void            load_editMesh(struct Scene *scene, struct Object *ob);
111 void            remake_editMesh(struct Scene *scene, struct Object *ob);
112 void            free_editMesh(struct EditMesh *em);
113
114 void            recalc_editnormals(struct EditMesh *em);
115
116 void            EM_init_index_arrays(struct EditMesh *em, int forVert, int forEdge, int forFace);
117 void            EM_free_index_arrays(void);
118 struct EditVert *EM_get_vert_for_index(int index);
119 struct EditEdge *EM_get_edge_for_index(int index);
120 struct EditFace *EM_get_face_for_index(int index);
121 int                     EM_texFaceCheck(struct EditMesh *em);
122 int                     EM_vertColorCheck(struct EditMesh *em);
123
124 void            undo_push_mesh(struct bContext *C, const char *name);
125
126
127 /* editmesh_lib.c */
128
129 struct EditFace *EM_get_actFace(struct EditMesh *em, int sloppy);
130 void             EM_set_actFace(struct EditMesh *em, struct EditFace *efa);
131 float            EM_face_area(struct EditFace *efa);
132
133 void            EM_select_edge(struct EditEdge *eed, int sel);
134 void            EM_select_face(struct EditFace *efa, int sel);
135 void            EM_select_face_fgon(struct EditMesh *em, struct EditFace *efa, int val);
136 void            EM_select_swap(struct EditMesh *em);
137 void            EM_toggle_select_all(struct EditMesh *em);
138 void            EM_select_all(struct EditMesh *em);
139 void            EM_deselect_all(struct EditMesh *em);
140 void            EM_selectmode_flush(struct EditMesh *em);
141 void            EM_deselect_flush(struct EditMesh *em);
142 void            EM_selectmode_set(struct EditMesh *em);
143 void            EM_select_flush(struct EditMesh *em);
144 void            EM_convertsel(struct EditMesh *em, short oldmode, short selectmode);
145 void            EM_validate_selections(struct EditMesh *em);
146 void            EM_selectmode_to_scene(struct Scene *scene, struct Object *obedit);
147
148                         /* exported to transform */
149 int                     EM_get_actSelection(struct EditMesh *em, struct EditSelection *ese);
150 void            EM_editselection_normal(float *normal, struct EditSelection *ese);
151 void            EM_editselection_plane(float *plane, struct EditSelection *ese);
152 void            EM_editselection_center(float *center, struct EditSelection *ese);                      
153
154 struct UvVertMap *EM_make_uv_vert_map(struct EditMesh *em, int selected, int do_face_idx_array, float *limit);
155 struct UvMapVert *EM_get_uv_map_vert(struct UvVertMap *vmap, unsigned int v);
156 void              EM_free_uv_vert_map(struct UvVertMap *vmap);
157
158 void            EM_add_data_layer(struct EditMesh *em, struct CustomData *data, int type, const char *name);
159 void            EM_free_data_layer(struct EditMesh *em, struct CustomData *data, int type);
160
161 void            EM_make_hq_normals(struct EditMesh *em);
162 void            EM_solidify(struct EditMesh *em, float dist);
163
164 int                     EM_deselect_nth(struct EditMesh *em, int nth);
165
166 void EM_project_snap_verts(struct bContext *C, struct ARegion *ar, struct Object *obedit, struct EditMesh *em);
167
168 /* editmesh_mods.c */
169 extern unsigned int em_vertoffs, em_solidoffs, em_wireoffs;
170
171 void            EM_cache_x_mirror_vert(struct Object *ob, struct EditMesh *em);
172 int                     mouse_mesh(struct bContext *C, short mval[2], short extend);
173 int                     EM_check_backbuf(unsigned int index);
174 int                     EM_mask_init_backbuf_border(struct ViewContext *vc, short mcords[][2], short tot, short xmin, short ymin, short xmax, short ymax);
175 void            EM_free_backbuf(void);
176 int                     EM_init_backbuf_border(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
177 int                     EM_init_backbuf_circle(struct ViewContext *vc, short xs, short ys, short rads);
178
179 void            EM_hide_mesh(struct EditMesh *em, int swap);
180 void            EM_reveal_mesh(struct EditMesh *em);
181
182 void            EM_select_by_material(struct EditMesh *em, int index);
183 void            EM_deselect_by_material(struct EditMesh *em, int index); 
184
185 void            EM_automerge(struct Scene *scene, struct Object *obedit, int update);
186
187 /* editface.c */
188 void paintface_flush_flags(struct Object *ob);
189 struct MTFace   *EM_get_active_mtface(struct EditMesh *em, struct EditFace **act_efa, struct MCol **mcol, int sloppy);
190 int paintface_mouse_select(struct bContext *C, struct Object *ob, short mval[2], int extend);
191 int do_paintface_box_select(struct ViewContext *vc, struct rcti *rect, int select, int extend);
192 void paintface_deselect_all_visible(struct Object *ob, int action, short flush_flags);
193 void paintface_select_linked(struct bContext *C, struct Object *ob, short mval[2], int mode);
194 int paintface_minmax(struct Object *ob, float *min, float *max);
195
196 /* TODO, 2.5x */
197 void paintface_unhide(struct Scene *scene);
198 void paintface_hide(struct Scene *scene);
199 void paintface_select_swap(struct Scene *scene);
200
201 /* object_vgroup.c */
202
203 #define WEIGHT_REPLACE 1
204 #define WEIGHT_ADD 2
205 #define WEIGHT_SUBTRACT 3
206
207 struct bDeformGroup             *ED_vgroup_add(struct Object *ob);
208 struct bDeformGroup             *ED_vgroup_add_name(struct Object *ob, const char *name);
209 void                                    ED_vgroup_delete(struct Object *ob, struct bDeformGroup *defgroup);
210 void                                    ED_vgroup_select_by_name(struct Object *ob, const char *name);
211 void                                    ED_vgroup_data_create(struct ID *id);
212 int                                             ED_vgroup_give_array(struct ID *id, struct MDeformVert **dvert_arr, int *dvert_tot);
213 int                                             ED_vgroup_copy_array(struct Object *ob, struct Object *ob_from);
214 void                                    ED_vgroup_mirror(struct Object *ob, int mirror_weights, int flip_vgroups);
215
216 int                                             ED_vgroup_object_is_edit_mode(struct Object *ob);
217
218 void            ED_vgroup_vert_add(struct Object *ob, struct bDeformGroup *dg, int vertnum,  float weight, int assignmode);
219 void            ED_vgroup_vert_remove(struct Object *ob, struct bDeformGroup *dg, int vertnum);
220 float           ED_vgroup_vert_weight(struct Object *ob, struct bDeformGroup *dg, int vertnum);
221
222 /*needed by edge slide*/
223 struct EditVert *editedge_getOtherVert(struct EditEdge *eed, struct EditVert *eve);
224 struct EditVert *editedge_getSharedVert(struct EditEdge *eed, struct EditEdge *eed2);
225 int editedge_containsVert(struct EditEdge *eed, struct EditVert *eve);
226 int editface_containsVert(struct EditFace *efa, struct EditVert *eve);
227 int editface_containsEdge(struct EditFace *efa, struct EditEdge *eed);
228 short sharesFace(struct EditMesh *em, struct EditEdge *e1, struct EditEdge *e2);
229
230 /* mesh_data.c */
231 // void ED_mesh_geometry_add(struct Mesh *mesh, struct ReportList *reports, int verts, int edges, int faces);
232 void ED_mesh_faces_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_vertices_add(struct Mesh *mesh, struct ReportList *reports, int count);
235
236 void ED_mesh_transform(struct Mesh *me, float *mat);
237 void ED_mesh_calc_normals(struct Mesh *me);
238 void ED_mesh_material_link(struct Mesh *me, struct Material *ma);
239 void ED_mesh_update(struct Mesh *mesh, struct bContext *C, int calc_edges);
240
241 int ED_mesh_uv_texture_add(struct bContext *C, struct Mesh *me, const char *name, int active_set);
242 int ED_mesh_uv_texture_remove(struct bContext *C, struct Object *ob, struct Mesh *me);
243 int ED_mesh_color_add(struct bContext *C, struct Scene *scene, struct Object *ob, struct Mesh *me, const char *name, int active_set);
244 int ED_mesh_color_remove(struct bContext *C, struct Object *ob, struct Mesh *me);
245
246 #ifdef __cplusplus
247 }
248 #endif
249
250 #endif /* ED_MESH_H */
251