Packageaway3d.cameras
Classpublic class Camera3D
InheritanceCamera3D Inheritance Object3D Inheritance flash.events.EventDispatcher
Subclasses SpringCam, TargetCamera3D

Basic camera used to resolve a view.

See also

away3d.containers.View3D


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
An optional alpha value that can be applied to the 3d object.
Object3D
 InheritedanimationLibrary : AnimationLibrary
Reference container for all animations used in the container.
Object3D
  aperture : Number
Used in DofSprite3D.
Camera3D
 InheritedblendMode : String
An optional blend mode that can be applied to the 3d object.
Object3D
 InheritedboundingRadius : Number
[read-only] Returns the bounding radius of the 3d object
Object3D
 Inheritedcollider : Boolean
Indicates whether this object is used for collision detection.
Object3D
 Inheriteddebugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
Object3D
 InheriteddebugBoundingBox : WireCube
[read-only]
Object3D
 InheriteddebugBoundingSphere : WireSphere
[read-only]
Object3D
 Inheriteddebugbs : Boolean
Indicates whether a debug bounding sphere should be rendered around the 3d object.
Object3D
  dof : Boolean
Used in DofSprite3D.
Camera3D
  doflevels : Number = 16
Used in DofSprite3D.
Camera3D
 Inheritedeulers : Vector3D
Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis.
Object3D
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties
Object3D
 Inheritedfilters : Array
An optional array of filters that can be applied to the 3d object.
Object3D
  fixedZoom : Boolean
Camera3D
  focus : Number
A divisor value for the perspective depth of the view.
Camera3D
  fov : Number
Defines the field of view of the camera in a vertical direction.
Camera3D
 InheritedgeometryLibrary : GeometryLibrary
Reference container for all geometries used in the container.
Object3D
 Inheritedid : int
[read-only]
Object3D
 InheritedinverseSceneTransform : Matrix3D
Returns the inverse of sceneTransform.
Object3D
  invViewMatrix : Matrix3D
Camera3D
  lens : AbstractLens
Defines a lens object used in vertex projection
Camera3D
 InheritedmaterialLibrary : MaterialLibrary
Reference container for all materials used in the container.
Object3D
  maxblur : Number = 150
Used in DofSprite3D.
Camera3D
 InheritedmaxX : Number
[read-only] Returns the maximum x value of the 3d object
Object3D
 InheritedmaxY : Number
[read-only] Returns the maximum y value of the 3d object
Object3D
 InheritedmaxZ : Number
[read-only] Returns the maximum z value of the 3d object
Object3D
 InheritedminX : Number
[read-only] Returns the minimum x value of the 3d object
Object3D
 InheritedminY : Number
[read-only] Returns the minimum y value of the 3d object
Object3D
 InheritedminZ : Number
[read-only] Returns the minimum z value of the 3d object
Object3D
 InheritedmouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
Object3D
 Inheritedname : String
An optional name string for the 3d object.
Object3D
 InheritedobjectDepth : Number
[read-only] Boundary depth of the 3d object return The depth of the mesh
Object3D
 InheritedobjectHeight : Number
[read-only] Boundary height of the 3d object return The height of the mesh
Object3D
 InheritedobjectWidth : Number
[read-only] Boundary width of the 3d object return The width of the object
Object3D
 InheritedownCanvas : Boolean
Defines whether the contents of the 3d object are rendered using it's own render session
Object3D
 InheritedownSession : AbstractSession
Defines a unique render session for the 3d object.
Object3D
 Inheritedparent : ObjectContainer3D
Defines the parent of the 3d object.
Object3D
 InheritedpivotPoint : Vector3D
Defines the local point around which the object rotates.
Object3D
 InheritedpivotZero : Boolean
[read-only]
Object3D
 Inheritedposition : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedpushback : Boolean
Elements use their furthest point from the camera when z-sorting
Object3D
 Inheritedpushfront : Boolean
Elements use their nearest point to the camera when z-sorting
Object3D
 Inheritedrenderer : Renderer
An optional renderer object that can be used to render the contents of the object.
Object3D
 InheritedrotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedscaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
Object3D
 InheritedscaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
Object3D
 InheritedscaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
Object3D
 Inheritedscene : Scene3D
[read-only] Returns the parent scene of the 3d object
Object3D
 InheritedscenePivotPoint : Vector3D
[read-only]
Object3D
 InheritedscenePosition : Vector3D
[read-only] Returns the position of the 3d object, relative to the global coordinates of the Scene3D object.
Object3D
 InheritedsceneTransform : Matrix3D
[read-only] Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D object.
Object3D
 InheritedscreenXOffset : Number
Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true
Object3D
 InheritedscreenYOffset : Number
Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true
Object3D
 InheritedscreenZOffset : Number
Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true
Object3D
 Inheritedsession : AbstractSession
[read-only] The render session used by the 3d object
Object3D
 Inheritedtransform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheriteduseHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
Object3D
  view : View3D
Camera3D
  viewMatrix : Matrix3D
[read-only] Returns the transformation matrix used to resolve the scene to the view.
Camera3D
 Inheritedvisible : Boolean
Defines whether the 3d object is visible in the scene
Object3D
 Inheritedx : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedy : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedz : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
  zoom : Number
Provides an overall scale value to the view
Camera3D
Protected Properties
 PropertyDefined By
 Inheritedini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
Object3D
 Inherited_pivotPoint : Vector3D
Object3D
Public Methods
 MethodDefined By
  
Camera3D(init:Object = null)
Creates a new Camera3D object.
Camera3D
  
addOnCameraUpdate(listener:Function):void
Default method for adding a cameraUpdated event listener
Camera3D
 Inherited
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
Object3D
 Inherited
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
Object3D
 Inherited
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
Object3D
 Inherited
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
Object3D
 Inherited
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
Object3D
 Inherited
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
Object3D
 Inherited
addOnPositionChange(listener:Function):void
Default method for adding a positionchanged event listener
Object3D
 Inherited
addOnRollOut(listener:Function):void
Default method for adding a rollOut3D event listener
Object3D
 Inherited
addOnRollOver(listener:Function):void
Default method for adding a rollOver3D event listener
Object3D
 Inherited
addOnScaleChange(listener:Function):void
Default method for adding a scalechanged event listener
Object3D
 Inherited
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
Object3D
 Inherited
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
Object3D
 Inherited
addOnSessionChange(listener:Function):void
Default method for adding a sessionchanged event listener
Object3D
 Inherited
addOnVisibilityUpdate(listener:Function):void
Default method for adding a visibilityUpdated event listener
Object3D
 Inherited
applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position to the object without altering the apperance of child objects
Object3D
 Inherited
Apply the local rotations to the object without altering the apperance of child objects
Object3D
 Inherited
Adjusts the pivot point of the object so that it lies at the center of it's geoemtry.
Object3D
  
clone(object:Object3D = null):Object3D
[override] Duplicates the camera's properties to another Camera3D object.
Camera3D
  
disableDof():void
Used in DofSprite3D
Camera3D
 Inherited
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
Object3D
  
enableDof():void
Used in DofSprite3D.
Camera3D
 Inherited
lookAt(target:Vector3D, upAxis:Vector3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inherited
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
Object3D
 Inherited
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
Object3D
 Inherited
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
Object3D
 Inherited
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
Object3D
 Inherited
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates.
Object3D
 Inherited
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Object3D
 Inherited
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
Object3D
 Inherited
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
Object3D
  
pan(angle:Number):void
Rotates the camera in its horizontal plane.
Camera3D
 Inherited
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
Object3D
  
removeOnCameraUpdate(listener:Function):void
Default method for removing a cameraUpdated event listener
Camera3D
 Inherited
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
Object3D
 Inherited
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
Object3D
 Inherited
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
Object3D
 Inherited
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
Object3D
 Inherited
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
Object3D
 Inherited
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
Object3D
 Inherited
removeOnPositionChange(listener:Function):void
Default method for removing a positionchanged event listener
Object3D
 Inherited
removeOnRollOut(listener:Function):void
Default method for removing a rollOut3D event listener
Object3D
 Inherited
removeOnRollOver(listener:Function):void
Default method for removing a rollOver3D event listener
Object3D
 Inherited
removeOnScaleChange(listener:Function):void
Default method for removing a scalechanged event listener
Object3D
 Inherited
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
Object3D
 Inherited
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
Object3D
 Inherited
removeOnSessionChange(listener:Function):void
Default method for removing a sessionchanged event listener
Object3D
 Inherited
removeOnVisibilityUpdate(listener:Function):void
Default method for removing a visibilityUpdated event listener
Object3D
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Vector3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
Object3D
 Inherited
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
Object3D
 Inherited
scale(scale:Number):void
Scales the contents of the 3d object.
Object3D
  
screen(object:Object3D, vertex:Vertex = null):ScreenVertex
Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object.
Camera3D
 Inherited
tick(time:int):void
Called by the TickTraverser.
Object3D
  
tilt(angle:Number):void
Rotates the camera in its vertical plane.
Camera3D
 Inherited
toString():String
[override] Used to trace the values of a 3d object.
Object3D
 Inherited
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
 Inherited
traverse(traverser:Traverser):void
Used when traversing the scenegraph
Object3D
  
unproject(mX:Number, mY:Number):Vector3D
Camera3D
  
update():void
Updates the transformation matrix used to resolve the scene to the view.
Camera3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined By
 Inherited
Object3D
 Inherited
Object3D
Events
 Event Summary Defined By
  Dispatched when the focus or zoom properties of a camera update.Camera3D
 InheritedDispatched when the contents of the 3d object updates.Object3D
 InheritedDispatched when the bounding dimensions of the 3d object changes.Object3D
 InheritedDispatched when a user presses the left hand mouse button while the cursor is over the 3d object.Object3D
 InheritedDispatched when a user moves the cursor while it is over the 3d object.Object3D
 InheritedDispatched when a user moves the cursor away from the 3d object.Object3D
 InheritedDispatched when a user moves the cursor over the 3d object.Object3D
 InheritedDispatched when a user releases the left hand mouse button while the cursor is over the 3d object.Object3D
 InheritedDispatched when a user rolls out of the 3d object.Object3D
 InheritedDispatched when a user rolls over the 3d object.Object3D
 InheritedDispatched when the parent scene of the 3d object changes.Object3D
 InheritedDispatched when the scene transform matrix of the 3d object changes.Object3D
 InheritedDispatched when the render session property of the 3d object changes.Object3D
 InheritedDispatched when the local transform matrix of the 3d object changes.Object3D
Protected Constants
 ConstantDefined By
  toDEGREES : Number = 57.29577951308232
Camera3D
  toRADIANS : Number = 0.017453292519943295
Camera3D
Property Detail
apertureproperty
aperture:Number

Used in DofSprite3D.


Implementation
    public function get aperture():Number
    public function set aperture(value:Number):void

See also

away3d.sprites.DofSprite3D
dofproperty 
dof:Boolean

Used in DofSprite3D.


Implementation
    public function get dof():Boolean
    public function set dof(value:Boolean):void

See also

away3d.sprites.DofSprite3D
doflevelsproperty 
public var doflevels:Number = 16

Used in DofSprite3D.

See also

away3d.sprites.DofSprite3D
fixedZoomproperty 
public var fixedZoom:Boolean

focusproperty 
focus:Number

A divisor value for the perspective depth of the view.


Implementation
    public function get focus():Number
    public function set focus(value:Number):void
fovproperty 
fov:Number

Defines the field of view of the camera in a vertical direction.


Implementation
    public function get fov():Number
    public function set fov(value:Number):void
invViewMatrixproperty 
public var invViewMatrix:Matrix3D

lensproperty 
lens:AbstractLens

Defines a lens object used in vertex projection


Implementation
    public function get lens():AbstractLens
    public function set lens(value:AbstractLens):void
maxblurproperty 
public var maxblur:Number = 150

Used in DofSprite3D.

See also

away3d.sprites.DofSprite3D
viewproperty 
view:View3D


Implementation
    public function get view():View3D
    public function set view(value:View3D):void
viewMatrixproperty 
viewMatrix:Matrix3D  [read-only]

Returns the transformation matrix used to resolve the scene to the view. Used in the ProjectionTraverser class


Implementation
    public function get viewMatrix():Matrix3D

See also

zoomproperty 
zoom:Number

Provides an overall scale value to the view


Implementation
    public function get zoom():Number
    public function set zoom(value:Number):void
Constructor Detail
Camera3D()Constructor
public function Camera3D(init:Object = null)

Creates a new Camera3D object.

Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
####INIT####
Method Detail
addOnCameraUpdate()method
public function addOnCameraUpdate(listener:Function):void

Default method for adding a cameraUpdated event listener

Parameters

listener:Function — The listener function

clone()method 
override public function clone(object:Object3D = null):Object3D

Duplicates the camera's properties to another Camera3D object.

Parameters

object:Object3D (default = null) — [optional] The new object instance into which all properties are copied.

Returns
Object3D — The new object instance with duplicated properties applied.
disableDof()method 
public function disableDof():void

Used in DofSprite3D

See also

away3d.sprites.DofSprite3D
enableDof()method 
public function enableDof():void

Used in DofSprite3D.

See also

away3d.sprites.DofSprite3D
pan()method 
public function pan(angle:Number):void

Rotates the camera in its horizontal plane. Panning the camera results in a motion similar to someone shaking their head "no".

Parameters

angle:Number — Angle to pan the camera.

removeOnCameraUpdate()method 
public function removeOnCameraUpdate(listener:Function):void

Default method for removing a cameraUpdated event listener

Parameters

listener:Function — The listener function

screen()method 
public function screen(object:Object3D, vertex:Vertex = null):ScreenVertex

Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object.

Parameters

object:Object3D — The local object for the Vertex. If none exists, use the Scene3D object.
 
vertex:Vertex (default = null) — The vertex to be resolved.

Returns
ScreenVertex

See also

tilt()method 
public function tilt(angle:Number):void

Rotates the camera in its vertical plane. Tilting the camera results in a motion similar to someone nodding their head "yes".

Parameters

angle:Number — Angle to tilt the camera.

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

Parameters

mX:Number
 
mY:Number

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

Updates the transformation matrix used to resolve the scene to the view. Used in the BasicRender class

See also

away3d.core.render.BasicRender
Event Detail
cameraUpdated Event
Event Object Type: away3d.events.CameraEvent
CameraEvent.type property = away3d.events.CameraEvent

Dispatched when the focus or zoom properties of a camera update.

See also

Constant Detail
toDEGREESConstant
protected const toDEGREES:Number = 57.29577951308232

toRADIANSConstant 
protected const toRADIANS:Number = 0.017453292519943295