You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
354 lines
9.5 KiB
354 lines
9.5 KiB
/****************************************************************************
|
|
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 "base/Macros.h"
|
|
#include "base/RefCounted.h"
|
|
#include "base/std/container/array.h"
|
|
#include "math/Color.h"
|
|
|
|
namespace cc {
|
|
namespace scene {
|
|
|
|
enum class FogType {
|
|
/**
|
|
* @zh
|
|
* 线性雾。
|
|
* @en
|
|
* Linear fog
|
|
* @readonly
|
|
*/
|
|
LINEAR = 0,
|
|
/**
|
|
* @zh
|
|
* 指数雾。
|
|
* @en
|
|
* Exponential fog
|
|
* @readonly
|
|
*/
|
|
EXP = 1,
|
|
/**
|
|
* @zh
|
|
* 指数平方雾。
|
|
* @en
|
|
* Exponential square fog
|
|
* @readonly
|
|
*/
|
|
EXP_SQUARED = 2,
|
|
/**
|
|
* @zh
|
|
* 层叠雾。
|
|
* @en
|
|
* Layered fog
|
|
* @readonly
|
|
*/
|
|
LAYERED = 3,
|
|
NONE = 4
|
|
};
|
|
|
|
class FogInfo;
|
|
|
|
class Fog final {
|
|
public:
|
|
Fog() = default;
|
|
~Fog() = default;
|
|
|
|
void initialize(const FogInfo &fogInfo);
|
|
|
|
inline void activate() {
|
|
updatePipeline();
|
|
_activated = true;
|
|
}
|
|
|
|
/**
|
|
* @zh 是否启用全局雾效
|
|
* @en Enable global fog
|
|
*/
|
|
inline void setEnabled(bool val) {
|
|
_enabled = val;
|
|
if (!val) {
|
|
_type = FogType::NONE;
|
|
updatePipeline();
|
|
} else {
|
|
activate();
|
|
}
|
|
}
|
|
inline bool isEnabled() const { return _enabled; }
|
|
|
|
/**
|
|
* @zh 是否启用精确雾效(像素雾)计算
|
|
* @en Enable accurate fog (pixel fog)
|
|
*/
|
|
inline void setAccurate(bool val) {
|
|
_accurate = val;
|
|
updatePipeline();
|
|
}
|
|
inline bool isAccurate() const { return _accurate; }
|
|
|
|
/**
|
|
* @zh 全局雾颜色
|
|
* @en Global fog color
|
|
*/
|
|
void setFogColor(const Color &val);
|
|
inline const Color &getFogColor() const { return _fogColor; }
|
|
|
|
/**
|
|
* @zh 当前雾化类型。
|
|
* @en The current global fog type.
|
|
* @returns {FogType}
|
|
* Returns the current global fog type
|
|
* - -1:Disable global Fog
|
|
* - 0:Linear fog
|
|
* - 1:Exponential fog
|
|
* - 2:Exponential square fog
|
|
* - 3:Layered fog
|
|
*/
|
|
inline FogType getType() const { return _type; }
|
|
inline void setType(FogType val) {
|
|
_type = _enabled ? val : FogType::NONE;
|
|
if (_enabled) {
|
|
updatePipeline();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @zh 全局雾浓度
|
|
* @en Global fog density
|
|
*/
|
|
inline float getFogDensity() const { return _fogDensity; }
|
|
inline void setFogDensity(float val) { _fogDensity = val; }
|
|
|
|
/**
|
|
* @zh 雾效起始位置，只适用于线性雾
|
|
* @en Global fog start position, only for linear fog
|
|
*/
|
|
inline float getFogStart() const { return _fogStart; }
|
|
inline void setFogStart(float val) { _fogStart = val; }
|
|
|
|
/**
|
|
* @zh 雾效结束位置，只适用于线性雾
|
|
* @en Global fog end position, only for linear fog
|
|
*/
|
|
float getFogEnd() const { return _fogEnd; }
|
|
void setFogEnd(float val) { _fogEnd = val; }
|
|
|
|
/**
|
|
* @zh 雾效衰减
|
|
* @en Global fog attenuation
|
|
*/
|
|
inline float getFogAtten() const { return _fogAtten; }
|
|
inline void setFogAtten(float val) { _fogAtten = val; }
|
|
|
|
/**
|
|
* @zh 雾效顶部范围，只适用于层级雾
|
|
* @en Global fog top range, only for layered fog
|
|
*/
|
|
inline float getFogTop() const { return _fogTop; }
|
|
|
|
inline void setFogTop(float val) { _fogTop = val; }
|
|
|
|
/**
|
|
* @zh 雾效范围，只适用于层级雾
|
|
* @en Global fog range, only for layered fog
|
|
*/
|
|
inline float getFogRange() const { return _fogRange; }
|
|
inline void setFogRange(float val) { _fogRange = val; }
|
|
|
|
const Vec4 &getColorArray() const { return _colorArray; }
|
|
|
|
private:
|
|
void updatePipeline();
|
|
|
|
Color _fogColor{200, 200, 200, 255};
|
|
Vec4 _colorArray{0.2F, 0.2F, 0.2F, 1.0F};
|
|
bool _enabled{false};
|
|
bool _accurate{false};
|
|
FogType _type{FogType::LINEAR};
|
|
float _fogDensity{0.3F};
|
|
float _fogStart{0.5F};
|
|
float _fogEnd{300.F};
|
|
float _fogAtten{5.F};
|
|
float _fogTop{1.5F};
|
|
float _fogRange{1.2F};
|
|
bool _activated{false};
|
|
|
|
CC_DISALLOW_COPY_MOVE_ASSIGN(Fog);
|
|
};
|
|
|
|
class FogInfo : public RefCounted {
|
|
public:
|
|
FogInfo() = default;
|
|
~FogInfo() override = default;
|
|
/**
|
|
* @zh 是否启用全局雾效
|
|
* @en Enable global fog
|
|
*/
|
|
void setEnabled(bool val) const;
|
|
inline bool isEnabled() const { return _isEnabled; }
|
|
|
|
/**
|
|
* @zh 是否启用精确雾效(像素雾)计算
|
|
* @en Enable accurate fog (pixel fog)
|
|
*/
|
|
// @editable
|
|
// @tooltip('i18n:fog.accurate')
|
|
inline void setAccurate(bool val) {
|
|
if (_accurate == val) return;
|
|
_accurate = val;
|
|
if (_resource != nullptr) {
|
|
_resource->setAccurate(val);
|
|
if (val) {
|
|
_resource->setType(_type);
|
|
}
|
|
}
|
|
}
|
|
inline bool isAccurate() const { return _accurate; }
|
|
|
|
/**
|
|
* @zh 全局雾颜色
|
|
* @en Global fog color
|
|
*/
|
|
// @editable
|
|
// @tooltip('i18n:fog.fogColor')
|
|
void setFogColor(const Color &val);
|
|
inline const Color &getFogColor() const { return _fogColor; }
|
|
|
|
/**
|
|
* @zh 全局雾类型
|
|
* @en Global fog type
|
|
*/
|
|
// @editable
|
|
// @type(FogType)
|
|
// @tooltip('i18n:fog.type')
|
|
void setType(FogType val);
|
|
inline FogType getType() const { return _type; }
|
|
|
|
/**
|
|
* @zh 全局雾浓度
|
|
* @en Global fog density
|
|
*/
|
|
// @visible(function (this: FogInfo) {
|
|
// return this._type !== FogType.LAYERED && this._type !== FogType.LINEAR;
|
|
// })
|
|
// @type(CCFloat)
|
|
// @range([0, 1])
|
|
// @rangeStep(0.01)
|
|
// @slide
|
|
// @displayOrder(3)
|
|
// @tooltip('i18n:fog.fogDensity')
|
|
void setFogDensity(float val);
|
|
inline float getFogDensity() const { return _fogDensity; }
|
|
|
|
// /**
|
|
// * @zh 雾效起始位置
|
|
// * @en Global fog start position
|
|
// */
|
|
// @visible(function (this: FogInfo) { return this._type !== FogType.LAYERED; })
|
|
// @type(CCFloat)
|
|
// @rangeStep(0.01)
|
|
// @displayOrder(4)
|
|
// @tooltip('i18n:fog.fogStart')
|
|
void setFogStart(float val);
|
|
inline float getFogStart() const { return _fogStart; }
|
|
|
|
// /**
|
|
// * @zh 雾效结束位置，只适用于线性雾
|
|
// * @en Global fog end position, only for linear fog
|
|
// */
|
|
// @visible(function (this: FogInfo) { return this._type === FogType.LINEAR; })
|
|
// @type(CCFloat)
|
|
// @rangeStep(0.01)
|
|
// @displayOrder(5)
|
|
// @tooltip('i18n:fog.fogEnd')
|
|
void setFogEnd(float val);
|
|
inline float getFogEnd() const { return _fogEnd; }
|
|
|
|
/**
|
|
* @zh 雾效衰减
|
|
* @en Global fog attenuation
|
|
*/
|
|
// @visible(function (this: FogInfo) { return this._type !== FogType.LINEAR; })
|
|
// @type(CCFloat)
|
|
// @rangeMin(0.01)
|
|
// @rangeStep(0.01)
|
|
// @displayOrder(6)
|
|
// @tooltip('i18n:fog.fogAtten')
|
|
void setFogAtten(float val);
|
|
inline float getFogAtten() const { return _fogAtten; }
|
|
|
|
/**
|
|
* @zh 雾效顶部范围，只适用于层级雾
|
|
* @en Global fog top range, only for layered fog
|
|
*/
|
|
// @visible(function (this: FogInfo) { return this._type === FogType.LAYERED; })
|
|
// @type(CCFloat)
|
|
// @rangeStep(0.01)
|
|
// @displayOrder(7)
|
|
// @tooltip('i18n:fog.fogTop')
|
|
void setFogTop(float val);
|
|
inline float getFogTop() const { return _fogTop; }
|
|
|
|
/**
|
|
* @zh 雾效范围，只适用于层级雾
|
|
* @en Global fog range, only for layered fog
|
|
*/
|
|
// @visible(function (this: FogInfo) { return this._type === FogType.LAYERED; })
|
|
// @type(CCFloat)
|
|
// @rangeStep(0.01)
|
|
// @displayOrder(8)
|
|
// @tooltip('i18n:fog.fogRange')
|
|
void setFogRange(float val);
|
|
inline float getFogRange() const { return _fogRange; }
|
|
|
|
void activate(Fog *resource);
|
|
|
|
//cjh JSB need to bind the property, so need to make it public
|
|
//private:
|
|
// @serializable
|
|
FogType _type{FogType::LINEAR};
|
|
// @serializable
|
|
Color _fogColor{200, 200, 200, 255};
|
|
// @serializable
|
|
bool _isEnabled{false};
|
|
// @serializable
|
|
float _fogDensity{0.3F};
|
|
// @serializable
|
|
float _fogStart{0.5F};
|
|
// @serializable
|
|
float _fogEnd{300.F};
|
|
// @serializable
|
|
float _fogAtten{5.F};
|
|
// @serializable
|
|
float _fogTop{1.5F};
|
|
// @serializable
|
|
float _fogRange{1.2F};
|
|
// @serializable
|
|
bool _accurate{false};
|
|
// weak reference
|
|
Fog *_resource{nullptr};
|
|
};
|
|
|
|
} // namespace scene
|
|
} // namespace cc
|
|
|