DetourTileCacheBuilder.h

Go to the documentation of this file.

//
// Copyright (c) 2009-2010 Mikko Mononen memon@inside.org
//
// This software is provided 'as-is', without any express or implied
// warranty.  In no event will the authors be held liable for any damages
// arising from the use of this software.
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would be
//    appreciated but is not required.
// 2. Altered source versions must be plainly marked as such, and must not be
//    misrepresented as being the original software.
// 3. This notice may not be removed or altered from any source distribution.
//

#ifndef DETOURTILECACHEBUILDER_H
#define DETOURTILECACHEBUILDER_H

#include "SharedConfig.h"
#include "DetourAlloc.h"
#include "DetourStatus.h"

static const int DT_TILECACHE_MAGIC = 'D'<<24 | 'T'<<16 | 'L'<<8 | 'R'; 
static const int DT_TILECACHE_VERSION = 1;

static const unsigned char DT_TILECACHE_NULL_AREA = 0;
static const unsigned char DT_TILECACHE_WALKABLE_AREA = 63;
static const unsigned short DT_TILECACHE_NULL_IDX = 0xffff;

struct dtTileCacheLayerHeader
{
    int magic;                              
    int version;                            
    int tx,ty,tlayer;
    float bmin[3], bmax[3];
    unsigned short hmin, hmax;              
    unsigned char width, height;            
    unsigned char minx, maxx, miny, maxy;   
};

struct dtTileCacheLayer
{
    dtTileCacheLayerHeader* header;
    unsigned char regCount;                 
    unsigned char* heights;
    unsigned char* areas;
    unsigned char* cons;
    unsigned char* regs;
};

struct dtTileCacheContour
{
    int nverts;
    unsigned char* verts;
    unsigned char reg;
    unsigned char area;
};

struct dtTileCacheContourSet
{
    int nconts;
    dtTileCacheContour* conts;
};

struct dtTileCachePolyMesh
{
    int nvp;
    int nverts;             
    int npolys;             
    unsigned short* verts;  
    unsigned short* polys;  
    navAreaMask* areaMasks; 
};


struct dtTileCacheAlloc
{
    virtual ~dtTileCacheAlloc() { }

    virtual void reset()
    {
    }
    
    virtual void* alloc(const int size)
    {
        return dtAlloc(size, DT_ALLOC_TEMP);
    }
    
    virtual void free(void* ptr)
    {
        dtFree(ptr);
    }
};

struct dtTileCacheCompressor
{
    virtual ~dtTileCacheCompressor() { }

    virtual int maxCompressedSize(const int bufferSize) = 0;
    virtual dtStatus compress(const unsigned char* buffer, const int bufferSize,
                              unsigned char* compressed, const int maxCompressedSize, int* compressedSize) = 0;
    virtual dtStatus decompress(const unsigned char* compressed, const int compressedSize,
                                unsigned char* buffer, const int maxBufferSize, int* bufferSize) = 0;
};


dtStatus dtBuildTileCacheLayer(dtTileCacheCompressor* comp,
                               dtTileCacheLayerHeader* header,
                               const unsigned char* heights,
                               const navAreaMask* areaMasks,
                               const unsigned char* cons,
                               unsigned char** outData, int* outDataSize);

void dtFreeTileCacheLayer(dtTileCacheAlloc* alloc, dtTileCacheLayer* layer);

dtStatus dtDecompressTileCacheLayer(dtTileCacheAlloc* alloc, dtTileCacheCompressor* comp,
                                    unsigned char* compressed, const int compressedSize,
                                    dtTileCacheLayer** layerOut);

dtTileCacheContourSet* dtAllocTileCacheContourSet(dtTileCacheAlloc* alloc);
void dtFreeTileCacheContourSet(dtTileCacheAlloc* alloc, dtTileCacheContourSet* cset);

dtTileCachePolyMesh* dtAllocTileCachePolyMesh(dtTileCacheAlloc* alloc);
void dtFreeTileCachePolyMesh(dtTileCacheAlloc* alloc, dtTileCachePolyMesh* lmesh);

dtStatus dtMarkCylinderArea(dtTileCacheLayer& layer, const float* orig, const float cs, const float ch,
                            const float* pos, const float radius, const float height, const unsigned char areaId);

dtStatus dtBuildTileCacheRegions(dtTileCacheAlloc* alloc,
                                 dtTileCacheLayer& layer,
                                 const int walkableClimb);

dtStatus dtBuildTileCacheContours(dtTileCacheAlloc* alloc,
                                  dtTileCacheLayer& layer,
                                  const int walkableClimb,  const float maxError,
                                  dtTileCacheContourSet& lcset);

dtStatus dtBuildTileCachePolyMesh(dtTileCacheAlloc* alloc,
                                  dtTileCacheContourSet& lcset,
                                  dtTileCachePolyMesh& mesh);

bool dtTileCacheHeaderSwapEndian(unsigned char* data, const int dataSize);


#endif // DETOURTILECACHEBUILDER_H