toolkit/NvBlastTkEvent.h

File members: toolkit/NvBlastTkEvent.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2016-2024 NVIDIA Corporation. All rights reserved.

#ifndef NVBLASTTKEVENT_H
#define NVBLASTTKEVENT_H

#include <vector>

#include "NvBlastTypes.h"

namespace Nv
{
namespace Blast
{

// Forward declarations
class TkObject;
class TkActor;
class TkFamily;
class TkJoint;

struct TkActorData
{
    TkFamily*   family;
    void*       userData;
    uint32_t    index;
};

struct TkEvent
{
    // Enums
    enum Type
    {
        Split,
        FractureCommand,
        FractureEvent,
        JointUpdate,

        TypeCount
    };

    // Data
    const void* payload;
    Type        type;

    template<typename T>
    const T* getPayload() const { return reinterpret_cast<const T*>(payload); }
};

struct TkSplitEvent
{
    enum { EVENT_TYPE = TkEvent::Split };

    TkActorData parentData;
    uint32_t    numChildren;
    TkActor**   children;
};

struct TkFractureCommands
{
    enum { EVENT_TYPE = TkEvent::FractureCommand };

    TkActorData             tkActorData;
    NvBlastFractureBuffers  buffers;
};

struct TkFractureEvents
{
    enum { EVENT_TYPE = TkEvent::FractureEvent };

    TkActorData             tkActorData;
    NvBlastFractureBuffers  buffers;
    uint32_t                bondsDamaged;
    uint32_t                bondsBroken;
    uint32_t                chunksDamaged;
    uint32_t                chunksBroken;
};

struct TkJointUpdateEvent
{
    enum { EVENT_TYPE = TkEvent::JointUpdate };

    enum Subtype
    {
        External,
        Changed,
        Unreferenced
    };

    TkJoint*    joint;
    Subtype     subtype;
};

class TkEventListener
{
public:
    virtual void    receive(const TkEvent* events, uint32_t eventCount) = 0;
};

} // namespace Blast
} // namespace Nv

#endif // ifndef NVBLASTTKEVENT_H