Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AnimationComponent

动画组件管理动画状态来控制动画的播放。 它提供了方便的接口用来预创建指定动画剪辑的动画状态,并提供了一系列事件:

  • play : 开始播放时
  • stop : 停止播放时
  • pause : 暂停播放时
  • resume : 恢复播放时
  • lastframe : 假如动画循环次数大于 1,当动画播放到最后一帧时
  • finished : 动画播放完成时

Hierarchy

Implements

Index

Constructors

constructor

Properties

_callbackTable

_callbackTable: ICallbackTable = createMap(true)

Protected _clips

_clips: Array<null | AnimationClip> = []

Protected _crossFade

_crossFade: CrossFade = new CrossFade()

Protected _defaultClip

_defaultClip: AnimationClip | null = null

Private _enabled

_enabled: boolean = true
property

_enabled

type

{Boolean}

_id

_id: string = idGenerator.getNewId()

For internal usage.

Protected _name

_name: string

Protected nameToState

nameToState: object = createMap(true)

Type declaration

_objFlags

_objFlags: number

sceneGetter

sceneGetter: null | function = null

node

node: Node = NullNode

该组件被附加到的节点。组件总会附加到一个节点。

property

node

type

{Node}

example
cc.log(comp.node);

playOnLoad

playOnLoad: boolean = false

是否在动画组件开始运行时自动播放默认动画剪辑。

Static EventType

EventType: EventType = EventType

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null
  • Returns null

isOnLoadCalled

  • get isOnLoadCalled(): number
  • 返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。

    property

    _isOnLoadCalled

    type

    {Number}

    readonly
    example
    cc.log(this._isOnLoadCalled > 0);

    Returns number

clips

  • 获取此动画组件的自有动画剪辑。 动画组件开始运行时会为每个自有动画剪辑创建动画状态。

    Returns (null | AnimationClip)[]

  • 设置此动画组件的自有动画剪辑。 设置时将移除已有的动画剪辑,并将其动画状态设为停止;若默认动画剪辑不在新的自有动画剪辑中,将被重置为空。

    Parameters

    Returns void

defaultClip

  • 获取默认动画剪辑。

    see

    playOnLoad

    Returns null | AnimationClip

  • 设置默认动画剪辑。当指定的剪辑不在 this.clips 中时会被自动添加至 this.clips

    Parameters

    Returns void

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void
  • 表示该组件自身是否启用。

    property

    enabled

    type

    {Boolean}

    default

    true

    example
    comp.enabled = true;
    cc.log(comp.enabled);

    Returns boolean

  • Parameters

    • value: boolean

    Returns void

enabledInHierarchy

  • get enabledInHierarchy(): boolean
  • 表示该组件是否被启用并且所在的节点也处于激活状态。

    property

    enabledInHierarchy

    type

    {Boolean}

    readonly
    example
    cc.log(comp.enabledInHierarchy);

    Returns boolean

isValid

  • get isValid(): boolean
  • 表示该对象是否可用(被 destroy 后将不可用)。
    当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy,请使用 cc.isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。

    property

    {Boolean} isValid

    default

    true

    readonly
    example
    import * as cc from 'cc';
    var node = new cc.Node();
    cc.log(node.isValid);    // true
    node.destroy();
    cc.log(node.isValid);    // true, still valid in this frame
    // after a frame...
    cc.log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

name

  • get name(): string
  • set name(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

uuid

  • get uuid(): string
  • 组件的 uuid,用于编辑器。

    property

    uuid

    type

    {String}

    readonly
    example
    cc.log(comp.uuid);

    Returns string

Methods

Optional Private preload

  • __preload(): void
  • __preload 在每次onLoad之前调用。
    它用于在内部初始化内置组件,
    以避免在每次公有方法调用之前检查是否调用了onLoad。
    如果支持脚本优先级,则应删除此方法。

    Returns void

Protected createState

  • Parameters

    Returns AnimationState

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Protected doCreateState

Protected Optional getLocalBounds

  • getLocalBounds(out_rect: Rect): void
  • 如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。

    Parameters

    • out_rect: Rect

      提供包围盒的 Rect

    Returns void

getRenderScene

  • _getRenderScene(): RenderScene

Private getStateByNameOrDefaultClip

  • getStateByNameOrDefaultClip(name?: undefined | string): null | AnimationState
  • Parameters

    • Optional name: undefined | string

    Returns null | AnimationState

instantiate

  • instantiate(cloned: any): any
  • Parameters

    • cloned: any

    Returns any

onPreDestroy

  • _onPreDestroy(): void

Private removeStateOfAutomaticClip

  • Parameters

    Returns void

addClip

  • 添加一个动画剪辑到 this.clips中并以此剪辑创建动画状态。

    deprecated

    将在 V1.0.0 移除,请转用 this.createState()

    Parameters

    • clip: AnimationClip

      动画剪辑。

    • Optional name: undefined | string

      动画状态的名称,若未指定,则使用动画剪辑的名称。

    Returns AnimationState

    新创建的动画状态。

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null
  • 向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。

    example
    var test = node.addComponent("Test");

    Type parameters

    Parameters

    Returns T | null

  • 向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。

    example
    var test = node.addComponent("Test");

    Parameters

    • className: string

    Returns Component | null

createState

  • 使用指定的动画剪辑创建一个动画状态,并将其命名为指定的名称。 若指定名称的动画状态已存在,已存在的动画状态将先被设为停止并被移除。

    Parameters

    • clip: AnimationClip

      动画剪辑。

    • Optional name: undefined | string

      动画状态的名称,若未指定,则使用动画剪辑的名称。

    Returns AnimationState

    新创建的动画状态。

crossFade

  • crossFade(name: string, duration?: number): void
  • 在指定周期内从当前动画状态平滑地切换到指定动画状态。

    Parameters

    • name: string

      目标动画状态的名称。

    • Default value duration: number = 0.3

      切换周期,单位为秒。

    Returns void

destroy

  • destroy(): any

dispatchEvent

  • dispatchEvent(event: Event): void
  • Parameters

    Returns void

emit

  • emit(key: string, ...args: any[]): void
  • Parameters

    • key: string
    • Rest ...args: any[]

    Returns void

getAnimationState

  • 获取指定的动画状态。

    deprecated

    将在 V1.0.0 移除,请转用 this.getState()

    Parameters

    • name: string

    Returns AnimationState

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null
  • 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Type parameters

    Parameters

    Returns T | null

  • 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Parameters

    • className: string

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null
  • 递归查找所有子节点中第一个匹配指定类型的组件。

    example
    var Test = node.getComponentInChildren("Test");

    Type parameters

    Parameters

    Returns T | null

  • 递归查找所有子节点中第一个匹配指定类型的组件。

    example
    var Test = node.getComponentInChildren("Test");

    Parameters

    • className: string

    Returns Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]
  • 返回节点上指定类型的所有组件。

    example
    var tests = node.getComponents("Test");

    Type parameters

    Parameters

    Returns T[]

  • 返回节点上指定类型的所有组件。

    example
    var tests = node.getComponents("Test");

    Parameters

    • className: string

    Returns Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]
  • 递归查找自身或所有子节点中指定类型的组件。

    example
    var tests = node.getComponentsInChildren("Test");

    Type parameters

    Parameters

    Returns T[]

  • 递归查找自身或所有子节点中指定类型的组件。

    example
    var tests = node.getComponentsInChildren("Test");

    Parameters

    • className: string

    Returns Component[]

getState

  • 获取指定的动画状态。

    Parameters

    • name: string

      动画状态的名称。

    Returns AnimationState

    不存在指定名称的动画状态时返回空,否则返回指定的动画状态。

hasEventListener

  • hasEventListener(key: string, callback?: Function | undefined, target?: Object | undefined): boolean
  • Parameters

    • key: string
    • Optional callback: Function | undefined
    • Optional target: Object | undefined

    Returns boolean

Protected Optional lateUpdate

  • lateUpdate(dt: number): void
  • 如果该组件启用,则每帧调用 LateUpdate。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

off

  • off(type: string, callback: Function, target?: Object): void
  • 取消注册动画事件回调。

    example
    // unregister event to all animation
    animation.off('play', this.onPlay, this);

    Parameters

    • type: string

      要删除的事件类型的字符串。

    • callback: Function

      要删除的回调

    • Optional target: Object

      调用回调的目标(此对象),如果没有给出,则只删除没有目标的回调

    Returns void

on

  • on(type: string, callback: function, target?: Object): undefined | Function
  • 注册动画事件回调。 回调的事件里将会附上发送事件的 AnimationState。 当播放一个动画时,会自动将事件注册到对应的 AnimationState 上,停止播放时会将事件从这个 AnimationState 上取消注册。

    example
    onPlay: function (type, state) {
        // callback
    }
    // register event to all animation
    animation.on('play', this.onPlay, this);

    Parameters

    • type: string

      表示要侦听的事件类型的字符串。

    • callback: function

      调度事件时将调用的回调。 如果回调是重复的(回调是唯一的),则忽略回调。

    • Optional target: Object

      调用回调的目标(此对象)可以为null

    Returns undefined | Function

    只返回传入的回调,以便可以更轻松地保存匿名函数。

onDestroy

  • onDestroy(): void
  • Returns void

onDisable

  • onDisable(): void
  • Returns void

onEnable

  • onEnable(): void
  • Returns void

Optional onFocusInEditor

  • onFocusInEditor(): void

onLoad

  • onLoad(): void
  • Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Protected Optional onRestore

  • onRestore(): void
  • onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。

    如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。

    编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。 然而,在极端的情况下,它可能无法良好运作。
    那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。 一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

    同样的,编辑可能无法在极端情况下正确地重置您的组件。
    于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
    一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
    此方法仅在编辑器下会被调用。

    Returns void

once

  • once(type: string, callback: Function, target?: Object | undefined): Function | undefined
  • Parameters

    • type: string
    • callback: Function
    • Optional target: Object | undefined

    Returns Function | undefined

pause

  • pause(): void
  • 暂停所有动画状态,并暂停动画切换。

    Returns void

play

  • play(name?: undefined | string): void
  • 立即切换到指定动画状态。

    Parameters

    • Optional name: undefined | string

    Returns void

removeAll

  • removeAll(keyOrTarget?: string | Object | undefined): void
  • Parameters

    • Optional keyOrTarget: string | Object | undefined

    Returns void

removeClip

  • removeClip(clip: AnimationClip, force?: undefined | false | true): void
  • 从动画列表中移除指定的动画剪辑,
    如果依赖于 clip 的 AnimationState 正在播放或者 clip 是 defaultClip 的话,默认是不会删除 clip 的。
    但是如果 force 参数为 true,则会强制停止该动画,然后移除该动画剪辑和相关的动画。这时候如果 clip 是 defaultClip,defaultClip 将会被重置为 null。

    deprecated

    将在 V1.0.0 移除,请转用 this.removeState()

    Parameters

    Returns void

removeState

  • removeState(name: string): void
  • 停止并移除指定名称的动画状态。

    Parameters

    • name: string

      动画状态的名称。

    Returns void

Optional resetInEditor

  • resetInEditor(): void
  • 用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

    Returns void

resume

  • resume(): void
  • 恢复所有动画状态,并继续动画切换。

    Returns void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void
  • 调度一个自定义的回调函数。
    如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。

    method

    schedule

    example
    var timeCallback = function (dt) {
      cc.log("time: " + dt);
    }
    this.schedule(timeCallback, 1);

    Parameters

    • callback: any

      回调函数。

    • Default value interval: number = 0

      时间间隔,0 表示每帧都重复。

    • Default value repeat: number = cc.macro.REPEAT_FOREVER

      将被重复执行(repeat+ 1)次,您可以使用 cc.macro.REPEAT_FOREVER 进行无限次循环。

    • Default value delay: number = 0

      第一次执行前等待的时间(延时执行)。

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void
  • 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    schedule

    example
    var timeCallback = function (dt) {
      cc.log("time: " + dt);
    }
    this.scheduleOnce(timeCallback, 2);

    Parameters

    • callback: any

      回调函数。

    • Default value delay: number = 0

      第一次执行前等待的时间(延时执行)。

    Returns void

start

  • start(): void
  • Returns void

stop

  • stop(): void
  • 停止所有动画状态,并停止动画切换。

    Returns void

targetOff

  • targetOff(keyOrTarget?: string | Object | undefined): void
  • IEventTarget 实现,它们将被 applyMixins 在 EventTarget 中用相同的实现覆盖。

    Parameters

    • Optional keyOrTarget: string | Object | undefined

    Returns void

unschedule

  • unschedule(callback_fn: any): void
  • 取消调度一个自定义的回调函数。

    example
    this.unschedule(_callback);

    Parameters

    • callback_fn: any

      回调函数。

    Returns void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void
  • 取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。

    method

    unscheduleAllCallbacks

    example
    this.unscheduleAllCallbacks();

    Returns void

Protected Optional update

  • update(dt: number): void
  • 如果该组件启用,则每帧调用 update。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc