Packageaway3d.core.session
Classpublic class SpriteSession
InheritanceSpriteSession Inheritance AbstractSession Inheritance flash.events.EventDispatcher

Drawing session object that renders all drawing primitives into a Sprite container.

Public Properties
 PropertyDefined by
 Inheritedalpha : Number = 1
Placeholder for alpha property of containers
AbstractSession
 InheritedblendMode : String
Placeholder for blendMode property of containers
AbstractSession
  cacheAsBitmap : Boolean
SpriteSession
 Inheritedconsumer : Renderer
AbstractSession
 Inheritedfilters : Array
Placeholder for filters property of containers
AbstractSession
 Inheritedgraphics : Graphics
Reference to the current graphics object being used for drawing.
AbstractSession
 Inheritedlayer : DisplayObject
AbstractSession
 Inheritedobject3D : Object3D
AbstractSession
 Inheritedparent : AbstractSession
AbstractSession
 Inheritedpriconsumers : Dictionary
AbstractSession
 Inheritedprimitives : Array
AbstractSession
 Inheritedrenderer : Renderer
AbstractSession
 InheritedscreenZ : Number
AbstractSession
 Inheritedsessions : Array
Array of child sessions.
AbstractSession
 Inheritedupdated : Boolean
AbstractSession
Public Methods
 MethodDefined by
  
Creates a new SpriteRenderSession object.
SpriteSession
 Inherited
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
 Inherited
addOnSessionUpdate(listener:Function):void
Default method for adding a sessionUpdated event listener
AbstractSession
  
clear(view:View3D):void
Clears the render session.
SpriteSession
 Inherited
AbstractSession
 Inherited
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
 Inherited
getLightShape(material:LayerMaterial, level:int, parent:Sprite, light:AbstractLight):Shape
AbstractSession
 Inherited
getLightShapeLayer(view:View3D):Dictionary
AbstractSession
 Inherited
AbstractSession
 Inherited
getShape(material:LayerMaterial, level:int, parent:Sprite):Shape
AbstractSession
 Inherited
getShapeLayer(view:View3D):Dictionary
AbstractSession
 Inherited
getSprite(material:LayerMaterial, level:int, parent:Sprite = null):Sprite
AbstractSession
 Inherited
getSpriteLayer(view:View3D):Dictionary
AbstractSession
 Inherited
getTotalFaces(view:View3D):int
AbstractSession
 Inherited
Removes a child session of the session object.
AbstractSession
 Inherited
removeOnSessionUpdate(listener:Function):void
Default method for removing a sessionUpdated event listener
AbstractSession
 Inherited
render(view:View3D):void
AbstractSession
 Inherited
renderDot(color:int, alpha:Number, x:Number, y:Number, layerGraphics:Graphics = null, w:int = 1):void
Draws a rect dot at given coordinates
AbstractSession
 Inherited
renderFogColor(color:int, alpha:Number, minX:Number, maxX:Number, minY:Number, maxY:Number):void
Draws a fog element into the graphics object.
AbstractSession
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 MethodDefined by
  
createLayer():void
Creates a new render layer for rendering composite materials.
SpriteSession
 Inherited
createShape(parent:Sprite):Shape
AbstractSession
  
createSprite(parent:Sprite = null):Sprite
SpriteSession
  
SpriteSession
Events
 EventSummaryDefined by
 Inherited Dispatched when the render contents of the session require updating.AbstractSession
Property detail
cacheAsBitmapproperty
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