topical media & game development
lib-flex-animation-code-10-org-as3lib-kitchensync-action-AbstractActionGroup.ax
lib-flex-animation-code-10-org-as3lib-kitchensync-action-AbstractActionGroup.ax
(swf
)
[ flash
]
flex
package org.as3lib.kitchensync.action
{
import org.as3lib.kitchensync.KitchenSyncDefaults;
import org.as3lib.kitchensync.core.*;
import org.as3lib.utils.AbstractEnforcer;
[Event(name="childActionStart", type="org.as3lib.kitchensync.KitchenSyncEvent")]
[Event(name="childActionComplete", type="org.as3lib.kitchensync.KitchenSyncEvent")]
public class @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-action-AbstractActionGroup extends AbstractAction
{
If true, the group's KSTween children will reset to their default positions when the group is started.
public var resetChildrenAtStart:Boolean = true;
An array containing all of the child actions of the group.
public function get childActions():Array { return _childActions; }
protected var _childActions:Array = new Array();
override public function set duration(duration:*):void {
throw new Error("duration is ignored for SynchronizedActionGroups");
}
Constructor.
@abstract
public function @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-action-AbstractActionGroup() {
super();
resetChildrenAtStart = KitchenSyncDefaults.resetChildrenAtStart;
AbstractEnforcer.enforceConstructor(this, @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-action-AbstractActionGroup);
}
Adds an action to the group.
parameter: action - One or more actions to add to the group. Don't start this action. That will be handled by the group.
public function addAction(action:IAction, ... additionalActions):void {
_childActions.push(action);
if (additionalActions.length > 0) {
for each (action in additionalActions) {
_childActions.push(action);
}
}
}
Adds an action to the group at the specified index.
parameter: action - The action to add. Don't start this action. That will be handled by the group.
parameter: index - The location at which to add the action. Defaults to the end of the Array
public function addActionAtIndex(action:IAction, index:int = -1):void {
if (index < 0) {
_childActions.push(action);
} else {
_childActions.splice(index, 0, action);
}
}
Removes an action from the group.
@throws Error if the action cannot be found.
parameter: action - The action to remove.
returns: The removed action.
public function removeAction(action:IAction):IAction {
var index:int = _childActions.indexOf(action);
if (index != -1) {
return _childActions.splice(index, 1)[0];
} else {
throw new Error("Specified child action does not exist");
}
}
Removes an action at the specified index.
@throws Error if the action cannot be found.
parameter: index - The index in the array of the action to remove.
returns: The removed action.
public function removeActionAtIndex(index:int):IAction {
if (index < 0 || index >= _childActions.length) {
throw new Error("Specified child action does not exist");
} else {
return _childActions.splice(index, 1)[0];
}
}
Returns the action at the specified index.
@throws Error if the action cannot be found.
parameter: index - The index in the array of the action to return.
returns: The specified action.
public function getChildAtIndex(index:int):IAction {
if (index < 0 || index >= _childActions.length) {
throw new Error("Specified child action does not exist");
} else {
return _childActions[index];
}
}
Reverse the order that the children play back in. Essentially, this just reverses the child array.
// todo - test this
public function reverseChildOrder():void {
_childActions = _childActions.reverse();
}
Dispatches a CHILD_START event when the child begins.
parameter: event - The SynchronizerEvent.START from the child action
@event SynchronizerEvent.CHILD_START
// todo - Add a reference to the started child to the event.
protected function onChildStart(event:KitchenSyncEvent):void {
dispatchEvent(new KitchenSyncEvent(KitchenSyncEvent.CHILD_START, event.timestamp));
}
Called when child actions are completed.
parameter: event - The SynchronizerEvent.COMPLETE from the child action
@event SynchronizerEvent.CHILD_COMPLETE
// todo - Add a reference to the completed child to the event.
protected function onChildFinished (event:KitchenSyncEvent):void {
dispatchEvent(new KitchenSyncEvent(KitchenSyncEvent.CHILD_COMPLETE, event.timestamp));
}
override public function start():IAction {
if (resetChildrenAtStart && !_running && !_paused) {
for (var i:int = 0; i < _childActions.length; i++ ) {
var tween:KSTween = _childActions[i] as KSTween;
if (tween != null) { tween.reset(); }
}
}
return super.start();
}
override public function pause():void {
super.pause();
//_paused = true;
for each (var child:IAction in childActions) {
child.pause();
}
}
override public function unpause():void {
super.unpause();
//_paused = false;
for each (var child:IAction in childActions) {
child.unpause();
}
}
override public function stop():void {
super.stop();
for each (var child:IAction in childActions) {
child.stop();
}
}
override public function kill():void {
// Kill child actions to avoid zombie actions.
for each (var child:IAction in _childActions) {
child.kill();
}
_childActions = [];
super.kill();
}
override public function toString():String {
return "SynchronizedActionGroup containing " + _childActions.length + " children";
}
}
}
(C) Æliens
19/08/2009
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.
