Packageorg.papervision3d.render
Classpublic class BasicRenderEngine
InheritanceBasicRenderEngine Inheritance AbstractRenderEngine Inheritance flash.events.EventDispatcher
ImplementsIRenderEngine
SubclassesLazyRenderEngine, QuadrantRenderEngine

BasicRenderEngine links Viewport3Ds, Scene3D, and Camera3Ds together by gathering in all of their data, rendering the data, then calling the necessary functions to update from the rendered data



Public Properties
 PropertyDefined by
  clipping : DefaultClipping
BasicRenderEngine
  filter : IRenderFilter
A filter (such as FogFilter) to be used in the renderList.
BasicRenderEngine
  projectionPipeline : ProjectionPipeline
The type of projection pipeline used for projecting and culling.
BasicRenderEngine
  sorter : IRenderSorter
The type of z-sorting to be used with the rendered data based on their respective screen depth.
BasicRenderEngine
Public Methods
 MethodDefined by
  
Creates and prepares all the objects and events needed for rendering
BasicRenderEngine
  
Adds a renderCommand to the renderList
BasicRenderEngine
  
destroy():void
Destroys all of BasicRenderEngine's objects for Garbage Collection purposes.
BasicRenderEngine
  
Removes a renderCommand from the renderList
BasicRenderEngine
  
renderLayers(scene:SceneObject3D, camera:CameraObject3D, viewPort:Viewport3D, layers:Array = null):RenderStatistics
Works similarly to renderScene, but also takes an array of specific ViewportLayer3D's to render
BasicRenderEngine
  
Takes the data from the scene, camera, and viewport, renders it, then updates the viewport
BasicRenderEngine
Property detail
clippingproperty
public var clipping:DefaultClipping
filterproperty 
public var filter:IRenderFilter

A filter (such as FogFilter) to be used in the renderList. Defaults to BasicRenderFilter

See also

projectionPipelineproperty 
public var projectionPipeline:ProjectionPipeline

The type of projection pipeline used for projecting and culling. Defaults to BasicProjectionPipeline

See also

sorterproperty 
public var sorter:IRenderSorter

The type of z-sorting to be used with the rendered data based on their respective screen depth. Defaults to BasicRenderSorter.

See also

Constructor detail
BasicRenderEngine()constructor
public function BasicRenderEngine()

Creates and prepares all the objects and events needed for rendering

Method detail
addToRenderList()method
public override function addToRenderList(renderCommand:RenderableListItem):int

Adds a renderCommand to the renderList

Parameters
renderCommand:RenderableListItem — A command to be used in the renderList

Returns
int — int An integer representing the length of the renderList
destroy()method 
public function destroy():void

Destroys all of BasicRenderEngine's objects for Garbage Collection purposes.

removeFromRenderList()method 
public override function removeFromRenderList(renderCommand:IRenderListItem):int

Removes a renderCommand from the renderList

Parameters
renderCommand:IRenderListItem — A command to be removed from the renderList

Returns
int — int An integer representing the length of the renderList
renderLayers()method 
public function renderLayers(scene:SceneObject3D, camera:CameraObject3D, viewPort:Viewport3D, layers:Array = null):RenderStatistics

Works similarly to renderScene, but also takes an array of specific ViewportLayer3D's to render

Parameters
scene:SceneObject3D — The CameraObject3D looking at the scene
 
camera:CameraObject3D — The Scene3D holding the DisplayObject3D's you want rendered
 
viewPort:Viewport3D — The Viewport3D that will display your scene
 
layers:Array (default = null)

Returns
RenderStatistics — RenderStatistics The RenderStatistics objectholds all the data from the last render

See also

renderScene()method 
public override function renderScene(scene:SceneObject3D, camera:CameraObject3D, viewPort:Viewport3D):RenderStatistics

Takes the data from the scene, camera, and viewport, renders it, then updates the viewport

Parameters
scene:SceneObject3D — The CameraObject3D looking at the scene
 
camera:CameraObject3D — The Scene3D holding the DisplayObject3D's you want rendered
 
viewPort:Viewport3D — The Viewport3D that will display your scene

Returns
RenderStatistics — RenderStatistics The RenderStatistics objectholds all the data from the last render