merge with/from trunk at r35190
[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 struct BLI_mempool;
49
50 /* note; changing this also might affect the undo copy in editmesh.c */
51 typedef struct EditVert
52 {
53         struct EditVert *next, *prev;
54         union {
55                 /* some lean storage for temporary usage 
56                  * in editmesh routines
57                  */
58                 struct EditVert *v;
59                 struct EditEdge *e;
60                 struct EditFace *f;
61                 void            *p;
62                 intptr_t         l;
63                 float            fp;
64         } tmp;
65         float no[3]; /*vertex normal */
66         float co[3]; /*vertex location */
67         short xs, ys; /* used to store a screenspace 2d projection of the verts */
68         
69         /* f stores selection eg. if (eve->f & SELECT) {...
70         h for hidden. if (!eve->h) {...
71         f1 and f2 can be used for temp data, clear them first*/
72         unsigned char f, h, f1, f2; 
73         float bweight;
74         short fast;     /* only 0 or 1, for editmesh_fastmalloc, do not store temp data here! */
75         int hash;     /* internal editmesh.c use only, don't touch! */
76         int keyindex; /* original index #, for restoring  key information */
77
78         void *data;             /* custom vertex data */
79 } EditVert;
80
81 struct EditEdge;
82
83 typedef struct HashEdge {
84         struct EditEdge *eed;
85         struct HashEdge *next;
86 } HashEdge;
87
88 /* note; changing this also might affect the undo copy in editmesh.c */
89 typedef struct EditEdge
90 {
91         struct EditEdge *next, *prev;
92         struct EditVert *v1, *v2;
93         union {
94                 /* some lean storage for temporary usage 
95                  * in editmesh routines
96                  */
97                 struct EditVert *v;
98                 struct EditEdge *e;
99                 struct EditFace *f;
100                 void            *p;
101                 intptr_t         l;
102                 float                   fp;
103         } tmp;
104         short f1, f2;   /* short, f1 is (ab)used in subdiv */
105         unsigned char f, h, dir, seam, sharp;
106         float crease;
107         float bweight;
108         short fast;             /* only 0 or 1, for editmesh_fastmalloc */
109         short fgoni;            /* index for fgon, for search */
110         HashEdge hash;
111         void *data;                     /*custom edge data*/
112 } EditEdge;
113
114 /* note; changing this also might affect the undo copy in editmesh.c */
115 typedef struct EditFace
116 {
117         struct EditFace *next, *prev;
118         struct EditVert *v1, *v2, *v3, *v4;
119         struct EditEdge *e1, *e2, *e3, *e4;
120         union {
121                 /* some lean storage for temporary usage 
122                  * in editmesh routines
123                  */
124                 struct EditVert *v;
125                 struct EditEdge *e;
126                 struct EditFace *f;
127                 void            *p;
128                 intptr_t         l;
129                 float                   fp;
130         } tmp;
131         float n[3], cent[3];
132         unsigned char flag;
133         unsigned char f, f1, h;
134         unsigned char fast;                     /* only 0 or 1, for editmesh_fastmalloc */
135         unsigned char fgonf;            /* flag for fgon options */
136         short mat_nr;
137         void *data;             /* custom face data */
138 } EditFace;
139
140
141 /*selection types*/
142 #define EDITVERT 0
143 #define EDITEDGE 1
144 #define EDITFACE 2
145
146 typedef struct EditSelection
147 {
148         struct EditSelection *next, *prev;
149         short type;
150         void *data;
151 } EditSelection;
152
153
154 typedef struct EditMesh
155 {
156         ListBase verts, edges, faces;
157         ListBase selected; /*EditSelections. Used to store the order in which things are selected.*/
158         HashEdge *hashedgetab;
159         
160         /* this is for the editmesh_fastmalloc */
161         struct BLI_mempool *vertpool, *edgepool, *facepool;
162
163         EditVert *allverts, *curvert;
164         EditEdge *alledges, *curedge;
165         EditFace *allfaces, *curface;
166                 /* DerivedMesh caches... note that derived cage can be equivalent
167                  * to derived final, care should be taken on release.
168                  */
169         
170         /* used for keeping track of the last clicked on face - so the space image
171          * when using the last selected face - (EditSelection) the space image flickered too much
172          * 
173          * never access this directly, use EM_set_actFace and EM_get_actFace */
174         EditFace *act_face; 
175         
176         /* copy from scene */
177         short selectmode;
178         /* copy from object actcol */
179         short mat_nr;
180         /* stats */
181         int totvert, totedge, totface, totvertsel, totedgesel, totfacesel;
182         /* shape key being edited */
183         int shapenr;
184         
185         struct DerivedMesh *derivedCage, *derivedFinal;
186         /* the custom data layer mask that was last used to calculate
187          * derivedCage and derivedFinal
188          */
189         int lastDataMask;
190
191         struct RetopoPaintData *retopo_paint_data;
192
193         CustomData vdata, edata, fdata;
194
195 } EditMesh;
196
197 #endif
198