source/blender/makesdna/DNA_meshdata_types.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  19  * All rights reserved.
  20  *
  21  * The Original Code is: all of this file.
  22  *
  23  * Contributor(s): none yet.
  24  *
  25  * ***** END GPL LICENSE BLOCK *****
  26  */
  27
  28 /** \file DNA_meshdata_types.h
  29  *  \ingroup DNA
  30  */
  31
  32 #ifndef __DNA_MESHDATA_TYPES_H__
  33 #define __DNA_MESHDATA_TYPES_H__
  34
  35 #include "DNA_customdata_types.h"
  36 #include "DNA_listBase.h"
  37
  38 struct Bone;
  39 struct Image;
  40
  41 /*tessellation face, see MLoop/MPoly for the real face data*/
  42 typedef struct MFace {
  43         unsigned int v1, v2, v3, v4;
  44         short mat_nr;
  45         char edcode, flag;      /* we keep edcode, for conversion to edges draw flags in old files */
  46 } MFace;
  47
  48 typedef struct MEdge {
  49         unsigned int v1, v2;
  50         char crease, bweight;
  51         short flag;
  52 } MEdge;
  53
  54 typedef struct MDeformWeight {
  55         int                             def_nr;
  56         float                   weight;
  57 } MDeformWeight;
  58
  59 typedef struct MDeformVert {
  60         struct MDeformWeight *dw;
  61         int totweight;
  62         int flag;       /* flag only in use for weightpaint now */
  63 } MDeformVert;
  64
  65 typedef struct MVert {
  66         float   co[3];
  67         short   no[3];
  68         char flag, bweight;
  69 } MVert;
  70
  71 /* tessellation vertex color data.
  72  * at the moment alpha is abused for vertex painting
  73  * and not used for transparency, note that red and blue are swapped */
  74 typedef struct MCol {
  75         char a, r, g, b;
  76 } MCol;
  77
  78 /* new face structure, replaces MFace, which is now
  79  * only used for storing tessellations.*/
  80 typedef struct MPoly {
  81         /* offset into loop array and number of loops in the face */
  82         int loopstart;
  83         int totloop; /* keep signed since we need to subtract when getting the previous loop */
  84         short mat_nr;
  85         char flag, pad;
  86 } MPoly;
  87
  88 /* the e here is because we want to move away from
  89  * relying on edge hashes.*/
  90 typedef struct MLoop {
  91         unsigned int v; /*vertex index*/
  92         unsigned int e; /*edge index*/
  93 } MLoop;
  94
  95 typedef struct MTexPoly {
  96         struct Image *tpage;
  97         char flag, transp;
  98         short mode, tile, unwrap;
  99 } MTexPoly;
 100
 101 /* can copy from/to MTexPoly/MTFace */
 102 #define ME_MTEXFACE_CPY(dst, src)   \
 103 {                                   \
 104         (dst)->tpage  = (src)->tpage;   \
 105         (dst)->flag   = (src)->flag;    \
 106         (dst)->transp = (src)->transp;  \
 107         (dst)->mode   = (src)->mode;    \
 108         (dst)->tile   = (src)->tile;    \
 109         (dst)->unwrap = (src)->unwrap;  \
 110 }
 111
 112 typedef struct MLoopUV {
 113         float uv[2];
 114         int flag;
 115 } MLoopUV;
 116
 117 /*mloopuv->flag*/
 118 #define MLOOPUV_EDGESEL 1
 119 #define MLOOPUV_VERTSEL 2
 120 #define MLOOPUV_PINNED  4
 121
 122 /* at the moment alpha is abused for vertex painting
 123  * and not used for transparency, note that red and blue are swapped */
 124 typedef struct MLoopCol {
 125         char r, g, b, a;
 126 } MLoopCol;
 127
 128 #define MESH_MLOOPCOL_FROM_MCOL(_mloopcol, _mcol) \
 129 {                                                 \
 130         MLoopCol   *mloopcol__tmp = _mloopcol;        \
 131         const MCol *mcol__tmp     = _mcol;            \
 132         mloopcol__tmp->r = mcol__tmp->b;              \
 133         mloopcol__tmp->g = mcol__tmp->g;              \
 134         mloopcol__tmp->b = mcol__tmp->r;              \
 135         mloopcol__tmp->a = mcol__tmp->a;              \
 136 } (void)0
 137
 138
 139 #define MESH_MLOOPCOL_TO_MCOL(_mloopcol, _mcol) \
 140 {                                               \
 141         const MLoopCol *mloopcol__tmp = _mloopcol;  \
 142         MCol           *mcol__tmp     = _mcol;      \
 143         mcol__tmp->b = mloopcol__tmp->r;            \
 144         mcol__tmp->g = mloopcol__tmp->g;            \
 145         mcol__tmp->r = mloopcol__tmp->b;            \
 146         mcol__tmp->a = mloopcol__tmp->a;            \
 147 } (void)0
 148
 149 typedef struct MSticky {
 150         float co[2];
 151 } MSticky;
 152
 153 typedef struct MSelect {
 154         int index;
 155         int type; /* EDITVERT/EDITEDGE/EDITFACE */
 156 } MSelect;
 157
 158 /*tessellation uv face data*/
 159 typedef struct MTFace {
 160         float uv[4][2];
 161         struct Image *tpage;
 162         char flag, transp;
 163         short mode, tile, unwrap;
 164 } MTFace;
 165
 166 /*Custom Data Properties*/
 167 typedef struct MFloatProperty {
 168         float   f;
 169 } MFloatProperty;
 170 typedef struct MIntProperty {
 171         int             i;
 172 } MIntProperty;
 173 typedef struct MStringProperty {
 174         char    s[256];
 175 } MStringProperty;
 176
 177 typedef struct OrigSpaceFace {
 178         float uv[4][2];
 179 } OrigSpaceFace;
 180
 181 typedef struct OrigSpaceLoop {
 182         float uv[2];
 183 } OrigSpaceLoop;
 184
 185 typedef struct MDisps {
 186         /* Strange bug in SDNA: if disps pointer comes first, it fails to see totdisp */
 187         int totdisp;
 188         int level;
 189         float (*disps)[3];
 190
 191         /* Used for hiding parts of a multires mesh. Essentially the multires
 192            equivalent of MVert.flag's ME_HIDE bit.
 193
 194            This is a bitmap, keep in sync with type used in BLI_bitmap.h */
 195         unsigned int *hidden;
 196 } MDisps;
 197
 198 /** Multires structs kept for compatibility with old files **/
 199 typedef struct MultiresCol {
 200         float a, r, g, b;
 201 } MultiresCol;
 202 typedef struct MultiresColFace {
 203         /* vertex colors */
 204         MultiresCol col[4];
 205 } MultiresColFace;
 206 typedef struct MultiresFace {
 207         unsigned int v[4];
 208         unsigned int mid;
 209         char flag, mat_nr, pad[2];
 210 } MultiresFace;
 211 typedef struct MultiresEdge {
 212         unsigned int v[2];
 213         unsigned int mid;
 214 } MultiresEdge;
 215
 216 struct MultiresMapNode;
 217 typedef struct MultiresLevel {
 218         struct MultiresLevel *next, *prev;
 219
 220         MultiresFace *faces;
 221         MultiresColFace *colfaces;
 222         MultiresEdge *edges;
 223
 224         unsigned int totvert, totface, totedge, pad;
 225
 226         /* Kept for compatibility with even older files */
 227         MVert *verts;
 228 } MultiresLevel;
 229
 230 typedef struct Multires {
 231         ListBase levels;
 232         MVert *verts;
 233
 234         unsigned char level_count, current, newlvl, edgelvl, pinlvl, renderlvl;
 235         unsigned char use_col, flag;
 236
 237         /* Special level 1 data that cannot be modified from other levels */
 238         CustomData vdata;
 239         CustomData fdata;
 240         short *edge_flags;
 241         char *edge_creases;
 242 } Multires;
 243
 244 /** End Multires **/
 245
 246 typedef struct MRecast {
 247         int             i;
 248 } MRecast;
 249
 250 typedef struct GridPaintMask {
 251         /* The data array contains gridsize*gridsize elements */
 252         float *data;
 253
 254         /* The maximum multires level associated with this grid */
 255         unsigned int level;
 256
 257         int pad;
 258 } GridPaintMask;
 259
 260 /* mvert->flag (1=SELECT) */
 261 #define ME_SPHERETEST           2
 262 #define ME_VERT_TMP_TAG         4
 263 #define ME_HIDE                         16
 264 #define ME_VERT_MERGED          (1<<6)
 265 #define ME_VERT_PBVH_UPDATE     (1<<7)
 266
 267 /* medge->flag (1=SELECT)*/
 268 #define ME_EDGEDRAW                     (1<<1)
 269 #define ME_SEAM                         (1<<2)
 270 #define ME_FGON                         (1<<3) /* no longer used (now we have ngons), only defined so we can clear it */
 271                                                 /* reserve 16 for ME_HIDE */
 272 #define ME_EDGERENDER           (1<<5)
 273 #define ME_LOOSEEDGE            (1<<7)
 274 /* #define ME_SEAM_LAST         (1<<8) */ /* UNUSED */
 275 #define ME_SHARP                        (1<<9)    /* only reason this flag remains a 'short' */
 276
 277 /* puno = vertexnormal (mface) */
 278 #define ME_PROJXY               16
 279 #define ME_PROJXZ               32
 280 #define ME_PROJYZ               64
 281
 282 /* edcode (mface) */
 283 #define ME_V1V2                 1
 284 #define ME_V2V3                 2
 285 #define ME_V3V1                 4
 286 #define ME_V3V4                 4
 287 #define ME_V4V1                 8
 288
 289 /* flag (mface) */
 290 #define ME_SMOOTH                       1
 291 #define ME_FACE_SEL                     2
 292 /* flag ME_HIDE==16 is used here too */
 293
 294 #define ME_POLY_LOOP_PREV(mloop, mp, i)  (&(mloop)[(mp)->loopstart + (((i) + (mp)->totloop - 1) % (mp)->totloop)])
 295 #define ME_POLY_LOOP_NEXT(mloop, mp, i)  (&(mloop)[(mp)->loopstart + (((i) + 1) % (mp)->totloop)])
 296
 297 /* mselect->type */
 298 #define ME_VSEL 0
 299 #define ME_ESEL 1
 300 #define ME_FSEL 2
 301
 302 /* mtface->flag */
 303 #define TF_SELECT       1 /* use MFace hide flag (after 2.43), should be able to reuse after 2.44 */
 304 #define TF_ACTIVE       2 /* deprecated! */
 305 #define TF_SEL1         4
 306 #define TF_SEL2         8
 307 #define TF_SEL3         16
 308 #define TF_SEL4         32
 309 #define TF_HIDE         64 /* unused, same as TF_SELECT */
 310
 311 /* mtface->mode */
 312 #define TF_DYNAMIC              1
 313 #define TF_ALPHASORT    2
 314 #define TF_TEX                  4
 315 #define TF_SHAREDVERT   8
 316 #define TF_LIGHT                16
 317
 318 #define TF_CONVERTED 32 /* tface converted to material */
 319
 320 #define TF_SHAREDCOL    64
 321 #define TF_TILES                128             /* deprecated */
 322 #define TF_BILLBOARD    256
 323 #define TF_TWOSIDE              512
 324 #define TF_INVISIBLE    1024
 325
 326 #define TF_OBCOL                2048
 327 #define TF_BILLBOARD2   4096    /* with Z axis constraint */
 328 #define TF_SHADOW               8192
 329 #define TF_BMFONT               16384
 330
 331 /* mtface->transp, values 1-4 are used as flags in the GL, WARNING, TF_SUB cant work with this */
 332 #define TF_SOLID        0
 333 #define TF_ADD          1
 334 #define TF_ALPHA        2
 335 #define TF_CLIP         4 /* clipmap alpha/binary alpha all or nothing! */
 336
 337 /* sub is not available in the user interface anymore */
 338 #define TF_SUB          3
 339
 340
 341 /* mtface->unwrap */
 342 #define TF_DEPRECATED1  1
 343 #define TF_DEPRECATED2  2
 344 #define TF_DEPRECATED3  4
 345 #define TF_DEPRECATED4  8
 346 #define TF_PIN1             16
 347 #define TF_PIN2             32
 348 #define TF_PIN3                 64
 349 #define TF_PIN4         128
 350
 351 #endif