cocos_lib/cocos/scene/DirectionalLight.h

/****************************************************************************
 Copyright (c) 2021-2023 Xiamen Yaji Software Co., Ltd.

 http://www.cocos.com

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights to
 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do so,
 subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
****************************************************************************/

#pragma once

#include "math/Vec3.h"
#include "scene/Ambient.h"
#include "scene/Light.h"
#include "scene/Shadow.h"

namespace cc {
namespace scene {

class DirectionalLight final : public Light {
public:
    DirectionalLight();
    ~DirectionalLight() override;

    void initialize() override;
    void update() override;

    inline void setShadowEnabled(bool enabled) {
        _shadowEnabled = enabled;
        activate();
    }
    inline void setShadowPcf(PCFType pcf) {
        _shadowPcf = pcf;
        activate();
    }
    inline void setShadowBias(float bias) { _shadowBias = bias; }
    inline void setShadowNormalBias(float normalBias) { _shadowNormalBias = normalBias; }
    inline void setShadowSaturation(float saturation) { _shadowSaturation = saturation; }
    inline void setShadowDistance(float distance) { _shadowDistance = distance; }
    inline void setShadowInvisibleOcclusionRange(float invisibleOcclusionRange) { _shadowInvisibleOcclusionRange = invisibleOcclusionRange; }
    inline void setCSMLevel(CSMLevel csmLevel) {
        _csmLevel = csmLevel;
        activate();
    }
    inline void setCSMLayerLambda(float lambda) { _csmLayerLambda = lambda; }
    inline void setCSMNeedUpdate(bool isCSMNeedUpdate) { _isCSMNeedUpdate = isCSMNeedUpdate; }
    inline void setCSMOptimizationMode(CSMOptimizationMode csmOptimizationMode) { _csmOptimizationMode = csmOptimizationMode; }
    inline void setShadowFixedArea(bool fixedArea) {
        _shadowFixedArea = fixedArea;
        activate();
    }
    inline void setShadowNear(float nearValue) { _shadowNear = nearValue; }
    inline void setShadowFar(float farValue) { _shadowFar = farValue; }
    inline void setShadowOrthoSize(float orthoSize) { _shadowOrthoSize = orthoSize; }
    inline void setCSMLayersTransition(bool csmLayersTransition) {
        _csmLayersTransition = csmLayersTransition;
        activate();
    }
    inline void setCSMTransitionRange(bool csmTransitionRange) { _csmTransitionRange = csmTransitionRange; }

    inline bool isShadowEnabled() const { return _shadowEnabled; }
    inline PCFType getShadowPcf() const { return _shadowPcf; }
    inline float getShadowBias() const { return _shadowBias; }
    inline float getShadowNormalBias() const { return _shadowNormalBias; }
    inline float getShadowSaturation() const { return _shadowSaturation; }
    inline float getShadowDistance() const { return _shadowDistance; }
    inline float getShadowInvisibleOcclusionRange() const { return _shadowInvisibleOcclusionRange; }
    inline CSMLevel getCSMLevel() const { return _csmLevel; }
    inline float getCSMLayerLambda() const { return _csmLayerLambda; }
    inline bool isCSMNeedUpdate() const { return _isCSMNeedUpdate; }
    inline CSMOptimizationMode getCSMOptimizationMode() const { return _csmOptimizationMode; }
    inline bool isShadowFixedArea() const { return _shadowFixedArea; }
    inline float getShadowNear() const { return _shadowNear; }
    inline float getShadowFar() const { return _shadowFar; }
    inline float getShadowOrthoSize() const { return _shadowOrthoSize; }

    inline const Vec3 &getDirection() const { return _dir; }
    inline void setDirection(const Vec3 &dir) { _dir = dir; }
    inline void setIlluminanceHDR(float value) { _illuminanceHDR = value; }
    inline void setIlluminanceLDR(float value) { _illuminanceLDR = value; }
    inline float getIlluminanceHDR() const { return _illuminanceHDR; }
    inline float getIlluminanceLDR() const { return _illuminanceLDR; }
    inline float getCSMLayersTransition() const { return _csmLayersTransition; }
    inline float getCSMTransitionRange() const { return _csmTransitionRange; }
    float getIlluminance() const;
    void setIlluminance(float value);
    void activate() const;

private:
    // shadow info
    bool _shadowEnabled{false};
    bool _isCSMNeedUpdate{false};
    bool _shadowFixedArea{false};
    bool _csmLayersTransition{false};

    PCFType _shadowPcf{PCFType::HARD};
    CSMLevel _csmLevel{CSMLevel::LEVEL_3};
    CSMOptimizationMode _csmOptimizationMode{CSMOptimizationMode::REMOVE_DUPLICATES};

    float _illuminanceHDR{Ambient::SUN_ILLUM};
    float _illuminanceLDR{1.F};
    float _shadowBias{0.0F};
    float _shadowNormalBias{0.0F};
    float _shadowSaturation{0.75F};
    float _shadowDistance{50.0F};
    float _shadowInvisibleOcclusionRange{200.0F};
    float _csmLayerLambda{0.75F};
    float _shadowNear{0.1F};
    float _shadowFar{10.0F};
    float _shadowOrthoSize{1.0F};
    float _csmTransitionRange{0.05F};

    Vec3 _dir{1.0F, -1.0F, -1.0F};

    CC_DISALLOW_COPY_MOVE_ASSIGN(DirectionalLight);
};

} // namespace scene
} // namespace cc