xr-frame / Exports / Animator

# Class: Animator

# Hierarchy

Component<IAnimatorData>

↳ Animator

# Table of contents

# Constructors

constructor

# Events

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new Animator()

# Inherited from

Component.constructor

# Events

# onAdd

▸ onAdd(parent, data): void

所挂载的element被挂载到场景时触发的回调。

# Parameters

Name	Type
`parent`	`Element`
`data`	`IAnimatorData`

# Returns

void

# Inherited from

Component.onAdd

# onRelease

▸ onRelease(data): void

从被挂载的element上被移除，或是element被销毁时，触发的回调。一般用于释放持有的资源。

# Parameters

Name	Type
`data`	`IAnimatorData`

# Returns

void

# Inherited from

Component.onRelease

# onRemove

▸ onRemove(parent, data): void

所挂载的element从父节点parent被移除时，或者自己从element上被移除时，触发的回调。一般用于消除功能的运作。 如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。

# Parameters

Name	Type
`parent`	`Element`
`data`	`IAnimatorData`

# Returns

void

# Inherited from

Component.onRemove

# onTick

▸ onTick(deltaTime, data): void

渲染每帧触发的回调。

# Parameters

Name	Type	Description
`deltaTime`	`number`	单位为毫秒(ms)。
`data`	`IAnimatorData`	-

# Returns

void

# Inherited from

Component.onTick

# onUpdate

▸ onUpdate(data, preData): void

数据更新时触发的回调。

# Parameters

Name	Type
`data`	`IAnimatorData`
`preData`	`IAnimatorData`

# Returns

void

# Inherited from

Component.onUpdate

# Properties

# priority

• Readonly priority: number = 200

自定义组件的更新优先级。

# Overrides

Component.priority

# schema

• Readonly schema: IComponentSchema

详见AnimatorSchema。

# Overrides

Component.schema

# EVENTS

▪ Static EVENTS: string[]

# Overrides

Component.EVENTS

# Accessors

# el

• get el(): Element

挂载的元素。

# Returns

Element

# scene

• get scene(): Scene

当前场景。

# Returns

Scene

# version

• get version(): number

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

# Returns

number

# Methods

# addAnimation

▸ addAnimation<T>(anim, clipMap?): T

手动添加一个动画。

# Type parameters

Name	Type
`T`	extends `Animation`<`any`, `any`, `T`>

# Parameters

Name	Type	Description
`anim`	`T`	-
`clipMap?`	`Object`	可选的动画片段名字映射。

# Returns

T

# createAnimation

▸ createAnimation<T>(clz, data, clipMap?): T

直接通过类clz和初始化数据data创建一个动画并添加到自身内。

# Type parameters

Name	Type
`T`	extends `Animation`<`any`, `any`, `T`>

# Parameters

Name	Type
`clz`	(`scene`: `Scene`, `data`: `T`[`"__DATA_TYPE"`]) => `T`
`data`	`T`[`"__DATA_TYPE"`]
`clipMap?`	`Object`

# Returns

T

# getData

▸ getData<T>(key): IAnimatorData[T]

获取一个当前值。

# Type parameters

Name	Type
`T`	extends keyof `IAnimatorData`

# Parameters

Name	Type
`key`	`T`

# Returns

IAnimatorData[T]

# Inherited from

Component.getData

# pause

▸ pause(name?): void

暂停播放。

# Parameters

Name	Type	Description
`name?`	`string`	需要暂停的片段，如果不填则暂停所有正在播放的片段。

# Returns

void

# pauseToFrame

▸ pauseToFrame(name, progress): void

播放动画片段到某一进度并停下。

# Parameters

Name	Type	Description
`name`	`string`	片段名称。
`progress`	`number`	停到的某个进度，0~1。

# Returns

void

# play

▸ play(name, options?): void

播放一个动画片段，可以同时播放多个片段。

# Parameters

Name	Type	Description
`name`	`string`	动画片段名称。
`options?`	`IAnimationPlayOptions` & { `[key: string]`: `any`; }	播放选项。

# Returns

void

# removeAnimation

▸ removeAnimation(anim): void

移除一个动画

# Parameters

Name	Type
`anim`	`Animation`<`any`, `any`>

# Returns

void

# resume

▸ resume(name?): void

唤醒暂停的动画。

# Parameters

Name	Type	Description
`name?`	`string`	需要唤醒的片段，如果不填则唤醒所有暂停的片段。

# Returns

void

# setData

▸ setData(data): void

不通过xml而是直接设置data，注意值的类型需要和schema中一致。

# Parameters

Name	Type
`data`	`Partial`<`IAnimatorData`>

# Returns

void

# Inherited from

Component.setData

# setDataOne

▸ setDataOne<T>(key, value): void

设置一个数据。

# Type parameters

Name	Type
`T`	extends keyof `IAnimatorData`

# Parameters

Name	Type
`key`	`T`
`value`	`IAnimatorData`[`T`]

# Returns

void

# Inherited from

Component.setDataOne

# stop

▸ stop(name?): void

停止播放。

# Parameters

Name	Type	Description
`name?`	`string`	需要停止的片段，如果不填则停止所有正在播放的片段。

# Returns

void