msg-chumby-display 0.2.0 → 0.2.1

data/widget/last_reading/caurina/transitions/PropertyInfoObj.as

@@ -0,0 +1,86 @@
+/**
+ * PropertyInfoObj
+ * An object containing the updating info for a given property (its starting value, its final value, and a few other things)
+ *
+ * @author		Zeh Fernando
+ * @version		1.0.0
+ * @private
+ */
+
+class caurina.transitions.PropertyInfoObj {
+	
+	public var valueStart				:Number;	// Starting value of the tweening (null if not started yet)
+	public var valueComplete			:Number;	// Final desired value (numerically)
+	public var originalValueComplete	:Object;	// Final desired value as declared initially
+	public var arrayIndex				:Number;	// Index (if this is an array item)
+	public var extra					:Object;	// Additional parameters, used by some special properties
+	public var isSpecialProperty		:Boolean;	// Whether or not this is a special property instead of a direct one
+	public var hasModifier				:Boolean;	// Whether or not it has a modifier function
+	public var modifierFunction			:Function;	// Modifier function, if any
+	public var modifierParameters		:Array;		// Additional array of modifier parameters
+
+	// ==================================================================================================================================
+	// CONSTRUCTOR function -------------------------------------------------------------------------------------------------------------
+
+	/**
+	 * Initializes the basic PropertyInfoObj.
+	 * 
+	 * @param	p_valueStart		Number		Starting value of the tweening (null if not started yet)
+	 * @param	p_valueComplete		Number		Final (desired) property value
+	 */
+	function PropertyInfoObj(p_valueStart:Number, p_valueComplete:Number, p_originalValueComplete:Object, p_arrayIndex:Number, p_extra:Object, p_isSpecialProperty:Boolean, p_modifierFunction:Function, p_modifierParameters:Array) {
+		valueStart				=	p_valueStart;
+		valueComplete			=	p_valueComplete;
+		originalValueComplete	=	p_originalValueComplete;
+		arrayIndex				=	p_arrayIndex;
+		extra					=	p_extra;
+		isSpecialProperty		=	p_isSpecialProperty;
+		hasModifier				=	p_modifierFunction != undefined;
+		modifierFunction 		=	p_modifierFunction;
+		modifierParameters		=	p_modifierParameters;
+	}
+
+
+	// ==================================================================================================================================
+	// OTHER functions ------------------------------------------------------------------------------------------------------------------
+
+	/**
+	 * Clones this property info and returns the new PropertyInfoObj
+	 *
+	 * @param	omitEvents		Boolean			Whether or not events such as onStart (and its parameters) should be omitted
+	 * @return 					TweenListObj	A copy of this object
+	 */
+	public function clone():PropertyInfoObj {
+		var nProperty:PropertyInfoObj = new PropertyInfoObj(valueStart, valueComplete, originalValueComplete, arrayIndex, extra, isSpecialProperty, modifierFunction, modifierParameters);
+		return nProperty;
+	}
+
+	/**
+	 * Returns this object described as a String.
+	 *
+	 * @return 					String		The description of this object.
+	 */
+	public function toString():String {
+		var returnStr:String = "\n[PropertyInfoObj ";
+		returnStr += "valueStart:" + String(valueStart);
+		returnStr += ", ";
+		returnStr += "valueComplete:" + String(valueComplete);
+		returnStr += ", ";
+		returnStr += "originalValueComplete:" + String(originalValueComplete);
+		returnStr += ", ";
+		returnStr += "arrayIndex:" + String(arrayIndex);
+		returnStr += ", ";
+		returnStr += "extra:" + String(extra);
+		returnStr += ", ";
+		returnStr += "isSpecialProperty:" + String(isSpecialProperty);
+		returnStr += ", ";
+		returnStr += "hasModifier:" + String(hasModifier);
+		returnStr += ", ";
+		returnStr += "modifierFunction:" + String(modifierFunction);
+		returnStr += ", ";
+		returnStr += "modifierParameters:" + String(modifierParameters);
+		returnStr += "]\n";
+		return returnStr;
+	}
+	
+}

data/widget/last_reading/caurina/transitions/SpecialProperty.as

@@ -0,0 +1,48 @@
+/**
+ * SpecialProperty
+ * A kind of a getter/setter for special properties
+ *
+ * @author		Zeh Fernando
+ * @version		1.0.0
+ */
+
+class caurina.transitions.SpecialProperty {
+
+	public var getValue:Function; // (p_obj:Object, p_parameters:Array): Number
+	public var setValue:Function; // (p_obj:Object, p_value:Number, p_parameters:Array): Void
+	public var parameters:Array;
+	public var preProcess:Function; // (p_obj:Object, p_parameters:Array, p_originalValueComplete:Object, p_extra:Object): Number
+
+	/**
+	 * Builds a new special property object.
+	 *
+	 * @param		p_getFunction		Function	Reference to the function used to get the special property value
+	 * @param		p_setFunction		Function	Reference to the function used to set the special property value
+	 * @param		p_parameters		Array		Additional parameters that should be passed to the function when executing (so the same function can apply to different special properties)
+	 */
+	public function SpecialProperty (p_getFunction:Function, p_setFunction:Function, p_parameters:Array, p_preProcessFunction:Function) {
+		getValue = p_getFunction;
+		setValue = p_setFunction;
+		parameters = p_parameters;
+		preProcess = p_preProcessFunction;
+	}
+
+	/**
+	 * Converts the instance to a string that can be used when trace()ing the object
+	 */
+	public function toString():String {
+		var value:String = "";
+		value += "[SpecialProperty ";
+		value += "getValue:"+getValue.toString();
+		value += ", ";
+		value += "setValue:"+setValue.toString();
+		value += ", ";
+		value += "parameters:"+parameters.toString();
+		value += ", ";
+		value += "preProcess:"+preProcess.toString();
+		value += "]";
+		return value;
+	}
+
+
+}

data/widget/last_reading/caurina/transitions/SpecialPropertyModifier.as

@@ -0,0 +1,39 @@
+/**
+ * SpecialPropertyModifier
+ * A special property which actually acts on other properties
+ *
+ * @author		Zeh Fernando
+ * @version		1.0.0
+ * @private
+ */
+
+class caurina.transitions.SpecialPropertyModifier {
+
+	public var modifyValues:Function;
+	public var getValue:Function;
+
+	/**
+	 * Builds a new special property modifier object.
+	 * 
+	 * @param		p_modifyFunction		Function		Function that returns the modifider parameters.
+	 */
+	public function SpecialPropertyModifier (p_modifyFunction:Function, p_getFunction:Function) {
+		modifyValues = p_modifyFunction;
+		getValue = p_getFunction;
+	}
+
+	/**
+	 * Converts the instance to a string that can be used when trace()ing the object
+	 */
+	public function toString():String {
+		var value:String = "";
+		value += "[SpecialPropertyModifier ";
+		value += "modifyValues:"+modifyValues.toString();
+		value += ", ";
+		value += "getValue:"+getValue.toString();
+		value += "]";
+		return value;
+	}
+
+
+}

data/widget/last_reading/caurina/transitions/SpecialPropertySplitter.as

@@ -0,0 +1,46 @@
+/**
+ * SpecialPropertySplitter
+ * A proxy setter for special properties
+ *
+ * @author		Zeh Fernando
+ * @version		1.0.0
+ */
+
+class caurina.transitions.SpecialPropertySplitter {
+
+	public var parameters:Array;
+
+	/**
+	 * Builds a new splitter special propery object.
+	 * 
+	 * @param		p_splitFunction		Function	Reference to the function used to split a value 
+	 */
+	public function SpecialPropertySplitter (p_splitFunction:Function, p_parameters:Array) {
+		splitValues = p_splitFunction;
+		parameters = p_parameters;
+	}
+
+	/**
+	 * Empty shell for the function that receives the value (usually just a Number), and splits it in new property names and values
+	 * Must return an array containing .name and .value
+	 */
+	public function splitValues(p_value:Object, p_parameters:Array):Array {
+		// This is rewritten
+		return [];
+	}
+
+	/**
+	 * Converts the instance to a string that can be used when trace()ing the object
+	 */
+	public function toString():String {
+		var value:String = "";
+		value += "[SpecialPropertySplitter ";
+		value += "splitValues:"+splitValues.toString();
+		value += ", ";
+		value += "parameters:"+parameters.toString();
+		value += "]";
+		return value;
+	}
+
+
+}

data/widget/last_reading/caurina/transitions/TweenListObj.as

@@ -0,0 +1,227 @@
+/**
+ * The tween list object. Stores all of the properties and information that pertain to individual tweens.
+ *
+ * @author		Nate Chatellier, Zeh Fernando
+ * @version		1.0.4
+ */
+import caurina.transitions.AuxFunctions;
+
+class caurina.transitions.TweenListObj {
+
+	public var scope					:Object;	// Object affected by this tweening
+	public var properties				:Object;	// List of properties that are tweened (PropertyInfoObj instances)
+		// .valueStart					:Number		// Initial value of the property
+		// .valueComplete				:Number		// The value the property should have when completed
+	public var timeStart				:Number;	// Time when this tweening should start
+	public var timeComplete				:Number;	// Time when this tweening should end
+	public var useFrames				:Boolean;	// Whether or not to use frames instead of time
+	public var transition				:Function;	// Equation to control the transition animation
+	public var transitionParams			:Object;	// Additional parameters for the transition
+	public var onStart					:Function;	// Function to be executed on the object when the tween starts (once)
+	public var onUpdate					:Function;	// Function to be executed on the object when the tween updates (several times)
+	public var onComplete				:Function;	// Function to be executed on the object when the tween completes (once)
+	public var onOverwrite				:Function;	// Function to be executed on the object when the tween is overwritten
+	public var onError  				:Function;	// Function to be executed if an error is thrown when tweener exectues a callback (onComplete, onUpdate etc)
+	public var onStartParams			:Array;		// Array of parameters to be passed for the event
+	public var onUpdateParams			:Array;		// Array of parameters to be passed for the event
+	public var onCompleteParams			:Array;		// Array of parameters to be passed for the event
+	public var onOverwriteParams		:Array;		// Array of parameters to be passed for the event
+	public var onStartScope				:Object;	// Scope in which the event function is ran
+	public var onUpdateScope			:Object;	// Scope in which the event function is ran
+	public var onCompleteScope			:Object;	// Scope in which the event function is ran
+	public var onOverwriteScope			:Object;	// Scope in which the event function is ran
+	public var onErrorScope				:Object;	// Scope in which the event function is ran
+	public var rounded					:Boolean;	// Use rounded values when updating
+	public var isPaused					:Boolean;	// Whether or not this tween is paused
+	public var timePaused				:Number;	// Time when this tween was paused
+	public var isCaller					:Boolean;	// Whether or not this tween is a "caller" tween
+	public var count					:Number;	// Number of times this caller should be called
+	public var timesCalled				:Number;	// How many times the caller has already been called ("caller" tweens only)
+	public var waitFrames				:Boolean;	// Whether or not this caller should wait at least one frame for each call execution ("caller" tweens only)
+	public var skipUpdates				:Number;	// How many updates should be skipped (default = 0; 1 = update-skip-update-skip...)
+	public var updatesSkipped			:Number;	// How many updates have already been skipped
+	public var hasStarted				:Boolean;	// Whether or not this tween has already started
+
+	// ==================================================================================================================================
+	// CONSTRUCTOR function -------------------------------------------------------------------------------------------------------------
+
+	/**
+	 * Initializes the basic TweenListObj
+	 *
+	 * @param	p_scope				Object		Object affected by this tweening
+	 * @param	p_timeStart			Number		Time when this tweening should start
+	 * @param	p_timeComplete		Number		Time when this tweening should end
+	 * @param	p_useFrames			Boolean		Whether or not to use frames instead of time
+	 * @param	p_transition		Function	Equation to control the transition animation
+	 */
+	function TweenListObj(p_scope:Object, p_timeStart:Number, p_timeComplete:Number, p_useFrames:Boolean, p_transition:Function, p_transitionParams:Object) {
+		scope				=	p_scope;
+		timeStart			=	p_timeStart;
+		timeComplete		=	p_timeComplete;
+		useFrames			=	p_useFrames;
+		transition			=	p_transition;
+		transitionParams	=	p_transitionParams;
+
+		// Other default information
+		properties		=	new Object();
+		isPaused		=	false;
+		timePaused		=	undefined;
+		isCaller		=	false;
+		updatesSkipped	=	0;
+		timesCalled		=	0;
+		skipUpdates 	= 	0;
+		hasStarted		=	false;
+	}
+
+
+	// ==================================================================================================================================
+	// OTHER functions ------------------------------------------------------------------------------------------------------------------
+
+	/**
+	 * Clones this tweening and returns the new TweenListObj
+	 *
+	 * @param	omitEvents		Boolean			Whether or not events such as onStart (and its parameters) should be omitted
+	 * @return 					TweenListObj	A copy of this object
+	 */
+	public function clone(omitEvents:Boolean):TweenListObj {
+		var nTween:TweenListObj = new TweenListObj(scope, timeStart, timeComplete, useFrames, transition, transitionParams);
+		nTween.properties = new Object();
+		for (var pName:String in properties) {
+			nTween.properties[pName] = properties[pName].clone();
+		}
+		nTween.skipUpdates = skipUpdates;
+		nTween.updatesSkipped = updatesSkipped;
+		if (!omitEvents) {
+			nTween.onStart = onStart;
+			nTween.onUpdate = onUpdate;
+			nTween.onComplete = onComplete;
+			nTween.onOverwrite = onOverwrite;
+			nTween.onError = onError;
+			nTween.onStartParams = onStartParams;
+			nTween.onUpdateParams = onUpdateParams;
+			nTween.onCompleteParams = onCompleteParams;
+			nTween.onOverwriteParams = onOverwriteParams;
+			nTween.onStartScope = onStartScope;
+			nTween.onUpdateScope = onUpdateScope;
+			nTween.onCompleteScope = onCompleteScope;
+			nTween.onOverwriteScope = onOverwriteScope;
+			nTween.onErrorScope = onErrorScope;
+		}
+		nTween.rounded = rounded;
+		nTween.isPaused = isPaused;
+		nTween.timePaused = timePaused;
+		nTween.isCaller = isCaller;
+		nTween.count = count;
+		nTween.timesCalled = timesCalled;
+		nTween.waitFrames = waitFrames;
+		nTween.hasStarted = hasStarted;
+
+		return nTween;
+	}
+
+	/**
+	 * Returns this object described as a String.
+	 *
+	 * @return 					String		The description of this object.
+	 */
+	public function toString():String {
+		var returnStr:String = "\n[TweenListObj ";
+		returnStr += "scope:" + String(scope);
+		returnStr += ", properties:";
+		var isFirst:Boolean = true;
+		for (var i:String in properties) {
+			if (!isFirst) returnStr += ",";
+			returnStr += "[name:"+properties[i].name;
+			returnStr += ",valueStart:"+properties[i].valueStart;
+			returnStr += ",valueComplete:"+properties[i].valueComplete;
+			returnStr += "]";
+			isFirst = false;
+		}
+		returnStr += ", timeStart:" + String(timeStart);
+		returnStr += ", timeComplete:" + String(timeComplete);
+		returnStr += ", useFrames:" + String(useFrames);
+		returnStr += ", transition:" + String(transition);
+		returnStr += ", transitionParams:" + String(transitionParams);
+
+		if (skipUpdates)		returnStr += ", skipUpdates:"		+ String(skipUpdates);
+		if (updatesSkipped)		returnStr += ", updatesSkipped:"	+ String(updatesSkipped);
+
+		if (onStart)			returnStr += ", onStart:"			+ String(onStart);
+		if (onUpdate)			returnStr += ", onUpdate:"			+ String(onUpdate);
+		if (onComplete)			returnStr += ", onComplete:"		+ String(onComplete);
+		if (onOverwrite)		returnStr += ", onOverwrite:"		+ String(onOverwrite);
+		if (onError)		    returnStr += ", onError:"		    + String(onError);
+
+		if (onStartParams)		returnStr += ", onStartParams:"		+ String(onStartParams);
+		if (onUpdateParams)		returnStr += ", onUpdateParams:"	+ String(onUpdateParams);
+		if (onCompleteParams)	returnStr += ", onCompleteParams:"	+ String(onCompleteParams);
+		if (onOverwriteParams)	returnStr += ", onOverwriteParams:"	+ String(onOverwriteParams);
+
+		if (onStartScope)		returnStr += ", onStartScope:"		+ String(onStartScope);
+		if (onUpdateScope)		returnStr += ", onUpdateScope:"		+ String(onUpdateScope);
+		if (onCompleteScope)	returnStr += ", onCompleteScope:"	+ String(onCompleteScope);
+		if (onOverwriteScope)	returnStr += ", onOverwriteScope:"	+ String(onOverwriteScope);
+		if (onErrorScope)		returnStr += ", onErrorScope:"		+ String(onErrorScope);
+
+		if (rounded)			returnStr += ", rounded:"			+ String(rounded);
+		if (isPaused)			returnStr += ", isPaused:"			+ String(isPaused);
+		if (timePaused)			returnStr += ", timePaused:"		+ String(timePaused);
+		if (isCaller)			returnStr += ", isCaller:"			+ String(isCaller);
+		if (count)				returnStr += ", count:"				+ String(count);
+		if (timesCalled)		returnStr += ", timesCalled:"		+ String(timesCalled);
+		if (waitFrames)			returnStr += ", waitFrames:"		+ String(waitFrames);
+		if (hasStarted)			returnStr += ", hasStarted:"		+ String(hasStarted);
+		
+		returnStr += "]\n";
+		return returnStr;
+	}
+	
+	/**
+	 * Checks if p_obj "inherits" properties from other objects, as set by the "base" property. Will create a new object, leaving others intact.
+	 * o_bj.base can be an object or an array of objects. Properties are collected from the first to the last element of the "base" filed, with higher
+	 * indexes overwritting smaller ones. Does not modify any of the passed objects, but makes a shallow copy of all properties.
+	 *
+	 * @param		p_obj		Object				Object that should be tweened: a movieclip, textfield, etc.. OR an array of objects
+	 * @return					Object				A new object with all properties from the p_obj and p_obj.base.
+	 */
+
+	public static function makePropertiesChain(p_obj : Object) : Object{
+		// Is this object inheriting properties from another object?
+		var baseObject : Object = p_obj.base;
+		if(baseObject){
+			// object inherits. Are we inheriting from an object or an array
+			var chainedObject : Object = {};
+			var chain : Object;
+			if (baseObject instanceof Array){
+				// Inheritance chain is the base array
+				chain = [];
+				// make a shallow copy
+				for (var k : Number = 0 ; k< baseObject.length; k++) chain.push(baseObject[k]);
+			}else{
+				// Only one object to be added to the array
+				chain = [baseObject];
+			}
+			// add the final object to the array, so it's properties are added last
+			chain.push(p_obj);
+			var currChainObj : Object;
+			// Loops through each object adding it's property to the final object
+			var len : Number = chain.length;
+			for(var i : Number = 0; i < len ; i ++){
+				if(chain[i]["base"]){
+					// deal with recursion: watch the order! "parent" base must be concatenated first!
+					currChainObj = AuxFunctions.concatObjects( makePropertiesChain(chain[i]["base"] ), chain[i]);
+				}else{
+					currChainObj = chain[i] ;
+				}
+				chainedObject = AuxFunctions.concatObjects(chainedObject, currChainObj );
+			}
+			if( chainedObject["base"]){
+			    delete chainedObject["base"];
+			}
+			return chainedObject;
+		}else{
+			// No inheritance, just return the object it self
+			return p_obj;
+		}
+	}
+}