Packageorg.axiis.layouts.utils
Classpublic class GeometryRepeater
InheritanceGeometryRepeater Inheritance flash.events.EventDispatcher

GeometryRepeater modifies geometries through the use of PropertyModifiers. When modifications take longer than a single frame, they are distributed over multiple frames to prevent the application from appearing to have frozen. Objects can register callback functions so they can be notified when the GeometryRepeater begins or ends each iteration or ends its final iteration.


Public Properties
 PropertyDefined By
  currentIteration : int
[read-only] The number of iterations that the GeometryRepeater has processed.
GeometryRepeater
  geometry : Geometry
The geometry that should be repeated.
GeometryRepeater
  iterationLoopComplete : Boolean
[read-only] A flag indicating that the GeometryRepeater has finished repeating but the geometry's properties have not yet been restored to their original values.
GeometryRepeater
  millisecondsPerFrame : Number = 50
Determines how many milliseconds repeater will iterate before waiting for the next frame;
GeometryRepeater
  modifiers : Array
An array of PropertyModifiers that should be applied with each iteration of the GeometryRepeater.
GeometryRepeater
Public Methods
 MethodDefined By
  
GeometryRepeater()
Constructor.
GeometryRepeater
  
repeat(numIterations:int, preIterationCallback:Function = null, postIterationCallback:Function = null, completeCallback:Function = null):void
Begins the modifications process.
GeometryRepeater
Property Detail
currentIterationproperty
currentIteration:int  [read-only]

The number of iterations that the GeometryRepeater has processed. When the GeometryRepeater is not running, this value is -1.

This property can be used as the source for data binding.


Implementation
    public function get currentIteration():int
geometryproperty 
public var geometry:Geometry

The geometry that should be repeated.

iterationLoopCompleteproperty 
iterationLoopComplete:Boolean  [read-only]

A flag indicating that the GeometryRepeater has finished repeating but the geometry's properties have not yet been restored to their original values.


Implementation
    public function get iterationLoopComplete():Boolean
millisecondsPerFrameproperty 
public var millisecondsPerFrame:Number = 50

Determines how many milliseconds repeater will iterate before waiting for the next frame;

modifiersproperty 
public var modifiers:Array

An array of PropertyModifiers that should be applied with each iteration of the GeometryRepeater.

Constructor Detail
GeometryRepeater()Constructor
public function GeometryRepeater()

Constructor.

Method Detail
repeat()method
public function repeat(numIterations:int, preIterationCallback:Function = null, postIterationCallback:Function = null, completeCallback:Function = null):void

Begins the modifications process.

Repeatedly applies the PropertyModifiers the specified number of times. Optionally, you can set up callbacks that this method will call before the PropertyModifiers are applied, after they are applied, and when the final iteration completes.

Parameters

numIterations:int — The number of iterations that should be executed by before the GeometryRepeater ends.
 
preIterationCallback:Function (default = null) — A function that will be called at the beginning of every repeat iteration, before the PropertyModifiers are applied.
 
postIterationCallback:Function (default = null) — A function that will be called on each iteration after the PropertyModifiers have been applied and the currentIteration has been incremented.
 
completeCallback:Function (default = null) — A function that will be called when numIterations of this GeometryRepeater have been executed.





Fri Oct 2 2009, 08:24 PM -04:00