类 AnimationPlayer

En

The AnimationPlayer class is used for animation players.

  • Event.PLAYED: Schedule at start of playback.
  • Event.PAUSED: Schedule when paused.
  • Event.COMPLETE: Schedule upon completion of one cycle.
  • Event.STOPPED: Schedule when stopped.

Zh

AnimationPlayer类用于动画播放器。

  • Event.PLAYED: 开始播放时调度。
  • Event.PAUSED: 暂停时调度。
  • Event.COMPLETE: 完成一次循环时调度。
  • Event.STOPPED: 停止时调度。

层级 (查看层级一览)

构造函数

constructor

属性

isCache playbackRate returnToZeroStopped

访问器

cacheFrameRate cacheFrameRateInterval cachePlayRate currentAnimationClipIndex currentFrameTime currentKeyframeIndex currentPlayTime currentTime destroyed overallDuration paused playDuration playEnd playStart state templet

方法

event hasListener off offAll offAllCaller on once play playByFrame stop

构造函数

constructor

属性

isCache

isCache: boolean = true

En

Whether to cache.

Zh

是否缓存。

playbackRate

playbackRate: number = 1.0

En

The playback rate of the animation.

Zh

播放速率。

returnToZeroStopped

returnToZeroStopped: boolean

En

Whether to return to zero when stopped.

Zh

停止时是否归零。

访问器

cacheFrameRate

cacheFrameRateInterval

cachePlayRate

currentAnimationClipIndex

currentFrameTime

currentKeyframeIndex

currentPlayTime

currentTime

destroyed

overallDuration

paused

playDuration

playEnd

playStart

state

templet

方法

event

  • event(type: string, data?: any): boolean

    参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

hasListener

  • hasListener(type: string): boolean

    参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

off

offAll

offAllCaller

on

  • on(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type: string, caller: any, listener: Function, args?: any[]): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

once

  • once(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(
        type: string,
        caller: any,
        listener: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

play

  • play(
        index?: number,
        playbackRate?: number,
        overallDuration?: number,
        playStart?: number,
        playEnd?: number,
    ): void

    参数

    • index: number = 0

      The index of the animation to play.

    • playbackRate: number = 1.0

      The rate at which to play the animation.

    • overallDuration: number = 2147483647

      The duration to play the animation (0 for once, Number.MAX_VALUE for loop play).

    • playStart: number = 0

      The start time position of the playback.

    • playEnd: number = 0

      The end time position of the playback (0 for the longest end time position of one loop of the animation).

    返回 void

    En

    Play animation based on time.

    Zh

    基于时间来播放动画。

playByFrame

  • playByFrame(
        index?: number,
        playbackRate?: number,
        overallDuration?: number,
        playStartFrame?: number,
        playEndFrame?: number,
        fpsIn3DBuilder?: number,
    ): void

    参数

    • index: number = 0

      The index of the animation to play.

    • playbackRate: number = 1.0

      The rate at which to play the animation.

    • overallDuration: number = 2147483647

      The duration to play the animation (0 for once, Number.MAX_VALUE for loop play).

    • playStartFrame: number = 0

      The original start frame rate position for playback.

    • playEndFrame: number = 0

      The original end frame rate position for playback (0 for the longest end time position of one loop of the animation).

    • fpsIn3DBuilder: number = 30

      The frames per second in the 3D builder.

    返回 void

    En

    Play animation based on frame parameters.

    Zh

    基于帧的参数来播放动画。

stop

  • stop(immediate?: boolean): void

    参数

    • immediate: boolean = true

      Whether to stop immediately. The default value is true.

    返回 void

    En

    Stop playing the current animation. If you don't stop immediately, wait for the animation to finish playing before stopping

    Zh

    停止播放当前动画。 如果不是立即停止，则会等待动画播放完成后再停止。

显示设置

成员可见性

目录

构造函数
属性
访问器
方法