Package | laya.d3.core.light |
Class | public class LightSprite |
Inheritance | LightSprite Sprite3D ComponentNode Node EventDispatcher Object |
Subclasses | DirectionLight, PointLight, SpotLight |
LightSprite
类用于创建灯光的父类。
Property | Defined By | ||
---|---|---|---|
active : Boolean
获取自身是否激活。
| Sprite3D | ||
activeInHierarchy : Boolean [read-only]
获取在场景中是否激活。
| Sprite3D | ||
color : Vector3 灯光颜色。 | LightSprite | ||
componentsCount : int [read-only]
获得组件的数量。
| Sprite3D | ||
destroyed : Boolean [只读]是否已经销毁。对象销毁后不能再使用。 | Node | ||
diffuseColor : Vector3
获取灯光的漫反射颜色。
| LightSprite | ||
displayedInStage : Boolean [read-only] 表示是否在显示列表中显示。 | Node | ||
id : int [read-only]
获取唯一标识ID。
| Sprite3D | ||
isStatic : Boolean 是否静态,静态包含一系列的静态处理。 | Sprite3D | ||
layer : Layer
获取蒙版。
| Sprite3D | ||
lightType : int [read-only]
获取灯光的类型。
| LightSprite | ||
loaded : Boolean [read-only]
获取是否已加载完成。
| Sprite3D | ||
name : String 节点名称。 | Node | ||
numChildren : int [read-only]
子对象数量。
| Node | ||
parent : Node 父节点。 | Node | ||
scene : Scene [read-only]
获得所属场景。
| Sprite3D | ||
shadow : Boolean
获取是否产生阴影。
| LightSprite | ||
shadowDistance : Number
获取阴影最远范围。
| LightSprite | ||
shadowPCFType : int
获取阴影PCF类型。
| LightSprite | ||
shadowPSSMCount : int
获取阴影分段数。
| LightSprite | ||
shadowResolution : Number
获取阴影贴图尺寸。
| LightSprite | ||
timer : Timer 时间控制器,默认为Laya.timer。 | Node | ||
transform : Transform3D [read-only]
获取精灵变换。
| Sprite3D | ||
url : String
获取资源的URL地址。
| Sprite3D |
Method | Defined By | ||
---|---|---|---|
创建一个 LightSprite 实例。
| LightSprite | ||
排序函数。
| Sprite3D | ||
_update(state:RenderState):void
更新
| Sprite3D | ||
_updateConch(state:RenderState):void
更新
| Sprite3D | ||
[override]
添加子节点。
| Sprite3D | ||
[override]
添加子节点到指定的索引位置。
| Sprite3D | ||
addChildren(... args):void
批量增加子节点
| Node | ||
addComponent(type:*):Component3D
添加指定类型组件。
| Sprite3D | ||
clearTimer(caller:*, method:Function):void
清理定时器。功能同Laya.timer.clearTimer()。
| Node | ||
clone():*
克隆。
| Sprite3D | ||
cloneTo(destObject:*):void
克隆。
| Sprite3D | ||
当前容器是否包含指定的 Node 节点对象 。
| Node | ||
destroy(destroyChild:Boolean = true):void [override]
销毁此对象。destroy对象默认会把自己从父节点移除,并且清理自身引用关系,等待js自动垃圾回收机制回收。destroy后不能再使用。
destroy时会移除自身的事情监听,自身的timer监听,移除子对象及从父节点移除自己。
| Sprite3D | ||
destroyChildren():void
销毁所有子对象,不销毁自己本身。
| Node | ||
event(type:String, data:* = null):Boolean
派发事件。
| EventDispatcher | ||
frameLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时重复执行某函数(基于帧率)。功能同Laya.timer.frameLoop()。
| Node | ||
frameOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时执行一次某函数(基于帧率)。功能同Laya.timer.frameOnce()。
| Node | ||
getChildAt(index:int):Node
根据子节点的索引位置,获取子节点对象。
| Node | ||
getChildByName(name:String):Node
根据子节点的名字,获取子节点对象。
| Node | ||
getChildIndex(node:Node):int
根据子节点对象,获取子节点的索引位置。
| Node | ||
getComponentByIndex(index:int):Component3D
通过指定索引获得组件。
| Sprite3D | ||
getComponentByType(type:*, typeIndex:int = 0):Component3D
通过指定类型和类型索引获得组件。
| Sprite3D | ||
getComponentsByType(type:*, components:Vector.<Component3D>):void
通过指定类型获得所有组件。
| Sprite3D | ||
获取投影视图世界矩阵。
| Sprite3D | ||
hasListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
| EventDispatcher | ||
instantiate(original:Sprite3D, parent:Node = null, worldPositionStays:Boolean = true, position:Vector3 = null, rotation:Quaternion = null):Sprite3D [static]
创建精灵的克隆实例。
| Sprite3D | ||
isMouseEvent(type:String):Boolean
检测指定事件类型是否是鼠标事件。
| EventDispatcher | ||
[static]
加载网格模板,注意:不缓存。
| Sprite3D | ||
loadHierarchy(url:String):void
加载层级文件,并作为该节点的子节点。
| Sprite3D | ||
off(type:String, caller:*, listener:Function, onceOnly:Boolean = false):EventDispatcher
从 EventDispatcher 对象中删除侦听器。
| EventDispatcher | ||
offAll(type:String = null):EventDispatcher
从 EventDispatcher 对象中删除指定事件类型的所有侦听器。
| EventDispatcher | ||
on(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher [override]
增加事件侦听器,以使侦听器能够接收事件通知。
如果侦听鼠标事件,则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false,则停止设置父节点mouseEnabled属性)。
| Node | ||
onAsynLoaded(url:String, data:*, params:Array):void
private
| Sprite3D | ||
once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher [override]
增加事件侦听器,以使侦听器能够接收事件通知,此侦听事件响应一次后则自动移除侦听。
如果侦听鼠标事件,则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false,则停止设置父节点mouseEnabled属性)。
| Node | ||
removeAllComponent():void
移除全部组件。
| Sprite3D | ||
删除子节点。
| Node | ||
removeChildAt(index:int):Node [override]
根据子节点索引位置,删除对应的子节点对象。
| Sprite3D | ||
removeChildByName(name:String):Node
根据子节点名字删除对应的子节点对象,如果找不到不会抛出异常。
| Node | ||
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):Node [override]
删除指定索引区间的所有子对象。
| Sprite3D | ||
removeComponentByType(type:*, typeIndex:int = 0):void
通过指定类型和类型索引移除组件。
| Sprite3D | ||
removeComponentsByType(type:*):void
通过指定类型移除所有组件。
| Sprite3D | ||
从父容器删除自己,如已经被删除不会抛出异常。
| Node | ||
替换子节点。
| Node | ||
设置子节点的索引位置。
| Node | ||
timerLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true, jumpFrame:Boolean = false):void
定时重复执行某函数。功能同Laya.timer.timerLoop()。
| Node | ||
timerOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时执行某函数一次。功能同Laya.timer.timerOnce()。
| Node | ||
updateToWorldState(state:RenderState):Boolean
更新灯光相关渲染状态参数。
| LightSprite |
Method | Defined By | ||
---|---|---|---|
_addSelfRenderObjects():void [override]
添加自身渲染物体,请重载此函数。
| LightSprite | ||
_clearSelfRenderObjects():void [override]
清理自身渲染物体,请重载此函数。
| LightSprite | ||
_parseCustomProps(rootNode:ComponentNode, innerResouMap:Object, customProps:Object, nodeData:Object):void
private
| Sprite3D | ||
_updateChilds(state:RenderState):void
更新子节点。
| Sprite3D | ||
_updateChildsConch(state:RenderState):void
更新子节点。
| Sprite3D |
Constant | Defined By | ||
---|---|---|---|
TYPE_DIRECTIONLIGHT : int = 1 [static] 定义平行光类型的标记。 | LightSprite | ||
TYPE_POINTLIGHT : int = 2 [static] 定义点光类型的标记。 | LightSprite | ||
TYPE_SPOTLIGHT : int = 3 [static] 定义聚光类型的标记。 | LightSprite |
color | property |
public var color:Vector3
灯光颜色。
diffuseColor | property |
diffuseColor:Vector3
获取灯光的漫反射颜色。
public function get diffuseColor():Vector3
public function set diffuseColor(value:Vector3):void
lightType | property |
lightType:int
[read-only] 获取灯光的类型。
public function get lightType():int
shadow | property |
shadow:Boolean
获取是否产生阴影。
public function get shadow():Boolean
public function set shadow(value:Boolean):void
shadowDistance | property |
shadowDistance:Number
获取阴影最远范围。
public function get shadowDistance():Number
public function set shadowDistance(value:Number):void
shadowPCFType | property |
shadowPCFType:int
获取阴影PCF类型。
public function get shadowPCFType():int
public function set shadowPCFType(value:int):void
shadowPSSMCount | property |
shadowPSSMCount:int
获取阴影分段数。
public function get shadowPSSMCount():int
public function set shadowPSSMCount(value:int):void
shadowResolution | property |
shadowResolution:Number
获取阴影贴图尺寸。
public function get shadowResolution():Number
public function set shadowResolution(value:Number):void
LightSprite | () | Constructor |
public function LightSprite()
创建一个 LightSprite
实例。
_addSelfRenderObjects | () | method |
override protected function _addSelfRenderObjects():void
添加自身渲染物体,请重载此函数。
_clearSelfRenderObjects | () | method |
override protected function _clearSelfRenderObjects():void
清理自身渲染物体,请重载此函数。
updateToWorldState | () | method |
public function updateToWorldState(state:RenderState):Boolean
更新灯光相关渲染状态参数。
Parameters
state:RenderState — 渲染状态参数。
|
Boolean |
TYPE_DIRECTIONLIGHT | Constant |
public static const TYPE_DIRECTIONLIGHT:int = 1
定义平行光类型的标记。
TYPE_POINTLIGHT | Constant |
public static const TYPE_POINTLIGHT:int = 2
定义点光类型的标记。
TYPE_SPOTLIGHT | Constant |
public static const TYPE_SPOTLIGHT:int = 3
定义聚光类型的标记。