NvBlastExtStressSolver.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 NVBLASTEXTSTRESSSOLVER_H
#define NVBLASTEXTSTRESSSOLVER_H

#include "NvBlastTypes.h"
#include "NvCTypes.h"


namespace Nv
{
namespace Blast
{


struct ExtStressSolverSettings
{
    float       hardness;                   
    float       stressLinearFactor;         
    float       stressAngularFactor;        
    uint32_t    bondIterationsPerFrame;     
    uint32_t    graphReductionLevel;        

    ExtStressSolverSettings() :
        hardness(1000.0f),
        stressLinearFactor(0.25f),
        stressAngularFactor(0.75f),
        bondIterationsPerFrame(18000),
        graphReductionLevel(3)
    {}
};


struct ExtForceMode
{
    enum Enum
    {
        IMPULSE,    
        VELOCITY,   
    };
};


class NV_DLL_EXPORT ExtStressSolver
{
public:

    static ExtStressSolver*                 create(NvBlastFamily& family, ExtStressSolverSettings settings = ExtStressSolverSettings());



    virtual void                            release() = 0;

    virtual void                            setNodeInfo(uint32_t graphNodeIndex, float mass, float volume, NvcVec3 localPosition, bool isStatic) = 0;

    virtual void                            setAllNodesInfoFromLL(float density = 1.0f) = 0;

    virtual void                            setSettings(const ExtStressSolverSettings& settings) = 0;

    virtual const ExtStressSolverSettings&  getSettings() const = 0;

    virtual bool                            notifyActorCreated(const NvBlastActor& actor) = 0;

    virtual void                            notifyActorDestroyed(const NvBlastActor& actor) = 0;

    virtual bool                            addForce(const NvBlastActor& actor, NvcVec3 localPosition, NvcVec3 localForce, ExtForceMode::Enum mode = ExtForceMode::IMPULSE) = 0;

    virtual void                            addForce(uint32_t graphNodeIndex, NvcVec3 localForce, ExtForceMode::Enum mode = ExtForceMode::IMPULSE) = 0;

    virtual bool                            addGravityForce(const NvBlastActor& actor, NvcVec3 localGravity) = 0;

    virtual bool                            addAngularVelocity(const NvBlastActor& actor, NvcVec3 localCenterMass, NvcVec3 localAngularVelocity) = 0;

    virtual void                            update() = 0;

    virtual uint32_t                        getOverstressedBondCount() const = 0;

    virtual void                            generateFractureCommands(const NvBlastActor& actor, NvBlastFractureBuffers& commands) = 0;

    virtual void                            generateFractureCommands(NvBlastFractureBuffers& commands) = 0;

    virtual uint32_t                        generateFractureCommandsPerActor(const NvBlastActor** actorBuffer, NvBlastFractureBuffers* commandsBuffer, uint32_t bufferSize) = 0;

    virtual void                            reset() = 0;

    virtual float                           getStressErrorLinear() const = 0;

    virtual float                           getStressErrorAngular() const = 0;

    virtual uint32_t                        getFrameCount() const = 0;

    virtual uint32_t                        getBondCount() const = 0;


    enum DebugRenderMode
    {
        STRESS_GRAPH = 0,                   
        STRESS_GRAPH_NODES_IMPULSES = 1,    
        STRESS_GRAPH_BONDS_IMPULSES = 2     
    };

    struct DebugLine
    {
        DebugLine(const NvcVec3& p0, const NvcVec3& p1, const uint32_t& c)
            : pos0(p0), color0(c), pos1(p1), color1(c) {}

        NvcVec3 pos0;
        uint32_t        color0;
        NvcVec3 pos1;
        uint32_t        color1;
    };

    struct DebugBuffer
    {
        const DebugLine* lines;
        uint32_t         lineCount;
    };

    virtual const DebugBuffer               fillDebugRender(const uint32_t* nodes, uint32_t nodeCount, DebugRenderMode mode, float scale = 1.0f) = 0;



    static uint32_t                         getIterationsPerFrame(const ExtStressSolverSettings& settings, uint32_t bondCount)
    {
        uint32_t perFrame = settings.bondIterationsPerFrame / (bondCount + 1);
        return perFrame > 0 ? perFrame : 1;
    }

    uint32_t                                getIterationsPerFrame() const
    {
        return getIterationsPerFrame(getSettings(), getBondCount());
    }

};

} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTEXTSTRESSSOLVER_H