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