NvBlastFamily.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 NVBLASTFAMILY_H
#define NVBLASTFAMILY_H


#include "NvBlastAsset.h"
#include "NvBlastPreprocessor.h"
#include "NvBlastDLink.h"
#include "NvBlastAtomic.h"
#include "NvBlastMemory.h"

#include <cstring>


struct NvBlastAsset;


namespace Nv
{
namespace Blast
{

// Forward declarations
class FamilyGraph;
class Actor;
class Asset;


struct FamilyHeader : public NvBlastDataBlock
{
    NvBlastID   m_assetID;

    NvBlastBlockArrayData(Actor, m_actorsOffset, getActors, m_asset->m_graph.m_nodeCount);

    NvBlastBlockArrayData(IndexDLink<uint32_t>, m_visibleChunkIndexLinksOffset, getVisibleChunkIndexLinks, m_asset->m_chunkCount);

    NvBlastBlockArrayData(uint32_t, m_chunkActorIndicesOffset, getChunkActorIndices, m_asset->m_firstSubsupportChunkIndex);

    NvBlastBlockArrayData(uint32_t, m_graphNodeIndexLinksOffset, getGraphNodeIndexLinks, m_asset->m_graph.m_nodeCount);

    NvBlastBlockArrayData(float, m_lowerSupportChunkHealthsOffset, getLowerSupportChunkHealths, m_asset->getLowerSupportChunkCount());

    float*  getSubsupportChunkHealths() const
    {
        NVBLAST_ASSERT(m_asset != nullptr);
        return (float*)((uintptr_t)this + m_lowerSupportChunkHealthsOffset) + m_asset->m_graph.m_nodeCount;
    }

    NvBlastBlockArrayData(float, m_graphBondHealthsOffset, getBondHealths, m_asset->getBondCount());

    NvBlastBlockData(FamilyGraph, m_familyGraphOffset, getFamilyGraph);



    volatile uint32_t   m_actorCount;

    union
    {
        const Asset*    m_asset;
        uint64_t        m_runtimePlaceholder;   // Make sure we reserve enough room for an 8-byte pointer
    };



    Actor*      borrowActor(uint32_t index);

    void        returnActor(Actor& actor);

    uint32_t    getActorBufferSize() const;

    bool        isActorActive(uint32_t index) const;

    Actor*      getActorByIndex(uint32_t index) const;

    uint32_t    getGetChunkActorIndex(uint32_t chunkIndex) const;

    uint32_t    getGetNodeActorIndex(uint32_t nodeIndex) const;

    Actor*      getGetChunkActor(uint32_t chunkIndex) const;

    Actor*      getGetNodeActor(uint32_t nodeIndex) const;



    void                fractureSubSupportNoEvents(uint32_t chunkIndex, uint32_t suboffset, float healthDamage, float* chunkHealths, const NvBlastChunk* chunks);

    void                fractureSubSupport(uint32_t chunkIndex, uint32_t suboffset, float healthDamage, float* chunkHealths, const NvBlastChunk* chunks, NvBlastChunkFractureData* outBuffer, uint32_t* currentIndex, const uint32_t maxCount);

    void                fractureNoEvents(uint32_t chunkFractureCount, const NvBlastChunkFractureData* chunkFractures, Actor* filterActor, NvBlastLog logFn);

    void                fractureWithEvents(uint32_t chunkFractureCount, const NvBlastChunkFractureData* commands, NvBlastChunkFractureData* events, uint32_t eventsSize, uint32_t* count, Actor* filterActor, NvBlastLog logFn);

    void                fractureInPlaceEvents(uint32_t chunkFractureCount, NvBlastChunkFractureData* inoutbuffer, uint32_t eventsSize, uint32_t* count, Actor* filterActor, NvBlastLog logFn);

    void                applyFracture(NvBlastFractureBuffers* eventBuffers, const NvBlastFractureBuffers* commands, Actor* filterActor, NvBlastLog logFn, NvBlastTimers* timers);
};

} // namespace Blast
} // namespace Nv


#include "NvBlastActor.h"


namespace Nv
{
namespace Blast
{


NV_INLINE Actor* FamilyHeader::borrowActor(uint32_t index)
{
    NVBLAST_ASSERT(index < getActorBufferSize());
    Actor& actor = getActors()[index];
    if (actor.m_familyOffset == 0)
    {
        const uintptr_t offset = (uintptr_t)&actor - (uintptr_t)this;
        NVBLAST_ASSERT(offset <= UINT32_MAX);
        actor.m_familyOffset = (uint32_t)offset;
        atomicIncrement(reinterpret_cast<volatile int32_t*>(&m_actorCount));
    }
    return &actor;
}


NV_INLINE void FamilyHeader::returnActor(Actor& actor)
{
    if (actor.m_familyOffset != 0)
    {
        actor.m_familyOffset = 0;
        // The actor count should be positive since this actor was valid.  Check to be safe.
        NVBLAST_ASSERT(m_actorCount > 0);
        atomicDecrement(reinterpret_cast<volatile int32_t*>(&m_actorCount));
    }
}


NV_INLINE uint32_t FamilyHeader::getActorBufferSize() const
{
    NVBLAST_ASSERT(m_asset);
    return m_asset->getLowerSupportChunkCount();
}


NV_INLINE bool FamilyHeader::isActorActive(uint32_t index) const
{
    NVBLAST_ASSERT(index < getActorBufferSize());
    return getActors()[index].m_familyOffset != 0;
}


NV_INLINE Actor* FamilyHeader::getActorByIndex(uint32_t index) const
{
    NVBLAST_ASSERT(index < getActorBufferSize());
    Actor& actor = getActors()[index];
    return actor.isActive() ? &actor : nullptr;
}


NV_INLINE uint32_t FamilyHeader::getGetChunkActorIndex(uint32_t chunkIndex) const
{
    NVBLAST_ASSERT(m_asset);
    NVBLAST_ASSERT(chunkIndex < m_asset->m_chunkCount);
    if (chunkIndex < m_asset->getUpperSupportChunkCount())
    {
        return getChunkActorIndices()[chunkIndex];
    }
    else
    {
        return chunkIndex - (m_asset->getUpperSupportChunkCount() - m_asset->m_graph.m_nodeCount);
    }
}


NV_INLINE uint32_t FamilyHeader::getGetNodeActorIndex(uint32_t nodeIndex) const
{
    NVBLAST_ASSERT(m_asset);
    NVBLAST_ASSERT(nodeIndex < m_asset->m_graph.m_nodeCount);
    const uint32_t chunkIndex = m_asset->m_graph.getChunkIndices()[nodeIndex];
    return isInvalidIndex(chunkIndex) ? chunkIndex : getChunkActorIndices()[chunkIndex];
}


NV_INLINE Actor* FamilyHeader::getGetChunkActor(uint32_t chunkIndex) const
{
    uint32_t actorIndex = getGetChunkActorIndex(chunkIndex);
    return !isInvalidIndex(actorIndex) ? getActorByIndex(actorIndex) : nullptr;
}


NV_INLINE Actor* FamilyHeader::getGetNodeActor(uint32_t nodeIndex) const
{
    uint32_t actorIndex = getGetNodeActorIndex(nodeIndex);
    return !isInvalidIndex(actorIndex) ? getActorByIndex(actorIndex) : nullptr;
}



size_t getFamilyMemorySize(const Asset* asset);

} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTFAMILY_H