BLI_editVert.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 BLI_EDITVERT_H
#define BLI_EDITVERT_H

#include "DNA_customdata_types.h"
#include "DNA_mesh_types.h"

#include "BLO_sys_types.h" // for intptr_t support

struct DerivedMesh;

/* note; changing this also might affect the undo copy in editmesh.c */
typedef struct EditVert
{
    struct EditVert *next, *prev;
    union {
        /* some lean storage for temporary usage 
         * in editmesh routines
         */
        struct EditVert *v;
        struct EditEdge *e;
        struct EditFace *f;
        void            *p;
        intptr_t         l;
        float            fp;
        int              t;
    } tmp;
    float no[3]; /*vertex normal */
    float co[3]; /*vertex location */
    short xs, ys; /* used to store a screenspace 2d projection of the verts */
    
    /* f stores selection eg. if (eve->f & SELECT) {...
    h for hidden. if (!eve->h) {...
    f1 and f2 can be used for temp data, clear them first*/
    unsigned char f, h, f1, f2; 
    float bweight;
    short fast; /* only 0 or 1, for editmesh_fastmalloc, do not store temp data here! */
    int hash;     /* internal editmesh.c use only, don't touch! */
    int keyindex; /* original index #, for restoring  key information */

    void *data;     /* custom vertex data */
} EditVert;

struct EditEdge;

typedef struct HashEdge {
    struct EditEdge *eed;
    struct HashEdge *next;
} HashEdge;

/* note; changing this also might affect the undo copy in editmesh.c */
typedef struct EditEdge
{
    struct EditEdge *next, *prev;
    struct EditVert *v1, *v2;
    union {
        /* some lean storage for temporary usage 
         * in editmesh routines
         */
        struct EditVert *v;
        struct EditEdge *e;
        struct EditFace *f;
        void            *p;
        intptr_t         l;
        float           fp;
    } tmp;
    short f1, f2;   /* short, f1 is (ab)used in subdiv */
    unsigned char f, h, dir, seam, sharp;
    float crease;
    float bweight;
    short fast;         /* only 0 or 1, for editmesh_fastmalloc */
    short fgoni;        /* index for fgon, for search */
    HashEdge hash;
    void *data;         /*custom edge data*/
} EditEdge;

/* note; changing this also might affect the undo copy in editmesh.c */
typedef struct EditFace
{
    struct EditFace *next, *prev;
    struct EditVert *v1, *v2, *v3, *v4;
    struct EditEdge *e1, *e2, *e3, *e4;
    union {
        /* some lean storage for temporary usage 
         * in editmesh routines
         */
        struct EditVert *v;
        struct EditEdge *e;
        struct EditFace *f;
        void            *p;
        intptr_t         l;
        float           fp;
    } tmp;
    float n[3], cent[3];
    unsigned char flag;
    unsigned char f, f1, h;
    unsigned char fast;         /* only 0 or 1, for editmesh_fastmalloc */
    unsigned char fgonf;        /* flag for fgon options */
    short mat_nr;
    void *data;     /* custom face data */
} EditFace;


/*selection types*/
#define EDITVERT 0
#define EDITEDGE 1
#define EDITFACE 2

typedef struct EditSelection
{
    struct EditSelection *next, *prev;
    short type;
    void *data;
} EditSelection;


typedef struct EditMesh
{
    ListBase verts, edges, faces;
    ListBase selected; /*EditSelections. Used to store the order in which things are selected.*/
    HashEdge *hashedgetab;
    
    /* this is for the editmesh_fastmalloc */
    EditVert *allverts, *curvert;
    EditEdge *alledges, *curedge;
    EditFace *allfaces, *curface;
        /* DerivedMesh caches... note that derived cage can be equivalent
         * to derived final, care should be taken on release.
         */
    
    /* used for keeping track of the last clicked on face - so the space image
     * when using the last selected face - (EditSelection) the space image flickered too much
     * 
     * never access this directly, use EM_set_actFace and EM_get_actFace */
    EditFace *act_face; 
    
    /* copy from scene */
    short selectmode;
    /* copy from object actcol */
    short mat_nr;
    /* stats */
    int totvert, totedge, totface, totvertsel, totedgesel, totfacesel;
    /* shape key being edited */
    int shapenr;
    
    struct DerivedMesh *derivedCage, *derivedFinal;
    /* the custom data layer mask that was last used to calculate
     * derivedCage and derivedFinal
     */
    int lastDataMask;

    CustomData vdata, edata, fdata;

} EditMesh;

#endif