GODPAPER | All Packages | All Classes | Index | Frames No Frames |
PDParticleSystem

Package | starling.extensions
Class | public class PDParticleSystem
Inheritance | PDParticleSystem ParticleSystem DisplayObject EventDispatcher Object
Subclasses | ParticleDesignerPS

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number The opacity of the object. | DisplayObject
|  | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject
|  | blendFactorDestination : String | ParticleSystem
|  | blendFactorSource : String | ParticleSystem
|  | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject
|  | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject
|  | capacity : int [read-only] | ParticleSystem
|  | emissionRate : Number | ParticleSystem
|  | emitAngle : Number | PDParticleSystem
|  | emitAngleVariance : Number | PDParticleSystem
|  | emitterType : int | PDParticleSystem
|  | emitterX : Number | ParticleSystem
|  | emitterXVariance : Number | PDParticleSystem
|  | emitterY : Number | ParticleSystem
|  | emitterYVariance : Number | PDParticleSystem
|  | endColor : ColorArgb | PDParticleSystem
|  | endColorVariance : ColorArgb | PDParticleSystem
|  | endRotation : Number | PDParticleSystem
|  | endRotationVariance : Number | PDParticleSystem
|  | endSize : Number | PDParticleSystem
|  | endSizeVariance : Number | PDParticleSystem
|  | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject
|  | gravityX : Number | PDParticleSystem
|  | gravityY : Number | PDParticleSystem
|  | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject
|  | height : Number The height of the object in pixels. | DisplayObject
|  | lifespan : Number | PDParticleSystem
|  | lifespanVariance : Number | PDParticleSystem
|  | maxCapacity : int | ParticleSystem
|  | maxNumParticles : int | PDParticleSystem
|  | maxRadius : Number | PDParticleSystem
|  | maxRadiusVariance : Number | PDParticleSystem
|  | minRadius : Number | PDParticleSystem
|  | name : String The name of the display object (default: null). | DisplayObject
|  | numParticles : int [read-only] | ParticleSystem
|  | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject
|  | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | radialAcceleration : Number | PDParticleSystem
|  | radialAccelerationVariance : Number | PDParticleSystem
|  | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject
|  | rotatePerSecond : Number | PDParticleSystem
|  | rotatePerSecondVariance : Number | PDParticleSystem
|  | rotation : Number The rotation of the object in radians. | DisplayObject
|  | scaleX : Number The horizontal scale factor. | DisplayObject
|  | scaleY : Number The vertical scale factor. | DisplayObject
|  | skewX : Number The horizontal skew angle in radians. | DisplayObject
|  | skewY : Number The vertical skew angle in radians. | DisplayObject
|  | speed : Number | PDParticleSystem
|  | speedVariance : Number | PDParticleSystem
|  | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage. | DisplayObject
|  | startColor : ColorArgb | PDParticleSystem
|  | startColorVariance : ColorArgb | PDParticleSystem
|  | startRotation : Number | PDParticleSystem
|  | startRotationVariance : Number | PDParticleSystem
|  | startSize : Number | PDParticleSystem
|  | startSizeVariance : Number | PDParticleSystem
|  | tangentialAcceleration : Number | PDParticleSystem
|  | tangentialAccelerationVariance : Number | PDParticleSystem
|  | texture : Texture | ParticleSystem
|  | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject
|  | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject
|  | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject
|  | visible : Boolean The visibility of the object. | DisplayObject
|  | width : Number The width of the object in pixels. | DisplayObject
|  | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject
|  | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | mBlendFactorDestination : String | ParticleSystem
|  | mBlendFactorSource : String | ParticleSystem
|  | mEmitterX : Number | ParticleSystem
|  | mEmitterY : Number | ParticleSystem
|  | mPremultipliedAlpha : Boolean | ParticleSystem

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | PDParticleSystem(config:XML, texture:Texture) | PDParticleSystem
|  | addEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | advanceTime(passedTime:Number):void | ParticleSystem
|  | alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object. | DisplayObject
|  | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher
|  | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type. | EventDispatcher
|  | dispose():void [override] | ParticleSystem
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns an empty rectangle at the particle system's position. | ParticleSystem
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another. | DisplayObject
|  | globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject
|  | hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher
|  | hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails. | DisplayObject
|  | localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject
|  | pause():void Pauses the system; when you 'start' again, it will continue from the old state. | ParticleSystem
|  | removeEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | removeEventListeners(type:String = null):void [override] | DisplayObject
|  | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject
|  | render(support:RenderSupport, alpha:Number):void [override] | ParticleSystem
|  | start(duration:Number):void Starts the sysytem for a certain time. | ParticleSystem
|  | stop():void Stops the system and removes all existing particles. | ParticleSystem

Protected Methods

| Method | Defined By
--- | --- | ---
|  | advanceParticle(aParticle:Particle, passedTime:Number):void [override] | PDParticleSystem
|  | createParticle():Particle [override] | PDParticleSystem
|  | initParticle(aParticle:Particle):void [override] | PDParticleSystem

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | added | Dispatched when an object is added to a parent. | DisplayObject
|  | addedToStage | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject
|  | complete | Dispatched when emission of particles is finished. | ParticleSystem
|  | enterFrame | Dispatched once every frame on every object that is connected to the stage. | DisplayObject
|  | keyDown | Dispatched when a key on the keyboard is pressed. | DisplayObject
|  | keyUp | Dispatched when a key on the keyboard is released. | DisplayObject
|  | removed | Dispatched when an object is removed from its parent. | DisplayObject
|  | removedFromStage | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject
|  | touch | Dispatched when an object is touched. | DisplayObject

Property Detail

emitAngle | property

`emitAngle:Number`

Implementation
`public function get emitAngle():Number`
`public function set emitAngle(value:Number):void`

emitAngleVariance | property |

`emitAngleVariance:Number`

Implementation
`public function get emitAngleVariance():Number`
`public function set emitAngleVariance(value:Number):void`

emitterType | property |

`emitterType:int`

Implementation
`public function get emitterType():int`
`public function set emitterType(value:int):void`

emitterXVariance | property |

`emitterXVariance:Number`

Implementation
`public function get emitterXVariance():Number`
`public function set emitterXVariance(value:Number):void`

emitterYVariance | property |

`emitterYVariance:Number`

Implementation
`public function get emitterYVariance():Number`
`public function set emitterYVariance(value:Number):void`

endColor | property |

`endColor:ColorArgb`

Implementation
`public function get endColor():ColorArgb`
`public function set endColor(value:ColorArgb):void`

endColorVariance | property |

`endColorVariance:ColorArgb`

Implementation
`public function get endColorVariance():ColorArgb`
`public function set endColorVariance(value:ColorArgb):void`

endRotation | property |

`endRotation:Number`

Implementation
`public function get endRotation():Number`
`public function set endRotation(value:Number):void`

endRotationVariance | property |

`endRotationVariance:Number`

Implementation
`public function get endRotationVariance():Number`
`public function set endRotationVariance(value:Number):void`

endSize | property |

`endSize:Number`

Implementation
`public function get endSize():Number`
`public function set endSize(value:Number):void`

endSizeVariance | property |

`endSizeVariance:Number`

Implementation
`public function get endSizeVariance():Number`
`public function set endSizeVariance(value:Number):void`

gravityX | property |

`gravityX:Number`

Implementation
`public function get gravityX():Number`
`public function set gravityX(value:Number):void`

gravityY | property |

`gravityY:Number`

Implementation
`public function get gravityY():Number`
`public function set gravityY(value:Number):void`

lifespan | property |

`lifespan:Number`

Implementation
`public function get lifespan():Number`
`public function set lifespan(value:Number):void`

lifespanVariance | property |

`lifespanVariance:Number`

Implementation
`public function get lifespanVariance():Number`
`public function set lifespanVariance(value:Number):void`

maxNumParticles | property |

`maxNumParticles:int`

Implementation
`public function get maxNumParticles():int`
`public function set maxNumParticles(value:int):void`

maxRadius | property |

`maxRadius:Number`

Implementation
`public function get maxRadius():Number`
`public function set maxRadius(value:Number):void`

maxRadiusVariance | property |

`maxRadiusVariance:Number`

Implementation
`public function get maxRadiusVariance():Number`
`public function set maxRadiusVariance(value:Number):void`

minRadius | property |

`minRadius:Number`

Implementation
`public function get minRadius():Number`
`public function set minRadius(value:Number):void`

radialAcceleration | property |

`radialAcceleration:Number`

Implementation
`public function get radialAcceleration():Number`
`public function set radialAcceleration(value:Number):void`

radialAccelerationVariance | property |

`radialAccelerationVariance:Number`

Implementation
`public function get radialAccelerationVariance():Number`
`public function set radialAccelerationVariance(value:Number):void`

rotatePerSecond | property |

`rotatePerSecond:Number`

Implementation
`public function get rotatePerSecond():Number`
`public function set rotatePerSecond(value:Number):void`

rotatePerSecondVariance | property |

`rotatePerSecondVariance:Number`

Implementation
`public function get rotatePerSecondVariance():Number`
`public function set rotatePerSecondVariance(value:Number):void`

speed | property |

`speed:Number`

Implementation
`public function get speed():Number`
`public function set speed(value:Number):void`

speedVariance | property |

`speedVariance:Number`

Implementation
`public function get speedVariance():Number`
`public function set speedVariance(value:Number):void`

startColor | property |

`startColor:ColorArgb`

Implementation
`public function get startColor():ColorArgb`
`public function set startColor(value:ColorArgb):void`

startColorVariance | property |

`startColorVariance:ColorArgb`

Implementation
`public function get startColorVariance():ColorArgb`
`public function set startColorVariance(value:ColorArgb):void`

startRotation | property |

`startRotation:Number`

Implementation
`public function get startRotation():Number`
`public function set startRotation(value:Number):void`

startRotationVariance | property |

`startRotationVariance:Number`

Implementation
`public function get startRotationVariance():Number`
`public function set startRotationVariance(value:Number):void`

startSize | property |

`startSize:Number`

Implementation
`public function get startSize():Number`
`public function set startSize(value:Number):void`

startSizeVariance | property |

`startSizeVariance:Number`

Implementation
`public function get startSizeVariance():Number`
`public function set startSizeVariance(value:Number):void`

tangentialAcceleration | property |

`tangentialAcceleration:Number`

Implementation
`public function get tangentialAcceleration():Number`
`public function set tangentialAcceleration(value:Number):void`

tangentialAccelerationVariance | property |

`tangentialAccelerationVariance:Number`

Implementation
`public function get tangentialAccelerationVariance():Number`
`public function set tangentialAccelerationVariance(value:Number):void`
Constructor Detail

PDParticleSystem | () | Constructor

`public function PDParticleSystem(config:XML, texture:Texture)`

Parameters

| `config:XML`
| `texture:Texture`

Method Detail

advanceParticle | () | method

`override protected function advanceParticle(aParticle:Particle, passedTime:Number):void`

Parameters

| `aParticle:Particle`
| `passedTime:Number`

createParticle | () | method |

`override protected function createParticle():Particle`

Returns

| `Particle`

initParticle | () | method |

`override protected function initParticle(aParticle:Particle):void`

Parameters

| `aParticle:Particle`

Thu Jan 16 2014, 01:11 PM +08:00