away3d.core.session.BitmapSession

	Property	Defined By
		alpha : Number = 1 Placeholder for alpha property of containers	AbstractSession
		blendMode : String Placeholder for blendMode property of containers	AbstractSession
		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

	Method		Defined By
		BitmapSession(scale:Number = 2) Creates a new BitmapRenderSession object.	BitmapSession
		addChildSession(session:AbstractSession):void Adds a session as a child of the session object.	AbstractSession
		addDisplayObject(child:DisplayObject):void [override] Adds a display object to the render session display list.	BitmapSession
		addOnSessionUpdate(listener:Function):void Default method for adding a sessionUpdated event listener	AbstractSession
		clear(view:View3D):void [override] Clears the render session.	BitmapSession
		clearChildSessions():void	AbstractSession
		clearRenderers():void	AbstractSession
		clone():AbstractSession [override] Duplicates the render session's properties to another render session.	BitmapSession
		getBitmapContainer(view:View3D):Bitmap	BitmapSession
		getBitmapData(view:View3D):BitmapData Returns a bitmapData object containing the rendered view.	BitmapSession
		getContainer(view:View3D):DisplayObject [override] Returns a display object representing the container for the specified view.	BitmapSession
		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 [override]	BitmapSession
		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, uvtData:Vector.<Number>, screenVertices:Vector.<Number>, screenIndices:Vector.<int>, startIndex:uint, endIndex:uint, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void Draws a triangle element with a bitmap texture into the graphics object (Flash 10)	AbstractSession
		renderTriangleBitmapMask(bitmap:BitmapData, offX:Number, offY:Number, sc:Number, screenVertices:Vector.<Number>, screenIndices:Vector.<int>, startIndex:uint, endIndex:uint, 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:Vector.<Number>, commands:Vector.<String>, screenIndices:Vector.<int>, 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:Vector.<Number>, commands:Vector.<String>, screenIndices:Vector.<int>, 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:Vector.<Number>, commands:Vector.<String>, screenIndices:Vector.<int>, startIndex:int, endIndex:int):void Draws a wire triangle element with a fill color into the graphics object.	AbstractSession

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

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

Constructor Detail

BitmapSession

()

Constructor

public function BitmapSession(scale:Number = 2)

Creates a new BitmapRenderSession object.

Parameters

scale:Number (default = 2) — [optional] Defines the scale of the pixel resolution in base pixels. Default value is 2.

####INIT####

Method Detail

addDisplayObject

()

method

override public 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

override public function clear(view:View3D):void

Clears the render session.

Parameters

view:View3D

clone

()

method

override public 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

override protected function createLayer():void

Creates a new render layer for rendering composite materials.

createSprite

()

method

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

Parameters

parent:Sprite (default = null)

Returns

Sprite

getBitmapContainer

()

method

public function getBitmapContainer(view:View3D):Bitmap

Parameters

view:View3D

Returns

Bitmap

getBitmapData

()

method

public function getBitmapData(view:View3D):BitmapData

Returns a bitmapData object containing the rendered view.

Parameters

view:View3D — The view object being rendered.

Returns

BitmapData — The bitmapData object.

getContainer

()

method

override public 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.

render

()

method

override public function render(view:View3D):void

Parameters

view:View3D

Tue Jun 7 2011, 11:27 PM +01:00

Away3D FP10 V3.6.0 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
BitmapSession	Properties \| Methods \| Events

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