NvBlastTkFramework.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 NVBLASTTKFRAMEWORK_H
#define NVBLASTTKFRAMEWORK_H


#include "NvBlastTkType.h"
#include "NvBlastTkEvent.h"

#include "NvBlastPreprocessor.h"
#include "NvBlastTypes.h"

#include "PxVec3.h"


// Forward declarations
namespace physx
{
class PxTransform;
}


namespace Nv
{
namespace Blast
{

// Forward declarations
class TkObject;
class TkEventDispatcher;
class TkAsset;
struct TkGroupDesc;
class TkGroup;
class TkActor;
class TkJoint;
class TkIdentifiable;
struct TkAssetJointDesc;



struct TkAssetDesc : public NvBlastAssetDesc
{
    enum BondFlags
    {
        NoFlags = 0,

        BondJointed = (1 << 0)
    };

    const uint8_t*  bondFlags;

    TkAssetDesc() : bondFlags(nullptr)
    {
        chunkCount = bondCount = 0;
        chunkDescs = nullptr;
        bondDescs = nullptr;
    }
};


struct TkActorDesc : public NvBlastActorDesc
{
    const TkAsset* asset;   

    TkActorDesc(const TkAsset* inAsset = nullptr) : asset(inAsset)
    {
        uniformInitialBondHealth = uniformInitialLowerSupportChunkHealth = 1.0f;
        initialBondHealths = initialSupportChunkHealths = nullptr;
    }
};


struct TkJointDesc
{
    TkFamily*       families[2];        
    uint32_t        chunkIndices[2];    
    physx::PxVec3   attachPositions[2]; 
};


struct TkTypeIndex
{
    enum Enum
    {
        Asset = 0,  
        Family,     
        Group,      

        TypeCount
    };
};


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

    virtual const TkType*   getType(TkTypeIndex::Enum typeIndex) const = 0;

    virtual TkIdentifiable* findObjectByID(const NvBlastID& id) const = 0;

    virtual uint32_t        getObjectCount(const TkType& type) const = 0;

    virtual uint32_t        getObjects(TkIdentifiable** buffer, uint32_t bufferSize, const TkType& type, uint32_t indexStart = 0) const = 0;


    virtual bool            reorderAssetDescChunks(NvBlastChunkDesc* chunkDescs, uint32_t chunkCount, NvBlastBondDesc* bondDescs, uint32_t bondCount, uint32_t* chunkReorderMap = nullptr, bool keepBondNormalChunkOrder = false) const = 0;

    virtual bool            ensureAssetExactSupportCoverage(NvBlastChunkDesc* chunkDescs, uint32_t chunkCount) const = 0;

    virtual TkAsset*        createAsset(const TkAssetDesc& desc) = 0;

    virtual TkAsset*        createAsset(const NvBlastAsset* assetLL, Nv::Blast::TkAssetJointDesc* jointDescs = nullptr, uint32_t jointDescCount = 0, bool ownsAsset = false) = 0;


    virtual TkGroup*        createGroup(const TkGroupDesc& desc) = 0;


    virtual TkActor*        createActor(const TkActorDesc& desc) = 0;


    virtual TkJoint*        createJoint(const TkJointDesc& desc)  = 0;

protected:
    virtual                 ~TkFramework() {}
};

} // namespace Blast
} // namespace Nv



NVBLAST_API Nv::Blast::TkFramework* NvBlastTkFrameworkCreate();


NVBLAST_API Nv::Blast::TkFramework* NvBlastTkFrameworkGet();


#endif // ifndef NVBLASTTKFRAMEWORK_H