commit of transform pinning patch by Fabian Fricke (frigi). wip hotkey is enter...
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 wmWindowManager;
40 struct EditSelection;
41 struct ViewContext;
42 struct bDeformGroup;
43 struct MDeformWeight;
44 struct MDeformVert;
45 struct Scene;
46 struct Mesh;
47 struct MCol;
48 struct UvVertMap;
49 struct UvMapVert;
50 struct CustomData;
51 struct BMEditSelection;
52 struct BMesh;
53 struct BMVert;
54 struct BMEdge;
55 struct BMFace;
56 struct UvVertMap;
57 struct UvMapVert;
58
59 // edge and face flag both
60 #define EM_FGON         2
61 // face flag
62 #define EM_FGON_DRAW    1
63
64 /* editbutflag */
65 #define B_CLOCKWISE             1
66 #define B_KEEPORIG              2
67 #define B_BEAUTY                4
68 #define B_SMOOTH                8
69 #define B_BEAUTY_SHORT          16
70 #define B_AUTOFGON              32
71 #define B_KNIFE                 0x80
72 #define B_PERCENTSUBD           0x40
73 #define B_MESH_X_MIRROR         0x100
74 #define B_JOINTRIA_UV           0x200
75 #define B_JOINTRIA_VCOL         0X400
76 #define B_JOINTRIA_SHARP        0X800
77 #define B_JOINTRIA_MAT          0X1000
78 #define B_FRACTAL               0x2000
79 #define B_SPHERE                0x4000
80
81 /* bmeshutils.c */
82
83 void EDBM_RecalcNormals(struct BMEditMesh *em);
84
85 void EDBM_MakeEditBMesh(struct Scene *scene, struct Object *ob);
86 void EDBM_FreeEditBMesh(struct BMEditMesh *tm);
87 void EDBM_LoadEditBMesh(struct Scene *scene, struct Object *ob);
88
89 void EDBM_init_index_arrays(struct BMEditMesh *tm, int forvert, int foredge, int forface);
90 void EDBM_free_index_arrays(struct BMEditMesh *tm);
91 struct BMVert *EDBM_get_vert_for_index(struct BMEditMesh *tm, int index);
92 struct BMEdge *EDBM_get_edge_for_index(struct BMEditMesh *tm, int index);
93 struct BMFace *EDBM_get_face_for_index(struct BMEditMesh *tm, int index);
94 struct BMFace *EDBM_get_actFace(struct BMEditMesh *em, int sloppy);
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_selectmode_flush(struct BMEditMesh *em);
101 int EDBM_get_actSelection(struct BMEditMesh *em, struct BMEditSelection *ese);
102 /*exactly the same as EDBM_selectmode_flush, but you pass in the selectmode
103   instead of using the current one*/
104 void EDBM_select_flush(struct BMEditMesh *em, int selectmode);
105
106 void EDBM_selectmode_set(struct BMEditMesh *em);
107 void EDBM_convertsel(struct BMEditMesh *em, short oldmode, short selectmode);
108
109 void EDBM_editselection_center(struct BMEditMesh *em, float *center, struct BMEditSelection *ese);
110 void EDBM_editselection_plane(struct BMEditMesh *em, float *plane, struct BMEditSelection *ese);
111 void EDBM_editselection_normal(float *normal, struct BMEditSelection *ese);
112 int EDBM_vertColorCheck(struct BMEditMesh *em);
113
114 void EDBM_pin_mesh(struct BMEditMesh *em, int swap);
115 void EDBM_unpin_mesh(struct BMEditMesh *em, int swap);
116
117 void EDBM_hide_mesh(struct BMEditMesh *em, int swap);
118 void EDBM_reveal_mesh(struct BMEditMesh *em);
119
120 int                     EDBM_check_backbuf(unsigned int index);
121 int                     EDBM_mask_init_backbuf_border(struct ViewContext *vc, short mcords[][2], short tot, short xmin, short ymin, short xmax, short ymax);
122 void            EDBM_free_backbuf(void);
123 int                     EDBM_init_backbuf_border(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
124 int                     EDBM_init_backbuf_circle(struct ViewContext *vc, short xs, short ys, short rads);
125
126 void EDBM_select_swap(struct BMEditMesh *em); /* exported for UV */
127 void EDBM_set_actFace(struct BMEditMesh *em, struct BMFace *efa);
128
129 int EDBM_texFaceCheck(struct BMEditMesh *em);
130 struct MTexPoly *EDBM_get_active_mtexpoly(struct BMEditMesh *em, struct BMFace **act_efa, int sloppy);
131
132 void EDBM_free_uv_vert_map(struct UvVertMap *vmap);
133 struct UvMapVert *EDBM_get_uv_map_vert(struct UvVertMap *vmap, unsigned int v);
134 struct UvVertMap *EDBM_make_uv_vert_map(struct BMEditMesh *em, int selected, int do_face_idx_array, float *limit);
135
136 void EDBM_toggle_select_all(struct BMEditMesh *em);
137 void EDBM_set_flag_all(struct BMEditMesh *em, int flag);
138
139 /* meshtools.c */
140
141 intptr_t        mesh_octree_table(struct Object *ob, struct BMEditMesh *em, float *co, char mode);
142 struct BMVert   *editmesh_get_x_mirror_vert(struct Object *ob, struct BMEditMesh *em, float *co);
143 int                     mesh_get_x_mirror_vert(struct Object *ob, int index);
144 int                     *mesh_get_x_mirror_faces(struct Object *ob, struct BMEditMesh *em);
145
146 /* mesh_ops.c */
147 void            ED_operatortypes_mesh(void);
148 void            ED_keymap_mesh(struct wmWindowManager *wm);
149
150
151 /* editmesh.c */
152
153 void            ED_spacetypes_init(void);
154 void            ED_keymap_mesh(struct wmWindowManager *wm);
155
156 struct EditMesh *make_editMesh(struct Scene *scene, Object *ob);
157 void            load_editMesh(struct Scene *scene, Object *ob, struct EditMesh *em);
158 void            remake_editMesh(struct Scene *scene, Object *ob);
159 void            free_editMesh(struct EditMesh *em);
160
161 void            recalc_editnormals(struct EditMesh *em);
162
163 void            EM_init_index_arrays(struct EditMesh *em, int forVert, int forEdge, int forFace);
164 void            EM_free_index_arrays(void);
165 struct EditVert *EM_get_vert_for_index(int index);
166 struct EditEdge *EM_get_edge_for_index(int index);
167 struct EditFace *EM_get_face_for_index(int index);
168 int                     EM_texFaceCheck(struct EditMesh *em);
169 int                     EM_vertColorCheck(struct EditMesh *em);
170
171 void            undo_push_mesh(struct bContext *C, char *name);
172
173
174 /* editmesh_lib.c */
175
176 struct EditFace *EM_get_actFace(struct EditMesh *em, int sloppy);
177 void             EM_set_actFace(struct EditMesh *em, struct EditFace *efa);
178 float            EM_face_area(struct EditFace *efa);
179 void             EM_add_data_layer(struct EditMesh *em, struct CustomData *data, int type);
180
181 void            EM_select_edge(struct EditEdge *eed, int sel);
182 void            EM_select_face(struct EditFace *efa, int sel);
183 void            EM_select_face_fgon(struct EditMesh *em, struct EditFace *efa, int val);
184 void            EM_select_swap(struct EditMesh *em);
185 void            EM_toggle_select_all(struct EditMesh *em);
186 void            EM_selectmode_flush(struct EditMesh *em);
187 void            EM_deselect_flush(struct EditMesh *em);
188 void            EM_selectmode_set(struct EditMesh *em);
189 void            EM_select_flush(struct EditMesh *em);
190 void            EM_convertsel(struct EditMesh *em, short oldmode, short selectmode);
191 void            EM_validate_selections(struct EditMesh *em);
192
193                         /* exported to transform */
194 int                     EM_get_actSelection(struct EditMesh *em, struct EditSelection *ese);
195 void            EM_editselection_normal(float *normal, struct EditSelection *ese);
196 void            EM_editselection_plane(float *plane, struct EditSelection *ese);
197 void            EM_editselection_center(float *center, struct EditSelection *ese);                      
198
199 struct UvVertMap *EM_make_uv_vert_map(struct EditMesh *em, int selected, int do_face_idx_array, float *limit);
200 struct UvMapVert *EM_get_uv_map_vert(struct UvVertMap *vmap, unsigned int v);
201 void              EM_free_uv_vert_map(struct UvVertMap *vmap);
202
203 /* editmesh_mods.c */
204 extern unsigned int bm_vertoffs, bm_solidoffs, bm_wireoffs;
205
206 void            mouse_mesh(struct bContext *C, short mval[2], short extend);
207 int                     EM_check_backbuf(unsigned int index);
208 int                     EM_mask_init_backbuf_border(struct ViewContext *vc, short mcords[][2], short tot, short xmin, short ymin, short xmax, short ymax);
209 void            EM_free_backbuf(void);
210 int                     EM_init_backbuf_border(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
211 int                     EM_init_backbuf_circle(struct ViewContext *vc, short xs, short ys, short rads);
212
213 void            EM_hide_mesh(struct EditMesh *em, int swap);
214 void            EM_reveal_mesh(struct EditMesh *em);
215
216 /* editface.c */
217 struct MTFace   *EM_get_active_mtface(struct EditMesh *em, struct EditFace **act_efa, struct MCol **mcol, int sloppy);
218
219 /* editdeform.c XXX rename functions? */
220
221 #define WEIGHT_REPLACE 1
222 #define WEIGHT_ADD 2
223 #define WEIGHT_SUBTRACT 3
224
225 void            add_defgroup (Object *ob);
226 void            create_dverts(struct ID *id);
227 float           get_vert_defgroup (Object *ob, struct bDeformGroup *dg, int vertnum);
228 void            remove_vert_defgroup (Object *ob, struct bDeformGroup *dg, int vertnum);
229 void            remove_verts_defgroup (Object *obedit, int allverts);
230 void            vertexgroup_select_by_name(Object *ob, char *name);
231 void            add_vert_to_defgroup (Object *ob, struct bDeformGroup *dg, int vertnum, 
232                            float weight, int assignmode);
233
234 struct bDeformGroup             *add_defgroup_name (Object *ob, char *name);
235 struct MDeformWeight    *verify_defweight (struct MDeformVert *dv, int defgroup);
236 struct MDeformWeight    *get_defweight (struct MDeformVert *dv, int defgroup);
237
238
239 #endif /* ED_MESH_H */
240