NvBlastExtPxFamily.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and 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.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2020 NVIDIA Corporation. All rights reserved.


#ifndef NVBLASTEXTPXFAMILY_H
#define NVBLASTEXTPXFAMILY_H

#include "PxFiltering.h"


// Forward declarations
namespace physx
{
class PxRigidDynamic;
class PxMaterial;
class PxScene;
class PxTransform;
}

struct NvBlastExtMaterial;


namespace Nv
{
namespace Blast
{

// Forward declarations
class ExtPxActor;
class ExtPxAsset;
class ExtPxListener;
class TkFamily;


struct ExtPxShapeDescTemplate
{
    uint8_t             flags;                  
    physx::PxFilterData simulationFilterData;   
    physx::PxFilterData queryFilterData;        
    float               contactOffset;          
    float               restOffset;             
};


struct ExtPxActorDescTemplate
{
    uint8_t             flags;                      
};


struct ExtPxSpawnSettings
{
    physx::PxScene*     scene;          
    physx::PxMaterial*  material;       
    float               density;        
};


class ExtPxFamily
{
public:
    virtual bool                            spawn(const physx::PxTransform& pose, const physx::PxVec3& scale, const ExtPxSpawnSettings& settings) = 0;

    
    virtual bool                            despawn() = 0;


    virtual uint32_t                        getActorCount() const = 0;

    virtual uint32_t                        getActors(ExtPxActor** buffer, uint32_t bufferSize) const = 0;

    virtual TkFamily&                       getTkFamily() const = 0;

    virtual const physx::PxShape* const*    getSubchunkShapes() const = 0;

    virtual ExtPxAsset&                     getPxAsset() const = 0;

    virtual void                            setMaterial(physx::PxMaterial& material) = 0;

    /*
    Set ExtPxPxShapeDesc to be used on all newly created PxShapes.

    NOTE: Using it will override marking LEAF_CHUNK in simulationFilterData.word3 now.

    \param[in] pxShapeDesc      The PxShape desc to be the new default. Can be nullptr.
    */
    virtual void                            setPxShapeDescTemplate(const ExtPxShapeDescTemplate* pxShapeDesc) = 0;

    virtual const ExtPxShapeDescTemplate*   getPxShapeDescTemplate() const = 0;

    /*
    Set ExtPxPxActorDesc to be used on all newly created PxActors.
    
    \param[in] pxActorDesc      The PxActor desc to be the new default. Can be nullptr.
    */
    virtual void                            setPxActorDesc(const ExtPxActorDescTemplate* pxActorDesc) = 0;

    virtual const ExtPxActorDescTemplate*   getPxActorDesc() const = 0;

    virtual const NvBlastExtMaterial*       getMaterial() const = 0;

    virtual void                            setMaterial(const NvBlastExtMaterial* material) = 0;

    virtual void                            subscribe(ExtPxListener& listener) = 0;

    virtual void                            unsubscribe(ExtPxListener& listener) = 0;

    virtual void                            postSplitUpdate() = 0;

    virtual void                            release() = 0;

    void* userData;
};



} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTEXTPXFAMILY_H