doxygen: editor entry
[blender.git] / source / blender / blenlib / BLI_editVert.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) 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 #ifndef BLI_EDITVERT_H
31 #define BLI_EDITVERT_H
32
33 /** \file BLI_editVert.h
34  *  \ingroup bli
35  *  \since March 2001
36  *  \author nzc
37  *  \brief Some editing types needed in the lib (unfortunately) for
38  *   scanfill.c
39  */
40
41 #include "DNA_customdata_types.h"
42 #include "DNA_mesh_types.h"
43
44 #include "BLO_sys_types.h" // for intptr_t support
45
46 struct DerivedMesh;
47 struct RetopoPaintData;
48
49 /* note; changing this also might affect the undo copy in editmesh.c */
50 typedef struct EditVert
51 {
52         struct EditVert *next, *prev;
53         union {
54                 /* some lean storage for temporary usage 
55                  * in editmesh routines
56                  */
57                 struct EditVert *v;
58                 struct EditEdge *e;
59                 struct EditFace *f;
60                 void            *p;
61                 intptr_t         l;
62                 float            fp;
63         } tmp;
64         float no[3]; /*vertex normal */
65         float co[3]; /*vertex location */
66         short xs, ys; /* used to store a screenspace 2d projection of the verts */
67         
68         /* f stores selection eg. if (eve->f & SELECT) {...
69         h for hidden. if (!eve->h) {...
70         f1 and f2 can be used for temp data, clear them first*/
71         unsigned char f, h, f1, f2; 
72         float bweight;
73         short fast;     /* only 0 or 1, for editmesh_fastmalloc, do not store temp data here! */
74         int hash;     /* internal editmesh.c use only, don't touch! */
75         int keyindex; /* original index #, for restoring  key information */
76
77         void *data;             /* custom vertex data */
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                 intptr_t         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         float bweight;
107         short fast;             /* only 0 or 1, for editmesh_fastmalloc */
108         short fgoni;            /* index for fgon, for search */
109         HashEdge hash;
110         void *data;                     /*custom edge data*/
111 } EditEdge;
112
113 /* note; changing this also might affect the undo copy in editmesh.c */
114 typedef struct EditFace
115 {
116         struct EditFace *next, *prev;
117         struct EditVert *v1, *v2, *v3, *v4;
118         struct EditEdge *e1, *e2, *e3, *e4;
119         union {
120                 /* some lean storage for temporary usage 
121                  * in editmesh routines
122                  */
123                 struct EditVert *v;
124                 struct EditEdge *e;
125                 struct EditFace *f;
126                 void            *p;
127                 intptr_t         l;
128                 float                   fp;
129         } tmp;
130         float n[3], cent[3];
131         unsigned char flag;
132         unsigned char f, f1, h;
133         unsigned char fast;                     /* only 0 or 1, for editmesh_fastmalloc */
134         unsigned char fgonf;            /* flag for fgon options */
135         short mat_nr;
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         
167         /* used for keeping track of the last clicked on face - so the space image
168          * when using the last selected face - (EditSelection) the space image flickered too much
169          * 
170          * never access this directly, use EM_set_actFace and EM_get_actFace */
171         EditFace *act_face; 
172         
173         /* copy from scene */
174         short selectmode;
175         /* copy from object actcol */
176         short mat_nr;
177         /* stats */
178         int totvert, totedge, totface, totvertsel, totedgesel, totfacesel;
179         /* shape key being edited */
180         int shapenr;
181         
182         struct DerivedMesh *derivedCage, *derivedFinal;
183         /* the custom data layer mask that was last used to calculate
184          * derivedCage and derivedFinal
185          */
186         int lastDataMask;
187
188         struct RetopoPaintData *retopo_paint_data;
189
190         CustomData vdata, edata, fdata;
191
192 } EditMesh;
193
194 #endif
195