DNA_mesh_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_MESH_TYPES_H
#define DNA_MESH_TYPES_H

#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_ID.h"
#include "DNA_customdata_types.h"

#include "DNA_defs.h" /* USE_BMESH_FORWARD_COMPAT */

struct DerivedMesh;
struct Ipo;
struct Key;
struct Material;
struct MVert;
struct MEdge;
struct MFace;
struct MCol;
struct MSticky;
struct Mesh;
struct OcInfo;
struct MPoly;
struct MTexPoly;
struct MLoop;
struct MLoopUV;
struct MLoopCol;
struct Multires;
struct EditMesh;
struct AnimData;

typedef struct Mesh {
    ID id;
    struct AnimData *adt;       /* animation data (must be immediately after id for utilities to use it) */

    struct BoundBox *bb;
    
    struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
    struct Key *key;
    struct Material **mat;

/*#ifdef USE_BMESH_FORWARD_COMPAT*/ /* XXX - ifdefs dont work here! */
/* BMESH ONLY */
    /*new face structures*/
    struct MPoly *mpoly;
    struct MTexPoly *mtpoly;
    struct MLoop *mloop;
    struct MLoopUV *mloopuv;
    struct MLoopCol *mloopcol;
/* END BMESH ONLY */
/*#endif*/

    struct MFace *mface;    /* array of mesh object mode faces */
    struct MTFace *mtface;  /* store face UV's and texture here */
    struct TFace *tface;    /* depecrated, use mtface */
    struct MVert *mvert;    /* array of verts */
    struct MEdge *medge;    /* array of edges */
    struct MDeformVert *dvert;  /* deformgroup vertices */
    struct MCol *mcol;      /* array of colors, this must be the number of faces * 4 */
    struct MSticky *msticky;
    struct Mesh *texcomesh;
    struct MSelect *mselect;
    
    struct EditMesh *edit_mesh; /* not saved in file! */

    struct CustomData vdata, edata, fdata;

/*#ifdef USE_BMESH_FORWARD_COMPAT*/ /* XXX - ifdefs dont work here! */
/* BMESH ONLY */
    struct CustomData pdata, ldata;
/* END BMESH ONLY */
/*#endif*/

    int totvert, totedge, totface, totselect;

/*#ifdef USE_BMESH_FORWARD_COMPAT*/
/* BMESH ONLY */
    int totpoly, totloop;
/* END BMESH ONLY */
/*#endif*/ /* XXX - ifdefs dont work here! */

    /* the last selected vertex/edge/face are used for the active face however
     * this means the active face must always be selected, this is to keep track
     * of the last selected face and is similar to the old active face flag where
     * the face does not need to be selected, -1 is inactive */
    int act_face; 

    /* texture space, copied as one block in editobject.c */
    float loc[3];
    float size[3];
    float rot[3];

    short texflag, drawflag;
    short smoothresh, flag;

    short subdiv  DNA_DEPRECATED, subdivr  DNA_DEPRECATED;
    char subsurftype  DNA_DEPRECATED; /* only kept for backwards compat, not used anymore */
    char editflag;

    short totcol;

    struct Multires *mr DNA_DEPRECATED; /* deprecated multiresolution modeling data, only keep for loading old files */
} Mesh;

/* deprecated by MTFace, only here for file reading */
typedef struct TFace {
    void *tpage;    /* the faces image for the active UVLayer */
    float uv[4][2];
    unsigned int col[4];
    char flag, transp;
    short mode, tile, unwrap;
} TFace;

/* **************** MESH ********************* */

/* texflag */
#define AUTOSPACE   1

/* me->editflag */
#define ME_EDIT_MIRROR_X (1 << 0)
#define ME_EDIT_MIRROR_Y (1 << 1) // unused so far
#define ME_EDIT_MIRROR_Z (1 << 2) // unused so far

#define ME_EDIT_PAINT_MASK (1 << 3)
#define ME_EDIT_MIRROR_TOPO (1 << 4)
#define ME_EDIT_VERT_SEL (1 << 5)

/* we cant have both flags enabled at once,
 * flags defined in DNA_scene_types.h */
#define ME_EDIT_PAINT_SEL_MODE(_me)  (                                        \
    (_me->editflag & ME_EDIT_PAINT_MASK) ? SCE_SELECT_FACE :                  \
        (_me->editflag & ME_EDIT_VERT_SEL) ? SCE_SELECT_VERTEX :              \
            0                                                                 \
    )

/* me->flag */
/* #define ME_ISDONE        1 */
#define ME_DEPRECATED   2
#define ME_TWOSIDED     4
#define ME_UVEFFECT     8
#define ME_VCOLEFFECT   16
#define ME_AUTOSMOOTH   32
#define ME_SMESH        64
#define ME_SUBSURF      128
#define ME_OPT_EDGES    256
#define ME_DS_EXPAND    512

/* me->drawflag, short */
#define ME_DRAWEDGES    (1 << 0)
#define ME_DRAWFACES    (1 << 1)
#define ME_DRAWNORMALS  (1 << 2)
#define ME_DRAW_VNORMALS (1 << 3)

#define ME_ALLEDGES     (1 << 4)
#define ME_HIDDENEDGES  (1 << 5)

#define ME_DRAWCREASES  (1 << 6)
#define ME_DRAWSEAMS    (1 << 7)
#define ME_DRAWSHARP    (1 << 8)
#define ME_DRAWBWEIGHTS (1 << 9)

#define ME_DRAWEXTRA_EDGELEN  (1 << 10)
#define ME_DRAWEXTRA_FACEAREA (1 << 11)
#define ME_DRAWEXTRA_FACEANG  (1 << 12)

/* debug only option */
#define ME_DRAWEXTRA_INDICES (1 << 13)

/* old global flags:
#define G_DRAWEDGES     (1 << 18)
#define G_DRAWFACES     (1 <<  7)
#define G_DRAWNORMALS   (1 <<  6)
#define G_DRAW_VNORMALS (1 << 14)

#define G_ALLEDGES      (1 << 11)
#define G_HIDDENEDGES   (1 << 21)

#define G_DRAWCREASES   (1 << 19)
#define G_DRAWSEAMS     (1 << 20)
#define G_DRAWSHARP     (1 << 28)
#define G_DRAWBWEIGHTS  (1 << 31)

#define G_DRAW_EDGELEN  (1 << 22) 
#define G_DRAW_FACEAREA (1 << 23)
#define G_DRAW_EDGEANG  (1 << 24)
*/



/* Subsurf Type */
#define ME_CC_SUBSURF       0
#define ME_SIMPLE_SUBSURF   1

#define MESH_MAX_VERTS 2000000000L

/* this is so we can save bmesh files that load in trunk, ignoring NGons
 * will eventually be removed */

#if 0 /* enable in bmesh branch only for now */
#define USE_BMESH_SAVE_AS_COMPAT
#endif


#endif