Packageaway3d.core.render
Classpublic class AbstractRenderSession
InheritanceAbstractRenderSession Inheritance flash.events.EventDispatcher
SubclassesBitmapRenderSession, SpriteRenderSession

Abstract Drawing session object containing the method used for drawing the view to screen. Not intended for direct use - use SpriteRenderSession or BitmapRenderSession.

Public Properties
 PropertyDefined by
  alpha : Number = 1
Placeholder for alpha property of containers
AbstractRenderSession
  blendMode : String
Placeholder for blendMode property of containers
AbstractRenderSession
  children : Dictionary
Dictionary of child displayobjects.
AbstractRenderSession
  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
  newLayer : Sprite
Holds the last added layer sprite.
AbstractRenderSession
  parent : AbstractRenderSession
AbstractRenderSession
  priconsumers : Dictionary
AbstractRenderSession
  primitives : Array
AbstractRenderSession
  renderer : IPrimitiveConsumer
AbstractRenderSession
  sessions : Array
Array of child sessions.
AbstractRenderSession
  spriteLayers : Array
Dictionary of sprite layers for rendering composite materials.
AbstractRenderSession
  updated : Boolean
AbstractRenderSession
Public Methods
 MethodDefined by
  
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.
AbstractRenderSession
  
addLayerObject(child:Sprite):void
Adds a layer sprite to the render session display list.
AbstractRenderSession
  
addOnSessionUpdate(listener:Function):void
Default method for adding a sessionUpdated event listener
AbstractRenderSession
  
clear(view:View3D):void
Clears the render session.
AbstractRenderSession
  
AbstractRenderSession
  
AbstractRenderSession
  
Duplicates the render session's properties to another render session.
AbstractRenderSession
  
AbstractRenderSession
  
getContainer(view:View3D):DisplayObject
Returns a display object representing the container for the specified view.
AbstractRenderSession
  
getTotalFaces(view:View3D):int
AbstractRenderSession
  
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
  
renderBillboardBitmap(bitmap:BitmapData, primitive:DrawBillboard, smooth:Boolean):void
Draws a billboard element with a fill bitmap into the graphics object.
AbstractRenderSession
  
renderBillboardColor(color:int, alpha:Number, primitive:DrawBillboard):void
Draws a billboard element with a fill color into the graphics object.
AbstractRenderSession
  
renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void
Draws a non-scaled bitmap into the graphics object.
AbstractRenderSession
  
renderFogColor(clip:Clipping, color:int, alpha:Number):void
Draws a fog element into the graphics object.
AbstractRenderSession
  
renderLine(v0:ScreenVertex, v1:ScreenVertex, 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
  
renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void
Draws a triangle element with a bitmap texture into the graphics object.
AbstractRenderSession
  
renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, layerGraphics:Graphics = null):void
Draws a triangle element with a fill color into the graphics object.
AbstractRenderSession
  
renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a wire triangle element into the graphics object.
AbstractRenderSession
  
renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a wire triangle element with a fill color into the graphics object.
AbstractRenderSession
Protected Methods
 MethodDefined by
  
createLayer():void
Creates a new render layer for rendering composite materials.
AbstractRenderSession
  
AbstractRenderSession
Events
 EventSummaryDefined by
   Dispatched when the render contents of the session require updating.AbstractRenderSession
Property detail
alphaproperty
public var alpha:Number = 1

Placeholder for alpha property of containers

blendModeproperty 
public var blendMode:String

Placeholder for blendMode property of containers

childrenproperty 
public var children:Dictionary

Dictionary of child displayobjects.

consumerproperty 
public var consumer:IPrimitiveConsumer
_doActiveproperty 
arcane var _doActive:Array

Array for storing added displayobjects to the canvas

_doStoreproperty 
arcane var _doStore:Array

Array for storing old displayobjects to the canvas

filtersproperty 
public var filters:Array

Placeholder for filters property of containers

graphicsproperty 
public var graphics:Graphics

Reference to the current graphics object being used for drawing.

newLayerproperty 
public var newLayer:Sprite

Holds the last added layer sprite.

parentproperty 
public var parent:AbstractRenderSession
priconsumersproperty 
public var priconsumers:Dictionary
primitivesproperty 
public var primitives:Array
rendererproperty 
renderer:IPrimitiveConsumer  [read-write]Implementation
    public function get renderer():IPrimitiveConsumer
    public function set renderer(value:IPrimitiveConsumer):void
sessionsproperty 
public var sessions:Array

Array of child sessions.

spriteLayersproperty 
public var spriteLayers:Array

Dictionary of sprite layers for rendering composite materials.

See also

updatedproperty 
public var updated:Boolean
Method detail
addChildSession()method
public function addChildSession(session:AbstractRenderSession):void

Adds a session as a child of the session object.

Parameters
session:AbstractRenderSession — The session object to be added as a child.
addDisplayObject()method 
public function addDisplayObject(child:DisplayObject):void

Adds a display object to the render session display list.

Parameters
child:DisplayObject — The display object to add.
addLayerObject()method 
public function addLayerObject(child:Sprite):void

Adds a layer sprite to the render session display list. Doesn't update graphics so that elements in comosite materials can render in separate layers.

Parameters
child:Sprite — The display object to add.
addOnSessionUpdate()method 
public function addOnSessionUpdate(listener:Function):void

Default method for adding a sessionUpdated event listener

Parameters
listener:Function — The listener function
clear()method 
public function clear(view:View3D):void

Clears the render session.

Parameters
view:View3D
clearChildSessions()method 
public function clearChildSessions():void
clearRenderers()method 
public function clearRenderers():void
clone()method 
public 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 function createLayer():void

Creates a new render layer for rendering composite materials.

See also

getConsumer()method 
public function getConsumer(view:View3D):IPrimitiveConsumer Parameters
view:View3D

Returns
IPrimitiveConsumer
getContainer()method 
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.
getTotalFaces()method 
public function getTotalFaces(view:View3D):int Parameters
view:View3D

Returns
int
onSessionUpdate()method 
protected function onSessionUpdate(event:SessionEvent):void Parameters
event:SessionEvent
removeChildSession()method 
public function removeChildSession(session:AbstractRenderSession):void

Removes a child session of the session object.

Parameters
session:AbstractRenderSession — The session object to be removed.
removeOnSessionUpdate()method 
public function removeOnSessionUpdate(listener:Function):void

Default method for removing a sessionUpdated event listener

Parameters
listener:Function — The listener function
render()method 
public function render(view:View3D):void Parameters
view:View3D
renderBillboardBitmap()method 
public function renderBillboardBitmap(bitmap:BitmapData, primitive:DrawBillboard, smooth:Boolean):void

Draws a billboard element with a fill bitmap into the graphics object.

Parameters
bitmap:BitmapData
 
primitive:DrawBillboard
 
smooth:Boolean
renderBillboardColor()method 
public function renderBillboardColor(color:int, alpha:Number, primitive:DrawBillboard):void

Draws a billboard element with a fill color into the graphics object.

Parameters
color:int
 
alpha:Number
 
primitive:DrawBillboard
renderBitmap()method 
public function renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void

Draws a non-scaled bitmap into the graphics object.

Parameters
bitmap:BitmapData
 
v0:ScreenVertex
 
smooth:Boolean (default = false)
renderFogColor()method 
public function renderFogColor(clip:Clipping, color:int, alpha:Number):void

Draws a fog element into the graphics object.

Parameters
clip:Clipping
 
color:int
 
alpha:Number
renderLine()method 
public function renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void

Draws a segment element into the graphics object.

Parameters
v0:ScreenVertex
 
v1:ScreenVertex
 
width:Number
 
color:uint
 
alpha:Number
renderScaledBitmap()method 
public function renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void

Draws a bitmap with a precalculated matrix into the graphics object.

Parameters
primitive:DrawScaledBitmap
 
bitmap:BitmapData
 
mapping:Matrix
 
smooth:Boolean (default = false)
renderTriangleBitmap()method 
public function renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void

Draws a triangle element with a bitmap texture into the graphics object.

Parameters
bitmap:BitmapData
 
map:Matrix
 
v0:ScreenVertex
 
v1:ScreenVertex
 
v2:ScreenVertex
 
smooth:Boolean
 
repeat:Boolean
 
layerGraphics:Graphics (default = null)
renderTriangleColor()method 
public function renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, layerGraphics:Graphics = null):void

Draws a triangle element with a fill color into the graphics object.

Parameters
color:int
 
alpha:Number
 
v0:ScreenVertex
 
v1:ScreenVertex
 
v2:ScreenVertex
 
layerGraphics:Graphics (default = null)
renderTriangleLine()method 
public function renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void

Draws a wire triangle element into the graphics object.

Parameters
width:Number
 
color:int
 
alpha:Number
 
v0:ScreenVertex
 
v1:ScreenVertex
 
v2:ScreenVertex
renderTriangleLineFill()method 
public function renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void

Draws a wire triangle element with a fill color into the graphics object.

Parameters
width:Number
 
color:int
 
alpha:Number
 
wirecolor:int
 
wirealpha:Number
 
v0:ScreenVertex
 
v1:ScreenVertex
 
v2:ScreenVertex
Event detail
sessionUpdatedevent 
Event object type: away3d.events.SessionEvent

Dispatched when the render contents of the session require updating.

Wiki link
Click to go to the wiki page for 'away3d.core.render.AbstractRenderSession'

Code examples

Comments