| Package | away3d.containers |
| Class | public class View3D |
| Inheritance | View3D  flash.display.Sprite |
| Property | Defined By | ||
|---|---|---|---|
| background : Sprite
A background sprite positioned under the rendered scene. | View3D | ||
| camera : Camera3D
Camera used when rendering. | View3D | ||
| cameraVarsStore : CameraVarsStore [read-only] | View3D | ||
| clipping : Clipping
Clipping area used when rendering. | View3D | ||
| forceUpdate : Boolean
Defines whether the view always redraws on a render, or just redraws what 3d objects change. | View3D | ||
| foreground : Sprite
A container for 2D overlays positioned over the rendered scene. | View3D | ||
| hitManager : HitManager [read-only] | View3D | ||
| mouseEvents : Boolean
Enables/Disables mouse interactivity. | View3D | ||
| mouseMaterial : Material
Current material under the mouse. | View3D | ||
| mouseObject : Object3D
Current object under the mouse. | View3D | ||
| mouseZeroMove : Boolean
Forces mousemove events to fire even when cursor is static. | View3D | ||
| overlay : Sprite
An overlay sprite positioned on top of the rendered scene. | View3D | ||
| renderer : Renderer
Renderer object used to traverse the scenegraph and output the drawing primitives required to render the scene to the view. | View3D | ||
| scene : Scene3D
Scene used when rendering. | View3D | ||
| screenClipping : Clipping [read-only] | View3D | ||
| session : AbstractSession
Session object used to draw all drawing primitives returned from the renderer to the view container. | View3D | ||
| sourceURL : String
Optional string for storing source url. | View3D | ||
| stats : Boolean
Enables/Disables stats panel. | View3D | ||
| statsOpen : Boolean
Keeps track of whether the stats panel is currently open. | View3D | ||
| statsPanel : Stats
Object instance of the stats panel. | View3D | ||
| updated : Boolean [read-only]
Flag used to determine if the camera has updated the view. | View3D | ||
| viewSourceObject : ViewSourceObject [read-only] | View3D | ||
| Method | Defined By | ||
|---|---|---|---|
View3D(init:Object = null)
Creates a new View3D object. | View3D | ||
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3d event listener. | View3D | ||
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3d event listener. | View3D | ||
addOnMouseOut(listener:Function):void
Default method for adding a 3d mouseOut event listener. | View3D | ||
addOnMouseOver(listener:Function):void
Default method for adding a 3d mouseOver event listener. | View3D | ||
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3d event listener. | View3D | ||
addOverlay(value:IOverlay):void
Adds an overlay effect on top of the view container. | 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 | ||
clear():void
Clears previously rendered view from all render sessions. | View3D | ||
fireMouseEvent(type:String, x:Number, y:Number, ctrlKey:Boolean = false, shiftKey:Boolean = false):void
Collects all information from the given type of 3d mouse event into a MouseEvent3D object that can be accessed from the getMouseEvent() method. | View3D | ||
fireMouseMoveEvent(force:Boolean = false):void
Manually fires a mouseMove3D event. | View3D | ||
getBitmapData():BitmapData
Returns the bitmapData of the rendered scene. | View3D | ||
getContainer():DisplayObject
Returns the DisplayObject container of the rendered scene. | View3D | ||
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3d event listener. | View3D | ||
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener. | View3D | ||
removeOnMouseOut(listener:Function):void
Default method for removing a 3d mouseOut event listener. | View3D | ||
removeOnMouseOver(listener:Function):void
Default method for removing a 3d mouseOver event listener. | View3D | ||
removeOnMouseUp(listener:Function):void
Default method for removing a 3d mouseUp event listener. | View3D | ||
removeOverlay(value:IOverlay):void
Removes an overlay effect on top of the view container. | View3D | ||
render():void
Renders a snapshot of the view to the render session's view container. | View3D | ||
updateScreenClipping():void | View3D | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when a user presses the let hand mouse button while the cursor is over a 3d object | View3D | |||
| Dispatched when a user moves the cursor while it is over a 3d object | View3D | |||
| Dispatched when a user moves the cursor away from a 3d object | View3D | |||
| Dispatched when a user moves the cursor over a 3d object | View3D | |||
| Dispatched when a user releases the let hand mouse button while the cursor is over a 3d object | View3D | |||
| background | property |
public var background:SpriteA background sprite positioned under the rendered scene.
| camera | property |
camera:Camera3DCamera used when rendering.
public function get camera():Camera3D public function set camera(value:Camera3D):voidSee also
| cameraVarsStore | property |
cameraVarsStore:CameraVarsStore [read-only] public function get cameraVarsStore():CameraVarsStore| clipping | property |
clipping:Clipping
Clipping area used when rendering.
If null, the visible edges of the screen are located with the Clipping.screen() method.
public function get clipping():Clipping public function set clipping(value:Clipping):voidSee also
| forceUpdate | property |
public var forceUpdate:BooleanDefines whether the view always redraws on a render, or just redraws what 3d objects change. Defaults to false.
See also
| foreground | property |
public var foreground:SpriteA container for 2D overlays positioned over the rendered scene.
| hitManager | property |
| mouseEvents | property |
public var mouseEvents:BooleanEnables/Disables mouse interactivity.
| mouseMaterial | property |
public var mouseMaterial:MaterialCurrent material under the mouse.
| mouseObject | property |
public var mouseObject:Object3DCurrent object under the mouse.
| mouseZeroMove | property |
public var mouseZeroMove:BooleanForces mousemove events to fire even when cursor is static.
| overlay | property |
public var overlay:SpriteAn overlay sprite positioned on top of the rendered scene.
| renderer | property |
renderer:RendererRenderer object used to traverse the scenegraph and output the drawing primitives required to render the scene to the view.
public function get renderer():Renderer public function set renderer(value:Renderer):void| scene | property |
scene:Scene3DScene used when rendering.
public function get scene():Scene3D public function set scene(value:Scene3D):voidSee also
| screenClipping | property |
| session | property |
session:AbstractSessionSession object used to draw all drawing primitives returned from the renderer to the view container.
public function get session():AbstractSession public function set session(value:AbstractSession):voidSee also
| sourceURL | property |
public var sourceURL:StringOptional string for storing source url.
| stats | property |
| statsOpen | property |
public var statsOpen:BooleanKeeps track of whether the stats panel is currently open.
See also
| statsPanel | property |
| updated | property |
updated:Boolean [read-only] Flag used to determine if the camera has updated the view.
public function get updated():BooleanSee also
| viewSourceObject | property |
viewSourceObject:ViewSourceObject [read-only] public function get viewSourceObject():ViewSourceObject| View3D | () | Constructor |
public function View3D(init:Object = null)
Creates a new View3D object.
init:Object (default = null) |
| addOnMouseDown | () | method |
public function addOnMouseDown(listener:Function):voidDefault method for adding a mouseDown3d event listener.
Parameters
listener:Function — The listener function.
|
| addOnMouseMove | () | method |
public function addOnMouseMove(listener:Function):voidDefault method for adding a mouseMove3d event listener.
Parameters
listener:Function — The listener function.
|
| addOnMouseOut | () | method |
public function addOnMouseOut(listener:Function):voidDefault method for adding a 3d mouseOut event listener.
Parameters
listener:Function — The listener function.
|
| addOnMouseOver | () | method |
public function addOnMouseOver(listener:Function):voidDefault method for adding a 3d mouseOver event listener.
Parameters
listener:Function — The listener function.
|
| addOnMouseUp | () | method |
public function addOnMouseUp(listener:Function):voidDefault method for adding a mouseUp3d event listener.
Parameters
listener:Function — The listener function.
|
| addOverlay | () | method |
public function addOverlay(value:IOverlay):voidAdds an overlay effect on top of the view container.
Parameters
value:IOverlay |
| addSourceURL | () | method |
public function addSourceURL(url:String):voidDefines 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.
|
| clear | () | method |
public function clear():voidClears previously rendered view from all render sessions.
See also
| fireMouseEvent | () | method |
public function fireMouseEvent(type:String, x:Number, y:Number, ctrlKey:Boolean = false, shiftKey:Boolean = false):void
Collects all information from the given type of 3d mouse event into a MouseEvent3D object that can be accessed from the getMouseEvent() method.
Parameters
type:String — The type of 3d mouse event being triggered - can be MOUSE_UP, MOUSE_DOWN, MOUSE_OVER, MOUSE_OUT, and MOUSE_MOVE.
| |
x:Number — The x coordinate being used for the 3d mouse event.
| |
y:Number — The y coordinate being used for the 3d mouse event.
| |
ctrlKey:Boolean (default = false) | |
shiftKey:Boolean (default = false) |
See also
| fireMouseMoveEvent | () | method |
public function fireMouseMoveEvent(force:Boolean = false):voidManually fires a mouseMove3D event.
Parameters
force:Boolean (default = false) |
| getBitmapData | () | method |
public function getBitmapData():BitmapData
Returns the bitmapData of the rendered scene.
session is required to be an instance of BitmapRenderSession, otherwise an error is thrown.
BitmapData — The rendered view image.
|
Error incorrect — session object - require BitmapRenderSession.
|
See also
| getContainer | () | method |
public function getContainer():DisplayObject
Returns the DisplayObject container of the rendered scene.
DisplayObject — The DisplayObject containing the output from the render session of the view.
|
See also
| removeOnMouseDown | () | method |
public function removeOnMouseDown(listener:Function):voidDefault method for removing a mouseDown3d event listener.
Parameters
listener:Function — The listener function.
|
| removeOnMouseMove | () | method |
public function removeOnMouseMove(listener:Function):voidDefault method for removing a mouseMove3D event listener.
Parameters
listener:Function — The listener function.
|
| removeOnMouseOut | () | method |
public function removeOnMouseOut(listener:Function):voidDefault method for removing a 3d mouseOut event listener.
Parameters
listener:Function — The listener function.
|
| removeOnMouseOver | () | method |
public function removeOnMouseOver(listener:Function):voidDefault method for removing a 3d mouseOver event listener.
Parameters
listener:Function — The listener function.
|
| removeOnMouseUp | () | method |
public function removeOnMouseUp(listener:Function):voidDefault method for removing a 3d mouseUp event listener.
Parameters
listener:Function — The listener function.
|
| removeOverlay | () | method |
public function removeOverlay(value:IOverlay):voidRemoves an overlay effect on top of the view container.
Parameters
value:IOverlay |
| render | () | method |
public function render():voidRenders a snapshot of the view to the render session's view container.
See also
| updateScreenClipping | () | method |
public function updateScreenClipping():void| mouseDown | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user presses the let hand mouse button while the cursor is over a 3d object
| mouseMove | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user moves the cursor while it is over a 3d object
| mouseOut | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user moves the cursor away from a 3d object
| mouseOver | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user moves the cursor over a 3d object
| mouseUp | Event |
away3d.events.MouseEvent3Daway3d.events.MouseEvent3DDispatched when a user releases the let hand mouse button while the cursor is over a 3d object