NvBlastExtSync.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 NVBLASTEXTSYNC_H
#define NVBLASTEXTSYNC_H

#include "NvBlastTk.h"
#include "foundation/PxTransform.h"
#include "NvPreprocessor.h"
#include "NvBlastGlobals.h"


namespace Nv
{
namespace Blast
{

class ExtPxFamily;
class ExtPxManager;


struct ExtSyncEventType
{
    enum Enum
    {
        Fracture = 0, 
        FamilySync,   
        Physics,      

        Count
    };
};


struct NV_DLL_EXPORT ExtSyncEvent
{
    ExtSyncEvent(ExtSyncEventType::Enum t) : type(t) {}
    virtual ~ExtSyncEvent() {}

    template<class T>
    const T* getEvent() const { return reinterpret_cast<const T*>(this); }

    virtual ExtSyncEvent* clone() const = 0;

    void release();

    ExtSyncEventType::Enum  type;       
    uint64_t                timestamp;  
    NvBlastID               familyID;   
};


template <class T, ExtSyncEventType::Enum eventType>
struct ExtSyncEventInstance : public ExtSyncEvent
{
    ExtSyncEventInstance() : ExtSyncEvent(eventType) {}

    static const ExtSyncEventType::Enum EVENT_TYPE = eventType;

    ExtSyncEvent* clone() const override
    {
        return NVBLAST_NEW (T) (*(T*)this);
    }
};


struct ExtSyncEventFracture : public ExtSyncEventInstance<ExtSyncEventFracture, ExtSyncEventType::Fracture>
{
    std::vector<NvBlastBondFractureData>    bondFractures;  
    std::vector<NvBlastChunkFractureData>   chunkFractures; 
};


struct ExtSyncEventFamilySync : public ExtSyncEventInstance<ExtSyncEventFamilySync, ExtSyncEventType::FamilySync>
{
    std::vector<char> family;   
};


struct ExtSyncEventPhysicsSync : public ExtSyncEventInstance<ExtSyncEventPhysicsSync, ExtSyncEventType::Physics>
{
    struct ActorData
    {
        uint32_t            actorIndex; 
        physx::PxTransform  transform;  
    };

    std::vector<ActorData> data;        
};


class NV_DLL_EXPORT ExtSync : public TkEventListener
{
public:

    static ExtSync*     create();



    virtual void        release() = 0;



    virtual void        receive(const TkEvent* events, uint32_t eventCount)  = 0;

    virtual void        syncFamily(const TkFamily& family) = 0;

    virtual void        syncFamily(const ExtPxFamily& family) = 0;

    virtual uint32_t    getSyncBufferSize() const = 0;

    virtual void        acquireSyncBuffer(const ExtSyncEvent*const*& buffer, uint32_t& size) const = 0;

    virtual void        releaseSyncBuffer() = 0;



    virtual void        applySyncBuffer(TkFramework& framework, const ExtSyncEvent** buffer, uint32_t size, TkGroup* groupForNewActors, ExtPxManager* manager = nullptr) = 0;

};

} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTEXTSYNC_H