Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Animator

动画状态机组件。

export

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Animator(entity: Entity3D): Animator

Properties

bindAnimationClipOnNeed

bindAnimationClipOnNeed: boolean = false

是否动态绑定动画资源，对于包含大量动画资源的动画状态机能够降低初始化耗时。

Readonly entity

entity: Entity3D

Readonly id

id: number = ...

interruptionSupport

interruptionSupport: boolean = ...

是否支持转移中断逻辑，默认关闭。

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean

  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

controller

  • 动画状态机的控制器。

    Returns AnimatorController

  • 动画状态机的控制器。

    Parameters

    Returns void

layerCount

  • get layerCount(): number

  • 动画状态机的分层数目。

    Returns number

layers

  • 动画状态机的分层。

    Returns readonly AnimatorControllerLayer[]

parameterCount

  • get parameterCount(): number

  • 动画状态机的参数数目。

    Returns number

parameters

skeleton

  • 动画状态机所操控的骨架。

    Returns Skeleton

  • 动画状态机所操控的骨架。

    Parameters

    Returns void

speed

  • get speed(): number
  • set speed(speed: number): void

  • 动画状态机的整体播放速度，可以设为0来实现暂停功能。

    Returns number

  • 动画状态机的整体播放速度，可以设为0来实现暂停功能。

    Parameters

    • speed: number

    Returns void

Methods

crossFade

  • crossFade(fullOrPartialName: string, normalizedTransitionDuration: number, layer?: number, normalizedTimeOffset?: number, normalizedTransitionTime?: number, fixedDuration?: boolean): void

  • 指定一个分层，设置从当前动画状态过渡到指定动画状态。

    Parameters

    • fullOrPartialName: string

      动画状态的名称，当第二个参数（分层索引）未设置的时候需要加上分层名称，例如：'Base Layer.Run'

    • normalizedTransitionDuration: number

      过渡时长

    • Optional layer: number

      分层索引

    • Optional normalizedTimeOffset: number

      动画状态已播放的归一化时长偏移

    • Optional normalizedTransitionTime: number

      动画状态转移已流逝的归一化时长

    • fixedDuration: boolean = true

      过渡时长是否被视为绝对长度（单位为秒），如果为false则被视为转移长度的百分比

    Returns void

destroy

  • destroy(): void

  • Returns void

getAnimatorTransitionInfo

  • getAnimatorTransitionInfo(layerIndex: number): IAnimatorStateTransitionInfo

  • 获取动画状态机指定分层的当前转移信息。

    Parameters

    • layerIndex: number

      分层索引

    Returns IAnimatorStateTransitionInfo

getBool

  • getBool(arg: string): boolean

  • 获取对应参数名的布尔型值。

    Parameters

    • arg: string

      参数名称

    Returns boolean

getCurrentAnimatorState

  • 获取指定分层的当前动画状态对象。

    Parameters

    • layerIndex: number = 0

      分层索引

    Returns AnimatorState

    对应分层当前动画状态对象

getCurrentAnimatorStateInfo

  • getCurrentAnimatorStateInfo(layerIndex?: number): IAnimatorStateInfo

  • 获取指定分层的当前动画状态信息。

    Parameters

    • layerIndex: number = 0

      分层索引

    Returns IAnimatorStateInfo

    对应分层当前动画状态信息

getCurrentAnimatorTransition

  • 获取指定分层的当前动画转移对象。

    Parameters

    • layerIndex: number = 0

      分层索引

    Returns AnimatorStateTransition

    对应分层当前动画转移对象

getCurrentAnimatorTransitionInfo

  • getCurrentAnimatorTransitionInfo(layerIndex?: number): IAnimatorStateTransitionInfo

  • Parameters

    • layerIndex: number = 0

    Returns IAnimatorStateTransitionInfo

getFloat

  • getFloat(arg: string): number

  • 获取对应参数名的浮点数值。

    Parameters

    • arg: string

      参数名称

    Returns number

getInteger

  • getInteger(arg: string): number

  • 获取对应参数名的整型数值。

    Parameters

    • arg: string

      参数名称

    Returns number

getLayerWeight

  • getLayerWeight(layerIndex?: number): number

  • 获取分层的权重。

    Parameters

    • layerIndex: number = 0

      分层索引

    Returns number

getNextAnimatorStateInfo

  • getNextAnimatorStateInfo(layerIndex?: number): IAnimatorStateInfo

  • 获取指定分层的当前动画下一状态对象。

    Parameters

    • layerIndex: number = 0

      分层索引

    Returns IAnimatorStateInfo

    如果当前状态存在并正在转移转移，则返回对应分层当前状态转移的目标状态对象

getParameter

  • 获取动画状态机的参数。

    Parameters

    • name: string

      参数名称

    Returns AnimatorControllerParameter

getTypeName

  • getTypeName(): string

hasState

  • hasState(layerIndex: number, name: string): boolean

  • 查询动画状态机指定分层是否包含指定名称的动画状态。

    Parameters

    • layerIndex: number

      分层索引

    • name: string

      动画状态名称

    Returns boolean

isDetached

  • isDetached(): boolean

  • Returns boolean

isInTransition

  • isInTransition(layerIndex: number): boolean

  • 查询动画状态机指定分层是否正在发生状态转移。

    Parameters

    • layerIndex: number

      分层索引

    Returns boolean

play

  • play(stateName: string, layer?: number, normalizedTime?: number): void

  • 指定一个分层，播放指定动画状态。

    Parameters

    • stateName: string

      动画状态的名称，当第二个参数（分层索引）未设置的时候需要加上分层名称，例如：'Base Layer.Run'

    • Optional layer: number

      分层索引

    • Optional normalizedTime: number

      动画状态已播放的归一化时长

    Returns void

rebind

  • rebind(flag?: number): void

  • 重绑动画。

    Parameters

    • flag: number = ...

      重绑类型

    Returns void

resetProperties

  • resetProperties(): void

resetTrigger

  • resetTrigger(arg: string): void

  • 重置对应参数名的触发器。

    Parameters

    • arg: string

      参数名称

    Returns void

setBool

  • setBool(arg: string, value: boolean): void

  • 设置对应参数名的布尔型值。

    Parameters

    • arg: string

      参数名称

    • value: boolean

      布尔型值

    Returns void

setFloat

  • setFloat(arg: string, value: number): void

  • 设置对应参数名的浮点数值。

    Parameters

    • arg: string

      参数名称

    • value: number

      浮点数值

    Returns void

setInteger

  • setInteger(arg: string, value: number): void

  • 设置对应参数名的整型数值。

    Parameters

    • arg: string

      参数名称

    • value: number

      整型数值

    Returns void

setTrigger

  • setTrigger(arg: string): void

  • 设置对应参数名的触发器。

    Parameters

    • arg: string

      参数名称

    Returns void

update

  • update(dt: number): void

  • 指定一段时长并更新动画。

    Parameters

    • dt: number

      时长（单位秒），可以为0

    Returns void

writeDefaults

  • writeDefaults(): void

  • 恢复动画绑定前的默认骨骼姿态。

    Returns void

Generated using TypeDoc