VedaLib3DEngine/lwo2reader.h

Go to the documentation of this file.

/*! \file 
    \author victorien ferry
    \brief This file applies the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1 , read file COPYING.
        independant lightwave object file format reader.    
                by krb (vic ferry), 02/11/2006, based on previous works.
                features:
                    - read LWOB and LWO2 versions.
                    - apply the right VMAP/VMAD vertex info for uv texture and rgb, for each polygon (LWO2).
                    - manage creation of new vertexes for discontinuous mapping, the best way
                     (no extra creation of vertex for a same discontinuity).
                    - can give a triangle list with polygons sorted by surface, for GL rendering...
                restrictions:
                    - all object polygons must be convex. n-gons with n>3 supported.
                    - patch spline surface unsuported ATM.
*/
#ifndef LWO2READER_H_
#define LWO2READER_H_
#ifdef __cplusplus
extern "C" {
#endif
/*!
    \brief  you must provide this allocator:
*/
extern void *lw_CleanAlloc( unsigned int _bytesize );
/*!
    \brief  you must provide this desallocator:
*/
extern void lw_FreeAlloc( void  *_pAllocToClose );

/*!
    \enum   lwo2_error 
    \brief  init error enum returned by ReadLwo()
*/
typedef enum
{
    lwoerr_Ok=0,
    lwoerr_AllocFailed,
    lwoerr_FileProblem
} lwo2_error;

typedef struct _LwoObject sLwoObject;
typedef struct _LwoLayer sLwoLayer;

    //! flag bits for ReadLwo(). Affect the way the objects are read.
    typedef enum
    {
        //! if present, the per-poly discontiuous texture coords are set back on new vertexes. This is needed if your engine only use vertex texture coord,( like usual hardware renderers.)
        ReadLwoFlag_DiscontinuousUVToNewVertex=1,
        //! Sort polygons by texture used in the polygon list.
        ReadLwoFlag_SortTriangleBySurfaces=2
    } ReadLwoFlag;

    /*!
        \brief  Read a File, open all layer shapes in tables. CloseLwo() must be called
                at destruction and will close all allocs.
                You can specify ReadLwoFlag_... flags if you need a special
                feature according to your engine, it will not open the same tables
                in each cases. Then if lwoerr_Ok is returned, 
                you can use LwoGetLayer() to get an object shape. 
                You can then copy all informations before CloseLwo().
                consider all informations as const.
        \param  _pLwoObject reference to a sLwoObject to init, to handle the file.
        \param  _pLwoFileChunk  pointer to the whole file chunk.
        \param  _lwoFileByteLength the length of _pLwoFileChunk in bytes.
        \param  _flags  look ReadLwoFlag enum up there. 
        \return lwoerr_Ok if no problem. else a lwo2_error enum.
    */
    lwo2_error  ReadLwo(sLwoObject *_pLwoObject, const unsigned char *_pLwoFileChunk, unsigned int _lwoFileByteLength, const unsigned int _flags );
    /*!
        \brief  Close all allocs from ReadLwo().
        \param  _pLwoObject reference to an object that manage the LWO.
    */
    void    CloseLwo(sLwoObject *_pLwoObject);

    /*!
        \brief  Get a layer shape from a struct inited with ReadLwo().
                Each .lwo files can contains one or more layer shapes.
                _layerIndex corrsponds to the layer index in the interface,
                and is zero-based.
                Then you can use 
        \param  _pLwoObject pointer to struct computed with ReadLwo().
        \param _layerIndex index of the layer in the file.
        \return a sLwoLayer layer shape description.
    */
    const sLwoLayer *LwoGetLayer(const sLwoObject *_pLwoObject, const unsigned int _layerIndex);



//! from LW envelope.h

#define SHAPE_TCB   0
#define SHAPE_HERM  1
#define SHAPE_BEZI  2
#define SHAPE_LINE  3
#define SHAPE_STEP  4
#define SHAPE_BEZ2  5

#define BEH_RESET      0
#define BEH_CONSTANT   1
#define BEH_REPEAT     2
#define BEH_OSCILLATE  3
#define BEH_OFFSET     4
#define BEH_LINEAR     5

typedef struct st_Key {
   struct st_Key *next;
   struct st_Key *prev;
   float  value;
   float  time;
   int    shape;
   float  tension;
   float  continuity;
   float  bias;
   float  param[ 4 ];
} Key;

typedef struct st_Envelope {
   Key   *key;
   int    nkeys;
   int    behavior[ 2 ];
} Envelope;

float evalEnvelope( Envelope *env, float time );

/*---------------------------------- LWOB-LWO2 structs  ---------------*/
struct  LwoMatrix{

    float   T1X;    /* pivot point (unused ?) */
    float   T1Y;
    float   T1Z;
};
/*!
    \struct sLwoVertex
    \brief Manages a Vertex read from a lwo file.
            as a position vector, a computed normal vector,
            Texture UV coordinates, etc
*/
typedef struct _LwoVertex{
    //! Vertex position vector
    float   XI,YI,ZI;
    //! vertex color (0.0f,1.0f)
    float   r,g,b;
    //! vertex computed normal vector
    float   XNI,YNI,ZNI;
    //! vertex UV texture coordinates.
    float   U,V;
    //! private use: trace VMAD discontinuity
    struct  _LwoPolyToVertex     *FirstDiscontinuousUse;
} sLwoVertex ;
/*!
    \struct sLwoPolyToVertex
    \brief Describes the reference of a polygon point to a given vertex
            in the vertex base. Informations can be discontinuous to the vertex,
            in which case they are here, or on the vertex, in which case they are in sLwoVertex.
*/
typedef struct _LwoPolyToVertex{
    //! zero-based Vertex index in the layer vertex list.
    int     m_VertexIndex;
    //! Discontinuous UV texture coordinates, relative to the polygon, values in [0,1] on image
    float   tU;   
    //! Discontinuous UV texture coordinates, relative to the polygon. values in [0,1] on image
    float   tV;
    //! private use: 0 if normal ,used if >0, val -1 please
    int     DiscontinuousMappingOffset;
    //! private use.
    struct  _LwoPolyToVertex     *NextDiscontinuousUse;
} sLwoPolyToVertex;
/*!
    \struct sLwoPolygon
    \brief  Describes a raw polygon as a N-gon, uner the form
            of a vertex reference list.
            that describe a convex polygon.
*/
typedef struct  _LwoPolygon{
    //! number of vertex reference.
    unsigned int m_NumberOfVertex;
    //! reference table with length=m_NumberOfVertex
    sLwoPolyToVertex *m_VertexList;
    //! computed face normal vector:
    float   XN,YN,ZN;
    //! texture surface used for this polygo.
    struct  LwTexture *surface;
} sLwoPolygon;
/*----------------------------------------*/
struct  LwoTriangle{
    //float   XN,YN,ZN;   /* face normal */
    // first vertex index
    unsigned int    v0;
    // vertex index
    unsigned int    v1;
    // vertex index
    unsigned int    v2;
};
/*
    \struct sLwoSortedTriangleSurface
    \brief  Define a triangle set for a layer and a texture,
            in the layer. Used if ReadLwoFlag_SortTriangleBySurfaces
            was set.
*/
typedef struct  _LwoSortedTriangleSurface {
    //! corresponding index in sLwoObject 's surface table.
    unsigned int    m_LwoFileSurfaceIndex;
    //! First 0-based triangle index in the layer triangle list.
    unsigned int    m_FirstTriangleIndex;
    //! number of triangle for this texture/layer set after m_FirstTriangleIndex.
    unsigned int    m_NumberOfTriangle;
} sLwoSortedTriangleSurface;
/*----------------------------------------*/
struct  LwoMorphVertex{
        float   X,Y,Z;
};

struct MorphSet{
    struct MorphSet         *next;
    char                    name[88];
    struct  LwoMorphVertex  *vertex;
    int                     morf0spot1;
};
/*!
    \struct sLwoLayer
    \brief Describes an Object Layer, which means a given shape in the file.
            Then the geometry is described under it.
*/
struct  _LwoLayer{
    //! file which manage this struct, private use.
    struct  _LwoObject  *m_LWOFile;
    //! index layer in LW's interface.
    int     m_LayerNumber;
    //! vertex table, used by m_LWO_Polygon and LWO_triangle lists. 
    sLwoVertex      *m_LWO_Vertex;
    //! number of vertex in table m_LWO_Vertex. polygons will index from 0 to m_NumberOfVertex-1.
    unsigned int    m_NumberOfVertex;
    //! the n-gon polygon tables, unsplitted and maybe not convex.
    sLwoPolygon *m_LWO_Polygon;
    //! Number of polygons in m_LWO_Polygon.
    unsigned int    m_MaxNbPolygon;
    //! this layer has a color-per-vertex map. (TODO)
    unsigned int    m_ColorFlag;
    // * these indented members are valid if ReadLwoFlag_SortTriangleBySurfaces was inited: *
        //! total number of triangle in m_LWO_Triangle, may be greater than m_MaxNbPolygon.
        int     m_MaxNbTriangle;
        //! triangle version of m_LWO_Polygon. active if ReadLwoFlag_SortTriangleBySurfaces.
        struct  LwoTriangle    *m_LWO_Triangle;
        //! number of surfaces (different rendering types)  used in m_LWO_Triangle, and length of m_pSurfaceSortedTriangleListIndex.
        unsigned int    m_NumberOfSurfaceUsed;
        //! point which surface use which part of the triangle list. Watch out, it is not the surface order surface are pointed by m_LwoFileSurfaceIndex.
        sLwoSortedTriangleSurface   *m_pSurfaceSortedTriangleListIndex;
    //! private use, algorythm to create discontinuous vertexes.(ReadLwoFlag_DiscontinuousUVToNewVertex)
    int     m_NumberOfDiscontinousVertexToAdd;
    //! object pivot matrix, not a pointer.
    struct LwoMatrix m_InitialObjectPos; 
    //! the * 16b flags, direct from lwo
    int     flags;    
    //! facultative parent layer (lwo)
    int     parent;  
    //! cube coordinates where the object is bound:
    float       m_boundMin[3]; 
    //! cube coordinates where the object is bound:
    float       m_boundMax[3]; 
    //! layer name
    char        *name;
    //! Number of element in m_MorphTable
    unsigned int m_NumberofMorph;
    //! Morph table
    struct MorphSet *m_MorphTable;
    //! facultative.exist if at least 1 morphset "morf" 
    struct  LwoMorphVertex  *baseMorph;
    //! hash to resolve mapping layer
    struct RememberVMAPChunk    *m_pFirstVMAP;
    //! hash to resolve mapping layer
    struct RememberVMAPChunk    *m_pFirstVMAD;

};
/*-----------------------------------*/
// for LwTexture.typebits
// for LwTexture.typebits
typedef enum
{
    TBit_MIPMap=1,
    TBit_ClampWidth=2,
    TBit_ClampHeight=4,
    TBit_NoSmooth=8,
    //TBit_Environment=16, now given by reflectimage.
} e_typebits;
    /*----- texture object -------*/
struct  LwTexture{
    unsigned int    IndexInFile;
    float            RGBAcolor[4];
    char            *name;       //used to bluit it.
    char            *txuv_used; // valid VMAP/VMAD name for this texture layer
    char            *mapimage;      // NULL if no image, or clip name.
    char            *reflectimage;  // NULL if no image, or clip name.
    char            *bumpimage; // NULL if no image, or clip name.
    int             typebits; //what type of rendering ? enum e_typebits.
    float             additiveRate; //if additive layer.
    float            transparencyRate;
//re    struct  LwsMatrixValue  transparency;
};
/*-----------------------------------*/
struct  LwoClip{
    int                 LWClipindex;
    //struct  LwoClip     *nextInStaticChain; // we
    char                *imagename;

};
/*-----------------------------------*/
struct  LwoIndexedEnvelope{
    struct KTable *lwEnvlope;
    int         index;
};


/*!
    \struct sLwoObject
    \brief  Describe the whole lwo file To be used with ReadLwo()
*/
struct _LwoObject 
{
    //! Number of layers in m_LWO_Layer
    unsigned int m_NumberOfLayers;
    //! table of layers. Beware, layers index are m_LWO_Layer->m_LayerNumber, use LwoGetLayer() to get it.
    sLwoLayer    *m_LWO_Layer;
    //! number of surfaces (rendering types) in the whole file, common to all layers:
    struct LwTexture   *m_pSurfaces;
    unsigned int         nbsurf;
    struct LwoIndexedEnvelope   *envlp;
    unsigned int         nbenvlp;
    unsigned int        nbclip;
//    int        *clipindextable; // used to link clipimages to textures.
    struct LwoClip *clipimagetable;

    //! if !=0, this is a LWO2 file, else a LWOB.
    int     LWO2_true;
    //! private use, link to binary while reading
    const unsigned char *m_pMainChunk;
    //! private use, main binary size
    unsigned int         m_mainsize;

} ;
/*----------------------------------*/

#ifdef __cplusplus
};
#endif
#endif

---

      /\/\        4         N         k         !         N         D
                      _______  _ __ ___  _____            ___ _ _  ____
     ___________  __//___   /________  |/    / ___________\_______/    \
    /   _   _   \/   _     /    _   /      _/_/____/    _       __     /
   /    /   /       /     /    /    \      \/     /    /    \   \     /
  \\___/___/___/    ¯    _____/_____/       ______\___/_____/\________\\
               \________/_ ___ __ l____\      /elD!  
                 http://www.m4nkind.com \____/