Files
cocos4/cocos/core/3d/framework/spot-light-component.ts
T
Jare Guo 0319477911 fix decorator warning of ValueTypes (#7553)
* fix decorator warning of ValueTypes (sync #6285)

* refresh copyright
2020-10-21 16:31:41 +08:00

159 lines
4.2 KiB
TypeScript

/*
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2020 Xiamen Yaji Software Co., Ltd.
http://www.cocos2d-x.org
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.
*/
/**
* @packageDocumentation
* @module component/light
*/
import { ccclass, help, executeInEditMode, menu, tooltip, type, slide, range, unit, serializable } from 'cc.decorator';
import { toRadian } from '../../math';
import { scene } from '../../renderer';
import { Light, PhotometricTerm } from './light-component';
@ccclass('cc.SpotLight')
@help('i18n:cc.SpotLight')
@menu('Light/SpotLight')
@executeInEditMode
export class SpotLight extends Light {
@serializable
protected _size = 0.15;
@serializable
protected _luminance = 1700 / scene.nt2lm(0.15);
@serializable
protected _term = PhotometricTerm.LUMINOUS_POWER;
@serializable
protected _range = 1;
@serializable
protected _spotAngle = 60;
protected _type = scene.LightType.SPOT;
protected _light: scene.SpotLight | null = null;
/**
* @en Luminous power of the light.
* @zh 光通量。
*/
@unit('lm')
@tooltip('i18n:lights.luminous_power')
get luminousPower () {
return this._luminance * scene.nt2lm(this._size);
}
set luminousPower (val) {
this._luminance = val / scene.nt2lm(this._size);
if (this._light) { this._light.luminance = this._luminance; }
}
/**
* @en Luminance of the light.
* @zh 光亮度。
*/
@unit('cd/m²')
@tooltip('i18n:lights.luminance')
get luminance () {
return this._luminance;
}
set luminance (val) {
this._luminance = val;
if (this._light) { this._light.luminance = val; }
}
/**
* @en The photometric term currently being used.
* @zh 当前使用的光度学计量单位。
*/
@type(PhotometricTerm)
@tooltip('i18n:lights.term')
get term () {
return this._term;
}
set term (val) {
this._term = val;
}
/**
* @en
* Size of the light.
* @zh
* 光源大小。
*/
@tooltip('i18n:lights.size')
get size () {
return this._size;
}
set size (val) {
this._size = val;
if (this._light) { this._light.size = val; }
}
/**
* @en
* Range of the light.
* @zh
* 光源范围。
*/
@tooltip('i18n:lights.range')
get range () {
return this._range;
}
set range (val) {
this._range = val;
if (this._light) { this._light.range = val; }
}
/**
* @en
* The spot light cone angle.
* @zh
* 聚光灯锥角。
*/
@slide
@range([2, 180, 1])
@tooltip('The spot light cone angle')
get spotAngle () {
return this._spotAngle;
}
set spotAngle (val) {
this._spotAngle = val;
if (this._light) { this._light.spotAngle = toRadian(val); }
}
constructor () {
super();
this._lightType = scene.SpotLight;
}
protected _createLight () {
super._createLight();
if (!this._light) { return; }
this.luminance = this._luminance;
this.size = this._size;
this.range = this._range;
this.spotAngle = this._spotAngle;
}
}