+Show TOC
×Hide TOC

TweenEvent

Kind of class:	public class
Package:	org.casalib.events
Inherits from:	Event
Dispatched by:	Tween
Version:	10/27/08
Author:	Mike Creighton, Aaron Clinger
Classpath:	org.casalib.events.TweenEvent
File last modified:	Monday, 01 December 2008, 11:16:36

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2008, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/
package org.casalib.events {
    import flash.events.Event;
    import org.casalib.math.Percent;
    
    /**
        An event dispatched from {@link Tween}.
        
        @author Mike Creighton
        @author Aaron Clinger
        @version 10/27/08
    */
    public class TweenEvent extends Event {
        public static const COMPLETE:String = 'complete';
        public static const RESUME:String   = 'resume';
        public static const START:String    = 'start';
        public static const STOP:String     = 'stop';
        public static const UPDATE:String   = 'update';
        protected var _position:Number;
        protected var _progress:Percent;
        
        
        /**
            Creates a new TweenEvent.
            
            @param type: The type of event.
            @param bubbles: Determines whether the Event object participates in the bubbling stage of the event flow.
            @param cancelable: Determines whether the Event object can be canceled.
        */
        public function TweenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) {
            super(type, bubbles, cancelable);
        }
        
        /**
            The current position of the tween.
        */
        public function get position():Number {
            return this._position;
        }
        
        public function set position(value:Number):void {
            this._position = value;
        }
        
        /**
            The percent completed of the tween's duration.
        */
        public function get progress():Percent {
            return this._progress.clone();
        }
        
        public function set progress(percent:Percent):void {
            this._progress = percent.clone();
        }
        
        /**
            @return A string containing all the properties of the event.
        */
        override public function toString():String {
            return formatToString('TweenEvent', 'type', 'bubbles', 'cancelable', 'position', 'progress');
        }
        
        /**
            @return Duplicates an instance of the event.
        */
        override public function clone():Event {
            var e:TweenEvent = new TweenEvent(this.type, this.bubbles, this.cancelable);
            e.position       = this.position;
            e.progress       = this.progress;
            
            return e;
        }
    }
}

An event dispatched from Tween.

Summary

Constructor

TweenEvent (type:String, bubbles:Boolean = false, cancelable:Boolean = false)
- Creates a new TweenEvent.

Constants

COMPLETE : String
RESUME : String
START : String
STOP : String
UPDATE : String

Instance properties

position : Number
- The current position of the tween.
progress : Percent
- The percent completed of the tween's duration.

Instance methods

toString : String
clone : Event

Constructor

TweenEvent

public function TweenEvent (

type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Creates a new TweenEvent.

Parameters:

type :

The type of event.

bubbles :

Determines whether the Event object participates in the bubbling stage of the event flow.

cancelable:

Determines whether the Event object can be canceled.

Constants

COMPLETE

public static const COMPLETE:String = 'complete'

(read)

RESUME

public static const RESUME:String = 'resume'

(read)

START

public static const START:String = 'start'

(read)

STOP

public static const STOP:String = 'stop'

(read)

UPDATE

public static const UPDATE:String = 'update'

(read)

Instance properties

position

public position:Number

(read,write)

The current position of the tween.

progress

public progress:Percent

(read,write)

The percent completed of the tween's duration.

Instance methods

clone

override public function clone (

) : Event

Returns:

Duplicates an instance of the event.

Overrides:

Event.clone

toString

override public function toString (

) : String

Returns:

A string containing all the properties of the event.

Overrides:

Event.toString