NvBlastTkActor.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 NVBLASTTKACTOR_H
#define NVBLASTTKACTOR_H

#include "NvBlastTkObject.h"
#include "NvBlastTypes.h"

// Forward declarations
struct NvBlastActor;
struct NvBlastFamily;


namespace Nv
{
namespace Blast
{

// Forward declarations
class TkAsset;
class TkFamily;
class TkGroup;
class TkJoint;


class TkActor : public TkObject
{
public:
    virtual const NvBlastActor* getActorLL() const = 0;

    virtual TkFamily&           getFamily() const = 0;

    virtual uint32_t            getIndex() const = 0;

    virtual TkGroup*            getGroup() const = 0;

    virtual TkGroup*            removeFromGroup() = 0;

    virtual const TkAsset*      getAsset() const = 0;

    virtual uint32_t            getVisibleChunkCount() const = 0;

    virtual uint32_t            getVisibleChunkIndices(uint32_t* visibleChunkIndices, uint32_t visibleChunkIndicesSize) const = 0;

    virtual uint32_t            getGraphNodeCount() const = 0;

    virtual uint32_t            getGraphNodeIndices(uint32_t* graphNodeIndices, uint32_t graphNodeIndicesSize) const = 0;

    virtual const float*        getBondHealths() const = 0;

    virtual uint32_t            getSplitMaxActorCount() const = 0;

    virtual bool                isPending() const = 0;

    virtual void                damage(const NvBlastDamageProgram& program, const void* programParams) = 0;

    virtual void                generateFracture(NvBlastFractureBuffers* commands, const NvBlastDamageProgram& program, const void* programParams) const = 0;

    virtual void                applyFracture(NvBlastFractureBuffers* eventBuffers, const NvBlastFractureBuffers* commands) = 0;

    virtual uint32_t            getJointCount() const = 0;

    virtual uint32_t            getJoints(TkJoint** joints, uint32_t jointsSize) const = 0;

    virtual bool                isBoundToWorld() const = 0;
};

} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTTKACTOR_H