+Show TOC
×Hide TOC

PropertyTween

Kind of class:	public class
Package:	org.casalib.transitions
Inherits from:	Tween < Process < RemovableEventDispatcher < EventDispatcher
Version:	09/06/09
Author:	Aaron Clinger, Mike Creighton, Jon Adams
Classpath:	org.casalib.transitions.PropertyTween
File last modified:	Sunday, 06 September 2009, 09:05:21

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2009, 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.transitions {
    
    /**
        A simple property tween class that extends {@link Tween}.
        
        @author Aaron Clinger
        @author Mike Creighton
        @author Jon Adams
        @version 09/06/09
        @example
            <code>
                package {
                    import fl.motion.easing.Bounce;
                    import org.casalib.display.CasaMovieClip;
                    import org.casalib.display.CasaSprite;
                    import org.casalib.transitions.PropertyTween;
                    
                    
                    public class MyExample extends CasaMovieClip {
                        protected var _box:CasaSprite;
                        protected var _tween:PropertyTween;
                        
                        
                        public function MyExample() {
                            super();
                            
                            this._box = new CasaSprite();
                            this._box.graphics.beginFill(0xFF00FF);
                            this._box.graphics.drawRect(0, 0, 25, 25);
                            this._box.graphics.endFill();
                            
                            this.addChild(this._box);
                            
                            this._tween = new PropertyTween(this._box, "x", Bounce.easeOut, 200, 5);
                            this._tween.start();
                        }
                    }
                }
            </code>
        @usageNote If you want to tween a value other than a property use {@link Tween}.
    */
    public class PropertyTween extends Tween {
        protected var _scope:Object;
        protected var _property:String;
        
        
        /**
            A convenience method that creates and starts a new PropertyTween and {@link Tween#start starts} it automatically.
            
            @param scope: An object that contains the property specified by {@code property}.
            @param property: Name of the property you want to tween.
            @param equation: The tween equation.
            @param endPos: The ending value of the transition.
            @param duration: Length of time of the transition.
            @param useFrames: Indicates to use frames {@code true}, or seconds {@code false} in relation to the value specified in the {@code duration} parameter.
            @return: A {@PropertyTween property}.
         */
        public static function to(scope:Object, property:String, equation:Function, endPos:Number, duration:Number, useFrames:Boolean = false):PropertyTween {
            var pt:PropertyTween = new PropertyTween(scope, property, equation, endPos, duration, useFrames);
            pt.start();
            
            return pt;
        }
        
        /**
            A convenience method that creates and starts a new PropertyTween and {@link Tween#start starts} it automatically.
            
            @param scope: An object that contains the property specified by {@code property}.
            @param property: Name of the property you want to tween.
            @param equation: The tween equation.
            @param startPos: The beginning value of the transition.
            @param duration: Length of time of the transition.
            @param useFrames: Indicates to use frames {@code true}, or seconds {@code false} in relation to the value specified in the {@code duration} parameter.
            @return: A {@PropertyTween property}.
         */
        public static function from(scope:Object, property:String, equation:Function, startPos:Number, duration:Number, useFrames:Boolean = false):PropertyTween {
            var endPos:Number = scope[property];
            scope[property]   = startPos;
            
            var pt:PropertyTween = new PropertyTween(scope, property, equation, endPos, duration, useFrames);
            pt.start();
            
            return pt;
        }
        
        /**
            Creates and defines a new PropertyTween.
            
            @param scope: An object that contains the property specified by <code>property</code>.
            @param property: Name of the property you want to tween.
            @param equation: The tween equation.
            @param endPos: The ending value of the transition.
            @param duration: Length of time of the transition.
            @param useFrames: Indicates to use frames <code>true</code>, or seconds <code>false</code> in relation to the value specified in the <code>duration</code> parameter.
            @usageNote The function specified in the <code>equation</code> parameter must follow the (currentTime, startPosition, endPosition, totalTime) parameter standard.
        */
        public function PropertyTween(scope:Object, property:String, equation:Function, endPos:Number, duration:Number, useFrames:Boolean = false) {
            this._scope    = scope;
            this._property = property;
            
            super(equation, this.position, endPos, duration, useFrames);
        }
        
        /**
            @exclude
        */
        override public function start():void {
            this._initPropertyTween();
            
            super.start();
        }
        
        /**
            @exclude
        */
        override public function continueTo(endPos:Number, duration:Number):void {
            this._initPropertyTween();
            
            super.continueTo(endPos, duration);
        }
        
        /**
            @exclude
        */
        override public function get position():Number {
            return this.scope[this.property];
        }
        
        /**
            @exclude
        */
        override public function set position(pos:Number):void {
            this.scope[this.property] = pos;
        }
        
        /**
            Retrieves the object defined as scope in the class' constructor.
        */
        public function get scope():Object {
            return this._scope;
        }
        
        /**
            Retrieves the property as a String defined in the class' constructor.
        */
        public function get property():String {
            return this._property;
        }
        
        protected function _initPropertyTween():void {
            this._begin   = this.position;
            this._diff    = this._end - this._begin;
        }
    }
}

A simple property tween class that extends Tween.

Example:

package {
    import fl.motion.easing.Bounce;
    import org.casalib.display.CasaMovieClip;
    import org.casalib.display.CasaSprite;
    import org.casalib.transitions.PropertyTween;


    public class MyExample extends CasaMovieClip {
        protected var _box:CasaSprite;
        protected var _tween:PropertyTween;


        public function MyExample() {
            super();

            this._box = new CasaSprite();
            this._box.graphics.beginFill(0xFF00FF);
            this._box.graphics.drawRect(0, 0, 25, 25);
            this._box.graphics.endFill();

            this.addChild(this._box);

            this._tween = new PropertyTween(this._box, "x", Bounce.easeOut, 200, 5);
            this._tween.start();
        }
    }
}

Usage note:

If you want to tween a value other than a property use Tween.

Summary

Constructor

PropertyTween (scope:Object, property:String, equation:Function, endPos:Number, duration:Number, useFrames:Boolean = false)
- Creates and defines a new PropertyTween.

Class properties

Class properties inherited from Process

NORM_PRIORITY

Instance properties

scope : Object
- Retrieves the object defined as scope in the class' constructor.
property : String
- Retrieves the property as a String defined in the class' constructor.

Instance properties inherited from Tween

_begin _currentPosition _diff _end _equat _frameFires _framePulse _hasInit _stopwatch _time _timeProgress _useFrames duration equation position progress

Instance properties inherited from Process

_hasCompleted _isRunning _priority completed priority running

Instance properties inherited from RemovableEventDispatcher

_isDestroyed _listenerManager destroyed

Class methods

to (scope:Object, property:String, equation:Function, endPos:Number, duration:Number, useFrames:Boolean = false) : PropertyTween
- A convenience method that creates and starts a new PropertyTween and starts it automatically.
from (scope:Object, property:String, equation:Function, startPos:Number, duration:Number, useFrames:Boolean = false) : PropertyTween
- A convenience method that creates and starts a new PropertyTween and starts it automatically.

Instance methods

Instance methods inherited from Tween

_onFrame continueTo destroy resume start stop

Instance methods inherited from Process

_complete destroy start stop

Instance methods inherited from RemovableEventDispatcher

addEventListener destroy dispatchEvent removeEventListener removeEventListeners removeEventsForListener removeEventsForType

Constructor

PropertyTween

public function PropertyTween (

scope:Object, property:String, equation:Function, endPos:Number, duration:Number, useFrames:Boolean = false)

Creates and defines a new PropertyTween.

Parameters:

scope :

An object that contains the property specified by property.

property :

Name of the property you want to tween.

equation :

The tween equation.

endPos :

The ending value of the transition.

duration :

Length of time of the transition.

useFrames:

Indicates to use frames true, or seconds false in relation to the value specified in the duration parameter.

Usage note:

The function specified in the equation parameter must follow the (currentTime, startPosition, endPosition, totalTime) parameter standard.

Instance properties

property

public property:String

(read)

Retrieves the property as a String defined in the class' constructor.

scope

public scope:Object

(read)

Retrieves the object defined as scope in the class' constructor.

Class methods

from

public static function from (

scope:Object, property:String, equation:Function, startPos:Number, duration:Number, useFrames:Boolean = false) : PropertyTween

A convenience method that creates and starts a new PropertyTween and starts it automatically.

Parameters:

scope :

An object that contains the property specified by property.

property :

Name of the property you want to tween.

equation :

The tween equation.

startPos :

The beginning value of the transition.

duration :

Length of time of the transition.

useFrames:

Indicates to use frames true, or seconds false in relation to the value specified in the duration parameter.

Returns:

A {@PropertyTween property}.

to

public static function to (

scope:Object, property:String, equation:Function, endPos:Number, duration:Number, useFrames:Boolean = false) : PropertyTween

A convenience method that creates and starts a new PropertyTween and starts it automatically.

Parameters:

scope :

An object that contains the property specified by property.

property :

Name of the property you want to tween.

equation :

The tween equation.

endPos :

The ending value of the transition.

duration :

Length of time of the transition.

useFrames:

Indicates to use frames true, or seconds false in relation to the value specified in the duration parameter.

Returns:

A {@PropertyTween property}.