Packageidv.cjcat.stardust.common.handlers
Classpublic class ParticleHandler
InheritanceParticleHandler Inheritance StardustElement
SubclassesAlternativa3DObject3DHandler, Away3DLiteObject3DHandler, Away3DObject3DHandler, Away3DSprite3DHandler, BitmapHandler, CompositeParticleHandler, DisplayObjectHandler, DisplayObjectHandler3D, Flare3DPivot3DHandler, Flare3DSprite3DHandler, ND3DObject3DHandler, PixelHandler, PollingStation, PV3DDisplayObject3DHandler, PV3DDisplayObjectHandler, PV3DParticleHandler, PV3DPixelsHandler, PyroGroupHandler, SingularBitmapHandler, ZBDisplayObjectHandler

A particle handler is assigned to a particle by using the Handler initializer. A handler monitors the beginning of an emitter step, the end of an emitter step, the adding of a new particle, and the removal of a dead particle. Also, the readParticle() method is used to read data out of Particle objects when each paritcle is completely updated by actions.


Public Properties
 PropertyDefined by
 Inheritedname : String
StardustElement
Public Methods
 MethodDefined by
  
ParticleHandler()
ParticleHandler
  
getElementTypeXMLTag():XML
ParticleHandler
 Inherited
getRelatedObjects():Array
[Abstract Method] Returns the related objects of the element.
StardustElement
  
getSingleton():ParticleHandler
[static]
ParticleHandler
 Inherited
getXMLTag():XML
Returns the root tag of the XML representation.
StardustElement
  
getXMLTagName():String
ParticleHandler
 Inherited
parseXML(xml:XML, builder:XMLBuilder = null):void
[Abstract Method] Reconstructs the element from XML representations.
StardustElement
  
particleAdded(particle:Particle):void
[Abstract Method] Invoked for each particle added.
ParticleHandler
  
particleRemoved(particle:Particle):void
[Abstract Method] Invoked for each particle removed.
ParticleHandler
  
readParticle(particle:Particle):void
[Abstract Method] Invoked for each particle when each particle's actions are all executed.
ParticleHandler
  
stepBegin(emitter:Emitter, particles:ParticleCollection, time:Number):void
[Abstract Method] Invoked when each emitter step begins.
ParticleHandler
  
stepEnd(emitter:Emitter, particles:ParticleCollection, time:Number):void
[Abstract Method] Invoked when each emitter step ends.
ParticleHandler
 Inherited
toXML():XML
[Abstract Method] Generates XML representation.
StardustElement
Constructor detail
ParticleHandler()constructor
public function ParticleHandler()
Method detail
getElementTypeXMLTag()method
public override function getElementTypeXMLTag():XML

Returns
XML
getSingleton()method 
public static function getSingleton():ParticleHandler

Returns
ParticleHandler
getXMLTagName()method 
public override function getXMLTagName():String

Returns
String
particleAdded()method 
public function particleAdded(particle:Particle):void

[Abstract Method] Invoked for each particle added. Handle particle creation in this method.

Parameters
particle:Particle
particleRemoved()method 
public function particleRemoved(particle:Particle):void

[Abstract Method] Invoked for each particle removed. Handle particle removal in this method.

Parameters
particle:Particle
readParticle()method 
public function readParticle(particle:Particle):void

[Abstract Method] Invoked for each particle when each particle's actions are all executed. Read out the particle's data in this method.

Parameters
particle:Particle
stepBegin()method 
public function stepBegin(emitter:Emitter, particles:ParticleCollection, time:Number):void

[Abstract Method] Invoked when each emitter step begins.

Parameters
emitter:Emitter
 
particles:ParticleCollection
 
time:Number
stepEnd()method 
public function stepEnd(emitter:Emitter, particles:ParticleCollection, time:Number):void

[Abstract Method] Invoked when each emitter step ends.

Parameters
emitter:Emitter
 
particles:ParticleCollection
 
time:Number