类 AnimationTemplet

En

The AnimationTemplate class is used for animation template resources.

Zh

AnimationTemplet类用于动画模板资源。

层级 (查看层级一览)

属性

_id destroyedImmediately lock? name? url uuid DEBUG interpolation

访问器

cpuMemory deps destroyed gpuMemory id obsolute referenceCount cpuMemory gpuMemory

方法

_addReference _clearReference _removeReference _setCPUMemory _setCreateURL _setGPUMemory addDep addDeps destroy event getAniDuration getAnimation getAnimationCount getAnimationDataWithCache getNodeCount getNodeIndexWithName getNodeKeyFrame getNodes getNodesCurrentFrameIndex getOriginalData getOriginalDataUnfixedRate getPublicExtData getTotalkeyframesLength hasListener isCreateFromURL off offAll offAllCaller on once setAnimationDataWithCache destroyUnusedResources

属性

_id

_id: number = 0

destroyedImmediately

destroyedImmediately: boolean

En

Whether to delete the resource immediately when the reference count is 0.

Zh

是否在引用计数为0的时候立马删除他

可选lock

lock?: boolean

En

Whether to lock the resource, if true, the resource cannot be automatically released.

Zh

是否加锁，如果true为不能使用自动释放机制。

可选name

name?: string

En

The name of the resource.

Zh

资源名称。

url

url: string

En

The URL of the resource.

Zh

获取资源的URL地址。

uuid

uuid: string

En

The UUID of the resource.

Zh

获取资源的UUID。

静态DEBUG

DEBUG: boolean = false

En

Whether the debug mode is enabled.

Zh

是否开启调试模式。

静态interpolation

interpolation: any[] = ...

En

Interpolation function

Zh

插值函数

访问器

cpuMemory

deps

destroyed

gpuMemory

id

obsolute

  • get obsolute(): boolean

    返回 boolean

    En

    If a cached resource observer is set to true, then:

      1. getRes will still return this resource;
      1. next time loading will ignore this cached resource and reload it.

    Zh

    如果设置一个已缓存的资源obsolute为true，则

    • 1）getRes仍然可以返回这个资源；
    • 2）下次加载时会忽略这个缓存而去重新加载。。
  • set obsolute(value: boolean): void

    参数

    • value: boolean

    返回 void

referenceCount

静态cpuMemory

静态gpuMemory

方法

_addReference

  • _addReference(count?: number): void

    参数

    • count: number = 1

      The amount by which to increment the reference count, default is 1.

    返回 void

    En

    Increments the reference count of the resource by the specified amount.

    Zh

    按指定数量增加资源的引用计数。

_clearReference

_removeReference

  • _removeReference(count?: number): void

    参数

    • count: number = 1

      The amount by which to decrement the reference count, default is 1.

    返回 void

    En

    Decrements the reference count of the resource by the specified amount. If the reference count reaches zero and certain conditions are met, the resource may be destroyed.

    Zh

    按指定数量减少资源的引用计数。如果引用计数达到零并且满足特定条件，资源可能会被销毁。

_setCPUMemory

_setCreateURL

  • _setCreateURL(url: string, uuid?: string): void

    参数

    • url: string

      The URL used to create the resource.

    • 可选uuid: string

      The optional UUID of the resource.

    返回 void

    En

    Sets the URL and UUID used to create this resource.

    Zh

    设置用于创建此资源的 URL 和 UUID。

_setGPUMemory

addDep

addDeps

destroy

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

    派发事件。

getAniDuration

  • getAniDuration(aniIndex: number): number

    参数

    • aniIndex: number

      The index of the animation to check.

    返回 number

    En

    Get the duration of an animation.

    Zh

    获取动画时长。

getAnimation

  • getAnimation(aniIndex: number): any

    参数

    • aniIndex: number

      The index of the animation to retrieve.

    返回 any

    En

    Retrieve an animation by its index.

    Zh

    通过索引获取动画。

getAnimationCount

getAnimationDataWithCache

  • getAnimationDataWithCache(
        key: any,
        cacheDatas: any,
        aniIndex: number,
        frameIndex: number,
    ): Float32Array

    参数

    • key: any

      The key associated with the data to retrieve.

    • cacheDatas: any

      The cache data storage.

    • aniIndex: number

      The index of the animation.

    • frameIndex: number

      The index of the frame to retrieve data from.

    返回 Float32Array

    The Float32Array containing the animation data, or null if not found.

    En

    Retrieve animation data with caching mechanism.

    Zh

    使用缓存机制获取动画数据。

getNodeCount

  • getNodeCount(aniIndex: number): number

    参数

    • aniIndex: number

      The index of the animation.

    返回 number

    The number of nodes in the animation.

    En

    Get the count of nodes in an animation.

    Zh

    获取动画中的nodes数量。

getNodeIndexWithName

  • getNodeIndexWithName(aniIndex: number, name: string): number

    参数

    • aniIndex: number

      The index of the animation.

    • name: string

      The name of the bone to retrieve.

    返回 number

    The index of the bone.

    En

    Retrieve the index of a bone by its name within an animation.

    Zh

    通过名称获取动画中的骨骼索引。

getNodeKeyFrame

  • getNodeKeyFrame(
        nodeframes: KeyFramesContent[],
        nodeid: number,
        tm: number,
    ): number

    参数

    • nodeframes: KeyFramesContent[]

      The keyframe data for the current bone.

    • nodeid: number

      The bone ID, used for updating the _boneCurKeyFrm.

    • tm: number

      The current time in the animation.

    返回 number

    The index of the keyframe that corresponds to the current time.

    En

    Calculate which keyframe corresponds to the current time.

    • There is an issue with the last frame. For example, if the time of the second to last frame is 0.033ms, the next two frames are very close together. When the actual last frame is given, the time calculated based on the frame number actually falls on the second to last frame. Using accumulated time consistent with AnimationPlayer will resolve this issue.

    Zh

    计算当前时间应该对应关键帧的哪一帧。

    • 最后一帧有问题，例如倒数第二帧时间是0.033ms,则后两帧非常靠近，当实际给最后一帧的时候，根据帧数计算出的时间实际上落在倒数第二帧使用与AnimationPlayer一致的累积时间就行

getNodes

  • getNodes(aniIndex: number): any

    参数

    • aniIndex: number

      The index of the animation.

    返回 any

    En

    Get information about the nodes involved in an animation.

    Zh

    获取动画的nodes信息。

getNodesCurrentFrameIndex

  • getNodesCurrentFrameIndex(aniIndex: number, playCurTime: number): Uint32Array

    参数

    • aniIndex: number

      The index of the animation to retrieve node information from.

    • playCurTime: number

      The current play time of the animation in milliseconds.

    返回 Uint32Array

    A Uint32Array containing the current frame index for each node.

    En

    Get the current frame index for each node in the specified animation.

    Zh

    获取指定动画中每个节点的当前帧索引。

getOriginalData

  • getOriginalData(
        aniIndex: number,
        originalData: Float32Array,
        nodesFrameIndices: any[],
        frameIndex: number,
        playCurTime: number,
    ): void

    参数

    • aniIndex: number

      The index of the animation.

    • originalData: Float32Array

      A Float32Array to be filled with the retrieved animation data. This array is modified in-place.

    • nodesFrameIndices: any[]

      An array containing frame indices for each node (Note: This parameter is not used in the current implementation).

    • frameIndex: number

      The index of the frame to retrieve data for (Note: This parameter is not used in the current implementation).

    • playCurTime: number

      The current play time in the animation (in milliseconds).

    返回 void

    En

    Retrieve and fill the original animation data for a specific frame and time.

    Zh

    获取并填充特定帧和时间的原始动画数据。

getOriginalDataUnfixedRate

  • getOriginalDataUnfixedRate(
        aniIndex: number,
        originalData: Float32Array,
        playCurTime: number,
    ): void

    参数

    • aniIndex: number

      The index of the animation to retrieve data from.

    • originalData: Float32Array

      A Float32Array to be filled with the retrieved animation data. This array is modified in-place.

    • playCurTime: number

      The current play time of the animation in milliseconds.

    返回 void

    En

    Retrieve and fill the original animation data at a specific time for the given animation.

    Zh

    获取并填充指定动画在特定时间的原始动画数据。

getPublicExtData

  • getPublicExtData(): ArrayBuffer

    返回 ArrayBuffer

    The ArrayBuffer containing the public extension data.

    En

    Get the public extension data associated with the animation.

    Zh

    获取动画的附加数据。

getTotalkeyframesLength

  • getTotalkeyframesLength(aniIndex: number): number

    参数

    • aniIndex: number

      The index of the animation.

    返回 number

    The total number of keyframes.

    En

    Get the total length of keyframes in an animation.

    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 对象是否为特定事件类型注册了任何侦听器。

isCreateFromURL

  • isCreateFromURL(url: string): boolean

    参数

    • url: string

      The URL to check against the resource's creation URL.

    返回 boolean

    True if the resource is created from the specified URL, otherwise false.

    En

    Checks if the resource is created from the specified URL.

    Zh

    检查资源是否从指定的 URL 创建。

off

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

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

  • off(
        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[]

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

offAll

  • offAll(type?: string): EventDispatcher

    参数

    • 可选type: string

      (Optional) The type of event. If the value is null, all types of listeners on this object are removed.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove all listeners of the specified event type from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除指定事件类型的所有侦听器。

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 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

setAnimationDataWithCache

  • setAnimationDataWithCache(
        key: any,
        cacheDatas: any[],
        aniIndex: number,
        frameIndex: number,
        data: any,
    ): void

    参数

    • key: any

      The key associated with the data to set.

    • cacheDatas: any[]

      The array of cache data storages.

    • aniIndex: number

      The index of the animation.

    • frameIndex: number

      The index of the frame to set data to.

    • data: any

      The data to set.

    返回 void

    En

    Set animation data with caching mechanism.

    Zh

    设置动画数据并使用缓存机制。

静态destroyUnusedResources

显示设置

成员可见性

目录

属性
访问器
方法