Packagelaya.d3.core.scene
Classpublic class Scene
InheritanceScene Inheritance Sprite Inheritance Node Inheritance EventDispatcher Inheritance Object
Implements ISubmit, laya.resource.ICreateResource

BaseScene 类用于实现场景。



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
透明度,值为0-1,默认值为1,表示不透明。更改alpha值会影响drawcall。
Sprite
  ambientColor : Vector3
获取环境光颜色。
Scene
 InheritedautoSize : Boolean = false
指定是否自动计算宽高数据。默认值为 false 。 Sprite宽高默认为0,并且不会随着绘制内容的变化而变化,如果想根据绘制内容获取宽高,可以设置本属性为true,或者通过getBounds方法获取。设置为true,对性能有一定影响。
Sprite
 InheritedblendMode : String
指定要使用的混合模式。目前只支持"lighter"。
Sprite
 InheritedcacheAs : String
指定显示对象是否缓存为静态图像,cacheAs时,子对象发生变化,会自动重新缓存,同时也可以手动调用reCache方法更新缓存。 建议把不经常变化的“复杂内容”缓存为静态图像,能极大提高渲染性能。cacheAs有"none","normal"和"bitmap"三个值可选。 默认为"none",不做任何缓存。 当值为"normal"时,canvas模式下进行画布缓存,webgl模式下进行命令缓存。 当值为"bitmap"时,canvas模式下进行依然是画布缓存,webgl模式下使用renderTarget缓存。 webgl下renderTarget缓存模式缺点:会额外创建renderTarget对象,增加内存开销,缓存面积有最大2048限制,不断重绘时会增加CPU开销。优点:大幅减少drawcall,渲染性能最高。 webgl下命令缓存模式缺点:只会减少节点遍历及命令组织,不会减少drawcall数,性能中等。优点:没有额外内存开销,无需renderTarget支持。
Sprite
 InheritedcacheAsBitmap : Boolean
指定显示对象是否缓存为静态图像。功能同cacheAs的normal模式。建议优先使用cacheAs代替。
Sprite
 InheritedcustomRenderEnable : Boolean
[write-only] 设置是否开启自定义渲染,只有开启自定义渲染,才能使用customRender函数渲染。
Sprite
 Inheriteddestroyed : Boolean
[只读]是否已经销毁。对象销毁后不能再使用。
Node
 InheriteddisplayedInStage : Boolean
[read-only] 表示是否在显示列表中显示。
Node
  enableDepthFog : Boolean
Scene
  enableFog : Boolean
获取是否允许雾化。
Scene
  enableLight : Boolean = true
是否启用灯光。
Scene
 Inheritedfilters : Array
滤镜集合。可以设置多个滤镜组合。
Sprite
  fogColor : Vector3
获取雾化颜色。
Scene
  fogRange : Number
获取雾化范围。
Scene
  fogStart : Number
获取雾化起始位置。
Scene
 InheritedglobalScaleX : Number
[read-only] 获得相对于stage的全局X轴缩放值(会叠加父亲节点的缩放值)。
Sprite
 InheritedglobalScaleY : Number
[read-only] 获得相对于stage的全局Y轴缩放值(会叠加父亲节点的缩放值)。
Sprite
 Inheritedgraphics : Graphics
绘图对象。封装了绘制位图和矢量图的接口,Sprite所有的绘图操作都通过Graphics来实现的。
Sprite
 Inheritedheight : Number
显示对象的高度,单位为像素,默认为0。 此高度用于鼠标碰撞检测,并不影响显示对象图像大小。需要对显示对象的图像进行缩放,请使用scale、scaleX、scaleY。 可以通过getbounds获取显示对象图像的实际高度。
Sprite
 InheritedhitArea : *
可以设置一个Rectangle区域作为点击区域,或者设置一个HitArea实例作为点击区域,HitArea内可以设置可点击和不可点击区域。 如果不设置hitArea,则根据宽高形成的区域进行碰撞。
Sprite
 InheritedhitTestPrior : Boolean = false
指定鼠标事件检测是优先检测自身,还是优先检测其子对象。鼠标事件检测发生在鼠标事件的捕获阶段,此阶段引擎会从stage开始递归检测stage及其子对象,直到找到命中的目标对象或者未命中任何对象。 如果为false,优先检测子对象,当有子对象被命中时,中断检测,获得命中目标。如果未命中任何子对象,最后再检测此对象;如果为true,则优先检测本对象,如果本对象没有被命中,直接中断检测,表示没有命中目标;如果本对象被命中,则进一步递归检测其子对象,以确认最终的命中目标。 合理使用本属性,能减少鼠标事件检测的节点,提高性能。可以设置为true的情况:开发者并不关心此节点的子节点的鼠标事件检测结果,也就是以此节点作为其子节点的鼠标事件检测依据。 Stage对象和UI的View组件默认为true。
Sprite
  loaded : Boolean
[read-only] 获取是否已加载完成。
Scene
 Inheritedmask : Sprite
遮罩,可以设置一个对象(支持位图和矢量图),根据对象形状进行遮罩显示。 【注意】遮罩对象坐标系是相对遮罩对象本身的,和Flash机制不同
Sprite
 InheritedmouseEnabled : Boolean
是否接受鼠标事件。 默认为false,如果监听鼠标事件,则会自动设置本对象及父节点的属性 mouseEnable 的值都为 true(如果父节点手动设置为false,则不会更改)。
Sprite
 InheritedmouseThrough : Boolean = false
鼠标事件与此对象的碰撞检测是否可穿透。碰撞检测发生在鼠标事件的捕获阶段,此阶段引擎会从stage开始递归检测stage及其子对象,直到找到命中的目标对象或者未命中任何对象。 穿透表示鼠标事件发生的位置处于本对象绘图区域内时,才算命中,而与对象宽高和值为Rectangle对象的hitArea属性无关。如果sprite.hitArea值是HitArea对象,表示显式声明了此对象的鼠标事件响应区域,而忽略对象的宽高、mouseThrough属性。 影响对象鼠标事件响应区域的属性为:width、height、hitArea,优先级顺序为:hitArea(type:HitArea)>hitArea(type:Rectangle)>width/height。
Sprite
 InheritedmouseX : Number
[read-only] 返回鼠标在此对象坐标系上的 X 轴坐标信息。
Sprite
 InheritedmouseY : Number
[read-only] 返回鼠标在此对象坐标系上的 Y 轴坐标信息。
Sprite
 Inheritedname : String
节点名称。
Node
 InheritednumChildren : int
[read-only] 子对象数量。
Node
 InheritedoptimizeScrollRect : Boolean
指定是否对使用了 scrollRect 的显示对象进行优化处理。默认为false(不优化)。 当值为ture时:将对此对象使用了scrollRect 设定的显示区域以外的显示内容不进行渲染,以提高性能(如果子对象有旋转缩放或者中心点偏移,则显示筛选会不精确)。
Sprite
  parallelSplitShadowMaps : Vector.<ParallelSplitShadowMap>
Scene
 Inheritedparent : Node
[override]
Sprite
 InheritedpivotX : Number
X轴 轴心点的位置,单位为像素,默认为0。轴心点会影响对象位置,缩放中心,旋转中心。
Sprite
 InheritedpivotY : Number
Y轴 轴心点的位置,单位为像素,默认为0。轴心点会影响对象位置,缩放中心,旋转中心。
Sprite
  renderableSprite3Ds : Vector.<RenderableSprite3D>
[read-only] 获取场景的可渲染精灵。
Scene
 Inheritedrotation : Number
旋转角度,默认值为0。以角度为单位。
Sprite
 InheritedscaleX : Number
X轴缩放值,默认值为1。设置为负数,可以实现水平反转效果,比如scaleX=-1。
Sprite
 InheritedscaleY : Number
Y轴缩放值,默认值为1。设置为负数,可以实现垂直反转效果,比如scaleX=-1。
Sprite
  scene : Scene
[read-only] 获取当前场景。
Scene
 InheritedscrollRect : Rectangle
显示对象的滚动矩形范围,具有裁剪效果(如果只想限制子对象渲染区域,请使用viewport),设置optimizeScrollRect=true,可以优化裁剪区域外的内容不进行渲染。 srollRect和viewport的区别: 1.srollRect自带裁剪效果,viewport只影响子对象渲染是否渲染,不具有裁剪效果(性能更高)。 2.设置rect的x,y属性均能实现区域滚动效果,但scrollRect会保持0,0点位置不变。
Sprite
 InheritedskewX : Number
水平倾斜角度,默认值为0。以角度为单位。
Sprite
 InheritedskewY : Number
垂直倾斜角度,默认值为0。以角度为单位。
Sprite
 Inheritedstage : Stage
[read-only] 对舞台 stage 的引用。
Sprite
 InheritedstaticCache : Boolean
是否静态缓存此对象的当前帧的最终属性。为 true 时,子对象变化时不会自动更新缓存,但是可以通过调用 reCache 方法手动刷新。 注意: 1.
Sprite
 Inheritedtexture : Texture
设置一个Texture实例,并显示此图片(如果之前有其他绘制,则会被清除掉)。等同于graphics.clear();graphics.drawTexture()
Sprite
 Inheritedtimer : Timer
时间控制器,默认为Laya.timer。
Node
 Inheritedtransform : Matrix
对象的矩阵信息。通过设置矩阵可以实现节点旋转,缩放,位移效果。 矩阵更多信息请参考 Matrix
Sprite
  treeLevel : int
四/八叉树的层数。
Scene
  treeRoot : ITreeNode
四/八叉树的根节点。
Scene
  treeSize : Vector3
四/八叉树的尺寸。
Scene
  url : String
获取资源的URL地址。
Scene
 Inheritedviewport : Rectangle = null
视口大小,视口外的子对象,将不被渲染(如果想实现裁剪效果,请使用srollRect),合理使用能提高渲染性能。比如由一个个小图片拼成的地图块,viewport外面的小图片将不渲染 srollRect和viewport的区别: 1.
Sprite
 Inheritedvisible : Boolean
表示是否可见,默认为true。如果设置不可见,节点将不被渲染。
Sprite
 Inheritedwidth : Number
显示对象的宽度,单位为像素,默认为0。 此宽度用于鼠标碰撞检测,并不影响显示对象图像大小。需要对显示对象的图像进行缩放,请使用scale、scaleX、scaleY。 可以通过getbounds获取显示对象图像的实际宽度。
Sprite
 Inheritedx : Number
表示显示对象相对于父容器的水平方向坐标值。
Sprite
 Inheritedy : Number
表示显示对象相对于父容器的垂直方向坐标值。
Sprite
 InheritedzOrder : Number
z排序,更改此值,则会按照值的大小对同一容器的所有对象重新排序。值越大,越靠上。默认为0,则根据添加顺序排序。
Sprite
Public Methods
 MethodDefined By
  
创建一个 Scene 实例。
Scene
  
[override] 添加子节点。
Scene
  
addChildAt(node:Node, index:int):Node
[override] 添加子节点到指定的索引位置。
Scene
 Inherited
addChildren(... args):void
批量增加子节点
Node
  
Scene
  
添加渲染队列。
Scene
  
添加指定类型脚本。
Scene
  
addShaderDefine(define:int):void
增加shader宏定义。
Scene
 Inherited
clearTimer(caller:*, method:Function):void
清理定时器。功能同Laya.timer.clearTimer()。
Node
 Inherited
contains(node:Node):Boolean
当前容器是否包含指定的 Node 节点对象 。
Node
 Inherited
customRender(context:RenderContext, x:Number, y:Number):void
自定义更新、呈现显示对象。一般用来扩展渲染模式,请合理使用,可能会导致在加速器上无法渲染。 注意不要在此函数内增加或删除树节点,否则会对树节点遍历造成影响。
Sprite
  
destroy(destroyChild:Boolean = true):void
[override] private
Scene
 Inherited
销毁所有子对象,不销毁自己本身。
Node
 Inherited
drawToCanvas(canvasWidth:Number, canvasHeight:Number, offsetX:Number, offsetY:Number):HTMLCanvas
绘制 当前Sprite 到 Canvas 上,并返回一个HtmlCanvas。 绘制的结果可以当作图片源,再次绘制到其他Sprite里面,示例: var htmlCanvas:HTMLCanvas = sprite.drawToCanvas(100, 100, 0, 0);//把精灵绘制到canvas上面 var texture:Texture = new Texture(htmlCanvas);//使用htmlCanvas创建Texture var sp:Sprite = new Sprite().pos(0, 200);//创建精灵并把它放倒200位置 sp.graphics.drawTexture(texture);//把截图绘制到精灵上 Laya.stage.addChild(sp);//把精灵显示到舞台 也可以获取原始图片数据,分享到网上,从而实现截图效果,示例: var htmlCanvas:HTMLCanvas = sprite.drawToCanvas(100, 100, 0, 0);//把精灵绘制到canvas上面 var canvas:= htmlCanvas.getCanvas();//获取原生的canvas对象 trace(canvas.toDataURL("image/png"));//打印图片base64信息,可以发给服务器或者保存为图片
Sprite
 Inherited
event(type:String, data:* = null):Boolean
派发事件。
EventDispatcher
 Inherited
frameLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时重复执行某函数(基于帧率)。功能同Laya.timer.frameLoop()。
Node
 Inherited
frameOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时执行一次某函数(基于帧率)。功能同Laya.timer.frameOnce()。
Node
 Inherited
fromImage(url:String):Sprite
[static] 根据图片地址创建一个新的 Sprite 对象用于加载并显示此图片。
Sprite
 Inherited
将父容器坐标系坐标转换到本地坐标系。
Sprite
 Inherited
获取本对象在父容器坐标系的矩形显示区域。 注意: 1.计算量较大,尽量少用,如果需要频繁使用,可以通过手动设置 setBounds 来缓存自身边界信息,从而避免比较消耗性能的计算。2.
Sprite
 Inherited
getChildAt(index:int):Node
根据子节点的索引位置,获取子节点对象。
Node
 Inherited
getChildByName(name:String):Node
根据子节点的名字,获取子节点对象。
Node
 Inherited
根据子节点对象,获取子节点的索引位置。
Node
 Inherited
getGraphicBounds(realSize:Boolean = false):Rectangle
返回此实例中的绘图对象( Graphics )的显示区域,不包括子对象。
Sprite
  
获取光照贴图。
Scene
 Inherited
获得相对于本对象上的鼠标坐标信息。
Sprite
  
getRenderQueue(index:int):RenderQueue
获得某个渲染队列。
Scene
  
通过指定索引获得脚本。
Scene
  
getScriptByType(type:*, typeIndex:int = 0):Script
通过指定类型和类型索引获得脚本。
Scene
  
getScriptsByType(type:*, scripts:Vector.<Script>):void
通过指定类型获得所有脚本。
Scene
 Inherited
获取对象在自身坐标系的边界范围。与 setBounds 对应。 注意:计算量较大,尽量少用,如果需要频繁使用,可以提前手动设置 setBounds 来缓存自身边界信息,从而避免比较消耗性能的计算。
Sprite
 Inherited
globalToLocal(point:Point, createNewPoint:Boolean = false):Point
把stage的全局坐标转换为本地坐标。
Sprite
 Inherited
hasListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
EventDispatcher
 Inherited
hitTestPoint(x:Number, y:Number):Boolean
检测某个点是否在此对象内。
Sprite
  
initOctree(width:int, height:int, depth:int, center:Vector3, level:int = 6):void
初始化八叉树。
Scene
 Inherited
isMouseEvent(type:String):Boolean
检测指定事件类型是否是鼠标事件。
EventDispatcher
  
load(url:String):Scene
[static] 加载场景,注意:不缓存。
Scene
 Inherited
loadImage(url:String, x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0, complete:Handler = null):Sprite
加载并显示一个图片。功能等同于graphics.loadImage方法。支持异步加载。 注意:多次调用loadImage绘制不同的图片,会同时显示。
Sprite
 Inherited
localToGlobal(point:Point, createNewPoint:Boolean = false):Point
把本地坐标转换为相对stage的全局坐标。
Sprite
 Inherited
off(type:String, caller:*, listener:Function, onceOnly:Boolean = false):EventDispatcher
从 EventDispatcher 对象中删除侦听器。
EventDispatcher
 Inherited
offAll(type:String = null):EventDispatcher
从 EventDispatcher 对象中删除指定事件类型的所有侦听器。
EventDispatcher
 Inherited
on(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
[override] 增加事件侦听器,以使侦听器能够接收事件通知。 如果侦听鼠标事件,则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false,则停止设置父节点mouseEnabled属性)。
Sprite
  
onAsynLoaded(url:String, data:*, params:Array):void
private
Scene
 Inherited
once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
[override] 增加事件侦听器,以使侦听器能够接收事件通知,此侦听事件响应一次后则自动移除侦听。 如果侦听鼠标事件,则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false,则停止设置父节点mouseEnabled属性)。
Sprite
 Inherited
cacheAs时,设置所有父对象缓存失效。
Sprite
 Inherited
pivot(x:Number, y:Number):Sprite
设置轴心点。相当于分别设置pivotX和pivotY属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.pivot(...).pos(...);
Sprite
 Inherited
pos(x:Number, y:Number, speedMode:Boolean = false):Sprite
设置坐标位置。相当于分别设置x和y属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.pos(...).scale(...);
Sprite
 Inherited
reCache():void
在设置cacheAs的情况下,调用此方法会重新刷新缓存。
Sprite
  
移除全部脚本。
Scene
 Inherited
删除子节点。
Node
  
removeChildAt(index:int):Node
[override] 根据子节点索引位置,删除对应的子节点对象。
Scene
 Inherited
removeChildByName(name:String):Node
根据子节点名字删除对应的子节点对象,如果找不到不会抛出异常。
Node
  
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):Node
[override] 删除指定索引区间的所有子对象。
Scene
  
removeScriptByType(type:*, typeIndex:int = 0):void
通过指定类型和类型索引移除脚本。
Scene
  
removeScriptsByType(type:*):void
通过指定类型移除所有脚本。
Scene
 Inherited
从父容器删除自己,如已经被删除不会抛出异常。
Node
  
removeShaderDefine(define:int):void
移除shader宏定义。
Scene
 Inherited
render(context:RenderContext, x:Number, y:Number):void
更新、呈现显示对象。由系统调用。
Sprite
 Inherited
repaint():void
cacheAs后,设置自己和父对象缓存失效。
Sprite
 Inherited
replaceChild(newNode:Node, oldNode:Node):Node
替换子节点。
Node
 Inherited
scale(scaleX:Number, scaleY:Number, speedMode:Boolean = false):Sprite
设置缩放。相当于分别设置scaleX和scaleY属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.scale(...).pos(...);
Sprite
 Inherited
setBounds(bound:Rectangle):void
设置对象在自身坐标系下的边界范围。与 getSelfBounds 对应。当 autoSize==true 时,会影响对象宽高。设置后,当需要获取自身边界范围时,就不再需要计算,合理使用能提高性能。比如 getBounds 会优先使用 setBounds 指定的值,如果没有指定则进行计算,此计算会对性能消耗比较大。 注意: setBounds 与 getBounds 并非对应相等关系, getBounds 获取的是本对象在父容器坐标系下的边界范围,通过设置 setBounds 会影响 getBounds 的结果。
Sprite
 Inherited
setChildIndex(node:Node, index:int):Node
设置子节点的索引位置。
Node
  
setlightmaps(value:Vector.<Texture2D>):void
设置光照贴图。
Scene
 Inherited
size(width:Number, height:Number):Sprite
设置宽高。相当于分别设置width和height属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.size(...).pos(...);
Sprite
 Inherited
skew(skewX:Number, skewY:Number):Sprite
设置倾斜角度。相当于分别设置skewX和skewY属性。 因为返回值为Sprite对象本身,所以可以使用如下语法:spr.skew(...).pos(...);
Sprite
 Inherited
startDrag(area:Rectangle = null, hasInertia:Boolean = false, elasticDistance:Number = 0, elasticBackTime:int = 300, data:* = null, disableMouseEvent:Boolean = false, ratio:Number = 0.92):void
开始拖动此对象。
Sprite
 Inherited
stopDrag():void
停止拖动此对象。
Sprite
 Inherited
timerLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true, jumpFrame:Boolean = false):void
定时重复执行某函数。功能同Laya.timer.timerLoop()。
Node
 Inherited
timerOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时执行某函数一次。功能同Laya.timer.timerOnce()。
Node
 Inherited
将本地坐标系坐标转转换到父容器坐标系。
Sprite
 Inherited
根据zOrder进行重新排序。
Sprite
Protected Methods
 MethodDefined By
  
_parseCustomProps(rootNode:ComponentNode, innerResouMap:Object, customProps:Object, nodeData:Object):void
private
Scene
Events
 Event Summary Defined By
 Inherited添加到父对象后调度。Node
 Inherited鼠标点击对象后调度。Sprite
 Inherited加入节点树时调度。Node
 Inherited拖动结束后调度。Sprite
 Inherited拖动中调度。Sprite
 Inherited开始拖动后调度。Sprite
 Inherited在显示对象上按下后调度。Sprite
 Inherited鼠标在对象身上进行移动后调度Sprite
 Inherited鼠标离开对象后调度。Sprite
 Inherited鼠标经过对象后调度。Sprite
 Inherited在显示对象抬起后调度。Sprite
 Inherited被父对象移除后调度。Node
 Inherited从节点树移除时调度。Node
Public Constants
 ConstantDefined By
  AMBIENTCOLOR : int = 21
[static]
Scene
  FOGCOLOR : int = 0
[static]
Scene
  FOGRANGE : int = 2
[static]
Scene
  FOGSTART : int = 1
[static]
Scene
  LIGHTDIRCOLOR : int = 4
[static]
Scene
  LIGHTDIRECTION : int = 3
[static]
Scene
  POINTLIGHTATTENUATION : int = 7
[static]
Scene
  POINTLIGHTCOLOR : int = 8
[static]
Scene
  POINTLIGHTPOS : int = 5
[static]
Scene
  POINTLIGHTRANGE : int = 6
[static]
Scene
  SHADOWDISTANCE : int = 15
[static]
Scene
  SHADOWLIGHTVIEWPROJECT : int = 16
[static]
Scene
  SHADOWMAPPCFOFFSET : int = 17
[static]
Scene
  SHADOWMAPTEXTURE1 : int = 18
[static]
Scene
  SHADOWMAPTEXTURE2 : int = 19
[static]
Scene
  SHADOWMAPTEXTURE3 : int = 20
[static]
Scene
  SPOTLIGHTATTENUATION : int = 13
[static]
Scene
  SPOTLIGHTCOLOR : int = 14
[static]
Scene
  SPOTLIGHTDIRECTION : int = 10
[static]
Scene
  SPOTLIGHTPOS : int = 9
[static]
Scene
  SPOTLIGHTRANGE : int = 12
[static]
Scene
  SPOTLIGHTSPOT : int = 11
[static]
Scene
Property Detail
ambientColorproperty
ambientColor:Vector3

获取环境光颜色。


Implementation
    public function get ambientColor():Vector3
    public function set ambientColor(value:Vector3):void
enableDepthFogproperty 
enableDepthFog:Boolean


Implementation
    public function get enableDepthFog():Boolean
    public function set enableDepthFog(value:Boolean):void
enableFogproperty 
enableFog:Boolean

获取是否允许雾化。


Implementation
    public function get enableFog():Boolean
    public function set enableFog(value:Boolean):void
enableLightproperty 
public var enableLight:Boolean = true

是否启用灯光。

fogColorproperty 
fogColor:Vector3

获取雾化颜色。


Implementation
    public function get fogColor():Vector3
    public function set fogColor(value:Vector3):void
fogRangeproperty 
fogRange:Number

获取雾化范围。


Implementation
    public function get fogRange():Number
    public function set fogRange(value:Number):void
fogStartproperty 
fogStart:Number

获取雾化起始位置。


Implementation
    public function get fogStart():Number
    public function set fogStart(value:Number):void
loadedproperty 
loaded:Boolean  [read-only]

获取是否已加载完成。


Implementation
    public function get loaded():Boolean
parallelSplitShadowMapsproperty 
public var parallelSplitShadowMaps:Vector.<ParallelSplitShadowMap>

renderableSprite3Dsproperty 
renderableSprite3Ds:Vector.<RenderableSprite3D>  [read-only]

获取场景的可渲染精灵。


Implementation
    public function get renderableSprite3Ds():Vector.<RenderableSprite3D>
sceneproperty 
scene:Scene  [read-only]

获取当前场景。


Implementation
    public function get scene():Scene
treeLevelproperty 
public var treeLevel:int

四/八叉树的层数。

treeRootproperty 
public var treeRoot:ITreeNode

四/八叉树的根节点。

treeSizeproperty 
public var treeSize:Vector3

四/八叉树的尺寸。

urlproperty 
url:String

获取资源的URL地址。


Implementation
    public function get url():String
    public function set url(value:String):void
Constructor Detail
Scene()Constructor
public function Scene()

创建一个 Scene 实例。

Method Detail
_parseCustomProps()method
protected function _parseCustomProps(rootNode:ComponentNode, innerResouMap:Object, customProps:Object, nodeData:Object):void

private

Parameters

rootNode:ComponentNode
 
innerResouMap:Object
 
customProps:Object
 
nodeData:Object

addChild()method 
override public function addChild(node:Node):Node

添加子节点。

Parameters

node:Node — 节点对象

Returns
Node — 返回添加的节点
addChildAt()method 
override public function addChildAt(node:Node, index:int):Node

添加子节点到指定的索引位置。

Parameters

node:Node — 节点对象。
 
index:int — 索引位置。

Returns
Node — 返回添加的节点。
addFrustumCullingObject()method 
public function addFrustumCullingObject(renderObject:BaseRender):void

Parameters

renderObject:BaseRender

addRenderQuene()method 
public function addRenderQuene():void

添加渲染队列。

addScript()method 
public function addScript(type:*):Script

添加指定类型脚本。

Parameters

type:* — 脚本类型。

Returns
Script — 组件。
addShaderDefine()method 
public function addShaderDefine(define:int):void

增加shader宏定义。

Parameters

define:int — shader宏定义。

destroy()method 
override public function destroy(destroyChild:Boolean = true):void

private

Parameters

destroyChild:Boolean (default = true)

getlightmaps()method 
public function getlightmaps():Vector.<Texture2D>

获取光照贴图。

Returns
Vector.<Texture2D> — 获取光照贴图。
getRenderQueue()method 
public function getRenderQueue(index:int):RenderQueue

获得某个渲染队列。

Parameters

index:int — 渲染队列索引。

Returns
RenderQueue — 渲染队列。
getScriptByIndex()method 
public function getScriptByIndex(index:int):Script

通过指定索引获得脚本。

Parameters

index:int — 索引。

Returns
Script — 脚本。
getScriptByType()method 
public function getScriptByType(type:*, typeIndex:int = 0):Script

通过指定类型和类型索引获得脚本。

Parameters

type:* — 脚本类型。
 
typeIndex:int (default = 0) — 脚本索引。

Returns
Script — 脚本。
getScriptsByType()method 
public function getScriptsByType(type:*, scripts:Vector.<Script>):void

通过指定类型获得所有脚本。

Parameters

type:* — 脚本类型。
 
scripts:Vector.<Script> — 脚本输出队列。

initOctree()method 
public function initOctree(width:int, height:int, depth:int, center:Vector3, level:int = 6):void

初始化八叉树。

Parameters

width:int — 八叉树宽度。
 
height:int — 八叉树高度。
 
depth:int — 八叉树深度。
 
center:Vector3 — 八叉树中心点
 
level:int (default = 6) — 八叉树层级。

load()method 
public static function load(url:String):Scene

加载场景,注意:不缓存。

Parameters

url:String — 模板地址。

Returns
Scene
onAsynLoaded()method 
public function onAsynLoaded(url:String, data:*, params:Array):void

private

Parameters

url:String
 
data:*
 
params:Array

removeAllScript()method 
public function removeAllScript():void

移除全部脚本。

removeChildAt()method 
override public function removeChildAt(index:int):Node

根据子节点索引位置,删除对应的子节点对象。

Parameters

index:int — 节点索引位置。

Returns
Node — 被删除的节点。
removeChildren()method 
override public function removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):Node

删除指定索引区间的所有子对象。

Parameters

beginIndex:int (default = 0) — 开始索引。
 
endIndex:int (default = 0x7fffffff) — 结束索引。

Returns
Node — 当前节点对象。
removeScriptByType()method 
public function removeScriptByType(type:*, typeIndex:int = 0):void

通过指定类型和类型索引移除脚本。

Parameters

type:* — 脚本类型。
 
typeIndex:int (default = 0) — 类型索引。

removeScriptsByType()method 
public function removeScriptsByType(type:*):void

通过指定类型移除所有脚本。

Parameters

type:* — 组件类型。

removeShaderDefine()method 
public function removeShaderDefine(define:int):void

移除shader宏定义。

Parameters

define:int — shader宏定义。

setlightmaps()method 
public function setlightmaps(value:Vector.<Texture2D>):void

设置光照贴图。

Parameters

value:Vector.<Texture2D> — 光照贴图。

Constant Detail
AMBIENTCOLORConstant
public static const AMBIENTCOLOR:int = 21

FOGCOLORConstant 
public static const FOGCOLOR:int = 0

FOGRANGEConstant 
public static const FOGRANGE:int = 2

FOGSTARTConstant 
public static const FOGSTART:int = 1

LIGHTDIRCOLORConstant 
public static const LIGHTDIRCOLOR:int = 4

LIGHTDIRECTIONConstant 
public static const LIGHTDIRECTION:int = 3

POINTLIGHTATTENUATIONConstant 
public static const POINTLIGHTATTENUATION:int = 7

POINTLIGHTCOLORConstant 
public static const POINTLIGHTCOLOR:int = 8

POINTLIGHTPOSConstant 
public static const POINTLIGHTPOS:int = 5

POINTLIGHTRANGEConstant 
public static const POINTLIGHTRANGE:int = 6

SHADOWDISTANCEConstant 
public static const SHADOWDISTANCE:int = 15

SHADOWLIGHTVIEWPROJECTConstant 
public static const SHADOWLIGHTVIEWPROJECT:int = 16

SHADOWMAPPCFOFFSETConstant 
public static const SHADOWMAPPCFOFFSET:int = 17

SHADOWMAPTEXTURE1Constant 
public static const SHADOWMAPTEXTURE1:int = 18

SHADOWMAPTEXTURE2Constant 
public static const SHADOWMAPTEXTURE2:int = 19

SHADOWMAPTEXTURE3Constant 
public static const SHADOWMAPTEXTURE3:int = 20

SPOTLIGHTATTENUATIONConstant 
public static const SPOTLIGHTATTENUATION:int = 13

SPOTLIGHTCOLORConstant 
public static const SPOTLIGHTCOLOR:int = 14

SPOTLIGHTDIRECTIONConstant 
public static const SPOTLIGHTDIRECTION:int = 10

SPOTLIGHTPOSConstant 
public static const SPOTLIGHTPOS:int = 9

SPOTLIGHTRANGEConstant 
public static const SPOTLIGHTRANGE:int = 12

SPOTLIGHTSPOTConstant 
public static const SPOTLIGHTSPOT:int = 11