Packageorg.papervision3d.view
Classpublic class Viewport3D
InheritanceViewport3D Inheritance flash.display.Sprite
ImplementsIViewport3D
SubclassesBitmapViewport3D



Public Properties
 PropertyDefined by
  autoClipping : Boolean
The clipping boolean flag
Viewport3D
  autoCulling : Boolean
The culling boolean flag
Viewport3D
  autoScaleToStage : Boolean
The auto scale to stage boolean flag
Viewport3D
  containerSprite : ViewportLayer
[read-only] The Sprite holding the Viewport3D
Viewport3D
  cullingRectangle : Rectangle
Viewport3D
  interactive : Boolean
The interactive boolean flag
Viewport3D
  interactiveSceneManager : InteractiveSceneManager
Viewport3D
  lastRenderList : Array
Viewport3D
  lineCuller : ILineCuller
Viewport3D
  particleCuller : IParticleCuller
Viewport3D
  sizeRectangle : Rectangle
Viewport3D
  triangleCuller : ITriangleCuller
Viewport3D
  viewportHeight : Number
Height of the Viewport
Viewport3D
  viewportObjectFilter : ViewportObjectFilter
The ViewportObjectFilter
Viewport3D
  viewportWidth : Number
Width of the Viewport3D
Viewport3D
Protected Properties
 PropertyDefined by
  _autoClipping : Boolean
Viewport3D
  _autoCulling : Boolean
Viewport3D
  _autoScaleToStage : Boolean
Viewport3D
  _containerSprite : ViewportBaseLayer
Viewport3D
  _height : Number
Viewport3D
  _hHeight : Number
Viewport3D
  _hWidth : Number
Viewport3D
  _interactive : Boolean
Viewport3D
  _lastRenderer : IRenderEngine
Viewport3D
  _layerInstances : Dictionary
Viewport3D
  renderHitData : RenderHitData
Viewport3D
  _viewportObjectFilter : ViewportObjectFilter
Viewport3D
  _width : Number
Viewport3D
Public Methods
 MethodDefined by
  
Viewport3D(viewportWidth:Number = 640, viewportHeight:Number = 480, autoScaleToStage:Boolean = false, interactive:Boolean = false, autoClipping:Boolean = true, autoCulling:Boolean = true)
Viewport3D
  
accessLayerFor(rc:RenderableListItem, setInstance:Boolean = false):ViewportLayer
Gets the layer of the RenderListItem.
Viewport3D
  
destroy():void
Removes all references and sets the viewport's InteractiveSceneManager to null for a future garbage collection sweep
Viewport3D
  
getChildLayer(do3d:DisplayObject3D, createNew:Boolean = true, recurse:Boolean = true):ViewportLayer
Creates or receives a ViewportLayer of the given DisplayObject3D
Viewport3D
  
Checks the Mouse x and y against the RenderHitData
Viewport3D
  
Checks a Point against the RenderHitData of the viewport
Viewport3D
  
updateAfterRender(renderSessionData:RenderSessionData):void
Updates a ViewportLayer after the 3d data is rendered into the 2d scene
Viewport3D
  
updateBeforeRender(renderSessionData:RenderSessionData):void
Updates a ViewportLayer prior to the 3d data being rendered into the 2d scene
Viewport3D
Protected Methods
 MethodDefined by
  
onAddedToStage(event:Event):void
Triggered when added to the stage to start listening to stage resizing
Viewport3D
  
onRemovedFromStage(event:Event):void
Triggered when removed from the stage to remove the stage resizing listener
Viewport3D
  
onStageResize(event:Event = null):void
Resizes the viewport when the stage is resized (if autoScaleToStage == true)
Viewport3D
  
Viewport3D
Property detail
_autoClippingproperty
protected var _autoClipping:Boolean
autoClippingproperty 
autoClipping:Boolean  [read-write]

The clipping boolean flag

Implementation
    public function get autoClipping():Boolean
    public function set autoClipping(value:Boolean):void
_autoCullingproperty 
protected var _autoCulling:Boolean
autoCullingproperty 
autoCulling:Boolean  [read-write]

The culling boolean flag

Implementation
    public function get autoCulling():Boolean
    public function set autoCulling(value:Boolean):void
_autoScaleToStageproperty 
protected var _autoScaleToStage:Boolean
autoScaleToStageproperty 
autoScaleToStage:Boolean  [read-write]

The auto scale to stage boolean flag

Implementation
    public function get autoScaleToStage():Boolean
    public function set autoScaleToStage(value:Boolean):void
_containerSpriteproperty 
protected var _containerSprite:ViewportBaseLayer
containerSpriteproperty 
containerSprite:ViewportLayer  [read-only]

The Sprite holding the Viewport3D

Implementation
    public function get containerSprite():ViewportLayer
cullingRectangleproperty 
public var cullingRectangle:Rectangle
_heightproperty 
protected var _height:Number
_hHeightproperty 
protected var _hHeight:Number
_hWidthproperty 
protected var _hWidth:Number
_interactiveproperty 
protected var _interactive:Boolean
interactiveproperty 
interactive:Boolean  [read-write]

The interactive boolean flag

Implementation
    public function get interactive():Boolean
    public function set interactive(value:Boolean):void
interactiveSceneManagerproperty 
public var interactiveSceneManager:InteractiveSceneManager
_lastRendererproperty 
protected var _lastRenderer:IRenderEngine
lastRenderListproperty 
public var lastRenderList:Array
_layerInstancesproperty 
protected var _layerInstances:Dictionary
lineCullerproperty 
public var lineCuller:ILineCuller
particleCullerproperty 
public var particleCuller:IParticleCuller
renderHitDataproperty 
protected var renderHitData:RenderHitData
sizeRectangleproperty 
public var sizeRectangle:Rectangle
triangleCullerproperty 
public var triangleCuller:ITriangleCuller
viewportHeightproperty 
viewportHeight:Number  [read-write]

Height of the Viewport

Implementation
    public function get viewportHeight():Number
    public function set viewportHeight(value:Number):void
_viewportObjectFilterproperty 
protected var _viewportObjectFilter:ViewportObjectFilter
viewportObjectFilterproperty 
viewportObjectFilter:ViewportObjectFilter  [read-write]

The ViewportObjectFilter

Implementation
    public function get viewportObjectFilter():ViewportObjectFilter
    public function set viewportObjectFilter(value:ViewportObjectFilter):void
viewportWidthproperty 
viewportWidth:Number  [read-write]

Width of the Viewport3D

Implementation
    public function get viewportWidth():Number
    public function set viewportWidth(value:Number):void
_widthproperty 
protected var _width:Number
Constructor detail
Viewport3D()constructor
public function Viewport3D(viewportWidth:Number = 640, viewportHeight:Number = 480, autoScaleToStage:Boolean = false, interactive:Boolean = false, autoClipping:Boolean = true, autoCulling:Boolean = true)

Parameters
viewportWidth:Number (default = 640) — Width of the viewport
 
viewportHeight:Number (default = 480) — Height of the viewport
 
autoScaleToStage:Boolean (default = false) — Determines whether the viewport should resize when the stage resizes
 
interactive:Boolean (default = false) — Determines whether the viewport should listen for Mouse events by creating an InteractiveSceneManager
 
autoClipping:Boolean (default = true) — Determines whether DisplayObject3Ds outside the rectangle of the viewport should be rendered
 
autoCulling:Boolean (default = true) — Detemines whether only the objects in front of the camera should be rendered. In other words, if a triangle is hidden by another triangle from the camera, it will not be rendered.
Method detail
accessLayerFor()method
public function accessLayerFor(rc:RenderableListItem, setInstance:Boolean = false):ViewportLayer

Gets the layer of the RenderListItem. Most-likely internal use.

Parameters
rc:RenderableListItem — A RenderableListItem to look for
 
setInstance:Boolean (default = false) — sets the container to the layer

Returns
ViewportLayer — The found ViewportLayer
destroy()method 
public function destroy():void

Removes all references and sets the viewport's InteractiveSceneManager to null for a future garbage collection sweep

getChildLayer()method 
public function getChildLayer(do3d:DisplayObject3D, createNew:Boolean = true, recurse:Boolean = true):ViewportLayer

Creates or receives a ViewportLayer of the given DisplayObject3D

Parameters
do3d:DisplayObject3D — A DisplayObject3D used to either find the layer or create a new one
 
createNew:Boolean (default = true) — Forces the creation of a new layer
 
recurse:Boolean (default = true) — Adds the DisplayObject3D as well as all of its children to a new layer

Returns
ViewportLayerViewportLayer of the given DisplayObject3D
hitTestMouse()method 
public function hitTestMouse():RenderHitData

Checks the Mouse x and y against the RenderHitData

Returns
RenderHitData — RenderHitData of the current mouse location
hitTestPoint2D()method 
public function hitTestPoint2D(point:Point):RenderHitData

Checks a Point against the RenderHitData of the viewport

Parameters
point:Point — a 2d Point you want to analyze into 3d space

Returns
RenderHitDataRenderHitData of the given Point
onAddedToStage()method 
protected function onAddedToStage(event:Event):void

Triggered when added to the stage to start listening to stage resizing

Parameters
event:Event
onRemovedFromStage()method 
protected function onRemovedFromStage(event:Event):void

Triggered when removed from the stage to remove the stage resizing listener

Parameters
event:Event
onStageResize()method 
protected function onStageResize(event:Event = null):void

Resizes the viewport when the stage is resized (if autoScaleToStage == true)

Parameters
event:Event (default = null)
setStageScaleMode()method 
protected function setStageScaleMode():void
updateAfterRender()method 
public function updateAfterRender(renderSessionData:RenderSessionData):void

Updates a ViewportLayer after the 3d data is rendered into the 2d scene

Parameters
renderSessionData:RenderSessionData — All the information regarding the current renderSession packed into one class
updateBeforeRender()method 
public function updateBeforeRender(renderSessionData:RenderSessionData):void

Updates a ViewportLayer prior to the 3d data being rendered into the 2d scene

Parameters
renderSessionData:RenderSessionData — All the information regarding the current renderSession packed into one class