topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

lib-flex-animation-code-10-org-as3lib-kitchensync-easing-EasingUtil.ax

lib-flex-animation-code-10-org-as3lib-kitchensync-easing-EasingUtil.ax (swf ) [ flash ] flex


  package org.as3lib.kitchensync.easing
  {

A package of handy methods for working with Easing functions and classes.
author: Mims Wright


  
          public class @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-easing-EasingUtil
          {

Provides a way to call an easing function with code-hinting and type checking (sorta). @throws ArgumentError - If the easing function is passed modifiers that it can't handle. (Don't use them unless they're handled by the function) @throws Error - You may get unexpected results if you use a function that isn't an easing function.
parameter: func - The function to call - Must be an Easing function.
parameter: timeElapsed - The time since the tween began in milliseconds or frames.
parameter: duration - The duration of the tween, in milliseconds or frames.
parameter: mod1 - An optional modifier for the function. Used for tweens such as Back and Elastic.
parameter: mod2 - An optional modifier for the function. Used for tweens such as Elastic.
returns: Number - the result of the easing function.


  
                  public static function call(func:Function, timeElapsed:Number, duration:Number, mod1:Number = NaN, mod2:Number = NaN):Number {
                          var result:Number;
                          try {
                                  if (!isNaN(mod1)) {
                                          if (!isNaN(mod2)) {
                                                  result = func.apply(func, [timeElapsed, duration, mod1, mod2]);                        
                                          } else {
                                                  result = func.apply(func, [timeElapsed, duration, mod1]);
                                          }
                                  } else {
                                          result = func.apply(func, [timeElapsed, duration]);
                                  }
                          } catch (e:ArgumentError) {
                                  e.message = "You most likely tried to add modifier parameters (e.g. aplitude, overshoot) to an easing function that couldn't handle them or you are using an invalid function. " + e.message;
                                  throw e;
                          } catch (e:Error) {
                                  e.message = "Make sure you are using a valid easing function with the signature funcitonName(timeElapsed:Number, duration:Number):Number. " + e.message;
                          }
                          return result;
                  }

Uses one of the easing functions to generate an array of results for as many steps as are specified. If steps is 10, you will have an array with length 10.
see: #call()
parameter: func - The function to call - Must be an Easing function.
parameter: steps - The number of results desired for the array.
parameter: mod1 - An optional modifier for the function. Used for tweens such as Back and Elastic.
parameter: mod2 - An optional modifier for the function. Used for tweens such as Elastic.
returns: Array - An array with the results from the easing function over 'steps' iterations.


   
                  public static function generateArray(func:Function, steps:int, mod1:Number = NaN, mod2:Number = NaN):Array {
                          var results:Array = new Array();
                          for (var i:int = 0; i < steps; i++) {
                                  results.push(call(func,i, steps-1, mod1, mod2));
                          }
                          return results;
                  }

Creates a new easing function based on two other easing functions. @example Combine cubic in/out easing with a sine wave oscillator. <listing version="3.0"> myTween.easingFunction = @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-easing-EasingUtil.getAveragedFunction(Cubic.easeInOut, Oscillate.sine); </listing>
parameter: easingFunciton1 One of the two easing functions that will be averaged by the new function.
parameter: easingFunciton2 The second of the two easing functions that will be averaged by the new function.
returns: A new easing function that produces values averaged from the two easing functions.


  
                  public static function getAveragedFunction(easingFunction1:Function, easingFunction2:Function):Function {
                          var func:Function;
                          var results:Number;
                          func = function (timeElapsed:Number, duration:Number, mod1:Number = NaN, mod2:Number = NaN):Number {
                                  var value1:Number = @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-easing-EasingUtil.call(easingFunction1, timeElapsed, duration, mod1, mod2);
                                  var value2:Number = @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-easing-EasingUtil.call(easingFunction2, timeElapsed, duration, mod1, mod2);
                                  return (value1 + value2)/2;
                          }
                          return func;
                  }
          }
  }

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.