Timeline

clay. Timeline

# new Timeline()

Source:

Timeline.js, line 6

Animation is global timeline that schedule all clips. each frame animation will set the time of clips to current and update the states of clips

Example

var animation = new clay.Timeline();
var node = new clay.Node();
animation.animate(node.position)
    .when(1000, {
        x: 500,
        y: 500
    })
    .when(2000, {
        x: 100,
        y: 100
    })
    .when(3000, {
        z: 10
    })
    .start('spline');

Extends

clay.core.Base

Members

# uid :number

Source:

core/Base.js, line 15

Inherited From:

clay.core.Base#__uid__

Type:

number

# stage :Object

Source:

Timeline.js, line 34

stage is an object with render method, each frame if there exists any animating clips, stage.render will be called

Type:

Object

Methods

# addAnimator(animator)

Source:

Timeline.js, line 54

Add animator

Parameters:

Name	Type	Description
`animator`	clay.animate.Animator

# addClip(clip)

Source:

Timeline.js, line 65

Parameters:

Name	Type	Description
`clip`	clay.animation.Clip

# after(name, action, contextopt)

Source:

core/mixin/notifier.js, line 125

Inherited From:

clay.core.Base#after

Mixes In:

clay.core.mixin.notifier.after

Alias of once('after' + name)

Parameters:

Name	Type	Attributes	Description
`name`	string
`action`	function
`context`	Object	<optional>

# animate(target, optionsopt) → {clay.animation.Animator}

Source:

Timeline.js, line 207

Create an animator

Parameters:

Name Type Attributes Description

target Object

options

Object

<optional>

Properties

Name	Type	Attributes	Description
`loop`	boolean	<optional>
`getter`	function	<optional>
`setter`	function	<optional>
`interpolater`	function	<optional>

Returns:

Type: clay.animation.Animator

# before(name, action, contextopt)

Source:

core/mixin/notifier.js, line 110

Inherited From:

clay.core.Base#before

Mixes In:

clay.core.mixin.notifier.before

Alias of once('before' + name)

Parameters:

Name	Type	Attributes	Description
`name`	string
`action`	function
`context`	Object	<optional>

# error(action, contextopt)

Source:

core/mixin/notifier.js, line 149

Inherited From:

clay.core.Base#error

Mixes In:

clay.core.mixin.notifier.error

Alias of on('error')

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# has(name, action) → {boolean}

Source:

core/mixin/notifier.js, line 187

Inherited From:

clay.core.Base#has

Mixes In:

clay.core.mixin.notifier.has

If registered the event handler

Parameters:

Name	Type	Description
`name`	string
`action`	function

Returns:

Type: boolean

# off(action, contextopt)

Source:

core/mixin/notifier.js, line 159

Inherited From:

clay.core.Base#off

Mixes In:

clay.core.mixin.notifier.off

Remove event listener

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# on(name, action, contextopt)

Source:

core/mixin/notifier.js, line 65

Inherited From:

clay.core.Base#on

Mixes In:

clay.core.mixin.notifier.on

Register event handler

Parameters:

Name	Type	Attributes	Description
`name`	string
`action`	function
`context`	Object	<optional>

# once(name, action, contextopt)

Source:

core/mixin/notifier.js, line 91

Inherited From:

clay.core.Base#once

Mixes In:

clay.core.mixin.notifier.once

Register event, event will only be triggered once and then removed

Parameters:

Name	Type	Attributes	Description
`name`	string
`action`	function
`context`	Object	<optional>

# pause()

Source:

Timeline.js, line 174

Pause

# removeAnimator(animator)

Source:

Timeline.js, line 85

Remove animator

Parameters:

Name	Type	Description
`animator`	clay.animate.Animator

# removeClip(clip)

Source:

Timeline.js, line 74

Parameters:

Name	Type	Description
`clip`	clay.animation.Clip

# removeClipsAll()

Source:

Timeline.js, line 194

Remove all clips

# resume()

Source:

Timeline.js, line 184

Resume

# start()

Source:

Timeline.js, line 140

Start running animation

# stop()

Source:

Timeline.js, line 167

Stop running animation

# success(action, contextopt)

Source:

core/mixin/notifier.js, line 139

Inherited From:

clay.core.Base#success

Mixes In:

clay.core.mixin.notifier.success

Alias of on('success')

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# trigger(name)

Source:

core/mixin/notifier.js, line 14

Inherited From:

clay.core.Base#trigger

Mixes In:

clay.core.mixin.notifier.trigger

Trigger event

Parameters:

Name	Type	Description
`name`	string