PxCooking.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.


#ifndef PX_COOKING_H
#define PX_COOKING_H

#include "common/PxPhysXCommonConfig.h"
#include "common/PxTolerancesScale.h"
#include "cooking/Pxc.h"

#include "cooking/PxConvexMeshDesc.h"
#include "cooking/PxTriangleMeshDesc.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxOutputStream;
class PxBinaryConverter;
class PxPhysicsInsertionCallback;

struct PxPlatform
{
    enum Enum
    {
        ePC,
        eXENON,
        ePLAYSTATION3,
        eARM,
        eWIIU
    };
};

struct PxConvexMeshCookingResult
{
    enum Enum
    {
        eSUCCESS,

        eZERO_AREA_TEST_FAILED,

        eFAILURE
    };
};

struct PxMeshPreprocessingFlag
{
    enum Enum
    {
        eWELD_VERTICES                  =   1 << 0, 

        PX_DEPRECATED   eREMOVE_UNREFERENCED_VERTICES   =   1 << 1,

        PX_DEPRECATED   eREMOVE_DUPLICATED_TRIANGLES    =   1 << 2,

        eDISABLE_CLEAN_MESH                             =   1 << 3, 

        eDISABLE_ACTIVE_EDGES_PRECOMPUTE                =   1 << 4,

        eFORCE_32BIT_INDICES                            =   1 << 5
    };
};

typedef PxFlags<PxMeshPreprocessingFlag::Enum,PxU32> PxMeshPreprocessingFlags;

struct PxMeshCookingHint
{
    enum Enum
    {
        eSIM_PERFORMANCE = 0,       
        eCOOKING_PERFORMANCE = 1    
    };
};

struct PxCookingParams
{
    PxPlatform::Enum    targetPlatform;

    float       skinWidth;

    float       areaTestEpsilon;

    bool        suppressTriangleMeshRemapTable;

    bool        buildTriangleAdjacencies;

    PxTolerancesScale scale;

    PxMeshPreprocessingFlags    meshPreprocessParams;

    PxMeshCookingHint::Enum         meshCookingHint;

    PxReal      meshWeldTolerance;

    PxF32 meshSizePerformanceTradeOff;

    PxCookingParams(const PxTolerancesScale& sc):
        skinWidth(0.025f*sc.length),
        areaTestEpsilon(0.06f*sc.length*sc.length),
        suppressTriangleMeshRemapTable(false),
        buildTriangleAdjacencies(false),
        scale(sc),
        meshPreprocessParams(0),
        meshCookingHint(PxMeshCookingHint::eSIM_PERFORMANCE),
        meshWeldTolerance(0.f),
        meshSizePerformanceTradeOff(0.55f)
    {
#if defined(PX_X86) || defined(PX_X64)
        targetPlatform = PxPlatform::ePC;
#elif defined(PX_X360)
        targetPlatform = PxPlatform::eXENON;
#elif defined(PX_PS3)
        targetPlatform = PxPlatform::ePLAYSTATION3;
#elif defined(PX_ARM) || defined(PX_A64)
        targetPlatform = PxPlatform::eARM;
#elif defined(PX_WIIU)
        targetPlatform = PxPlatform::eWIIU;
#else
#error Unknown platform
#endif
    }
};

class PxCooking
{
public:
    virtual void  release() = 0;

    virtual void  setParams(const PxCookingParams& params) = 0;

    virtual const PxCookingParams& getParams() = 0;

    virtual bool  platformMismatch() = 0;

    virtual bool  cookTriangleMesh(const PxTriangleMeshDesc& desc, PxOutputStream& stream) = 0;

    virtual PxTriangleMesh*    createTriangleMesh(const PxTriangleMeshDesc& desc, PxPhysicsInsertionCallback& insertionCallback) = 0;

    virtual bool  validateTriangleMesh(const PxTriangleMeshDesc& desc) = 0;

    virtual bool  cookConvexMesh(const PxConvexMeshDesc& desc, PxOutputStream& stream, PxConvexMeshCookingResult::Enum* condition = NULL) = 0;  

    virtual bool  computeHullPolygons(const PxSimpleTriangleMesh& mesh, PxAllocatorCallback& inCallback, PxU32& nbVerts, PxVec3*& vertices,
                                            PxU32& nbIndices, PxU32*& indices, PxU32& nbPolygons, PxHullPolygon*& hullPolygons) = 0;

    virtual bool  cookHeightField(const PxHeightFieldDesc& desc, PxOutputStream& stream) = 0;

    virtual PxHeightField*    createHeightField(const PxHeightFieldDesc& desc, PxPhysicsInsertionCallback& insertionCallback) = 0;


protected:
    virtual ~PxCooking(){}
};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

PX_C_EXPORT PX_PHYSX_COOKING_API physx::PxCooking* PX_CALL_CONV PxCreateCooking(physx::PxU32 version,
                                                                                physx::PxFoundation& foundation,
                                                                                const physx::PxCookingParams& params);

#endif