away3d.core.session.SpriteSession

Public Properties

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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		SpriteSession () Creates a new `SpriteRenderSession` object.	SpriteSession
		addChildSession(session:AbstractSession):void Adds a session as a child of the session object.	AbstractSession
		addDisplayObject(child:DisplayObject):void Adds a display object to the render session display list.	SpriteSession
		addOnSessionUpdate(listener:Function):void Default method for adding a sessionUpdated event listener	AbstractSession
		clear(view:View3D):void Clears the render session.	SpriteSession
		clearChildSessions():void	AbstractSession
		clearRenderers():void	AbstractSession
		clone():AbstractSession Duplicates the render session's properties to another render session.	SpriteSession
		getContainer(view:View3D):DisplayObject Returns a display object representing the container for the specified view.	SpriteSession
		getLightShape(material:LayerMaterial, level:int, parent:Sprite, light:AbstractLight):Shape	AbstractSession
		getLightShapeLayer(view:View3D):Dictionary	AbstractSession
		getRenderer(view:View3D):Renderer	AbstractSession
		getShape(material:LayerMaterial, level:int, parent:Sprite):Shape	AbstractSession
		getShapeLayer(view:View3D):Dictionary	AbstractSession
		getSprite(material:LayerMaterial, level:int, parent:Sprite = null):Sprite	AbstractSession
		getSpriteLayer(view:View3D):Dictionary	AbstractSession
		getTotalFaces(view:View3D):int	AbstractSession
		removeChildSession(session:AbstractSession):void Removes a child session of the session object.	AbstractSession
		removeOnSessionUpdate(listener:Function):void Default method for removing a sessionUpdated event listener	AbstractSession
		render(view:View3D):void	AbstractSession
		renderDot(color:int, alpha:Number, x:Number, y:Number, layerGraphics:Graphics = null, w:int = 1):void Draws a rect dot at given coordinates	AbstractSession
		renderFogColor(color:int, alpha:Number, minX:Number, maxX:Number, minY:Number, maxY:Number):void Draws a fog element into the graphics object.	AbstractSession
		renderLine(v0x:Number, v0y:Number, v1x:Number, v1y:Number, width:Number, color:uint, alpha:Number):void Draws a segment element into the graphics object.	AbstractSession
		renderSpriteBitmap(bitmap:BitmapData, smooth:Boolean, priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):void Draws a billboard element with a fill bitmap into the graphics object.	AbstractSession
		renderSpriteColor(color:int, alpha:Number, priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):void Draws a billboard element with a fill color into the graphics object.	AbstractSession
		renderSpriteLine(thickness:Number, wireColor:int, wireAlpha:Number, priIndex:uint, viewSourceObject:ViewSourceObject, renderer:Renderer):void Draws a billboard element with a fill color into the graphics object.	AbstractSession
		renderTriangleBitmap(bitmap:BitmapData, map:Matrix, 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.	AbstractSession
		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.	AbstractSession
		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.	AbstractSession
		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.	AbstractSession
		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.	AbstractSession

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

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

Events

Hide Inherited Events

Show Inherited Events

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

Property detail

cacheAsBitmap

property

public var cacheAsBitmap:Boolean

Constructor detail

SpriteSession

()

constructor

public function SpriteSession() 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():AbstractSession

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

Returns

AbstractSession — 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.session.SpriteSession'

Code examples

Comments

Away3D FP9 V2.5.2 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class SpriteSession		Properties \| Methods \| Events

Package	away3d.core.session
Class	public class SpriteSession
Inheritance	SpriteSession AbstractSession flash.events.EventDispatcher