abstract light~Light(options)

所有光源的父类,是抽象类,所有可以发出光线的物体都可以看做是光源,如太阳,白炽灯,手电筒,开启的电脑屏幕等,光源作为增强场景效果的一种手段,结合受光材质可以营造出丰富的显示效果。
光源分为两类:
1,精准光源,包括DirectionLight,PointLight,SpotLight三种,添加方式是通过Map#addLight接口
2,环境光源,包括Environment,AmbientLight两种,添加方式是通过Map#setEnvironment接口进行

Summary

Methods:
getColor

获取光照颜色

getDirection

获取当前光照方向,针对点光源和聚光灯

getId

获取光源的id

getIntensity

获取光照强度

getMaxDistance

获取光照最大距离,点光源和聚光灯有效

getPosition

光照位置坐标数组

getTarget

目标点坐标数组

setColor

设置光照颜色

setDecay

设置聚光灯和点光源的衰减参数

setDirection

光照方向

setInnerAngle

设置聚光灯夹角,光强度从内角往外角进行衰减

setIntensity

设置光照强度

setMaxDistance

设置聚光灯和点光源的最大距离

setOuterAngle

设置聚光灯夹角,光强度从内角往外角进行衰减

setPosition

光照位置

setShadowAntialiasing

开启或者关闭抗锯齿

setShadowBias

设置阴影偏移值,消除阴影马赫带

setShadowEnable

设置是否显示阴影

setTarget

光照目标点,用于计算光照方向

Constructor

new abstract Light(options)

基础光源构造函数

Parameters:
Name Type Description
options Object
Name Type Description
color module:style~Color

光线颜色,默认为白色

position Array.<Number>

光源的位置,限定于PointLight和SpotLight,DirectionLight没有位置

target Array.<Number>

光源照射的目标点坐标,限定于DirectionLight和SpotLight,跟options.position决定光线的方向,PointLight没有目标位置

intensity Number

光源的强度,默认值为1

enableShadow Boolean

开启光源阴影,默认为false,只针对点光源、平行光、聚光灯有效

antialiasing Boolean

是否开启阴影抗锯齿,默认为true,开启后阴影边界更加平滑,但资源消耗较高

shadowDarkness Number

阴影强度,默认0.4,范围[0,1]

shadowBias Number

阴影偏移,默认0.0015

Methods

getColor() → {module:style~Color}

获取光照颜色

Returns:
module:style~Color -

颜色类

getDirection() → {Array}

获取当前光照方向,针对点光源和聚光灯

Returns:
Array

getId() → {String}

获取光源的id

Returns:
String -

光源的id

getIntensity() → {Number}

获取光照强度

Returns:
Number -

intensity

getMaxDistance() → {Number}

获取光照最大距离,点光源和聚光灯有效

Returns:
Number

getPosition() → {Array}

光照位置坐标数组

Returns:
Array

getTarget() → {Array}

目标点坐标数组

Returns:
Array

setColor(颜色类)

设置光照颜色

Parameters:
Name Type Description
颜色类 module:style~Color

setDecay(decay)

设置聚光灯和点光源的衰减参数

Parameters:
Name Type Description
decay Number

衰减系数

setDirection(direction)

光照方向

Parameters:
Name Type Description
direction Array.<Number>

setInnerAngle(inner)

设置聚光灯夹角,光强度从内角往外角进行衰减

Parameters:
Name Type Description
inner Number

内角

setIntensity(intensity)

设置光照强度

Parameters:
Name Type Description
intensity Number

setMaxDistance(maxDistance)

设置聚光灯和点光源的最大距离

Parameters:
Name Type Description
maxDistance Number

最大距离

setOuterAngle(outer)

设置聚光灯夹角,光强度从内角往外角进行衰减

Parameters:
Name Type Description
outer Number

外角

setPosition(positions)

光照位置

Parameters:
Name Type Description
positions Array.<Number>

setShadowAntialiasing(value)

开启或者关闭抗锯齿

Parameters:
Name Type Description
value Boolean

ture开启 false关闭

setShadowBias(value)

设置阴影偏移值,消除阴影马赫带

Parameters:
Name Type Description
value Number

setShadowEnable(flag, darkness)

设置是否显示阴影

Parameters:
Name Type Description
flag Boolean
darkness Number

阴影强度

setTarget(target)

光照目标点,用于计算光照方向

Parameters:
Name Type Description
target Array.<Number>