Package | com.boostworthy.animation.management |
Class | public class Buffer |
Inheritance | Buffer ![]() |
Implements | ICollection, IDisposable, IRenderable |
See also
Property | Defined by | ||
---|---|---|---|
length : uint [read-only]
Gets the number of items in this buffer.
| Buffer |
Property | Defined by | ||
---|---|---|---|
m_objQueue : Queue
A queue for storing animation objects.
| Buffer |
Method | Defined by | ||
---|---|---|---|
Buffer()
Constructor.
| Buffer | ||
add(objAnimation:IAnimation):void
Adds a new animation to the buffer.
| Buffer | ||
clear():void
Clears all animations from the buffer.
| Buffer | ||
dispose():void
Performs any appropriate clean-up tasks for garbage collection such as
removing event listeners, setting object references to 'null', etc.
| Buffer | ||
getIterator(uIterator:uint = 2):IIterator
Returns an iterator of the specified type.
| Buffer | ||
remove(objAnimation:IAnimation):void
Removes the specified animation from the buffer.
| Buffer | ||
removeByProperty(objTarget:Object, strProperty:String):void
Removes all animations involving the target object and it's specified property from the buffer.
| Buffer | ||
removeByTarget(objTarget:Object):void
Removes all animations involving the target object from the buffer.
| Buffer | ||
render():Boolean
Iterates through the contents of this buffer and renders each animation.
| Buffer |
Method | Defined by | ||
---|---|---|---|
init():void
Initializes this object.
| Buffer | ||
removeElement(objElement:IAnimation):void
Removes an element from the queue.
| Buffer |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when an animation changes. | Buffer | |||
Dispatched when an animation is finished. | Buffer | |||
Dispatched when an animation stops. | Buffer |
length | property |
length:uint
[read-only]Gets the number of items in this buffer.
Implementation public function get length():uint
m_objQueue | property |
protected var m_objQueue:Queue
A queue for storing animation objects.
Buffer | () | constructor |
public function Buffer()
Constructor.
add | () | method |
public function add(objAnimation:IAnimation):void
Adds a new animation to the buffer.
ParametersobjAnimation:IAnimation — The aniamtion to be added to the buffer.
|
clear | () | method |
public function clear():void
Clears all animations from the buffer.
dispose | () | method |
public function dispose():void
Performs any appropriate clean-up tasks for garbage collection such as removing event listeners, setting object references to 'null', etc.
getIterator | () | method |
public function getIterator(uIterator:uint = 2):IIterator
Returns an iterator of the specified type.
ParametersuIterator:uint (default = 2 ) — The iterator type to use for iterating through the data being stored by this collection. Default is '2' (IteratorType.ARRAY_FORWARD).
|
IIterator —
An iterator instance of the specified type.
|
See also
init | () | method |
protected function init():void
Initializes this object.
remove | () | method |
public function remove(objAnimation:IAnimation):void
Removes the specified animation from the buffer.
ParametersobjAnimation:IAnimation — The animation to be removed.
|
removeByProperty | () | method |
public function removeByProperty(objTarget:Object, strProperty:String):void
Removes all animations involving the target object and it's specified property from the buffer.
ParametersobjTarget:Object — The target object whose animations are to be removed.
|
|
strProperty:String — The target object's property being searched for.
|
removeByTarget | () | method |
public function removeByTarget(objTarget:Object):void
Removes all animations involving the target object from the buffer.
ParametersobjTarget:Object — The target object whose animations are to be removed.
|
removeElement | () | method |
protected function removeElement(objElement:IAnimation):void
Removes an element from the queue.
ParametersobjElement:IAnimation — The element to be removed from the queue.
|
render | () | method |
public function render():Boolean
Iterates through the contents of this buffer and renders each animation.
ReturnsBoolean |
animationChange | event |
animationFinish | event |
animationStop | event |