PxPhysics.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_PHYSICS_NX_PHYSICS
#define PX_PHYSICS_NX_PHYSICS


#include "PxPhysXConfig.h"
#include "PxDeletionListener.h"
#include "foundation/PxTransform.h"
#include "PxShape.h"
#include "physxvisualdebuggersdk/PvdConnectionManager.h"

#if PX_USE_CLOTH_API
#include "cloth/PxClothTypes.h"
#include "cloth/PxClothFabric.h"
#endif

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxInputStream;
class PxOutputStream;
class PxPhysicsInsertionCallback;

class PxRigidActor;
class PxConstraintConnector;
struct PxConstraintShaderTable;

class PxProfileZone;
class PxProfileZoneManager;

class PxGeometry;

class PxSerializationRegistry;

struct PxCookingValue
{
    enum Enum
    {
        eCONVEX_VERSION_PC,
        eMESH_VERSION_PC,
        eCONVEX_VERSION_XENON,
        eMESH_VERSION_XENON,
        eCONVEX_VERSION_PLAYSTATION3,
        eMESH_VERSION_PLAYSTATION3
    };
};

class PxPhysics
{
public:

    
    

    virtual ~PxPhysics() {}
    
    
    virtual void release() = 0;

    virtual PxFoundation&       getFoundation() = 0;

    virtual PxVisualDebugger*   getVisualDebugger() = 0;

    virtual PxVisualDebuggerConnectionManager* getPvdConnectionManager() = 0;

    /*
    \brief Retrieves the profile sdk manager.
    *   The profile sdk manager manages collections of SDKs and objects that are interested in 
    *   receiving events from them.  This is the hook if you want to write the profiling events
    *   from multiple SDK's out to a file.
    \return The SDK's profiling system manager.
    */
    virtual PxProfileZoneManager* getProfileZoneManager() = 0;  

    virtual PxAggregate*        createAggregate(PxU32 maxSize, bool enableSelfCollision)    = 0;

    virtual const PxTolerancesScale&        getTolerancesScale() const = 0;

    


    virtual PxTriangleMesh*    createTriangleMesh(PxInputStream& stream) = 0;
    


    virtual PxU32               getNbTriangleMeshes() const = 0;

    virtual PxU32               getTriangleMeshes(PxTriangleMesh** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;

    PX_DEPRECATED virtual PxHeightField*        createHeightField(const PxHeightFieldDesc& heightFieldDesc) = 0;

    virtual PxHeightField*      createHeightField(PxInputStream& stream) = 0;

    virtual PxU32               getNbHeightFields() const = 0;

    virtual PxU32               getHeightFields(PxHeightField** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;

    virtual PxConvexMesh*       createConvexMesh(PxInputStream &stream)                 = 0;

    virtual PxU32               getNbConvexMeshes() const = 0;

    virtual PxU32               getConvexMeshes(PxConvexMesh** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;


#if PX_USE_CLOTH_API

    virtual PxClothFabric*      createClothFabric(PxInputStream& stream) = 0;

    virtual PxClothFabric*      createClothFabric(const PxClothFabricDesc& desc) = 0;

    virtual PxU32               getNbClothFabrics() const = 0;

    virtual PxU32               getClothFabrics(PxClothFabric** userBuffer, PxU32 bufferSize) const = 0;
#endif



    virtual PxScene*            createScene(const PxSceneDesc& sceneDesc) = 0;

    virtual PxU32               getNbScenes()           const   = 0;

    virtual PxU32               getScenes(PxScene** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;
    


    virtual PxRigidStatic*      createRigidStatic(const PxTransform& pose) = 0;



    virtual PxRigidDynamic*      createRigidDynamic(const PxTransform& pose) = 0;


#if PX_USE_PARTICLE_SYSTEM_API

    virtual PxParticleSystem*   createParticleSystem(PxU32 maxParticles, bool perParticleRestOffset = false) = 0;

    virtual PxParticleFluid*    createParticleFluid(PxU32 maxParticles, bool perParticleRestOffset = false) = 0;
#endif


#if PX_USE_CLOTH_API

    virtual PxCloth*            createCloth(const PxTransform& globalPose, PxClothFabric& fabric, const PxClothParticle* particles, PxClothFlags flags) = 0;
#endif
    

    

    PX_FORCE_INLINE PxShape*    createShape(    const PxGeometry& geometry, 
                                                const PxMaterial& material, 
                                                bool isExclusive = false, 
                                                PxShapeFlags shapeFlags = PxShapeFlag::eVISUALIZATION | PxShapeFlag::eSCENE_QUERY_SHAPE | PxShapeFlag::eSIMULATION_SHAPE)
    {
        PxMaterial* materialPtr = const_cast<PxMaterial*>(&material);
        return createShape(geometry, &materialPtr, 1, isExclusive, shapeFlags);
    }


    virtual PxShape*            createShape(const PxGeometry& geometry, 
                                            PxMaterial*const * materials, 
                                            PxU16 materialCount, 
                                            bool isExclusive = false,
                                            PxShapeFlags shapeFlags = PxShapeFlag::eVISUALIZATION | PxShapeFlag::eSCENE_QUERY_SHAPE | PxShapeFlag::eSIMULATION_SHAPE) = 0;


    virtual PxU32               getNbShapes() const = 0;

    virtual PxU32               getShapes(PxShape** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;




    virtual PxConstraint*      createConstraint(PxRigidActor* actor0, PxRigidActor* actor1, PxConstraintConnector& connector, const PxConstraintShaderTable& shaders, PxU32 dataSize)       = 0;


    virtual PxArticulation*      createArticulation() = 0;




    virtual PxMaterial*        createMaterial(PxReal staticFriction, PxReal dynamicFriction, PxReal restitution)        = 0;


    virtual PxU32               getNbMaterials() const = 0;

    virtual PxU32               getMaterials(PxMaterial** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;



    virtual void registerDeletionListener(PxDeletionListener& observer, const PxDeletionEventFlags& deletionEvents, bool restrictedObjectSet = false) = 0;

    virtual void unregisterDeletionListener(PxDeletionListener& observer) = 0;

    virtual void registerDeletionListenerObjects(PxDeletionListener& observer, const PxBase* const* observables, PxU32 observableCount) = 0;

    virtual void unregisterDeletionListenerObjects(PxDeletionListener& observer, const PxBase* const* observables, PxU32 observableCount) = 0;

    virtual PxPhysicsInsertionCallback& getPhysicsInsertionCallback() = 0;

};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

PX_C_EXPORT PX_PHYSX_CORE_API physx::PxU32 PX_CALL_CONV PxGetValue(physx::PxCookingValue::Enum cookValue);


PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxRegisterArticulations(physx::PxPhysics& physics);

PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxRegisterHeightFields(physx::PxPhysics& physics);

PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxRegisterUnifiedHeightFields(physx::PxPhysics& physics);

PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxRegisterCloth(physx::PxPhysics& physics);

PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxRegisterParticles(physx::PxPhysics& physics);

PX_C_EXPORT PX_PHYSX_CORE_API physx::PxPhysics* PX_CALL_CONV PxCreateBasePhysics(physx::PxU32 version,
                                                                                 physx::PxFoundation& foundation,
                                                                                 const physx::PxTolerancesScale& scale,                                                                              
                                                                                 bool trackOutstandingAllocations = false,
                                                                                 physx::PxProfileZoneManager* profileZoneManager = NULL);

PX_INLINE physx::PxPhysics* PxCreatePhysics(physx::PxU32 version,
                                            physx::PxFoundation& foundation,
                                            const physx::PxTolerancesScale& scale,                                          
                                            bool trackOutstandingAllocations = false,
                                            physx::PxProfileZoneManager* profileZoneManager = NULL)
{
    physx::PxPhysics* physics = PxCreateBasePhysics(version, foundation, scale, trackOutstandingAllocations, profileZoneManager);
    if(!physics)
        return NULL;

    PxRegisterArticulations(*physics);
    PxRegisterHeightFields(*physics);
    PxRegisterCloth(*physics);
    PxRegisterParticles(*physics);

    return physics;
}

PX_C_EXPORT PX_PHYSX_CORE_API physx::PxPhysics& PX_CALL_CONV PxGetPhysics();

#ifndef PX_DOXYGEN

PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxGetPhysicsBinaryMetaData(physx::PxOutputStream& stream);

PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxRegisterPhysicsSerializers(physx::PxSerializationRegistry& sr);

PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxUnregisterPhysicsSerializers(physx::PxSerializationRegistry& sr);


PX_C_EXPORT PX_PHYSX_CORE_API void PX_CALL_CONV PxAddCollectionToPhysics(const physx::PxCollection& collection);

#endif

#endif