File Event.h¶

// Copyright (c) 2021-present Sparky Studios. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#ifndef _AM_CORE_EVENT_H
#define _AM_CORE_EVENT_H

#include <SparkyStudios/Audio/Amplitude/Core/Asset.h>
#include <SparkyStudios/Audio/Amplitude/Core/Common.h>
#include <SparkyStudios/Audio/Amplitude/Core/Entity.h>
#include <SparkyStudios/Audio/Amplitude/Core/Playback/Channel.h>

namespace SparkyStudios::Audio::Amplitude
{
    class EventInstance;

    class AM_API_PUBLIC EventCanceler
    {
    public:
        EventCanceler();

        explicit EventCanceler(std::shared_ptr<EventInstance> event);

        ~EventCanceler();

        [[nodiscard]] bool Valid() const;

        void Cancel() const;

        [[nodiscard]] std::shared_ptr<EventInstance> GetEvent() const;

    private:
        std::shared_ptr<EventInstance> _event;
    };

    class AM_API_PUBLIC Event : public Asset<AmEventID>
    {
    };

    class AM_API_PUBLIC EventInstance
    {
    public:
        virtual ~EventInstance() = default;

        virtual void AdvanceFrame(AmTime deltaTime) = 0;

        [[nodiscard]] virtual bool IsRunning() const = 0;

        virtual void Abort() = 0;

        virtual void OnFinish(std::function<void(bool aborted)> callback) = 0;

        virtual Entity GetEntity() const = 0;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_CORE_EVENT_H