cv.OrionContainer

Public Properties

	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 the height of the emitter, setting is disabled.	OrionContainer
		offSet : Point This offset is used by the BitmapRenderer to fix render issues.	OrionContainer
		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
		spriteClass : Class The spriteClass property is disabled with this emitter.	OrionContainer
		spriteTarget : DisplayObjectContainer The SpriteTarget property is OrionContainer's equivalent of SpriteClass.	OrionContainer
		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 The useFrameCaching property is disabled with this emitter.	OrionContainer
		width : Number Gets the width of the emitter, setting is disabled.	OrionContainer
		x : Number Gets the x position of the emitter, setting is disabled.	OrionContainer
		y : Number Gets the y position of the emitter, setting is disabled.	OrionContainer

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		OrionContainer(target:DisplayObjectContainer, config:Object = null) The constructor for OrionContainer is slightly different from Orion.	OrionContainer
		applyPreset(config:Object = null, reset:Boolean = false):void	Orion
		applySettings():void	OrionContainer
		emit(point:Point = null):void Stops Orion from creating new particles.	OrionContainer
		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
		render(e:Event = null):void Updates all the particles and positions, updates the output class as well.	Orion
		rotateCoord(x:Number, y:Number, sin:Number, cos:Number):Point [static] Takes a given coordinate and rotates it in a 2D space.	Orion
		update(emitter:Orion):void This acts as a fake output update function for use by the Update and Destroy emitters.	Orion

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	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.	Orion
		getNew():ParticleVO Returns a new particle	Orion
		getRecycled():ParticleVO 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(e:Event):void The stage handler, this listens for the Event.ADDED_TO_STAGE event, so it knows when it can access the stage property.	Orion

	Event	Summary	Defined by
		change	This event is dispatched each time Orion renders the particles.	Orion
		resize	This event is dispatched each time Orion is resized.	Orion

	Constant	Defined by
		DEG2RAD : Number = 0.017453292519943295 [static] Stored decimal value for conversion	Orion
		VERSION : String = "1.0.0" [static] The current version of Orion.	Orion

Property detail

height

property

height:Number [read-write]

Gets the height of the emitter, setting is disabled.

Implementation
public function get height():Number
public function set height(value:Number):void

offSet

property

public var offSet:Point

This offset is used by the BitmapRenderer to fix render issues. This is set automatically by assignParticles(), but is public to allow for custom alignment if necessary.

spriteClass

property

spriteClass:Class [read-write]

The spriteClass property is disabled with this emitter.

Implementation
public function get spriteClass():Class
public function set spriteClass(value:Class):void

spriteTarget

property

spriteTarget:DisplayObjectContainer [read-write]

The SpriteTarget property is OrionContainer's equivalent of SpriteClass. This sets the target to use as particles.

Implementation
public function get spriteTarget():DisplayObjectContainer
public function set spriteTarget(value:DisplayObjectContainer):void

useFrameCaching

property

useFrameCaching:Boolean [read-write]

The useFrameCaching property is disabled with this emitter.

Implementation
public function get useFrameCaching():Boolean
public function set useFrameCaching(value:Boolean):void

width

property

width:Number [read-write]

Gets the width of the emitter, setting is disabled.

Implementation
public function get width():Number
public function set width(value:Number):void

property

x:Number [read-write]

Gets the x position of the emitter, setting is disabled.

Implementation
public function get x():Number
public function set x(value:Number):void

Orion API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class OrionContainer	Properties \| Methods \| Events \| Constants

Package	cv
Class	public class OrionContainer
Inheritance	OrionContainer Orion flash.display.Sprite

	`target:DisplayObjectContainer` — The display object to use.

	`config:Object` (default = `null`) — Whether to add the target or the children inside the target.