Packageflare.vis.operator
Classpublic class OperatorSequence
InheritanceOperatorSequence Inheritance OperatorList Inheritance flash.utils.Proxy

An OperatorSequence maintains a list of operators that are run in sequence with an animated transition in between each. This is in contrast to an OperatorList, which runs all the operators at once and constructs a single animated transition across all sub-operators. Instead, an OperatorSequence runs each operator separately, providing each with a different Transitioner. The result is a multi-stage animation, in which each operator in the seqeunce get its own sub-transition.

The add method is not supported by this class. Instead, use the addToSequence method, which includes the operator to add along with a duration value (in seconds) specifying the length of the animated transition for the operator.

An OperatorSequence is implemented by creating a flare.animate.FunctionSequence instance and using it to construct the staged animation. The FunctionSequence is then added to the Transitioner passed in to the operate method for this class. As a result, the operate methods for each operator contained in the seqeunce will not be invoked until the top-level Transitioner is played.

However, if the input Transitioner is null or in immediate mode, all the operators in the sequence will be run immediately, exactly like a normal OperatorList.



Public Properties
 PropertyDefined by
 Inheritedenabled : Boolean
Indicates if the operator is enabled or disabled.
OperatorList
 Inheritedfirst : Object
Returns the first operator in the list.
OperatorList
 Inheritedlast : Object
Returns the last operator in the list.
OperatorList
 Inheritedlength : uint
The number of operators in the list.
OperatorList
 Inheritedlist : Array
An array of the operators contained in the operator list.
OperatorList
 Inheritedparameters : Object
Sets parameter values for this operator.
OperatorList
 Inheritedvisualization : Visualization
The visualization processed by this operator.
OperatorList
Protected Properties
 PropertyDefined by
 Inherited_enabled : Boolean = true
OperatorList
 Inherited_list : Array
OperatorList
 Inherited_vis : Visualization
OperatorList
Public Methods
 MethodDefined by
  
Creates a new OperatorSequence.
OperatorSequence
  
add(op:IOperator):void
This method is not supported by this class and will throw an error if invoked.
OperatorSequence
 Inherited
clear():void
Removes all operators from this list.
OperatorList
 Inherited
Returns the operator at the specified position in the list
OperatorList
  
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
OperatorSequence
  
push(op:IOperator, duration:Number):void
Adds an operator and its timing information to this operator sequence.
OperatorSequence
  
remove(op:IOperator):Boolean
Removes an operator from this list.
OperatorSequence
  
Removes the operator at the specified position in the list
OperatorSequence
  
setDurationAt(i:uint, duration:Number):Number
Sets the duration in seconds for the animated transition for the operator at the given index.
OperatorSequence
 Inherited
Set the operator at the specified position in the list
OperatorList
 Inherited
setup():void
Setup method invoked whenever this operator's visualization property is set.
OperatorList
Protected Methods
 MethodDefined by
 Inherited
getProperty(name:*):*
Proxy method for retrieving operators from the internal array.
OperatorList
 Inherited
setProperty(name:*, value:*):void
Proxy method for setting operators in the internal array.
OperatorList
Constructor detail
OperatorSequence()constructor
public function OperatorSequence()

Creates a new OperatorSequence.

Method detail
add()method
public override function add(op:IOperator):void

This method is not supported by this class and will throw an error if invoked.

Parameters
op:IOperator — an input operator (ignored)
operate()method 
public override function operate(t:Transitioner = null):void

Performs an operation over the contents of a visualization.

Parameters
t:Transitioner (default = null) — a Transitioner instance for collecting value updates.
push()method 
public function push(op:IOperator, duration:Number):void

Adds an operator and its timing information to this operator sequence. The operator will be invoked with a transitioner configured with the given duration (in seconds).

Parameters
op:IOperator — the operator to add to the sequence
 
duration:Number — the duration of the animated transition to be used for results of the given operator.
remove()method 
public override function remove(op:IOperator):Boolean

Removes an operator from this list.

Parameters
op:IOperator — the operator to remove

Returns
Boolean — true if the operator was found and removed, false otherwise
removeOperatorAt()method 
public override function removeOperatorAt(i:uint):IOperator

Removes the operator at the specified position in the list

Parameters
i:uint — the index into the operator list

Returns
IOperator — the removed operator
setDurationAt()method 
public function setDurationAt(i:uint, duration:Number):Number

Sets the duration in seconds for the animated transition for the operator at the given index.

Parameters
i:uint — the index at which to set the duration
 
duration:Number — the desired duration, in seconds

Returns
Number — the previous duration value