Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AnimationClip

动画剪辑。

Hierarchy

Implements

Indexable

[]: any

动画剪辑。

Index

Type aliases

Static PropertyCurveData

PropertyCurveData: IPropertyCurveData

Constructors

constructor

  • newAnimationClip(...args: ConstructorParameters<RawAsset>): AnimationClip
  • Parameters

    • Rest ...args: ConstructorParameters<RawAsset>

    Returns AnimationClip

Properties

IAnimationEventGroup

IAnimationEventGroup: any

_callbackTable

_callbackTable: any = createMap(true)

IEventTarget 实现,它们将被 applyMixins 在 EventTarget 中用相同的实现覆盖

Private _commonTargets

_commonTargets: CommonTarget[] = []

Private _curves

_curves: ICurve[] = []

Private _data

_data: Uint8Array | null = null

Private _duration

_duration: number = 0

Private _hash

_hash: number = 0

Private _keys

_keys: number[][] = []

Protected _name

_name: string

_native

_native: string = ""

用于本机资产的可序列化URL。供内部使用。

default

""

_objFlags

_objFlags: number

Private _ratioSamplers

_ratioSamplers: RatioSampler[] = []

Private Optional _runtimeCurves

_runtimeCurves: IRuntimeCurve[]

Private Optional runtimeEvents

runtimeEvents: undefined | object

Private _stepness

_stepness: number = 0

_uuid

_uuid: string

内部使用。

Private Optional curveDatas

curveDatas: ICurveData

动画的曲线数据。

deprecated

请转用 this.curves

events

events: IEvent[] = []

动画包含的事件数据。

Private frameRate

frameRate: number = 0

loaded

loaded: boolean = true

该资源是否已经成功加载。

sample

sample: number = 60

动画帧率,单位为帧/秒。

speed

speed: number = 1

动画的播放速度。

wrapMode

wrapMode: WrapMode = AnimationWrapMode.Normal

动画的循环模式。

Static WrapMode

WrapMode: WrapMode = AnimationWrapMode

Static preventDeferredLoadDependents

preventDeferredLoadDependents: boolean = true

Static preventPreloadNativeObject

preventPreloadNativeObject: boolean = false

禁止预加载原生对象。

property

{Boolean} preventPreloadNativeObject

default

false

static

Accessors

Private nativeAsset

  • get nativeAsset(): any
  • set nativeAsset(obj: any): void
  • 此资源的基础资源(如果有)。 此属性可用于访问与资源相关的其他详细信息或功能。
    如果_native可用,则此属性将由加载器初始化。

    property

    {Object} _nativeAsset

    default

    null

    type

    {any}

    Returns any

  • Parameters

    • obj: any

    Returns void

duration

  • get duration(): number
  • set duration(value: number): void
  • 动画的周期。

    Returns number

  • Parameters

    • value: number

    Returns void

Protected eventGroups

  • Returns readonly

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

keys

  • get keys(): number[][]
  • set keys(value: number[][]): void
  • 动画所有时间轴。

    Returns number[][]

  • Parameters

    • value: number[][]

    Returns void

name

  • get name(): string
  • set name(value: string): void
  • 该对象的名称。

    property

    {String} name

    default

    ""

    example
    obj.name = "New Obj";

    Returns string

  • Parameters

    • value: string

    Returns void

nativeUrl

  • get nativeUrl(): string
  • 返回该资源对应的目标平台资源的 URL,如果没有将返回一个空字符串。

    property

    nativeUrl

    type

    {String}

    readonly

    Returns string

Methods

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

Private setRawAsset

  • setRawAsset(filename: string, inLibrary?: boolean): void
  • 为此资源设置原始文件名。

    seealso

    nativeUrl

    Parameters

    • filename: string
    • Default value inLibrary: boolean = true

    Returns void

Optional createNode

  • 使用该资源在场景中创建一个新节点。
    如果这类资源没有相应的节点类型,该方法应该是空的。

    Parameters

    Returns void

destroy

  • destroy(): boolean
  • 销毁该对象,并释放所有它对其它对象的引用。
    实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始,该对象将不再可用。 您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。

    example
    obj.destroy();

    Returns boolean

    whether it is the first time the destroy being called

dispatchEvent

  • dispatchEvent(event: Event): void
  • Parameters

    Returns void

emit

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

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

    Returns void

hasEventListener

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

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

    Returns boolean

off

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

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

    Returns void

on

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

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

    Returns Function | undefined

once

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

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

    Returns Function | undefined

removeAll

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

    • Optional keyOrTarget: string | Object | undefined

    Returns void

targetOff

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

    • Optional keyOrTarget: string | Object | undefined

    Returns void

toString

  • toString(): string
  • 返回对象的字符串表示形式。
    Asset 对象将会重写 Object 对象的 toString() 方法。
    当资源要表示为文本值时或在字符串连接时引用时,
    JavaScript 会自动调用 toString() 方法。

    对于原始类型的资源,它将返回this.nativeUrl
    否则,返回空字符串。
    子类可能会覆盖此方法。

    method

    toString

    Returns string

Static deferredDestroy

  • _deferredDestroy(): void

Static createWithSpriteFrames

  • 使用一组序列帧图片来创建动画剪辑

    example
    const clip = cc.AnimationClip.createWithSpriteFrames(spriteFrames, 10);

    Parameters

    Returns null | AnimationClip

Static deserialize

  • deserialize(data: any): any
  • 应 AssetDB 要求提供这个方法。

    method

    deserialize

    Parameters

    • data: any

    Returns any

Static isRawAssetType

  • isRawAssetType(ctor: Function): boolean
  • 内部使用。

    Parameters

    • ctor: Function

    Returns boolean

Generated using TypeDoc