commit of transform pinning patch by Fabian Fricke (frigi). wip hotkey is enter...
[blender-staging.git] / source / blender / editors / mesh / mesh_intern.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) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /* Internal for editmesh_xxxx.c functions */
31
32 #ifndef MESH_INTERN_H
33 #define MESH_INTERN_H
34
35 #include "BLI_editVert.h"
36 #include "DNA_scene_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_mesh_types.h"
39
40 struct bContext;
41 struct wmOperatorType;
42 struct ViewContext;
43 struct BMEditMesh;
44 struct BMesh;
45 struct BMEdge;
46 struct BMFace;
47
48 #define UVCOPY(t, s) memcpy(t, s, 2 * sizeof(float));
49
50 /* ******************** bmeshutils.c */
51
52 /*
53 ok: the EDBM module is for editmode bmesh stuff.  in contrast, the 
54     BMEdit module is for code shared with blenkernel that concerns
55     the BMEditMesh structure.
56 */
57
58 /*calls a bmesh op, reporting errors to the user, doing conversions,
59   etc.*/
60 int EDBM_CallOpf(struct BMEditMesh *em, struct wmOperator *op, char *fmt, ...);
61
62 /*same as above, but doesn't report errors.*/
63 int EDBM_CallOpfSilent(struct BMEditMesh *em, char *fmt, ...);
64
65 /*these next two functions are the split version of EDBM_CallOpf, so you can
66   do stuff with a bmesh operator, after initializing it but before executing
67   it.
68   
69   execute the operator with BM_Exec_Op*/
70 int EDBM_InitOpf(struct BMEditMesh *em, struct BMOperator *bmop,
71                 struct wmOperator *op, char *fmt, ...);
72 /*cleans up after a bmesh operator*/
73 int EDBM_FinishOp(struct BMEditMesh *em, struct BMOperator *bmop,
74                 struct wmOperator *op, int report);
75
76 void EDBM_clear_flag_all(struct BMEditMesh *em, int flag);
77 void EDBM_store_selection(struct BMEditMesh *em, void *data);
78 void EDBM_validate_selections(struct BMEditMesh *em);
79 void EDBM_remove_selection(struct BMEditMesh *em, void *data);
80 void EDBM_stats_update(struct BMEditMesh *em);
81
82 /* ******************** editface.c */
83
84 int edgetag_context_check(Scene *scene, EditEdge *eed);
85 void edgetag_context_set(Scene *scene, EditEdge *eed, int val);
86 int edgetag_shortest_path(Scene *scene, EditMesh *em, EditEdge *source, EditEdge *target);
87
88 /* ******************* editmesh.c */
89
90 void EM_beginEditMesh(struct Object *ob);
91 void EM_endEditMesh(struct Object *ob, EditMesh *em);
92
93 extern void free_editvert(EditMesh *em, EditVert *eve);
94 extern void free_editedge(EditMesh *em, EditEdge *eed);
95 extern void free_editface(EditMesh *em, EditFace *efa);
96 void free_editMesh(EditMesh *em);
97
98 /*frees dst mesh, then copies the contents of 
99   *src (the struct) to dst. */
100 void set_editMesh(EditMesh *dst, EditMesh *src);
101
102 extern void free_vertlist(EditMesh *em, ListBase *edve);
103 extern void free_edgelist(EditMesh *em, ListBase *lb);
104 extern void free_facelist(EditMesh *em, ListBase *lb);
105
106 extern void remedge(EditMesh *em, EditEdge *eed);
107
108 extern struct EditVert *addvertlist(EditMesh *em, float *vec, struct EditVert *example);
109 extern struct EditEdge *addedgelist(EditMesh *em, struct EditVert *v1, struct EditVert *v2, struct EditEdge *example);
110 extern struct EditFace *addfacelist(EditMesh *em, struct EditVert *v1, struct EditVert *v2, struct EditVert *v3, struct EditVert *v4, struct EditFace *example, struct EditFace *exampleEdges);
111 extern struct EditEdge *findedgelist(EditMesh *em, struct EditVert *v1, struct EditVert *v2);
112
113 EditVert *editedge_getOtherVert(EditEdge *eed, EditVert *eve);
114 EditVert *editedge_getSharedVert(EditEdge *eed, EditEdge *eed2);
115 int editedge_containsVert(struct EditEdge *eed, struct EditVert *eve);
116 int editface_containsVert(struct EditFace *efa, struct EditVert *eve);
117 int editface_containsEdge(struct EditFace *efa, struct EditEdge *eed);
118
119 void em_setup_viewcontext(struct bContext *C, struct ViewContext *vc);
120
121 void MESH_OT_separate(struct wmOperatorType *ot);
122
123 /* ******************* editmesh_add.c */
124 void MESH_OT_primitive_plane_add(struct wmOperatorType *ot);
125 void MESH_OT_primitive_cube_add(struct wmOperatorType *ot);
126 void MESH_OT_primitive_circle_add(struct wmOperatorType *ot);
127 void MESH_OT_primitive_cylinder_add(struct wmOperatorType *ot);
128 void MESH_OT_primitive_tube_add(struct wmOperatorType *ot);
129 void MESH_OT_primitive_cone_add(struct wmOperatorType *ot);
130 void MESH_OT_primitive_grid_add(struct wmOperatorType *ot);
131 void MESH_OT_primitive_monkey_add(struct wmOperatorType *ot);
132 void MESH_OT_primitive_uv_sphere_add(struct wmOperatorType *ot);
133 void MESH_OT_primitive_ico_sphere_add(struct wmOperatorType *ot);
134
135 void MESH_OT_edge_face_add(struct wmOperatorType *ot);
136 void MESH_OT_dupli_extrude_cursor(struct wmOperatorType *ot);
137 void MESH_OT_duplicate(struct wmOperatorType *ot);
138
139 void MESH_OT_fgon_make(struct wmOperatorType *ot);
140 void MESH_OT_fgon_clear(struct wmOperatorType *ot);
141
142 /* ******************* editmesh_lib.c */
143 void EM_stats_update(EditMesh *em);
144
145 extern void EM_fgon_flags(EditMesh *em);
146 extern void EM_hide_reset(EditMesh *em);
147
148 extern int faceselectedOR(EditFace *efa, int flag);
149 extern int faceselectedAND(EditFace *efa, int flag);
150
151 void EM_remove_selection(EditMesh *em, void *data, int type);
152 void EM_clear_flag_all(EditMesh *em, int flag);
153 void EM_set_flag_all(EditMesh *em, int flag);
154
155 void EM_data_interp_from_verts(EditMesh *em, EditVert *v1, EditVert *v2, EditVert *eve, float fac);
156 void EM_data_interp_from_faces(EditMesh *em, EditFace *efa1, EditFace *efa2, EditFace *efan, int i1, int i2, int i3, int i4);
157
158 int EM_nvertices_selected(EditMesh *em);
159 int EM_nedges_selected(EditMesh *em);
160 int EM_nfaces_selected(EditMesh *em);
161
162 float EM_face_perimeter(EditFace *efa);
163
164 void EM_store_selection(EditMesh *em, void *data, int type);
165
166 extern EditFace *exist_face(EditMesh *em, EditVert *v1, EditVert *v2, EditVert *v3, EditVert *v4);
167 extern void flipface(EditMesh *em, EditFace *efa); // flips for normal direction
168 extern int compareface(EditFace *vl1, EditFace *vl2);
169
170 /* flag for selection bits, *nor will be filled with normal for extrusion constraint */
171 /* return value defines if such normal was set */
172 extern short extrudeflag_face_indiv(EditMesh *em, short flag, float *nor);
173 extern short extrudeflag_verts_indiv(EditMesh *em, short flag, float *nor);
174 extern short extrudeflag_edges_indiv(EditMesh *em, short flag, float *nor);
175 extern short extrudeflag_vert(Object *obedit, EditMesh *em, short flag, float *nor);
176 extern short extrudeflag(Object *obedit, EditMesh *em, short flag, float *nor);
177
178 extern void adduplicateflag(EditMesh *em, int flag);
179 extern void delfaceflag(EditMesh *em, int flag);
180
181 extern void rotateflag(EditMesh *em, short flag, float *cent, float rotmat[][3]);
182 extern void translateflag(EditMesh *em, short flag, float *vec);
183
184 extern int convex(float *v1, float *v2, float *v3, float *v4);
185
186 extern struct EditFace *EM_face_from_faces(EditMesh *em, struct EditFace *efa1,
187                                                                                    struct EditFace *efa2, int i1, int i2, int i3, int i4);
188
189 extern int EM_view3d_poll(struct bContext *C);
190
191 /* ******************* editmesh_loop.c */
192
193 #define LOOP_SELECT     1
194 #define LOOP_CUT        2
195
196 void MESH_OT_knife_cut(struct wmOperatorType *ot);
197
198 /* ******************* editmesh_mods.c */
199 void MESH_OT_loop_select(struct wmOperatorType *ot);
200 void MESH_OT_select_all_toggle(struct wmOperatorType *ot);
201 void MESH_OT_bmesh_test(struct wmOperatorType *ot);
202 void MESH_OT_select_more(struct wmOperatorType *ot);
203 void MESH_OT_select_less(struct wmOperatorType *ot);
204 void MESH_OT_select_inverse(struct wmOperatorType *ot);
205 void MESH_OT_select_non_manifold(struct wmOperatorType *ot);
206 void MESH_OT_select_linked(struct wmOperatorType *ot);
207 void MESH_OT_select_linked_pick(struct wmOperatorType *ot);
208 void MESH_OT_pin(struct wmOperatorType *ot);
209 void MESH_OT_unpin(struct wmOperatorType *ot);
210 void MESH_OT_hide(struct wmOperatorType *ot);
211 void MESH_OT_reveal(struct wmOperatorType *ot);
212 void MESH_OT_select_by_number_vertices(struct wmOperatorType *ot);
213 void MESH_OT_normals_make_consistent(struct wmOperatorType *ot);
214 void MESH_OT_faces_select_linked_flat(struct wmOperatorType *ot);
215 void MESH_OT_edges_select_sharp(struct wmOperatorType *ot);
216 void MESH_OT_select_shortest_path(struct wmOperatorType *ot);
217 void MESH_OT_select_similar(struct wmOperatorType *ot);
218 void MESH_OT_select_random(struct wmOperatorType *ot);
219 void MESH_OT_vertices_transform_to_sphere(struct wmOperatorType *ot);
220 void MESH_OT_selection_type(struct wmOperatorType *ot);
221 void MESH_OT_loop_multi_select(struct wmOperatorType *ot);
222 void MESH_OT_mark_seam(struct wmOperatorType *ot);
223 void MESH_OT_mark_sharp(struct wmOperatorType *ot);
224 void MESH_OT_vertices_smooth(struct wmOperatorType *ot);
225 void MESH_OT_flip_normals(struct wmOperatorType *ot);
226
227 extern EditEdge *findnearestedge(struct ViewContext *vc, int *dist);
228 extern void EM_automerge(int update);
229 void editmesh_select_by_material(EditMesh *em, int index);
230 void righthandfaces(EditMesh *em, int select);  /* makes faces righthand turning */
231 void EM_select_more(EditMesh *em);
232 void selectconnected_mesh_all(EditMesh *em);
233 void faceloop_select(struct BMEditMesh *em, struct BMEdge *startedge, int select);
234
235 /**
236  * findnearestvert
237  * 
238  * dist (in/out): minimal distance to the nearest and at the end, actual distance
239  * sel: selection bias
240  *              if SELECT, selected vertice are given a 5 pixel bias to make them farter than unselect verts
241  *              if 0, unselected vertice are given the bias
242  * strict: if 1, the vertice corresponding to the sel parameter are ignored and not just biased 
243  */
244 extern EditVert *findnearestvert(struct ViewContext *vc, int *dist, short sel, short strict);
245
246
247 /* ******************* editmesh_tools.c */
248
249 #define SUBDIV_SELECT_ORIG      0
250 #define SUBDIV_SELECT_INNER     1
251 #define SUBDIV_SELECT_INNER_SEL 2
252 #define SUBDIV_SELECT_LOOPCUT 3
253
254 void join_triangles(EditMesh *em);
255 int removedoublesflag(EditMesh *em, short flag, short automerge, float limit);          /* return amount */
256 void esubdivideflag(Object *obedit, EditMesh *em, int flag, float smooth, float fractal, int beauty, int numcuts, int seltype);
257 int EdgeSlide(EditMesh *em, struct wmOperator *op, short immediate, float imperc);
258
259 void MESH_OT_merge(struct wmOperatorType *ot);
260 void MESH_OT_subdivide(struct wmOperatorType *ot);
261 void MESH_OT_remove_doubles(struct wmOperatorType *ot);
262 void MESH_OT_extrude(struct wmOperatorType *ot);
263 void MESH_OT_spin(struct wmOperatorType *ot);
264 void MESH_OT_screw(struct wmOperatorType *ot);
265
266 void MESH_OT_fill(struct wmOperatorType *ot);
267 void MESH_OT_beauty_fill(struct wmOperatorType *ot);
268 void MESH_OT_quads_convert_to_tris(struct wmOperatorType *ot);
269 void MESH_OT_tris_convert_to_quads(struct wmOperatorType *ot);
270 void MESH_OT_edge_flip(struct wmOperatorType *ot);
271 void MESH_OT_faces_shade_smooth(struct wmOperatorType *ot);
272 void MESH_OT_faces_shade_flat(struct wmOperatorType *ot);
273 void MESH_OT_split(struct wmOperatorType *ot);
274 void MESH_OT_extrude_repeat(struct wmOperatorType *ot);
275 void MESH_OT_edge_rotate(struct wmOperatorType *ot);
276 void MESH_OT_select_vertex_path(struct wmOperatorType *ot);
277 void MESH_OT_loop_to_region(struct wmOperatorType *ot);
278 void MESH_OT_region_to_loop(struct wmOperatorType *ot);
279
280 void MESH_OT_uvs_rotate(struct wmOperatorType *ot);
281 void MESH_OT_uvs_mirror(struct wmOperatorType *ot);
282 void MESH_OT_colors_rotate(struct wmOperatorType *ot);
283 void MESH_OT_colors_mirror(struct wmOperatorType *ot);
284
285 void MESH_OT_delete(struct wmOperatorType *ot);
286 void MESH_OT_rip(struct wmOperatorType *ot);
287
288 /* ******************* mesh_layers.c */
289
290 void MESH_OT_uv_texture_add(struct wmOperatorType *ot);
291 void MESH_OT_uv_texture_remove(struct wmOperatorType *ot);
292 void MESH_OT_vertex_color_add(struct wmOperatorType *ot);
293 void MESH_OT_vertex_color_remove(struct wmOperatorType *ot);
294 void MESH_OT_sticky_add(struct wmOperatorType *ot);
295 void MESH_OT_sticky_remove(struct wmOperatorType *ot);
296
297 /* ************* bmesh_tools.c ***********/
298 void MESH_OT_vert_connect(struct wmOperatorType *ot);
299 void MESH_OT_edge_split(struct wmOperatorType *ot);
300 void MESH_OT_extrude_region(struct wmOperatorType *ot);
301 void MESH_OT_extrude_verts_indiv(struct wmOperatorType *ot);
302 void MESH_OT_extrude_edges_indiv(struct wmOperatorType *ot);
303 void MESH_OT_extrude_faces_indiv(struct wmOperatorType *ot);
304 void MESH_OT_bm_test(struct wmOperatorType *ot);
305
306 #endif // MESH_INTERN_H
307