File Attenuation.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_SOUND_ATTENUATION_H
#define _AM_SOUND_ATTENUATION_H

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

#include <SparkyStudios/Audio/Amplitude/Core/Asset.h>
#include <SparkyStudios/Audio/Amplitude/Core/Entity.h>
#include <SparkyStudios/Audio/Amplitude/Core/Listener.h>

#include <SparkyStudios/Audio/Amplitude/Math/Curve.h>

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

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

        virtual AmReal32 GetAttenuationFactor(const Attenuation* attenuation, const AmVector3& soundLocation, const Listener& listener) = 0;

        virtual AmReal32 GetAttenuationFactor(const Attenuation* attenuation, const Entity& entity, const Listener& listener) = 0;
    };

    class AM_API_PUBLIC Attenuation : public Asset<AmAttenuationID>
    {
    public:
        [[nodiscard]] virtual AmReal32 GetGain(const AmVector3& soundLocation, const Listener& listener) const = 0;

        [[nodiscard]] virtual AmReal32 GetGain(const Entity& entity, const Listener& listener) const = 0;

        [[nodiscard]] virtual AttenuationZone* GetShape() const = 0;

        [[nodiscard]] virtual const Curve& GetGainCurve() const = 0;

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

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

        [[nodiscard]] virtual AmReal32 EvaluateAirAbsorption(
            const AmVector3& soundLocation, const AmVector3& listenerLocation, AmUInt32 band) const = 0;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_SOUND_ATTENUATION_H