NvBlastTkFrameworkImpl.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 NVBLASTTKFRAMEWORKIMPL_H
#define NVBLASTTKFRAMEWORKIMPL_H

#include "NvBlastTkFramework.h"
#include "NvBlastProfilerInternal.h"

#include "NvBlastTkCommon.h"

#include "NvBlastArray.h"
#include "NvBlastHashMap.h"
#include "NvBlastHashSet.h"


namespace Nv
{
namespace Blast
{

// Forward declarations
class TkTypeImpl;
class TkJointImpl;

class TkFrameworkImpl : public TkFramework
{
public:
                                        TkFrameworkImpl();
                                        ~TkFrameworkImpl();

    // Begin TkFramework
    virtual void                        release() override;

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

    virtual TkIdentifiable*             findObjectByID(const NvBlastID& id) const override;

    virtual uint32_t                    getObjectCount(const TkType& type) const override;

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

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

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

    virtual TkAsset*                    createAsset(const TkAssetDesc& desc) override;

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

    virtual TkGroup*                    createGroup(const TkGroupDesc& desc) override;

    virtual TkActor*                    createActor(const TkActorDesc& desc) override;

    virtual TkJoint*                    createJoint(const TkJointDesc& desc) override;
    // End TkFramework

    // Public methods
    void                                onCreate(TkIdentifiable& object);

    void                                onDestroy(TkIdentifiable& object);

    void                                onCreate(TkJointImpl& joint);

    void                                onDestroy(TkJointImpl& joint);

    void                                onIDChange(TkIdentifiable& object, const NvBlastID& IDPrev, const NvBlastID& IDCurr);

    TkIdentifiable*                     findObjectByIDInternal(const NvBlastID& id) const;

    // Access to singleton

    static TkFrameworkImpl*             get();

    static bool                         set(TkFrameworkImpl* framework);

private:
    // Enums
    enum { ClassID = NVBLAST_FOURCC('T', 'K', 'F', 'W') };  

    // Static data
    static TkFrameworkImpl*                                                     s_framework;            

    // Types
    InlineArray<const TkTypeImpl*, TkTypeIndex::TypeCount>::type                m_types;                
    HashMap<uint32_t, uint32_t>::type                                           m_typeIDToIndex;        

    // Objects and object names
    HashMap<NvBlastID, TkIdentifiable*>::type                                   m_IDToObject;           
    InlineArray<Array<TkIdentifiable*>::type, TkTypeIndex::TypeCount>::type     m_objects;              

    // Track external joints (to do: make this a pool)
    HashSet<TkJointImpl*>::type                                                 m_joints;               
};



NV_INLINE TkIdentifiable* TkFrameworkImpl::findObjectByIDInternal(const NvBlastID& id) const
{
    const auto entry = m_IDToObject.find(id);
    if (entry == nullptr)
    {
        return nullptr;
    }

    return entry->second;
}

} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTTKFRAMEWORKIMPL_H