Class Index | File Index

Classes


Class zwt.animation.Animation


Extends zwt.Object.

This is the base animation class.

An animation is applied on an HTML element to modify one or more of its properties within a given period. The values are updated based on a function provided by an animation engine.


Defined in: Animation.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
zwt.animation.Animation(Element_element)
Construct an animation object.
Method Summary
Method Attributes Method Name and Description
 
Return the animation event manager attached to the animation.
 
Return the duration of the animation.
 
Return the animation engine.
 
onEvent(zwt_animation_AnimationEvent_event)
Dispatch the specified event to the appropriate event manager.
 
setDuration(int_duration)
Set the duration of the animation.
 
setEngine(zwt_animation_Engine_engine)
Set the animation engine.
 
step(int_time)
Execute an animation step and updates the element properties to the values returned by the engine for the specified time.
Class Detail
zwt.animation.Animation(Element_element)
Construct an animation object.
Author: Jeremy KUHN.
Parameters:
{Element} Element_element
The HTML element to animate
See:
zwt.animation.Engine
zwt.animation.AnimationProcessor
Method Detail
{zwt.animation.AnimationEventManager} getAnimationEventManager()
Return the animation event manager attached to the animation.
Returns:
The animation event manager

{Integer} getDuration()
Return the duration of the animation.
Returns:
The duration of the animation

{zwt.animation.Engine} getEngine()
Return the animation engine.
Returns:
The animation engine

onEvent(zwt_animation_AnimationEvent_event)
Dispatch the specified event to the appropriate event manager.
Parameters:
{zwt.animation.AnimationEvent} zwt_animation_AnimationEvent_event
The event to dispatch

setDuration(int_duration)
Set the duration of the animation.
Parameters:
{Integer} int_duration
The duration of the animation

setEngine(zwt_animation_Engine_engine)
Set the animation engine.
Parameters:
{zwt.animation.Engine} zwt_animation_Engine_engine
The engine to set

step(int_time)
Execute an animation step and updates the element properties to the values returned by the engine for the specified time.

This method is called by the animation processor.

Parameters:
{Integer} int_time
The current step time

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Nov 09 2011 19:29:06 GMT+0100 (CET)