+Show TOC
×Hide TOC

AdvancedTween

Kind of class:	public interface
Package:	com.bourre.transitions
Inherits from:	Tween < Suspendable
Implemented by:	AbstractMultiTween AbstractTween
Author:	Francis Bourre, Cédric Néhémie
Classpath:	com.bourre.transitions.AdvancedTween
File last modified:	Monday, 24 November 2008, 11:36:57

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */     
package com.bourre.transitions
{
    import com.bourre.commands.ASyncCommand;     

    /**
     * The <code>AdvancedTween</code> interface extends <code>Tween</code> and
     * add the support for event dispatching.
     * <p>
     * The tween object invokes the <code>TweenEvent.onMotionChangedEVENT</code>
     * event on a regular interval on the effect instance for the duration of
     * the tween, passing to the <code>onMotionChanged</code> method the interpolated
     * value between the start value and the end value. Typically, the callback function
     * updates some property of the target object, causing that object to animate
     * over the duration of the effect.
     * </p><p>
     * When the effect ends, the tween objects invokes <code>TweenEvent.onMotionFinishedEVENT</code>
     * event on its listeners, if you defined one.
     * </p><p>
     * Take a look at <a href='MultiTweenFPS.html'>MultiTweenFPS</a>, 
     * <a href='MultiTweenMS.html'>MultiTweenMS</a>, <a href='TweenFPS.html'>TweenFPS</a> 
     * and <a href='cTweenMS.html'>TweenMS</a> for concret implementations.
     * </p>
     * @author    Francis Bourre
     * @author    C√©dric N√©h√©mie
     * @see        Tween
     */
    public interface AdvancedTween extends Tween, ASyncCommand
    {
        /**
         * Adds the passed-in listener object as listener for
         * all events dispatched by the tween. The object must
         * implements the <code>TweenListener</code> interface.
         * 
         * @param    listener    object to be added as listener.
         * @return    <code>true</code> if the object have been succesfully
         *             added as listener for this object
         * @see        com.bourre.events.EventBroadcaster#addListener() See the
         *             EventBroadcaster.addListener() documentation for a complete
         *             description of the behavior of that method
         */
        function addListener( listener : TweenListener ) : Boolean;
        
        /**
         * Removes the passed-in listener from listening all events
         * dispatched by this tween. 
         * 
         * @param    listener     object to be removed as listener.
         * @return    <code>true</code> if the object have been succesfully removed
         *             as listener for this object
         * @see        com.bourre.events.EventBroadcaster#removeListener() See the
         *             EventBroadcaster.removeListener() documentation for a complete
         *             description of the behavior of that method
         */
        function removeListener( listener : TweenListener ) : Boolean;
        
        /**
         * Adds the passed-in listener as listener for the passed-in event type.
         * 
         * @param    type        name of the event type.
         * @param    listener    object to be added as listener.
         * @return    <code>true</code> if the object have been succesfully added as
         *             listener for the passed-in event type
         * @see        com.bourre.events.EventBroadcaster#addEventListener() See the
         *             EventBroadcaster.addEventListener() documentation for a complete
         *             description of the behavior of that method
         */
        function addEventListener( type : String, listener : Object, ... rest ) : Boolean;
        
        /**
         * Removes the passed-in listener for listening the passed-in event type.
         * 
         * @param    type        name of the event type.
         * @param    listener    object to be removed as listener.
         * @return    <code>true</code> if the object have been succesfully remove as
         *             listener for the passed-in event type
         * @see        com.bourre.events.EventBroadcaster#removeEventListener() See the
         *             EventBroadcaster.removeEventListener() documentation for a complete
         *             description of the behavior of that method
         */
        function removeEventListener( type : String, listener : Object ) : Boolean;
    }
}

The AdvancedTween interface extends Tween and
add the support for event dispatching.

The tween object invokes the TweenEvent.onMotionChangedEVENTevent on a regular interval on the effect instance for the duration of
the tween, passing to the onMotionChanged method the interpolated
value between the start value and the end value. Typically, the callback function
updates some property of the target object, causing that object to animate
over the duration of the effect.

When the effect ends, the tween objects invokes TweenEvent.onMotionFinishedEVENTevent on its listeners, if you defined one.

Take a look at MultiTweenFPS,
MultiTweenMS, TweenFPS
and TweenMS for concret implementations.

See also:

Tween

Summary

Instance methods

addListener (listener:TweenListener) : Boolean
- Adds the passed-in listener object as listener for
removeListener (listener:TweenListener) : Boolean
- Removes the passed-in listener from listening all events
addEventListener (type:String, listener:Object, rest) : Boolean
- Adds the passed-in listener as listener for the passed-in event type.
removeEventListener (type:String, listener:Object) : Boolean
- Removes the passed-in listener for listening the passed-in event type.

Instance methods inherited from Tween

setEasing

Instance methods

addEventListener

public function addEventListener (

type:String, listener:Object, rest) : Boolean

Adds the passed-in listener as listener for the passed-in event type.

Parameters:

type :

name of the event type.

listener:

object to be added as listener.

Returns:

true if the object have been succesfully added as
listener for the passed-in event type

See also:

See the
EventBroadcaster.addEventListener() documentation for a complete
description of the behavior of that method

addListener

public function addListener (

listener:TweenListener) : Boolean

Adds the passed-in listener object as listener for
all events dispatched by the tween. The object must
implements the TweenListener interface.

Parameters:

listener:

object to be added as listener.

Returns:

true if the object have been succesfully
added as listener for this object

See also:

See the
EventBroadcaster.addListener() documentation for a complete
description of the behavior of that method

removeEventListener

public function removeEventListener (

type:String, listener:Object) : Boolean

Removes the passed-in listener for listening the passed-in event type.

Parameters:

type :

name of the event type.

listener:

object to be removed as listener.

Returns:

true if the object have been succesfully remove as
listener for the passed-in event type

See also:

See the
EventBroadcaster.removeEventListener() documentation for a complete
description of the behavior of that method

removeListener

public function removeListener (

listener:TweenListener) : Boolean

Removes the passed-in listener from listening all events
dispatched by this tween.

Parameters:

listener:

object to be removed as listener.

Returns:

true if the object have been succesfully removed
as listener for this object

See also:

See the
EventBroadcaster.removeListener() documentation for a complete
description of the behavior of that method