| Package | cv |
| Class | public class OrionBitmap |
| Inheritance | OrionBitmap  Orion flash.display.Sprite |
| Property | Defined by | ||
|---|---|---|---|
 | cacheBlendMode : String = "normal"
Gets or sets the blend mode applied to particles when they are created.
| Orion | |
| cacheFrames : Array
The storage location for frames that are cached.
| Orion | |
| cachePixelSnapping : String = "auto"
Gets or sets pixel snapping when frame caching is enabled.
| Orion | |
| cacheSmoothing : Boolean = false
Gets or sets bitmap smoothing when using frame caching.
| Orion | |
| cacheTarget : MovieClip
Gets the frame cache movieclip.
| Orion | |
| canvas : Rectangle
The canvas is used to control the boundaries (edge filter) of the particles animating.
| Orion | |
| createEmitters : Array
Triggers the emitters everytime a particle from this emitter
is created.
| Orion | |
| debug : Boolean = false
Turns on debug lines to outline the emitter and canvas dimensions
| Orion | |
| destroyEmitters : Array
Triggers the emitters everytime a particle from this emitter
is destroyed.
| Orion | |
| edgeFilter : IFilter
Gets or sets the edge filter used by the emitter to determine what the particles
will do when they hit the edge.
| Orion | |
| effectFilters : Array
Gets the filters being applied by the emitter.
| Orion | |
| height : Number
Gets or sets the height of the emitter.
| Orion | |
| isRandom : Boolean = false
If true, it ignores speedX and speedY and randomly chooses a point within
the emitter.
| OrionBitmap | ||
| output : IOutput
Gets or sets the output class used.
| Orion | |
| particles : Array
The array of all the particles in this instance of Orion
| Orion | |
| particlesVisible : Boolean = true
As the particles are updated, this will toggle visibility on or off.
| Orion | |
| paused : Boolean
Gets or sets the paused property
| Orion | |
| settings : Object
The settings object controls all configuration.
| Orion | |
| speedX : Number = 6
The X speed that the emitter scans the bitmap and adds particles.
| OrionBitmap | ||
| speedY : Number = 2
The Y speed that the emitter scans the bitmap and adds particles.
| OrionBitmap | ||
| spriteClass : Class
Gets or sets the specific library linkId (class reference)
| Orion | |
| target : DisplayObject
The display object to use as a reference for the bitmapdata.
| OrionBitmap | ||
| targetColor : Number
The target color to attach particles to within the bitmap.
| OrionBitmap | ||
| time : int [static]
Current Time
| Orion | |
| updateEmitters : Array
Triggers the emitters everytime a particle from this emitter
gets updated.
| Orion | |
| useCacheAsBitmap : Boolean = false
Gets or sets whether bitmap caching is enabled on particles used within this emitter.
| Orion | |
| useFrameCaching : Boolean
Gets or sets whether frame caching will be enabled.
| Orion | |
| width : Number
Gets or sets the width of the emitter.
| Orion | |
| x : Number
Gets or sets the x position of the emitter.
| Orion | |
| y : Number
Gets or sets the y position of the emitter.
| Orion | |
| Property | Defined by | ||
|---|---|---|---|
| startY : Number = 0 | OrionBitmap | ||
| Method | Defined by | ||
|---|---|---|---|
|
OrionBitmap(spriteClass:Class = null, output:IOutput = null, config:Object = null, useFrameCaching:Boolean = false)
The constructor allows a few common settings to be specified during construction.
| OrionBitmap | ||
|
applyPreset(config:Object = null, reset:Boolean = false):void
| Orion | |
|
emit(point:Point = null):void
Causes the emitter to add particles.
| Orion | |
|
interpolateColor(fromColor:uint, toColor:uint, progress:Number):uint
[static]
Finds a color that's between the two numbers given.
| Orion | |
|
interpolateTransform(fromColor:ColorTransform, toColor:ColorTransform, progress:Number):ColorTransform
[static]
Finds a ColorTransform that's between the two ColorTransforms given.
| Orion | |
|
killGarbage(e:TimerEvent = null):void
This will run ever 2 seconds and remove any inactive particles from memory.
| Orion | |
|
pause():void
Pauses the particle system
| Orion | |
|
play():void
Resumes or plays the particle system
| Orion | |
|
removeAllParticles():void
Removes all particles from the emitter.
| Orion | |
|
removeItem(array:Array, item:*):Boolean
[static]
Removes a specified item from the array.
| Orion | |
|
Updates all the particles and positions, updates the output class as well.
| OrionBitmap | ||
|
rotateCoord(x:Number, y:Number, sin:Number, cos:Number):Point
[static]
Takes a given coordinate and rotates it in a 2D space.
| Orion | |
|
This acts as a fake output update function for use by the Update
and Destroy emitters.
| Orion | |
|
updateBitmap():void
Updates the bitmapdata of the target display object if it has changed.
| OrionBitmap | ||
| Method | Defined by | ||
|---|---|---|---|
|
addParticle(pt:Point = null):void
Adds a new particle to the system.
| Orion | |
|
cacheFramesOf(mc:MovieClip):void
If it's a movieclip, cache it's frames.
| Orion | |
|
getColorTransform(p:ParticleVO, targetColor:uint):ColorTransform
Used to get a colortransform object for a specific particle.
| Orion | |
|
getCoordinate():Point
Returns a coordinate it's designated position.
| OrionBitmap | ||
|
Returns a new particle
| Orion | |
|
Checks the recycle bin if a suitable particle can be re-used.
| Orion | |
|
gotoAndStopCached(d:DisplayObject, frame:int):void
Sets a given particle to a specific frame in the movieclip, from
the frame cached in memory.
| Orion | |
|
randomRange(min:Number, max:Number):Number
[static]
Return a random number between a range of numbers
| Orion | |
|
recycleParticle(p:ParticleVO):void
Removes a particle and stores the reference to the particle inside
of the recyclebin dictionary.
| Orion | |
|
removeParticle(p:ParticleVO, doArray:Boolean = true):void
Removes a particle.
| Orion | |
|
renderParticle(p:ParticleVO):void
Updates the specific particle based on the filters assigned to the emitter.
| Orion | |
|
resetParticle(p:ParticleVO):void
Resets the particle and initializes it for use.
| Orion | |
|
stageHandler(event:Event):void
| OrionBitmap | ||
|
updateIntersection():void
Update the intersecting rectangle.
| OrionBitmap | ||
| isRandom | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var isRandom:Boolean = falseIf true, it ignores speedX and speedY and randomly chooses a point within the emitter.
The default value is false.
| speedX | property |
public var speedX:Number = 6The X speed that the emitter scans the bitmap and adds particles.
The default value is 6.
See also
| speedY | property |
public var speedY:Number = 2The Y speed that the emitter scans the bitmap and adds particles.
The default value is 2.
See also
| startY | property |
protected var startY:Number = 0
| target | property |
target:DisplayObject [read-write]The display object to use as a reference for the bitmapdata. This is the object that is actually drawn from and the dimensions are grabbed from. If no target is specified, then it will default to the parent of the emitter.
The default value is this.parent.
public function get target():DisplayObject
public function set target(value:DisplayObject):void
| targetColor | property |
targetColor:Number [read-write]The target color to attach particles to within the bitmap.
The default value is 0xFFFFFFFF.
public function get targetColor():Number
public function set targetColor(value:Number):void
| OrionBitmap | () | constructor |
public function OrionBitmap(spriteClass:Class = null, output:IOutput = null, config:Object = null, useFrameCaching:Boolean = false)The constructor allows a few common settings to be specified during construction. Options such as the output class or any configuration settings.
ParametersspriteClass:Class (default = null) |
|
output:IOutput (default = null)null
|
|
config:Object (default = null)configuration object. A configuration object is generated by a
preset or you can write one by hand. Each configuration object can contain an effectFilters array, an
edgeFilter object, and a settings object. The settings object can contain all the same properties that
modifying the settings property directly allows.
|
|
useFrameCaching:Boolean (default = false) |
| getCoordinate | () | method |
protected override function getCoordinate():PointReturns a coordinate it's designated position.
ReturnsPoint — Returns a coordinate at the emitters x,y position or within it.
|
| render | () | method |
public override function render(e:Event = null):voidUpdates all the particles and positions, updates the output class as well.
Parameterse:Event (default = null) |
| stageHandler | () | method |
protected override function stageHandler(event:Event):voidParameters
event:Event |
| updateBitmap | () | method |
public function updateBitmap():voidUpdates the bitmapdata of the target display object if it has changed.
| updateIntersection | () | method |
protected function updateIntersection():voidUpdate the intersecting rectangle. Only emit particles within the emitter and within the bounds of the image.