FORGE. Animation

new Animation(viewer, target)

Abstract class allowing the animation of an element, given instructions about it.
Parameters:
Name Type Description
viewer FORGE.Viewer FORGE.Viewer reference
target * The element to animate
Source:

Extends

Members

(readonly) alive :boolean

Get the alive flag value of the object.
Type:
  • boolean
Inherited From:
Source:

(readonly) className :string

Get the class name of the object.
Type:
  • string
Inherited From:
Source:

data :*

Get and set any custom data you want to associate to this object.
Type:
  • *
Inherited From:
Source:

debug :boolean

Get and set the debug flag.
Type:
  • boolean
Inherited From:
Source:

instruction :AnimationInstruction

Accessors to instruction.
Type:
  • AnimationInstruction
Source:

(readonly) onComplete :FORGE.EventDispatcher

Get the "onComplete" FORGE.EventDispatcher of the target.
Type:
Source:

(readonly) onDestroy :FORGE.EventDispatcher

Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
Inherited From:
Source:

(readonly) onPlay :FORGE.EventDispatcher

Get the "onPlay" FORGE.EventDispatcher of the target.
Type:
Source:

(readonly) onProgress :FORGE.EventDispatcher

Get the "onProgress" FORGE.EventDispatcher of the target.
Type:
Source:

(readonly) onStop :FORGE.EventDispatcher

Get the "onStop" FORGE.EventDispatcher of the target.
Type:
Source:

(readonly) running :boolean

Accessors to the running flag
Type:
  • boolean
Source:

smooth :number

Accessors to smooth.
Type:
  • number
Source:

(readonly) tags :Array

Get the tags associated to this object.
Type:
  • Array
Inherited From:
Source:

(readonly) timeline :FORGE.Timeline

Accessors to timeline
Type:
Source:

tween :number

Accessors to tween.
Type:
  • number
Source:

tweenTime :number

Accessors to normalized tween time.
Type:
  • number
Source:

(readonly) uid :string

Get the uid of the object.
Type:
  • string
Inherited From:
Source:

warning :boolean

Get and set the warning flag.
Type:
  • boolean
Inherited From:
Source:

Methods

destroy()

Destroy sequence.
Overrides:
Source:

log(value)

Basic log method, log a string in the console if debug is enabled.
Parameters:
Name Type Description
value * The value you want to log in the console.
Inherited From:
Source:

play(timeopt)

Play the animation.
Parameters:
Name Type Attributes Description
time number <optional>
 Time to start the animation at
Source:

resume()

Resume the animation.
Source:

stop()

Stop the animation.
Source:

warn(valuenullable)

Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
Name Type Attributes Description
value string | Object <nullable>
 The value you want to warn in the console.
Inherited From:
Source:

FORGE. Animation

Members
Methods