File Environment.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_ENVIRONMENT_H
#define _AM_CORE_ENVIRONMENT_H

#include <SparkyStudios/Audio/Amplitude/Core/Common.h>
#include <SparkyStudios/Audio/Amplitude/Core/Entity.h>
#include <SparkyStudios/Audio/Amplitude/Math/Shape.h>
#include <SparkyStudios/Audio/Amplitude/Sound/Effect.h>

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

    class AM_API_PUBLIC Environment
    {
    public:
        Environment();

        explicit Environment(EnvironmentInternalState* state);

        void Clear();

        [[nodiscard]] bool Valid() const;

        [[nodiscard]] AmEnvironmentID GetId() const;

        void SetLocation(const AmVector3& location) const;

        [[nodiscard]] const AmVector3& GetLocation() const;

        void SetOrientation(const Orientation& orientation) const;

        [[nodiscard]] const Orientation& GetOrientation() const;

        [[nodiscard]] AmVector3 GetDirection() const;

        [[nodiscard]] AmVector3 GetUp() const;

        [[nodiscard]] AmReal32 GetFactor(const AmVector3& location) const;

        [[nodiscard]] AmReal32 GetFactor(const Entity& entity) const;

        void SetEffect(AmEffectID effect) const;

        void SetEffect(const AmString& effect) const;

        void SetEffect(const Effect* effect) const;

        [[nodiscard]] const Effect* GetEffect() const;

        void SetZone(std::shared_ptr<Zone> zone) const;

        [[nodiscard]] std::shared_ptr<Zone> GetZone() const;

        [[nodiscard]] EnvironmentInternalState* GetState() const;

        void Update() const;

    private:
        EnvironmentInternalState* _state;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_CORE_ENVIRONMENT_H