away3d.core.render.SpriteRenderSession

	Property	Defined by
		alpha : Number = 1 Placeholder for alpha property of containers	AbstractRenderSession
		blendMode : String Placeholder for blendMode property of containers	AbstractRenderSession
		cacheAsBitmap : Boolean	SpriteRenderSession
		consumer : IPrimitiveConsumer	AbstractRenderSession
		filters : Array Placeholder for filters property of containers	AbstractRenderSession
		graphics : Graphics Reference to the current graphics object being used for drawing.	AbstractRenderSession
		layer : DisplayObject	AbstractRenderSession
		parent : AbstractRenderSession	AbstractRenderSession
		priconsumers : Dictionary	AbstractRenderSession
		primitives : Array	AbstractRenderSession
		renderer : IPrimitiveConsumer	AbstractRenderSession
		screenZ : Number	AbstractRenderSession
		sessions : Array Array of child sessions.	AbstractRenderSession
		updated : Boolean	AbstractRenderSession

Public Methods

	Method		Defined by
		SpriteRenderSession () Creates a new `SpriteRenderSession` object.	SpriteRenderSession
		addChildSession(session:AbstractRenderSession):void Adds a session as a child of the session object.	AbstractRenderSession
		addDisplayObject(child:DisplayObject):void Adds a display object to the render session display list.	SpriteRenderSession
		addOnSessionUpdate(listener:Function):void Default method for adding a sessionUpdated event listener	AbstractRenderSession
		clear(view:View3D):void Clears the render session.	SpriteRenderSession
		clearChildSessions():void	AbstractRenderSession
		clearRenderers():void	AbstractRenderSession
		clone():AbstractRenderSession Duplicates the render session's properties to another render session.	SpriteRenderSession
		getConsumer(view:View3D):IPrimitiveConsumer	AbstractRenderSession
		getContainer(view:View3D):DisplayObject Returns a display object representing the container for the specified view.	SpriteRenderSession
		getLightShape(material:LayerMaterial, level:int, parent:Sprite, light:LightPrimitive):Shape	AbstractRenderSession
		getLightShapeLayer(view:View3D):Dictionary	AbstractRenderSession
		getShape(material:LayerMaterial, level:int, parent:Sprite):Shape	AbstractRenderSession
		getShapeLayer(view:View3D):Dictionary	AbstractRenderSession
		getSprite(material:LayerMaterial, level:int, parent:Sprite = null):Sprite	AbstractRenderSession
		getSpriteLayer(view:View3D):Dictionary	AbstractRenderSession
		getTotalFaces(view:View3D):int	AbstractRenderSession
		removeChildSession(session:AbstractRenderSession):void Removes a child session of the session object.	AbstractRenderSession
		removeOnSessionUpdate(listener:Function):void Default method for removing a sessionUpdated event listener	AbstractRenderSession
		render(view:View3D):void	AbstractRenderSession
		renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void Draws a non-scaled bitmap into the graphics object.	AbstractRenderSession
		renderDot(color:int, alpha:Number, x:Number, y:Number, layerGraphics:Graphics = null, w:int = 1):void Draws a rect dot at given coordinates	AbstractRenderSession
		renderFogColor(clip:Clipping, color:int, alpha:Number):void Draws a fog element into the graphics object.	AbstractRenderSession
		renderLine(v0x:Number, v0y:Number, v1x:Number, v1y:Number, width:Number, color:uint, alpha:Number):void Draws a segment element into the graphics object.	AbstractRenderSession
		renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void Draws a bitmap with a precalculated matrix into the graphics object.	AbstractRenderSession
		renderSpriteBitmap(bitmap:BitmapData, primitive:DrawSprite, smooth:Boolean):void Draws a billboard element with a fill bitmap into the graphics object.	AbstractRenderSession
		renderSpriteColor(color:int, alpha:Number, primitive:DrawSprite):void Draws a billboard element with a fill color into the graphics object.	AbstractRenderSession
		renderTriangleBitmap(bitmap:BitmapData, uvtData:Vector, screenVertices:Array, screenIndices:Array, startIndex:Number, endIndex:Number, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void Draws a triangle element with a bitmap texture into the graphics object (Flash 10)	AbstractRenderSession
		renderTriangleBitmapMask(bitmap:BitmapData, offX:Number, offY:Number, sc:Number, screenVertices:Array, screenIndices:Array, startIndex:Number, endIndex:Number, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void Draws a triangle element with a bitmap texture into the graphics object, with no uv transforms.	AbstractRenderSession
		renderTriangleColor(color:int, alpha:Number, screenVertices:Array, commands:Array, screenIndices:Array, startIndex:Number, endIndex:Number, layerGraphics:Graphics = null):void Draws a triangle element with a fill color into the graphics object.	AbstractRenderSession
		renderTriangleLine(thickness:Number, wireColor:int, wireAlpha:Number, screenVertices:Array, commands:Array, screenIndices:Array, startIndex:Number, endIndex:Number):void Draws a wire triangle element into the graphics object.	AbstractRenderSession
		renderTriangleLineFill(thickness:Number, color:int, alpha:Number, wireColor:int, wireAlpha:Number, screenVertices:Array, commands:Array, screenIndices:Array, startIndex:int, endIndex:int):void Draws a wire triangle element with a fill color into the graphics object.	AbstractRenderSession

	Method	Defined by
		createLayer():void Creates a new render layer for rendering composite materials.	SpriteRenderSession
		createShape(parent:Sprite):Shape	AbstractRenderSession
		createSprite(parent:Sprite = null):Sprite	SpriteRenderSession
		onSessionUpdate(event:SessionEvent):void	SpriteRenderSession

	Event	Summary	Defined by
		sessionUpdated	Dispatched when the render contents of the session require updating.	AbstractRenderSession

Property detail

cacheAsBitmap

property

public var cacheAsBitmap:Boolean

Constructor detail

SpriteRenderSession

()

constructor

public function SpriteRenderSession() Init Parameters

Method detail

addDisplayObject

()

method

public override function addDisplayObject(child:DisplayObject):void

Adds a display object to the render session display list.

Parameters

child:DisplayObject — The display object to add.

clear

()

method

public override function clear(view:View3D):void

Clears the render session.

Parameters

view:View3D

clone

()

method

public override function clone():AbstractRenderSession

Duplicates the render session's properties to another render session.

Returns

AbstractRenderSession — The new render session instance with duplicated properties applied

createLayer

()

method

protected override function createLayer():void

Creates a new render layer for rendering composite materials.

createSprite

()

method

protected override function createSprite(parent:Sprite = null):Sprite

Parameters

parent:Sprite (default = null)

Returns

Sprite

getContainer

()

method

public override function getContainer(view:View3D):DisplayObject

Returns a display object representing the container for the specified view.

Parameters

view:View3D — The view object being rendered.

Returns

DisplayObject — The display object container.

onSessionUpdate

()

method

protected override function onSessionUpdate(event:SessionEvent):void Parameters

event:SessionEvent

Wiki link

Click to go to the wiki page for 'away3d.core.render.SpriteRenderSession'

Code examples

Comments

Away3D FP10 V3.5.0 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class SpriteRenderSession		Properties \| Methods \| Events

Package	away3d.core.render
Class	public class SpriteRenderSession
Inheritance	SpriteRenderSession AbstractRenderSession flash.events.EventDispatcher