org.flintparticles.threeD.renderers.PixelRenderer

Package	org.flintparticles.threeD.renderers
Class	public class PixelRenderer
Inheritance	PixelRenderer BitmapRenderer SpriteRendererBase flash.display.Sprite

The PixelRenderer is a native Flint 3D renderer that draws particles as single pixels on a Bitmap display object.

The region of the projection plane drawn by this renderer must be defined in the canvas property of the BitmapRenderer. Particles outside this region are not drawn.

The PixelRenderer allows the use of BitmapFilters to modify the appearance of the bitmap. Every frame, under normal circumstances, the Bitmap used to display the particles is wiped clean before all the particles are redrawn. However, if one or more filters are added to the renderer, the filters are applied to the bitmap instead of wiping it clean. This enables various trail effects by using blur and other filters.

The PixelRenderer has mouse events disabled for itself and any display objects in its display list. To enable mouse events for the renderer or its children set the mouseEnabled or mouseChildren properties to true.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bitmapData : BitmapData [read-only] The bitmap data of the renderer.	BitmapRenderer
		camera : Camera The camera controls the view for the renderer	BitmapRenderer
		canvas : Rectangle The canvas is the area within the renderer on which particles can be drawn.	BitmapRenderer
		emitters : Vector.<Emitter> The array of all emitters being rendered by this renderer.	SpriteRendererBase
		postFilters : Array The array of all filters being applied before rendering.	BitmapRenderer
		preFilters : Array The array of all filters being applied before rendering.	BitmapRenderer
		smoothing : Boolean	BitmapRenderer
		zSort : Boolean Indicates whether the particles should be sorted in distance order for display.	BitmapRenderer

	Property	Defined By
		_particles : Array	SpriteRendererBase
		toDegrees : Number	BitmapRenderer
		ZERO_POINT : Point [static]	BitmapRenderer

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		PixelRenderer(canvas:Rectangle, zSort:Boolean = false) The constructor creates a PixelRenderer.	PixelRenderer
		addEmitter(emitter:Emitter):void Adds the emitter to the renderer.	SpriteRendererBase
		addFilter(filter:BitmapFilter, postRender:Boolean = false):void The addFilter method adds a BitmapFilter to the renderer.	BitmapRenderer
		clearPaletteMap():void Clears any palette map that has been set for the renderer.	BitmapRenderer
		removeEmitter(emitter:Emitter):void Removes the emitter from the renderer.	SpriteRendererBase
		removeFilter(filter:BitmapFilter):void Removes a BitmapFilter object from the Renderer.	BitmapRenderer
		setPaletteMap(red:Array = null, green:Array = null, blue:Array = null, alpha:Array = null):void Sets a palette map for the renderer.	BitmapRenderer

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		addParticle(particle:Particle):void The addParticle method is called when a particle is added to one of the emitters that is being rendered by this renderer.	SpriteRendererBase
		createBitmap():void Create the Bitmap and BitmapData objects	BitmapRenderer
		drawParticle(particle:Particle3D):void [override] This is the method that draws each particle.	PixelRenderer
		emitterUpdated(ev:EmitterEvent):void	SpriteRendererBase
		removeParticle(particle:Particle):void The removeParticle method is called when a particle is removed from one of the emitters that is being rendered by this renderer.	SpriteRendererBase
		renderParticles(particles:Array):void [override] This method draws the particles in the bitmap image, positioning and scaling them according to their positions relative to the camera viewport.	BitmapRenderer
		updateParticles(ev:Event):void	SpriteRendererBase

Constructor Detail

PixelRenderer

()

Constructor

public function PixelRenderer(canvas:Rectangle, zSort:Boolean = false)

The constructor creates a PixelRenderer. After creation it should be added to the display list of a DisplayObjectContainer to place it on the stage.

Emitter's should be added to the renderer using the renderer's addEmitter method. The renderer displays all the particles created by the emitter's that have been added to it.

Parameters

	`canvas:Rectangle` — The area within the renderer on which particles can be drawn. Particles outside this area will not be drawn.

	`zSort:Boolean` (default = `false`) — Whether to sort the particles according to their z order when rendering them or not.

Flint Particles documentation v3.0.1	All Packages \| All Classes \| Index \| Frames No Frames
PixelRenderer	Properties \| Methods