com.desuade.motion.tweens.ColorTween

Package	com.desuade.motion.tweens
Class	public class ColorTween
Inheritance	ColorTween MultiTween Tween BasicTween BaseBasic flash.events.EventDispatcher

Language Version :

ActionScript 3

Since :

02.05.2009

Runtime Versions :

AIR 1.0, Flash Player 9.0.0

Standard tween class to change the color of a DisplayObject.

	Property	Defined By
		active : Boolean [read-only] If the primitive is currently active and running.	BaseBasic
		completed : Boolean [read-only] If the tween finished or not.	Tween
		config : Object [read-only] Gets the config object that was passed in the constructor.	BaseBasic
		pid : int [read-only] The primitive's id	BaseBasic
		position : Number [read-only] Gets the current position 0-1 of the tween.	Tween
		target : Object The target object	BaseBasic

Public Methods

	Method		Defined By
		ColorTween(target:Object, configObject:Object = null) The constructor accepts an object that has all the paramaters needed to create a new tween. Paramaters for the tween object: type:String – the type of color transformation to apply.	ColorTween
		fromXML(xml:XML):* [override] Configures the object based on the values provided by the XML. Most properties can assigned in the attributes using the same names. The values of the attributes will be converted to Numbers if they're not NaN.	MultiTween
		reset():void [override] Resets the tween back to the beginning.	MultiTween
		run(target:Object, property:String, value:, duration:Number, ease: = linear, position:Number = 0, endfunc:Function = null):int [static] This let's you run a tween that's unmanaged and bypasses events, using just a callback function on end. The syntax is just a strict function call, so there's no configObject. While there's little speed improvement with this over creating an tween object, it does use about half the memory.	Tween
		start(delay:Number = -1, position:Number = -1):* [override] This starts the tween.	Tween
		stop():Boolean [override] This stops the currently playing tween at it's current position.	Tween
		toXML():XML [override] This creates an XML object that represents the object, based on it's config object.	MultiTween

Constructor Detail

ColorTween

()

Constructor

public function ColorTween(target:Object, configObject:Object = null)

The constructor accepts an object that has all the paramaters needed to create a new tween.

Paramaters for the tween object:

type:String – the type of color transformation to apply. Defaults to 'tint', see ColorHelper for more types.
amount:int – The amount of transform to apply. Depends on 'type'
value:– the new (end) color. A string or hex is accepted - ie: {value: '#ff0038} or {value:0xff883a}
ease:String – the easing to use. Default is 'linear'. Can pass a Function, but may not be fully compatable.
duration:Number – how long in seconds for the tween to last
delay:Number – how long in seconds to delay starting the tween
position:Number – what position to start the tween at 0-1
update:Boolean – enable broadcasting of UPDATED event (can lower performance)
property:String – To tween a hex value instead of a DisplayObject, set this to the property

Example: var mt:ColorTween = new ColorTween(myobj, {value:0xff77d5, amount:0.8, duration:2, ease:'easeInBounce', delay:2, position:0})

Parameters

	`target:Object` — The target object to have it's property tweened

	`configObject:Object` (default = `null`) — The config object that has all the values for the tween

Desuade API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
ColorTween	Properties \| Methods