SpotLight.h

//
//  SpotLight.h
//  avara3d
//
//  Created by Morgan Davis on 7/31/2024.
//  Copyright © 2026 Morgan K Davis. All rights reserved.
//
 
#ifndef AVARA3D_VISUAL_LIGHT_SPOTLIGHT_H
#define AVARA3D_VISUAL_LIGHT_SPOTLIGHT_H
 
#include <cstdint>
#include <string>
 
#include "a3d/Color.h"
#include "a3d/visual/light/Attenuation.h"
#include "a3d/visual/light/Light.h"
 
namespace a3d {
 
    class SpotLight : public Light {
 
    public:
        // [Public Types]
 
        enum class FeatheringMode : uint8_t {
            Linear = 0, 
            Sharp  = 1, 
            Soft   = 2  
        };
 
        // [Public Lifecycle Functions]
 
        SpotLight();
 
        explicit SpotLight(const std::string& name);
 
        explicit SpotLight(const Color& color);
 
        SpotLight(const std::string& name, const Color& color);
 
        SpotLight(const SpotLight&)            = default;
        SpotLight& operator=(const SpotLight&) = default;
 
        SpotLight(SpotLight&&) noexcept            = default;
        SpotLight& operator=(SpotLight&&) noexcept = default;
 
    public:
        // [Public Member Functions]
 
        float              innerAngle() const;
 
        void               innerAngle(float angle);
 
        float              outerAngle() const;
 
        void               outerAngle(float angle);
 
        FeatheringMode     featheringMode() const;
 
        void               featheringMode(FeatheringMode mode);
 
        const Attenuation& attenuation() const;
 
        void               attenuation(const Attenuation& attenuation);
 
        // [Internal Member Functions]
 
        float              innerAngleCos() const;
        float              outerAngleCos() const;
 
    private:
        // [Private Member Variables]
 
        float          _innerAngleCos;
        float          _outerAngleCos;
        FeatheringMode _featherMode;
        Attenuation    _attenuation;
    };
 
}
 
#endif // AVARA3D_VISUAL_LIGHT_SPOTLIGHT_H