Blend2DClip

clay.animation. Blend2DClip

# new Blend2DClip(optsopt)

Source:

2d blending node in animation blend tree. output clip must have blend2D method

Parameters:
Name Type Attributes Description
opts Object <optional>
Properties
Name Type Attributes Description
name string <optional>
target Object <optional>
life number <optional>
delay number <optional>
gap number <optional>
playbackRatio number <optional>
loop boolean | number <optional>

If loop is a number, it indicate the loop count of animation
easing string | function <optional>
onframe function <optional>
onfinish function <optional>
onrestart function <optional>
inputs Array.<object> <optional>
position clay.Vector2 <optional>
output clay.animation.Clip <optional>

Extends

Members

# delay :number

Source:
Inherited From:
Type:
  • number

# gap :number

Source:
Inherited From:
Type:
  • number

# inputs :Array.<clay.animation.Blend2DClip.IClipInput>

Source:
Type:

# life :number

Source:
Overrides:
Type:
  • number

# name :string

Source:
Inherited From:
Type:
  • string

# onfinish :function

Source:
Inherited From:
Type:
  • function

# onframe :function

Source:
Inherited From:
Type:
  • function

# onrestart :function

Source:
Inherited From:
Type:
  • function

# output :clay.animation.Clip

Source:

Output clip must have blend2D method

Type:

# playbackRate :number

Source:
Inherited From:
Type:
  • number

# position :clay.Vector2

Source:
Type:

# target :Object

Source:
Inherited From:
Type:
  • Object

Methods

# addInput(position, inputClip, offsetopt) → {clay.animation.Blend2DClip.IClipInput}

Source:
Parameters:
Name Type Attributes Description
position clay.Vector2
inputClip clay.animation.Clip
offset number <optional>
Returns:
Type
clay.animation.Blend2DClip.IClipInput

# clone(cloneInputs) → {clay.animation.Blend2DClip}

Source:

Clone a new Blend2D clip

Parameters:
Name Type Description
cloneInputs boolean

True if clone the input clips
Returns:
Type
clay.animation.Blend2DClip

# pause()

Source:
Inherited From:

Pause the clip.

# resume()

Source:
Inherited From:

Resume the clip.

# setEasing(easing)

Source:
Inherited From:
Parameters:
Name Type Description
easing string | function

# setLoop(loop)

Source:
Inherited From:
Parameters:
Name Type Description
loop number | boolean

# setTime(time) → {string}

Source:
Overrides:
Parameters:
Name Type Description
time number
Returns:
Type
string

# step(time) → {string}

Source:
Overrides:
Parameters:
Name Type Description
time number
Returns:
Type
string

Type Definitions

# IClipInput

Source:
Properties:
Name Type Description
position clay.Vector2
clip clay.animation.Clip
offset number
Type:
  • Object