Added custom face data support in edit mode. The code used to do this is
[blender.git] / source / blender / blenlib / BLI_editVert.h
1 /**
2  * blenlib/BLI_editVert.h    mar 2001 Nzc
3  *
4  * Some editing types needed in the lib (unfortunately) for
5  * scanfill.c
6  *
7  * $Id$
8  *
9  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version. The Blender
15  * Foundation also sells licenses for use in proprietary software under
16  * the Blender License.  See http://www.blender.org/BL/ for information
17  * about this.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software Foundation,
26  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
27  *
28  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
29  * All rights reserved.
30  *
31  * The Original Code is: all of this file.
32  *
33  * Contributor(s): none yet.
34  *
35  * ***** END GPL/BL DUAL LICENSE BLOCK *****
36  */
37
38 #ifndef BLI_EDITVERT_H
39 #define BLI_EDITVERT_H
40
41 #include "DNA_customdata_types.h"
42 #include "DNA_mesh_types.h"
43
44 struct DerivedMesh;
45 struct RetopoPaintData;
46
47 /* note; changing this also might affect the undo copy in editmesh.c */
48 typedef struct EditVert
49 {
50         struct EditVert *next, *prev;
51         union {
52                 /* some lean storage for temporary usage 
53                  * in editmesh routines
54                  */
55                 struct EditVert *v;
56                 struct EditEdge *e;
57                 struct EditFace *f;
58                 float           *fp;
59                 void            *p;
60                 long             l;
61         } tmp;
62         float no[3]; /*vertex normal */
63         float co[3]; /*vertex location */
64         short xs, ys; /* used to store a screenspace 2d projection of the verts */
65         
66         /* f stores selection eg. if (eve->f & SELECT) {...
67         h for hidden. if (!eve->h) {...
68         f1 and f2 can be used for temp data, clear them first*/
69         unsigned char f, h, f1, f2; 
70         short fast;     /* only 0 or 1, for editmesh_fastmalloc, do not store temp data here! */
71         short   totweight; /* __NLA total number of vertex weights for this vertex */
72         int hash;
73         struct MDeformWeight *dw;       /* __NLA a pointer to an array of defirm weights */
74         int keyindex; /* original index #, for restoring  key information */
75 /*#ifdef WITH_VERSE*/
76         void *vvert;
77 /*#endif*/
78 } EditVert;
79
80 struct EditEdge;
81
82 typedef struct HashEdge {
83         struct EditEdge *eed;
84         struct HashEdge *next;
85 } HashEdge;
86
87 /* note; changing this also might affect the undo copy in editmesh.c */
88 typedef struct EditEdge
89 {
90         struct EditEdge *next, *prev;
91         struct EditVert *v1, *v2;
92         union {
93                 /* some lean storage for temporary usage 
94                  * in editmesh routines
95                  */
96                 struct EditVert *v;
97                 struct EditEdge *e;
98                 struct EditFace *f;
99                 void            *p;
100                 long             l;
101                 float                   fp;
102         } tmp;
103         short f1, f2;   /* short, f1 is (ab)used in subdiv */
104         unsigned char f, h, dir, seam, sharp;
105         float crease;
106         short fast;             /* only 0 or 1, for editmesh_fastmalloc */
107         short fgoni;            /* index for fgon, for search */
108         HashEdge hash;
109 } EditEdge;
110
111 /* note; changing this also might affect the undo copy in editmesh.c */
112 typedef struct EditFace
113 {
114         struct EditFace *next, *prev;
115         struct EditVert *v1, *v2, *v3, *v4;
116         struct EditEdge *e1, *e2, *e3, *e4;
117         union {
118                 /* some lean storage for temporary usage 
119                  * in editmesh routines
120                  */
121                 struct EditVert *v;
122                 struct EditEdge *e;
123                 struct EditFace *f;
124                 void            *p;
125                 long             l;
126                 float                   fp;
127         } tmp;
128         float n[3], cent[3];
129         unsigned char mat_nr, flag;
130         unsigned char f, f1, h;
131         unsigned char fast;                     /* only 0 or 1, for editmesh_fastmalloc */
132         unsigned char fgonf;            /* flag for fgon options */
133 /*#ifdef WITH_VERSE*/
134         void *vface;
135 /*#endif*/
136         void *data;             /* custom face data */
137 } EditFace;
138
139
140 /*selection types*/
141 #define EDITVERT 0
142 #define EDITEDGE 1
143 #define EDITFACE 2
144
145 typedef struct EditSelection
146 {
147         struct EditSelection *next, *prev;
148         short type;
149         void *data;
150 } EditSelection;
151
152
153 typedef struct EditMesh
154 {
155         ListBase verts, edges, faces;
156         ListBase selected; /*EditSelections. Used to store the order in which things are selected.*/
157         HashEdge *hashedgetab;
158         
159         /* this is for the editmesh_fastmalloc */
160         EditVert *allverts, *curvert;
161         EditEdge *alledges, *curedge;
162         EditFace *allfaces, *curface;
163                 /* DerivedMesh caches... note that derived cage can be equivalent
164                  * to derived final, care should be taken on release.
165                  */
166         struct DerivedMesh *derivedCage, *derivedFinal;
167
168         char retopo_mode; /* 0=OFF, 1=ON, 2=PAINT */
169         struct RetopoPaintData *retopo_paint_data;
170
171         CustomData fdata;
172
173 #ifdef WITH_VERSE
174         void *vnode;
175 #endif
176 } EditMesh;
177
178 #endif
179