as per discussion with ton, the editmesh accessors now live
[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., 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
52 // edge and face flag both
53 #define EM_FGON         2
54 // face flag
55 #define EM_FGON_DRAW    1
56
57 /* editbutflag */
58 #define B_CLOCKWISE             1
59 #define B_KEEPORIG              2
60 #define B_BEAUTY                4
61 #define B_SMOOTH                8
62 #define B_BEAUTY_SHORT          16
63 #define B_AUTOFGON              32
64 #define B_KNIFE                 0x80
65 #define B_PERCENTSUBD           0x40
66 #define B_MESH_X_MIRROR         0x100
67 #define B_JOINTRIA_UV           0x200
68 #define B_JOINTRIA_VCOL         0X400
69 #define B_JOINTRIA_SHARP        0X800
70 #define B_JOINTRIA_MAT          0X1000
71
72
73 /* meshtools.c */
74
75 intptr_t        mesh_octree_table(struct Object *ob, struct EditMesh *em, float *co, char mode);
76 struct EditVert   *editmesh_get_x_mirror_vert(struct Object *ob, struct EditMesh *em, float *co);
77 int                     mesh_get_x_mirror_vert(struct Object *ob, int index);
78 int                     *mesh_get_x_mirror_faces(struct Object *ob, struct EditMesh *em);
79
80 /* mesh_ops.c */
81 void            ED_operatortypes_mesh(void);
82 void            ED_keymap_mesh(struct wmWindowManager *wm);
83
84
85 /* editmesh.c */
86
87 /*accessor functions for editmesh, all access to editmesh must
88   go through them!*/
89 struct EditMesh *BKE_mesh_get_editmesh(struct Mesh *me);
90 void BKE_mesh_end_editmesh(struct Mesh *me, struct EditMesh *em);
91
92 void            ED_spacetypes_init(void);
93 void            ED_keymap_mesh(struct wmWindowManager *wm);
94
95 void            make_editMesh(struct Scene *scene, Object *ob);
96 void            load_editMesh(struct Scene *scene, Object *ob);
97 void            remake_editMesh(struct Scene *scene, Object *ob);
98 void            free_editMesh(struct EditMesh *em);
99
100 void            recalc_editnormals(struct EditMesh *em);
101
102 void            EM_init_index_arrays(struct EditMesh *em, int forVert, int forEdge, int forFace);
103 void            EM_free_index_arrays(void);
104 struct EditVert *EM_get_vert_for_index(int index);
105 struct EditEdge *EM_get_edge_for_index(int index);
106 struct EditFace *EM_get_face_for_index(int index);
107 int                     EM_texFaceCheck(struct EditMesh *em);
108 int                     EM_vertColorCheck(struct EditMesh *em);
109
110 void            undo_push_mesh(struct bContext *C, char *name);
111
112
113 /* editmesh_lib.c */
114
115 struct EditFace *EM_get_actFace(struct EditMesh *em, int sloppy);
116 void             EM_set_actFace(struct EditMesh *em, struct EditFace *efa);
117 float            EM_face_area(struct EditFace *efa);
118 void             EM_add_data_layer(struct EditMesh *em, struct CustomData *data, int type);
119
120 void            EM_select_edge(struct EditEdge *eed, int sel);
121 void            EM_select_face(struct EditFace *efa, int sel);
122 void            EM_select_face_fgon(struct EditMesh *em, struct EditFace *efa, int val);
123 void            EM_select_swap(struct EditMesh *em);
124 void            EM_toggle_select_all(struct EditMesh *em);
125 void            EM_selectmode_flush(struct EditMesh *em);
126 void            EM_deselect_flush(struct EditMesh *em);
127 void            EM_selectmode_set(struct EditMesh *em);
128 void            EM_select_flush(struct EditMesh *em);
129 void            EM_convertsel(struct EditMesh *em, short oldmode, short selectmode);
130 void            EM_validate_selections(struct EditMesh *em);
131
132                         /* exported to transform */
133 int                     EM_get_actSelection(struct EditMesh *em, struct EditSelection *ese);
134 void            EM_editselection_normal(float *normal, struct EditSelection *ese);
135 void            EM_editselection_plane(float *plane, struct EditSelection *ese);
136 void            EM_editselection_center(float *center, struct EditSelection *ese);                      
137
138 struct UvVertMap *EM_make_uv_vert_map(struct EditMesh *em, int selected, int do_face_idx_array, float *limit);
139 struct UvMapVert *EM_get_uv_map_vert(struct UvVertMap *vmap, unsigned int v);
140 void              EM_free_uv_vert_map(struct UvVertMap *vmap);
141
142 /* editmesh_mods.c */
143 extern unsigned int em_vertoffs, em_solidoffs, em_wireoffs;
144
145 void            mouse_mesh(struct bContext *C, short mval[2], short extend);
146 int                     EM_check_backbuf(unsigned int index);
147 int                     EM_mask_init_backbuf_border(struct ViewContext *vc, short mcords[][2], short tot, short xmin, short ymin, short xmax, short ymax);
148 void            EM_free_backbuf(void);
149 int                     EM_init_backbuf_border(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
150 int                     EM_init_backbuf_circle(struct ViewContext *vc, short xs, short ys, short rads);
151
152 void            EM_hide_mesh(struct EditMesh *em, int swap);
153 void            EM_reveal_mesh(struct EditMesh *em);
154
155 /* editface.c */
156 struct MTFace   *EM_get_active_mtface(struct EditMesh *em, struct EditFace **act_efa, struct MCol **mcol, int sloppy);
157
158 /* editdeform.c XXX rename functions? */
159
160 #define WEIGHT_REPLACE 1
161 #define WEIGHT_ADD 2
162 #define WEIGHT_SUBTRACT 3
163
164 void            add_defgroup (Object *ob);
165 void            create_dverts(struct ID *id);
166 float           get_vert_defgroup (Object *ob, struct bDeformGroup *dg, int vertnum);
167 void            remove_vert_defgroup (Object *ob, struct bDeformGroup *dg, int vertnum);
168 void            remove_verts_defgroup (Object *obedit, int allverts);
169 void            vertexgroup_select_by_name(Object *ob, char *name);
170 void            add_vert_to_defgroup (Object *ob, struct bDeformGroup *dg, int vertnum, 
171                            float weight, int assignmode);
172
173 struct bDeformGroup             *add_defgroup_name (Object *ob, char *name);
174 struct MDeformWeight    *verify_defweight (struct MDeformVert *dv, int defgroup);
175 struct MDeformWeight    *get_defweight (struct MDeformVert *dv, int defgroup);
176
177
178 #endif /* ED_MESH_H */
179