DNA_meshdata_types.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef DNA_MESHDATA_TYPES_H
#define DNA_MESHDATA_TYPES_H

#include "DNA_customdata_types.h"
#include "DNA_listBase.h"

struct Bone;
struct Image;

typedef struct MFace {
    unsigned int v1, v2, v3, v4;
    short mat_nr;
    char edcode, flag;  /* we keep edcode, for conversion to edges draw flags in old files */
} MFace;

typedef struct MEdge {
    unsigned int v1, v2;
    char crease, bweight;
    short flag;
} MEdge;

typedef struct MDeformWeight {
    int             def_nr;
    float           weight;
} MDeformWeight;

typedef struct MDeformVert {
    struct MDeformWeight *dw;
    int totweight;
    int flag;   /* flag only in use for weightpaint now */
} MDeformVert;

typedef struct MVert {
    float   co[3];
    short   no[3];
    char flag, bweight;
} MVert;

/* at the moment alpha is abused for vertex painting
 * and not used for transperency, note that red and blue are swapped */
typedef struct MCol {
    char a, r, g, b;    
} MCol;

#ifdef USE_BMESH_FORWARD_COMPAT

/*new face structure, replaces MFace, which is now
  only used for storing tesselations.*/
typedef struct MPoly {
    /* offset into loop array and number of loops in the face */
    int loopstart;
    int totloop; /* keep signed since we need to subtract when getting the previous loop */
    short mat_nr;
    char flag, pad;
} MPoly;

/*the e here is because we want to move away from
  relying on edge hashes.*/
typedef struct MLoop {
    unsigned int v; /*vertex index*/
    unsigned int e; /*edge index*/
} MLoop;

#endif /* USE_BMESH_FORWARD_COMPAT */

/*bmesh custom data stuff*/
typedef struct MTexPoly {
    struct Image *tpage;
    char flag, transp;
    short mode,tile,unwrap;
} MTexPoly;

typedef struct MLoopUV {
    float uv[2];
} MLoopUV;

typedef struct MLoopCol {
    char a, r, g, b;
} MLoopCol;

typedef struct MSticky {
    float co[2];
} MSticky;

typedef struct MSelect {
    int index;
    int type; /* EDITVERT/EDITEDGE/EDITFACE */
} MSelect;

typedef struct MTFace {
    float uv[4][2];
    struct Image *tpage;
    char flag, transp;
    short mode, tile, unwrap;
} MTFace;

/*Custom Data Properties*/
typedef struct MFloatProperty {
    float   f;
} MFloatProperty;
typedef struct MIntProperty {
    int     i;
} MIntProperty;
typedef struct MStringProperty {
    char    s[256];
} MStringProperty;

typedef struct OrigSpaceFace {
    float uv[4][2];
} OrigSpaceFace;

typedef struct MDisps {
    /* Strange bug in SDNA: if disps pointer comes first, it fails to see totdisp */
    int totdisp;
    char pad[4];
    float (*disps)[3];
} MDisps;

typedef struct MultiresCol {
    float a, r, g, b;
} MultiresCol;
typedef struct MultiresColFace {
    /* vertex colors */
    MultiresCol col[4];
} MultiresColFace;
typedef struct MultiresFace {
    unsigned int v[4];
    unsigned int mid;
    char flag, mat_nr, pad[2];
} MultiresFace;
typedef struct MultiresEdge {
    unsigned int v[2];
    unsigned int mid;
} MultiresEdge;

struct MultiresMapNode;
typedef struct MultiresLevel {
    struct MultiresLevel *next, *prev;

    MultiresFace *faces;
    MultiresColFace *colfaces;
    MultiresEdge *edges;

    unsigned int totvert, totface, totedge, pad;

    /* Kept for compatibility with even older files */
    MVert *verts;
} MultiresLevel;

typedef struct Multires {
    ListBase levels;
    MVert *verts;

    unsigned char level_count, current, newlvl, edgelvl, pinlvl, renderlvl;
    unsigned char use_col, flag;

    /* Special level 1 data that cannot be modified from other levels */
    CustomData vdata;
    CustomData fdata;
    short *edge_flags;
    char *edge_creases;
} Multires;

typedef struct MRecast {
    int     i;
} MRecast;

/* mvert->flag (1=SELECT) */
#define ME_SPHERETEST       2
#define ME_VERT_TMP_TAG     4
#define ME_HIDE             16
#define ME_VERT_MERGED      (1<<6)
#define ME_VERT_PBVH_UPDATE (1<<7)

/* medge->flag (1=SELECT)*/
#define ME_EDGEDRAW         (1<<1)
#define ME_SEAM             (1<<2)
#define ME_FGON             (1<<3)
                        /* reserve 16 for ME_HIDE */
#define ME_EDGERENDER       (1<<5)
#define ME_LOOSEEDGE        (1<<7)
/* #define ME_SEAM_LAST     (1<<8) */ /* UNUSED */
#define ME_SHARP            (1<<9)    /* only reason this flag remains a 'short' */

/* puno = vertexnormal (mface) */
#define ME_PROJXY       16
#define ME_PROJXZ       32
#define ME_PROJYZ       64

/* edcode (mface) */
#define ME_V1V2         1
#define ME_V2V3         2
#define ME_V3V1         4
#define ME_V3V4         4
#define ME_V4V1         8

/* flag (mface) */
#define ME_SMOOTH           1
#define ME_FACE_SEL         2
                        /* flag ME_HIDE==16 is used here too */ 
/* mtface->flag */
#define TF_SELECT   1 /* use MFace hide flag (after 2.43), should be able to reuse after 2.44 */
#define TF_ACTIVE   2 /* deprecated! */
#define TF_SEL1     4
#define TF_SEL2     8
#define TF_SEL3     16
#define TF_SEL4     32
#define TF_HIDE     64 /* unused, same as TF_SELECT */

/* mtface->mode */
#define TF_DYNAMIC      1
#define TF_ALPHASORT    2
#define TF_TEX          4
#define TF_SHAREDVERT   8
#define TF_LIGHT        16

#define TF_CONVERTED 32 /* tface converted to material */

#define TF_SHAREDCOL    64
#define TF_TILES        128     /* deprecated */
#define TF_BILLBOARD    256
#define TF_TWOSIDE      512
#define TF_INVISIBLE    1024

#define TF_OBCOL        2048
#define TF_BILLBOARD2   4096    /* with Z axis constraint */
#define TF_SHADOW       8192
#define TF_BMFONT       16384

/* mtface->transp, values 1-4 are used as flags in the GL, WARNING, TF_SUB cant work with this */
#define TF_SOLID    0
#define TF_ADD      1
#define TF_ALPHA    2
#define TF_CLIP     4 /* clipmap alpha/binary alpha all or nothing! */

/* sub is not available in the user interface anymore */
#define TF_SUB      3


/* mtface->unwrap */
#define TF_DEPRECATED1  1
#define TF_DEPRECATED2  2
#define TF_DEPRECATED3  4
#define TF_DEPRECATED4  8
#define TF_PIN1         16
#define TF_PIN2         32
#define TF_PIN3         64
#define TF_PIN4         128

#endif