| Package | laya.d3.core |
| Class | public class Sprite3D |
| Inheritance | Sprite3D  ComponentNode Node EventDispatcher Object |
| Implements | IUpdate, laya.resource.ICreateResource, laya.d3.core.IClone |
| Subclasses | BaseCamera, LightSprite, RenderableSprite3D, Terrain |
Sprite3D 类用于实现3D精灵。
| Property | Defined By | ||
|---|---|---|---|
| active : Boolean
获取自身是否激活。
| Sprite3D | ||
| activeInHierarchy : Boolean [read-only]
获取在场景中是否激活。
| Sprite3D | ||
| componentsCount : int [read-only]
获得组件的数量。
| Sprite3D | ||
 | destroyed : Boolean [只读]是否已经销毁。对象销毁后不能再使用。 | Node | |
| displayedInStage : Boolean [read-only] 表示是否在显示列表中显示。 | Node | |
| id : int [read-only]
获取唯一标识ID。
| Sprite3D | ||
| isStatic : Boolean 是否静态,静态包含一系列的静态处理。 | Sprite3D | ||
| layer : Layer
获取蒙版。
| Sprite3D | ||
| loaded : Boolean [read-only]
获取是否已加载完成。
| Sprite3D | ||
| name : String 节点名称。 | Node | |
| numChildren : int [read-only]
子对象数量。
| Node | |
| parent : Node 父节点。 | Node | |
| scene : Scene [read-only]
获得所属场景。
| Sprite3D | ||
| timer : Timer 时间控制器，默认为Laya.timer。 | Node | |
| transform : Transform3D [read-only]
获取精灵变换。
| Sprite3D | ||
| url : String
获取资源的URL地址。
| Sprite3D | ||
| Method | Defined By | ||
|---|---|---|---|
Sprite3D(name:String = null)
创建一个 Sprite3D 实例。
| Sprite3D | ||
排序函数。
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
_addSelfRenderObjects():void
添加自身渲染物体，请重载此函数。
| Sprite3D | ||
_clearSelfRenderObjects():void
清理自身渲染物体，请重载此函数。
| Sprite3D | ||
_parseCustomProps(rootNode:ComponentNode, innerResouMap:Object, customProps:Object, nodeData:Object):void
private
| Sprite3D | ||
_updateChilds(state:RenderState):void
更新子节点。
| Sprite3D | ||
_updateChildsConch(state:RenderState):void
更新子节点。
| Sprite3D | ||
| active | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesactive:Boolean获取自身是否激活。
public function get active():Boolean public function set active(value:Boolean):void| activeInHierarchy | property |
activeInHierarchy:Boolean [read-only] 获取在场景中是否激活。
public function get activeInHierarchy():Boolean| componentsCount | property |
componentsCount:int [read-only] 获得组件的数量。
public function get componentsCount():int| id | property |
id:int [read-only] 获取唯一标识ID。
public function get id():int| isStatic | property |
public var isStatic:Boolean是否静态,静态包含一系列的静态处理。
| layer | property |
layer:Layer获取蒙版。
public function get layer():Layer public function set layer(value:Layer):void| loaded | property |
loaded:Boolean [read-only] 获取是否已加载完成。
public function get loaded():Boolean| scene | property |
| transform | property |
transform:Transform3D [read-only] 获取精灵变换。
public function get transform():Transform3D| url | property |
url:String获取资源的URL地址。
public function get url():String public function set url(value:String):void| Sprite3D | () | Constructor |
public function Sprite3D(name:String = null)
创建一个 Sprite3D 实例。
name:String (default = null) |
| _addSelfRenderObjects | () | method |
protected function _addSelfRenderObjects():void添加自身渲染物体，请重载此函数。
| _clearSelfRenderObjects | () | method |
protected function _clearSelfRenderObjects():void清理自身渲染物体，请重载此函数。
| _getSortID | () | method |
public function _getSortID(renderElement:IRenderable, material:BaseMaterial):int排序函数。
Parameters
renderElement:IRenderable — 渲染相关状态。
| |
material:BaseMaterial |
int |
| _parseCustomProps | () | method |
protected function _parseCustomProps(rootNode:ComponentNode, innerResouMap:Object, customProps:Object, nodeData:Object):voidprivate
Parameters
rootNode:ComponentNode | |
innerResouMap:Object | |
customProps:Object | |
nodeData:Object |
| _update | () | method |
| _updateChilds | () | method |
protected function _updateChilds(state:RenderState):void更新子节点。
Parameters
state:RenderState — 渲染相关状态。
|
| _updateChildsConch | () | method |
protected function _updateChildsConch(state:RenderState):void更新子节点。
Parameters
state:RenderState — 渲染相关状态。
|
| _updateConch | () | method |
| addChild | () | method |
override public function addChild(node:Node):Node添加子节点。
Parameters
node:Node — 节点对象
|
Node — 返回添加的节点
|
| addChildAt | () | method |
override public function addChildAt(node:Node, index:int):Node添加子节点到指定的索引位置。
Parameters
node:Node — 节点对象。
| |
index:int — 索引位置。
|
Node — 返回添加的节点。
|
| addComponent | () | method |
public function addComponent(type:*):Component3D添加指定类型组件。
Parameters
type:* — 组件类型。
|
Component3D — 组件。
|
| clone | () | method |
public function clone():*克隆。
Returns* — 克隆副本。
|
| cloneTo | () | method |
public function cloneTo(destObject:*):void克隆。
Parameters
destObject:* — 克隆源。
|
| destroy | () | method |
override public function destroy(destroyChild:Boolean = true):void
销毁此对象。destroy对象默认会把自己从父节点移除，并且清理自身引用关系，等待js自动垃圾回收机制回收。destroy后不能再使用。
destroy时会移除自身的事情监听，自身的timer监听，移除子对象及从父节点移除自己。
Parameters
destroyChild:Boolean (default = true) |
| getComponentByIndex | () | method |
public function getComponentByIndex(index:int):Component3D通过指定索引获得组件。
Parameters
index:int — 索引。
|
Component3D — 组件。
|
| getComponentByType | () | method |
public function getComponentByType(type:*, typeIndex:int = 0):Component3D通过指定类型和类型索引获得组件。
Parameters
type:* — 组件类型。
| |
typeIndex:int (default = 0) |
Component3D — 组件。
|
| getComponentsByType | () | method |
public function getComponentsByType(type:*, components:Vector.<Component3D>):void通过指定类型获得所有组件。
Parameters
type:* — 组件类型。
| |
components:Vector.<Component3D> — 组件输出队列。
|
| getProjectionViewWorldMatrix | () | method |
public function getProjectionViewWorldMatrix(projectionViewMatrix:Matrix4x4):Matrix4x4获取投影视图世界矩阵。
Parameters
projectionViewMatrix:Matrix4x4 — 投影视图矩阵。
|
Matrix4x4 — 投影视图世界矩阵。
|
| instantiate | () | method |
public static function instantiate(original:Sprite3D, parent:Node = null, worldPositionStays:Boolean = true, position:Vector3 = null, rotation:Quaternion = null):Sprite3D创建精灵的克隆实例。
Parameters
original:Sprite3D — 原始精灵。
| |
parent:Node (default = null) | |
worldPositionStays:Boolean (default = true) | |
position:Vector3 (default = null) | |
rotation:Quaternion (default = null) |
Sprite3D — 克隆实例。
|
| load | () | method |
public static function load(url:String):Sprite3D加载网格模板,注意:不缓存。
Parameters
url:String — 模板地址。
|
Sprite3D |
| loadHierarchy | () | method |
public function loadHierarchy(url:String):void加载层级文件，并作为该节点的子节点。
Parameters
url:String |
| onAsynLoaded | () | method |
public function onAsynLoaded(url:String, data:*, params:Array):voidprivate
Parameters
url:String | |
data:* | |
params:Array |
| removeAllComponent | () | method |
public function removeAllComponent():void移除全部组件。
| removeChildAt | () | method |
override public function removeChildAt(index:int):Node根据子节点索引位置，删除对应的子节点对象。
Parameters
index:int — 节点索引位置。
|
Node — 被删除的节点。
|
| removeChildren | () | method |
override public function removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):Node删除指定索引区间的所有子对象。
Parameters
beginIndex:int (default = 0) | |
endIndex:int (default = 0x7fffffff) |
Node — 当前节点对象。
|
| removeComponentByType | () | method |
public function removeComponentByType(type:*, typeIndex:int = 0):void通过指定类型和类型索引移除组件。
Parameters
type:* — 组件类型。
| |
typeIndex:int (default = 0) |
| removeComponentsByType | () | method |
public function removeComponentsByType(type:*):void通过指定类型移除所有组件。
Parameters
type:* — 组件类型。
|