+Show TOC
×Hide TOC

TweenEvent

Kind of class:	public class
Package:	com.bourre.transitions
Inherits from:	BasicEvent < Event
Classpath:	com.bourre.transitions.TweenEvent
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.events.BasicEvent;
    import com.bourre.log.PixlibStringifier; 

    /**
     * <code>TweenEvent</code> defines event model for Tween API.
     * <p>
     * Based on <code>com.bourre.events.BasicEvent</code> class.
     * </p><p>
     * <code>TweenEvent</code> events are broadcasted by <code>Tween</code>
     * instances. 
     * </p>
     * @author Francis Bourre
     */
    public class TweenEvent extends BasicEvent
    {
        /**
         * Broadcasted to listeners when tween starts.
         */
        public static const onStartEVENT:String = "onStart";
        
        /**
         * Broadcasted to listeners when tween stops.
         */
        public static const onStopEVENT:String = "onStop";
        
        /**
         * Broadcasted to listeners when tween is finished.
         */
        public static const onMotionFinishedEVENT:String = "onMotionFinished";
        
        /**
         * Broadcasted to listeners when property value is updated.
         */
        public static const onMotionChangedEVENT:String = "onMotionChanged";
        
        //-------------------------------------------------------------------------
        // Private properties
        //-------------------------------------------------------------------------
        
        private var _oTween:AdvancedTween;
        
        //-------------------------------------------------------------------------
        // Public API
        //-------------------------------------------------------------------------
        
        /**
         * Constructs a new <code>TweenEvent</code> instance broadcasted by <code>Tween</code> 
         * family classes.
         * 
         * @param    e        name of the event type.
         * @param    tween     <code>Tween</code> instance which trigger the event.
         * @example
         * <listing>
         *   var e:TweenEvent = new TweenEvent( TweenEvent.onMotionFinishedEVENT, this );
         * </listing>
         */
        public function TweenEvent( e : String, tween : AdvancedTween )
        {
            super(e);
            _oTween = tween;
        }
        
        /**
         * Returns <code>Tween</code> event source.
         * 
         * @return <code>Tween</code> instance
         * @example 
         * <listing>
         *   var t:TweenMS = e.getTween();
         * </listing>
         */
        public function getTween() : AdvancedTween
        {
            return _oTween;
        }
        
        /**
         * Returns the string representation of this instance.
         * <p>
         * <code>com.bourre.events.BasciEvent#toString</code> overridding
         * </p>
         * @return <code>String</code> representation of this instance
         */
        public override function toString() : String
        {
            return PixlibStringifier.stringify( this ) + type + ', ' + getTween();
        }
    }
}

Summary

Constructor

TweenEvent (e:String, tween:AdvancedTween)
- Constructs a new TweenEvent instance broadcasted by Tween

Instance properties

Instance properties inherited from BasicEvent

_oTarget _sType target type

Instance methods

getTween : AdvancedTween
- Returns Tween event source.
toString : String
- Returns the string representation of this instance.

Instance methods inherited from BasicEvent

clone getTarget getType setTarget setType toString

Event handlers

onStartEVENT : String
- Broadcasted to listeners when tween starts.
onStopEVENT : String
- Broadcasted to listeners when tween stops.
onMotionFinishedEVENT : String
- Broadcasted to listeners when tween is finished.
onMotionChangedEVENT : String
- Broadcasted to listeners when property value is updated.

Constructor

TweenEvent

public function TweenEvent (

e:String, tween:AdvancedTween)

Constructs a new TweenEvent instance broadcasted by Tween
family classes.

Parameters:

e :

name of the event type.

tween:

Tween instance which trigger the event.

Example:

var e:TweenEvent = new TweenEvent( TweenEvent.onMotionFinishedEVENT, this );

Instance methods

getTween

public function getTween (

) : AdvancedTween

Returns Tween event source.

Returns:

Tween instance

Example:

var t:TweenMS = e.getTween();

toString

override public function toString (

) : String

Returns the string representation of this instance.

com.bourre.events.BasciEvent#toString overridding

Returns:

String representation of this instance

Overrides:

BasicEvent.toString

Event handlers

onMotionChangedEVENT

public static const onMotionChangedEVENT:String = "onMotionChanged"

(read)

Broadcasted to listeners when property value is updated.

onMotionFinishedEVENT

public static const onMotionFinishedEVENT:String = "onMotionFinished"

(read)

Broadcasted to listeners when tween is finished.

onStartEVENT

public static const onStartEVENT:String = "onStart"

(read)

Broadcasted to listeners when tween starts.

onStopEVENT

public static const onStopEVENT:String = "onStop"

(read)

Broadcasted to listeners when tween stops.