Packageaway3d.containers
Classpublic class View3D
InheritanceView3D Inheritance flash.display.Sprite



Public Properties
 PropertyDefined By
  antiAlias : uint
The amount of anti-aliasing to be used.
View3D
  background : Texture2DBase
View3D
  backgroundAlpha : Number
View3D
  backgroundColor : uint
The background color of the screen.
View3D
  camera : Camera3D
The camera that's used to render the scene for this viewport
View3D
  deltaTime : uint
[read-only] The amount of milliseconds the last render call took
View3D
  filters : Array
[override] Not supported.
View3D
  filters3d : Array
View3D
  forceMouseMove : Boolean
Forces mouse-move related events even when the mouse hasn't moved.
View3D
  height : Number
[override] The height of the viewport.
View3D
  mousePicker : IPicker
View3D
  renderedFacesCount : uint
[read-only] The amount of faces that were pushed through the render pipeline on the last frame render.
View3D
  renderer : RendererBase
The renderer used to draw the scene.
View3D
  rightClickMenuEnabled : Boolean
View3D
  rotation : Number
[override] [write-only]
View3D
  rotationX : Number
[override] [write-only]
View3D
  rotationY : Number
[override] [write-only]
View3D
  rotationZ : Number
[override] [write-only]
View3D
  scaleX : Number
[override] [write-only]
View3D
  scaleY : Number
[override] [write-only]
View3D
  scaleZ : Number
[override] [write-only]
View3D
  scene : Scene3D
The scene that's used to render for this viewport
View3D
  shareContext : Boolean
Defers control of Context3D clear() and present() calls to Stage3DProxy, enabling multiple Stage3D frameworks to share the same Context3D object.
View3D
  stage3DProxy : Stage3DProxy
View3D
  transform : Transform
[override] [write-only]
View3D
  visible : Boolean
[override] [write-only]
View3D
  width : Number
[override] The width of the viewport.
View3D
  x : Number
[override] [write-only]
View3D
  y : Number
[override] [write-only]
View3D
  z : Number
[override] [write-only]
View3D
Protected Properties
 PropertyDefined By
  _aspectRatio : Number
View3D
  _backBufferInvalid : Boolean = true
View3D
  _camera : Camera3D
View3D
  _depthRender : Texture
View3D
  _entityCollector : EntityCollector
View3D
  _filter3DRenderer : Filter3DRenderer
View3D
  _parentIsStage : Boolean
View3D
  _renderer : RendererBase
View3D
  _requireDepthRender : Boolean
View3D
  _rttBufferManager : RTTBufferManager
View3D
  _scene : Scene3D
View3D
  _stage3DProxy : Stage3DProxy
View3D
Public Methods
 MethodDefined By
  
View3D(scene:Scene3D = null, camera:Camera3D = null, renderer:RendererBase = null, forceSoftware:Boolean = false)
View3D
  
addSourceURL(url:String):void
Defines a source url string that can be accessed though a View Source option in the right-click menu.
View3D
  
dispose():void
Disposes all memory occupied by the view.
View3D
  
getRay(mX:Number, mY:Number, mZ:Number = 0):Vector3D
Returns the ray in scene space from the camera to the point on the screen.
View3D
  
project(point3d:Vector3D):Vector3D
View3D
  
render():void
Renders the view.
View3D
  
unproject(mX:Number, mY:Number, mZ:Number = 0):Vector3D
Calculates the scene position of the given screen coordinates.
View3D
Protected Methods
 MethodDefined By
  
renderSceneDepth(entityCollector:EntityCollector):void
View3D
  
Updates the backbuffer dimensions.
View3D
  
View3D
  
updateTime():void
View3D
Property Detail
_aspectRatioproperty
protected var _aspectRatio:Number

_backBufferInvalidproperty 
protected var _backBufferInvalid:Boolean = true

_cameraproperty 
protected var _camera:Camera3D

_depthRenderproperty 
protected var _depthRender:Texture

_entityCollectorproperty 
protected var _entityCollector:EntityCollector

_filter3DRendererproperty 
protected var _filter3DRenderer:Filter3DRenderer

_parentIsStageproperty 
protected var _parentIsStage:Boolean

_rendererproperty 
protected var _renderer:RendererBase

_requireDepthRenderproperty 
protected var _requireDepthRender:Boolean

_rttBufferManagerproperty 
protected var _rttBufferManager:RTTBufferManager

_sceneproperty 
protected var _scene:Scene3D

_stage3DProxyproperty 
protected var _stage3DProxy:Stage3DProxy

antiAliasproperty 
antiAlias:uint

The amount of anti-aliasing to be used.


Implementation
    public function get antiAlias():uint
    public function set antiAlias(value:uint):void
backgroundproperty 
background:Texture2DBase


Implementation
    public function get background():Texture2DBase
    public function set background(value:Texture2DBase):void
backgroundAlphaproperty 
backgroundAlpha:Number


Implementation
    public function get backgroundAlpha():Number
    public function set backgroundAlpha(value:Number):void
backgroundColorproperty 
backgroundColor:uint

The background color of the screen. This value is only used when clearAll is set to true.


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
cameraproperty 
camera:Camera3D

The camera that's used to render the scene for this viewport


Implementation
    public function get camera():Camera3D
    public function set camera(value:Camera3D):void
deltaTimeproperty 
deltaTime:uint  [read-only]

The amount of milliseconds the last render call took


Implementation
    public function get deltaTime():uint
filtersproperty 
filters:Array[override]

Not supported. Use filters3d instead.


Implementation
    public function get filters():Array
    public function set filters(value:Array):void
filters3dproperty 
filters3d:Array


Implementation
    public function get filters3d():Array
    public function set filters3d(value:Array):void
forceMouseMoveproperty 
forceMouseMove:Boolean

Forces mouse-move related events even when the mouse hasn't moved. This allows mouseOver and mouseOut events etc to be triggered due to changes in the scene graph. Defaults to false.


Implementation
    public function get forceMouseMove():Boolean
    public function set forceMouseMove(value:Boolean):void
heightproperty 
height:Number[override]

The height of the viewport. When software rendering is used, this is limited by the platform to 2048 pixels.


Implementation
    public function get height():Number
    public function set height(value:Number):void
mousePickerproperty 
mousePicker:IPicker


Implementation
    public function get mousePicker():IPicker
    public function set mousePicker(value:IPicker):void
renderedFacesCountproperty 
renderedFacesCount:uint  [read-only]

The amount of faces that were pushed through the render pipeline on the last frame render.


Implementation
    public function get renderedFacesCount():uint
rendererproperty 
renderer:RendererBase

The renderer used to draw the scene.


Implementation
    public function get renderer():RendererBase
    public function set renderer(value:RendererBase):void
rightClickMenuEnabledproperty 
rightClickMenuEnabled:Boolean


Implementation
    public function get rightClickMenuEnabled():Boolean
    public function set rightClickMenuEnabled(value:Boolean):void
rotationproperty 
rotation:Number  [write-only] [override]


Implementation
    public function set rotation(value:Number):void
rotationXproperty 
rotationX:Number  [write-only] [override]


Implementation
    public function set rotationX(value:Number):void
rotationYproperty 
rotationY:Number  [write-only] [override]


Implementation
    public function set rotationY(value:Number):void
rotationZproperty 
rotationZ:Number  [write-only] [override]


Implementation
    public function set rotationZ(value:Number):void
scaleXproperty 
scaleX:Number  [write-only] [override]


Implementation
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number  [write-only] [override]


Implementation
    public function set scaleY(value:Number):void
scaleZproperty 
scaleZ:Number  [write-only] [override]


Implementation
    public function set scaleZ(value:Number):void
sceneproperty 
scene:Scene3D

The scene that's used to render for this viewport


Implementation
    public function get scene():Scene3D
    public function set scene(value:Scene3D):void
shareContextproperty 
shareContext:Boolean

Defers control of Context3D clear() and present() calls to Stage3DProxy, enabling multiple Stage3D frameworks to share the same Context3D object.


Implementation
    public function get shareContext():Boolean
    public function set shareContext(value:Boolean):void
stage3DProxyproperty 
stage3DProxy:Stage3DProxy


Implementation
    public function get stage3DProxy():Stage3DProxy
    public function set stage3DProxy(value:Stage3DProxy):void
transformproperty 
transform:Transform  [write-only] [override]


Implementation
    public function set transform(value:Transform):void
visibleproperty 
visible:Boolean  [write-only] [override]


Implementation
    public function set visible(value:Boolean):void
widthproperty 
width:Number[override]

The width of the viewport. When software rendering is used, this is limited by the platform to 2048 pixels.


Implementation
    public function get width():Number
    public function set width(value:Number):void
xproperty 
x:Number  [write-only] [override]


Implementation
    public function set x(value:Number):void
yproperty 
y:Number  [write-only] [override]


Implementation
    public function set y(value:Number):void
zproperty 
z:Number  [write-only] [override]


Implementation
    public function set z(value:Number):void
Constructor Detail
View3D()Constructor
public function View3D(scene:Scene3D = null, camera:Camera3D = null, renderer:RendererBase = null, forceSoftware:Boolean = false)



Parameters
scene:Scene3D (default = null)
 
camera:Camera3D (default = null)
 
renderer:RendererBase (default = null)
 
forceSoftware:Boolean (default = false)
Method Detail
addSourceURL()method
public function addSourceURL(url:String):void

Defines a source url string that can be accessed though a View Source option in the right-click menu. Requires the stats panel to be enabled.

Parameters

url:String — The url to the source files.

dispose()method 
public function dispose():void

Disposes all memory occupied by the view. This will also dispose the renderer.

getRay()method 
public function getRay(mX:Number, mY:Number, mZ:Number = 0):Vector3D

Returns the ray in scene space from the camera to the point on the screen.

Parameters

mX:Number — The x coordinate relative to the View3D.
 
mY:Number — The y coordinate relative to the View3D.
 
mZ:Number (default = 0) — The z coordinate relative to the View3D.

Returns
Vector3D — The ray from the camera to the scene space position of a point on the projection plane.
project()method 
public function project(point3d:Vector3D):Vector3D

Parameters

point3d:Vector3D

Returns
Vector3D
render()method 
public function render():void

Renders the view.

renderSceneDepth()method 
protected function renderSceneDepth(entityCollector:EntityCollector):void

Parameters

entityCollector:EntityCollector

unproject()method 
public function unproject(mX:Number, mY:Number, mZ:Number = 0):Vector3D

Calculates the scene position of the given screen coordinates.

Parameters

mX:Number — The x coordinate relative to the View3D.
 
mY:Number — The y coordinate relative to the View3D.
 
mZ:Number (default = 0) — The z coordinate relative to the View3D.

Returns
Vector3D — The scene position of the given screen coordinates. The returned point corresponds to a point on the projection plane.
updateBackBuffer()method 
protected function updateBackBuffer():void

Updates the backbuffer dimensions.

updateGlobalPos()method 
protected function updateGlobalPos():void

updateTime()method 
protected function updateTime():void