| Package | impression.simulation |
| Interface | public interface ISequencer extends flash.events.IEventDispatcher |
sequencing--sometimes called driving--is the process of setting the simulation state through a series of
programmatic commands. Note that, although the commands are provided to the ISequencer object as a single String object, the
specific format of the commands and the mechanism used to place the simulation in the desired state is project- and simulation-
specific. The sample runtime included in the AS3 DevKit shows only one possible approach.
| Method | Defined By | ||
|---|---|---|---|
cancel():void
Cancels any sequencing currently in progress. | ISequencer | ||
sequence(simulation:ISimulation, sequenceData:String):void
Begins sequencing the simulation. | ISequencer | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatch when sequencing has completed. | ISequencer | |||
| Dispatch when an error occurs. | ISequencer | |||
| cancel | () | method |
public function cancel():voidCancels any sequencing currently in progress.
| sequence | () | method |
public function sequence(simulation:ISimulation, sequenceData:String):void
Begins sequencing the simulation. Implementers must dispatch the SimulationObjectEvent.INITIALIZATION_COMPLETE
event when sequencing has completed.
Parameters
simulation:ISimulation — The simulation to sequence.
| |
sequenceData:String — Sequence data.
|
| initializationComplete | Event |
impression.events.SimulationObjectEventimpression.events.SimulationObjectEvent.INITIALIZATION_COMPLETEDispatch when sequencing has completed.
The SimulationObjectEvent.INITIALIZATION_COMPLETE constant defines the value of the type property of a simulation object initialization complete event object. This event has the following properties:| Property | Value |
|---|---|
| bubbles | false |
| cancelable | false; there is no default behavior to cancel. |
| currentTarget | The object that is actively processing the Event object with an event listener. |
| target | The object that raised the event. |
| simulationObjectError | Event |
impression.events.SimulationObjectErrorEventimpression.events.SimulationPlayerErrorEvent.ERRORDispatch when an error occurs.
The SimulationPlayerErrorEvent.ERROR constant defines the value of the type property of an error event object. This event has the following properties:| Property | Value |
|---|---|
| bubbles | false |
| cancelable | false; there is no default behavior to cancel. |
| currentTarget | The object that is actively processing the Event object with an event listener. |
| target | The object that raised the event. |
| sb | The Storyboard object assigned to the target. |
| loading | Indicates whether or not the event occurred during the loading phase of the storyboard. |
| message | The message associated with the error. |
| errorData | Additional data associated with the error. |
| source | The type of object that initially raised the error. |