Skip to content

File Rtpc.h

File List > Amplitude > Sound > Rtpc.h

Go to the documentation of this file

// 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_SOUND_RTPC_H
#define _AM_SOUND_RTPC_H

#include <SparkyStudios/Audio/Amplitude/Core/Common.h>

#include <SparkyStudios/Audio/Amplitude/Core/Asset.h>
#include <SparkyStudios/Audio/Amplitude/IO/File.h>
#include <SparkyStudios/Audio/Amplitude/Math/Curve.h>

namespace SparkyStudios::Audio::Amplitude
{
    struct RtpcCompatibleValue;

    class AM_API_PUBLIC Rtpc : public Asset<AmRtpcID>
    {
    public:
        virtual void Update(AmTime deltaTime) = 0;

        [[nodiscard]] virtual AmReal64 GetMinValue() const = 0;

        [[nodiscard]] virtual AmReal64 GetMaxValue() const = 0;

        [[nodiscard]] virtual AmReal64 GetValue() const = 0;

        virtual void SetValue(AmReal64 value) = 0;

        [[nodiscard]] virtual AmReal64 GetDefaultValue() const = 0;

        virtual void Reset() = 0;
    };

    struct AM_API_PUBLIC RtpcValue
    {
    public:
        static void Init(RtpcValue& value, const RtpcCompatibleValue* definition, AmReal32 staticValue);

        RtpcValue();

        RtpcValue(const RtpcValue& other);

        ~RtpcValue();

        void Init(AmReal32 value);

        void Init(const Rtpc* rtpc, std::shared_ptr<Curve> curve);

        void Init(const RtpcCompatibleValue* definition);

        [[nodiscard]] AmReal32 GetValue() const;

        [[nodiscard]] bool IsStatic() const;

    private:
        AmInt8 _valueKind;
        AmReal32 _value;
        std::shared_ptr<Curve> _curve;
        const Rtpc* _rtpc;

        bool _initialized;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_SOUND_RTPC_H