Package | laya.d3.component |
Class | public class Animator |
Inheritance | Animator Component3D EventDispatcher Object |
Implements | laya.resource.IDestroy |
Animator
类用于创建动画组件。
Property | Defined By | ||
---|---|---|---|
avatar : Avatar
获取avatar。
| Animator | ||
cacheFrameRate : int
获取缓存播放帧,缓存模式下生效。
| Animator | ||
cachePlayRate : Number
获取缓存播放速率,缓存模式下生效。
| Animator | ||
clip : AnimationClip
获取默认动画片段。
| Animator | ||
curAnimationDatas : Vector.<Float32Array> [read-only]
获取骨骼数据。
| Animator | ||
currentFrameIndex : int [read-only]
获取当前帧数
| Animator | ||
currentFrameTime : Number [read-only]
获取当前帧时间,不包括重播时间
| Animator | ||
currentPlayClip : AnimationClip [read-only]
获取当前动画索引
| Animator | ||
currentPlayTime : Number [read-only]
获取当前精确时间,不包括重播时间
| Animator | ||
destroyed : Boolean [read-only]
获取是否已销毁。
| Component3D | ||
enable : Boolean
获取是否启用。
| Component3D | ||
id : int [read-only]
获取唯一标识ID。
| Component3D | ||
isCache : Boolean 是否为缓存模式。 | Animator | ||
isSingleton : Boolean [read-only]
获取是否为单实例组件。
| Component3D | ||
owner : ComponentNode [read-only]
获取所属Sprite3D节点。
| Component3D | ||
paused : Boolean
获取当前是否暂停
| Animator | ||
playbackRate : Number 播放速率 | Animator | ||
playbackTime : Number [write-only]
设置当前播放位置
| Animator | ||
playState : int [read-only]
获取当前播放状态
| Animator | ||
started : Boolean 是否已执行start函数。 | Component3D |
Method | Defined By | ||
---|---|---|---|
Animator()
创建一个 Animation 实例。
| Animator | ||
_load(owner:ComponentNode):void [override]
| Animator | ||
_unload(owner:ComponentNode):void [override]
| Animator | ||
_updateAvatarNodes(avatarAnimationDatas:Vector.<Matrix4x4>):void
private
| Animator | ||
_updateAvatarNodesCache(avatarAnimationDatas:Vector.<Matrix4x4>):void
private
| Animator | ||
addClip(clip:AnimationClip, playName:String = null, startFrame:int = 0, endFrame:int = 4294967295):void
添加动画片段。
| Animator | ||
event(type:String, data:* = null):Boolean
派发事件。
| EventDispatcher | ||
getClip(playName:String):AnimationClip
通过播放名字获取动画片段。
| Animator | ||
getClipCount():int
获取动画片段个数。
| Animator | ||
hasListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
| EventDispatcher | ||
isMouseEvent(type:String):Boolean
检测指定事件类型是否是鼠标事件。
| EventDispatcher | ||
linkSprite3DToAvatarNode(nodeName:String, sprite3D:Sprite3D):Boolean
关联精灵节点到Avatar节点,此Animator必须有Avatar文件。
| Animator | ||
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
使用 EventDispatcher 对象注册指定类型的事件侦听器对象,以使侦听器能够接收事件通知。
| EventDispatcher | ||
once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
使用 EventDispatcher 对象注册指定类型的事件侦听器对象,以使侦听器能够接收事件通知,此侦听事件响应一次后自动移除。
| EventDispatcher | ||
play(name:String = null, playbackRate:Number = 1.0):void
播放动画。
| Animator | ||
removeClip(clip:AnimationClip):void
移除动画片段。
| Animator | ||
removeClipByName(playName:String):void
通过播放名字移除动画片段。
| Animator | ||
stop(immediate:Boolean = true):void
停止播放当前动画
| Animator | ||
unLinkSprite3DToAvatarNode(sprite3D:Sprite3D):Boolean
解除精灵节点到Avatar节点的关联,此Animator必须有Avatar文件。
| Animator |
avatar | property |
avatar:Avatar
获取avatar。
public function get avatar():Avatar
public function set avatar(value:Avatar):void
cacheFrameRate | property |
cacheFrameRate:int
获取缓存播放帧,缓存模式下生效。
public function get cacheFrameRate():int
public function set cacheFrameRate(value:int):void
cachePlayRate | property |
cachePlayRate:Number
获取缓存播放速率,缓存模式下生效。
public function get cachePlayRate():Number
public function set cachePlayRate(value:Number):void
clip | property |
clip:AnimationClip
获取默认动画片段。
public function get clip():AnimationClip
public function set clip(value:AnimationClip):void
curAnimationDatas | property |
curAnimationDatas:Vector.<Float32Array>
[read-only] 获取骨骼数据。
public function get curAnimationDatas():Vector.<Float32Array>
currentFrameIndex | property |
currentFrameIndex:int
[read-only] 获取当前帧数
public function get currentFrameIndex():int
currentFrameTime | property |
currentFrameTime:Number
[read-only] 获取当前帧时间,不包括重播时间
public function get currentFrameTime():Number
currentPlayClip | property |
currentPlayClip:AnimationClip
[read-only] 获取当前动画索引
public function get currentPlayClip():AnimationClip
currentPlayTime | property |
currentPlayTime:Number
[read-only] 获取当前精确时间,不包括重播时间
public function get currentPlayTime():Number
isCache | property |
public var isCache:Boolean
是否为缓存模式。
paused | property |
paused:Boolean
获取当前是否暂停
public function get paused():Boolean
public function set paused(value:Boolean):void
playbackRate | property |
public var playbackRate:Number
播放速率
playbackTime | property |
playbackTime:Number
[write-only] 设置当前播放位置
public function set playbackTime(value:Number):void
playState | property |
playState:int
[read-only] 获取当前播放状态
public function get playState():int
Animator | () | Constructor |
public function Animator()
创建一个 Animation
实例。
_load | () | method |
_unload | () | method |
_updateAvatarNodes | () | method |
public function _updateAvatarNodes(avatarAnimationDatas:Vector.<Matrix4x4>):void
private
Parameters
avatarAnimationDatas:Vector.<Matrix4x4> |
_updateAvatarNodesCache | () | method |
public function _updateAvatarNodesCache(avatarAnimationDatas:Vector.<Matrix4x4>):void
private
Parameters
avatarAnimationDatas:Vector.<Matrix4x4> |
addClip | () | method |
public function addClip(clip:AnimationClip, playName:String = null, startFrame:int = 0, endFrame:int = 4294967295):void
添加动画片段。
Parameters
clip:AnimationClip — 动画片段。
| |
playName:String (default = null ) — 动画片段播放名称,如果为null,则使用clip.name作为播放名称。
| |
startFrame:int (default = 0 )
| |
endFrame:int (default = 4294967295 )
|
getClip | () | method |
public function getClip(playName:String):AnimationClip
通过播放名字获取动画片段。
Parameters
playName:String — 播放名字。
|
AnimationClip — 动画片段。
|
getClipCount | () | method |
public function getClipCount():int
获取动画片段个数。
Returnsint — 动画个数。
|
linkSprite3DToAvatarNode | () | method |
public function linkSprite3DToAvatarNode(nodeName:String, sprite3D:Sprite3D):Boolean
关联精灵节点到Avatar节点,此Animator必须有Avatar文件。
Parameters
nodeName:String — 关联节点的名字。
| |
sprite3D:Sprite3D — 精灵节点。
|
Boolean — 是否关联成功。
|
play | () | method |
public function play(name:String = null, playbackRate:Number = 1.0):void
播放动画。
Parameters
name:String (default = null ) — 如果为null则播放默认动画,否则按名字播放动画片段。
| |
playbackRate:Number (default = 1.0 ) — 播放速率。
|
removeClip | () | method |
removeClipByName | () | method |
public function removeClipByName(playName:String):void
通过播放名字移除动画片段。
Parameters
playName:String — 播放名字。
|
stop | () | method |
public function stop(immediate:Boolean = true):void
停止播放当前动画
Parameters
immediate:Boolean (default = true ) — 是否立即停止
|
unLinkSprite3DToAvatarNode | () | method |
public function unLinkSprite3DToAvatarNode(sprite3D:Sprite3D):Boolean
解除精灵节点到Avatar节点的关联,此Animator必须有Avatar文件。
Parameters
sprite3D:Sprite3D — 精灵节点。
|
Boolean — 是否解除关联成功。
|