Class AnimationLayer

The AnimationLayerInfo struct contains persistent information about a known layer, such as blend opacity or name.

Index

Constructors

Accessors

animationID blendMode defaultSpeed defaultWrapMode id mask name opacity

Methods

Constructors

`Protected`constructor

new AnimationLayer(isInternalConstructor?: boolean): AnimationLayer
Parameters
- OptionalisInternalConstructor: boolean
Returns AnimationLayer

Overrides FrameworkObject.constructor

Accessors

animationID

get animationID(): number

Returns number

blendMode

get blendMode(): EnumValue<AnimationLayerBlendMode>

The blend mode of the layer.

Returns EnumValue<AnimationLayerBlendMode>
set blendMode(value: EnumValue<AnimationLayerBlendMode>): void
Parameters
- value: EnumValue<AnimationLayerBlendMode>
Returns void

defaultSpeed

get defaultSpeed(): number

The default speed for new clips of the layer.

Returns number
set defaultSpeed(value: number): void
Parameters
- value: number
Returns void

defaultWrapMode

get defaultWrapMode(): EnumValue<AnimationWrapMode>

The default wrap mode for new clips of the layer.

Returns EnumValue<AnimationWrapMode>
set defaultWrapMode(value: EnumValue<AnimationWrapMode>): void
Parameters
- value: EnumValue<AnimationWrapMode>
Returns void

id

get id(): number

Returns number

mask

get mask(): SkeletonMask

The SkeletonMask of the layer, can be used to disable the influence of a layer.

Returns SkeletonMask
set mask(value: SkeletonMask): void
Parameters
- value: SkeletonMask
Returns void

name

get name(): string

The name of the layer.

Returns string
set name(value: string): void
Parameters
- value: string
Returns void

opacity

get opacity(): number

The opacity of the layer.

Returns number
set opacity(value: number): void
Parameters
- value: number
Returns void

Methods

fadeIn

fadeIn(length: number, targetOpacity: number): void
Fades in the layer for the specified length in seconds.
Parameters
- length: number
  The fade length in seconds.
- targetOpacity: number
  The target opacity.
Returns void

fadeOut

fadeOut(length: number, stopWhenDone: boolean): void
Fades out the layer for the specified length in seconds.
Parameters
- length: number
  The fade length in seconds.
- stopWhenDone: boolean
  Stops all clips on the layer when done.
Returns void