away3d.cameras.Camera3D

Public Properties

	Property		Defined by
		alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
		animationLibrary : AnimationLibrary Reference container for all animations used in the container.	Object3D
		aperture : Number Used in `DofSprite3D`.	Camera3D
		blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
		boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
		center : Array	Object3D
		collider : Boolean Indicates whether this object is used for collision detection.	Object3D
		debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Object3D
		debugBoundingBox : WireCube	Object3D
		debugBoundingSphere : WireSphere	Object3D
		debugbs : 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
		eulers : Number3D Defines the rotation of the 3d object as a `Number3D` object containing euler angles for rotation around x, y and z axis.	Object3D
		extra : Object An optional untyped object that can contain used-defined properties	Object3D
		filters : 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
		geometryLibrary : GeometryLibrary Reference container for all geometries used in the container.	Object3D
		id : int	Object3D
		inverseSceneTransform : MatrixAway3D Returns the inverse of sceneTransform.	Object3D
		invViewMatrix : MatrixAway3D	Camera3D
		lens : AbstractLens Defines a lens object used in vertex projection	Camera3D
		lightarray : ILightConsumer returns the array of lights contained inside the container.	Object3D
		materialLibrary : MaterialLibrary Reference container for all materials used in the container.	Object3D
		maxblur : Number = 150 Used in `DofSprite3D`.	Camera3D
		maxX : Number Returns the maximum x value of the 3d object	Object3D
		maxY : Number Returns the maximum y value of the 3d object	Object3D
		maxZ : Number Returns the maximum z value of the 3d object	Object3D
		minX : Number Returns the minimum x value of the 3d object	Object3D
		minY : Number Returns the minimum y value of the 3d object	Object3D
		minZ : Number Returns the minimum z value of the 3d object	Object3D
		mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
		name : String An optional name string for the 3d object.	Object3D
		objectDepth : Number Boundary depth of the 3d object return The depth of the mesh	Object3D
		objectHeight : Number Boundary height of the 3d object return The height of the mesh	Object3D
		objectWidth : Number Boundary width of the 3d object return The width of the object	Object3D
		ownCanvas : Boolean Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
		ownLights : Boolean Defines whether the children of the container are rendered using it's own lights.	Object3D
		ownSession : AbstractRenderSession Defines a unique render session for the 3d object.	Object3D
		parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
		pivotPoint : Number3D Defines the local point around which the object rotates.	Object3D
		pivotZero : Boolean	Object3D
		position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		projectorType : String	Object3D
		pushback : Boolean Elements use their furthest point from the camera when z-sorting	Object3D
		pushfront : Boolean Elements use their nearest point to the camera when z-sorting	Object3D
		renderer : IPrimitiveConsumer An optional renderer object that can be used to render the contents of the object.	Object3D
		rotationX : 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
		rotationY : 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
		rotationZ : 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
		scaleX : Number Defines the scale of the 3d object along the x-axis, relative to local coordinates.	Object3D
		scaleY : Number Defines the scale of the 3d object along the y-axis, relative to local coordinates.	Object3D
		scaleZ : Number Defines the scale of the 3d object along the z-axis, relative to local coordinates.	Object3D
		scene : Scene3D Returns the parent scene of the 3d object	Object3D
		scenePivotPoint : Number3D	Object3D
		scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
		sceneTransform : MatrixAway3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
		screenXOffset : Number Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true	Object3D
		screenYOffset : Number Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true	Object3D
		screenZOffset : Number Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true	Object3D
		session : AbstractRenderSession The render session used by the 3d object	Object3D
		transform : MatrixAway3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
		view : View3D	Camera3D
		viewMatrix : MatrixAway3D [read-only] Returns the transformation matrix used to resolve the scene to the view.	Camera3D
		visible : Boolean Defines whether the 3d object is visible in the scene	Object3D
		x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		z : 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

	Property	Defined by
		ini : 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
		_pivotPoint : Number3D	Object3D

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		Camera3D (init:Object = null) Creates a new `Camera3D` object.	Camera3D
		addOnCameraUpdate(listener:Function):void Default method for adding a cameraUpdated event listener	Camera3D
		addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
		addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
		addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
		addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
		addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
		addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
		addOnParentUpdate(listener:Function):void Default method for adding a parentupdated event listener	Object3D
		addOnRollOut(listener:Function):void Default method for adding a rollOut3D event listener	Object3D
		addOnRollOver(listener:Function):void Default method for adding a rollOver3D event listener	Object3D
		addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
		addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
		addOnSessionChange(listener:Function):void Default method for adding a sessionchanged event listener	Object3D
		addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
		applyPosition(dx:Number, dy:Number, dz:Number):void Apply the given position to the object without altering the apperance of child objects	Object3D
		applyRotations():void Apply the local rotations to the object without altering the apperance of child objects	Object3D
		centerPivot():void Adjusts the pivot point of the object so that it lies at the center of it's geoemtry.	Object3D
		clone(object:Object3D = null):Object3D Duplicates the camera's properties to another `Camera3D` object.	Camera3D
		disableDof():void Used in `DofSprite3D`	Camera3D
		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
		lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
		moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
		moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
		moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
		movePivot(dx:Number, dy:Number, dz:Number):void Moves the local point around which the object rotates.	Object3D
		moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
		moveTo(dx:Number, dy:Number, dz:Number):void Moves the 3d object directly to a point in space	Object3D
		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
		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
		removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
		removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
		removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
		removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
		removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
		removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
		removeOnParentUpdate(listener:Function):void Default method for removing a parentupdated event listener	Object3D
		removeOnRollOut(listener:Function):void Default method for removing a rollOut3D event listener	Object3D
		removeOnRollOver(listener:Function):void Default method for removing a rollOver3D event listener	Object3D
		removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
		removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
		removeOnSessionChange(listener:Function):void Default method for removing a sessionchanged event listener	Object3D
		removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
		roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
		rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
		rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
		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
		tick(time:int):void Called by the `TickTraverser`.	Object3D
		tilt(angle:Number):void Rotates the camera in its vertical plane.	Camera3D
		toString():String Used to trace the values of a 3d object.	Object3D
		translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
		traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
		unproject(mX:Number, mY:Number):Number3D	Camera3D
		update():void Updates the transformation matrix used to resolve the scene to the view.	Camera3D
		updateObject():void	Object3D
		updateSession():void	Object3D
		yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

	Method	Defined by
		updateDimensions():void	Object3D
		updateTransform():void	Object3D

Summary	Defined by
cameraUpdated	Dispatched when the focus or zoom properties of a camera update.	Camera3D
dimensionsChanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
mouseDown	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	Object3D
mouseMove	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
mouseOut	Dispatched when a user moves the cursor away from the 3d object.	Object3D
mouseOver	Dispatched when a user moves the cursor over the 3d object.	Object3D
mouseUp	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	Object3D
rollOut	Dispatched when a user rolls out of the 3d object.	Object3D
rollOver	Dispatched when a user rolls over the 3d object.	Object3D
sceneChanged	Dispatched when the parent scene of the 3d object changes.	Object3D
scenetransformChanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
sessionChanged	Dispatched when the render session property of the 3d object changes.	Object3D
sessionUpdated	Dispatched when the render session property of the 3d object updates its contents.	Object3D
transformChanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

	Constant	Defined by
		toDEGREES : Number = 57.29577951308232	Camera3D
		toRADIANS : Number = 0.017453292519943295	Camera3D

Property detail

aperture

property

aperture:Number [read-write]

Used in DofSprite3D.

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

See also

away3d.sprites.DofSprite3D

dof

property

dof:Boolean [read-write]

Used in DofSprite3D.

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

See also

away3d.sprites.DofSprite3D

doflevels

property

public var doflevels:Number = 16

Used in DofSprite3D.

See also

away3d.sprites.DofSprite3D

fixedZoom

property

public var fixedZoom:Boolean

focus

property

focus:Number [read-write]

A divisor value for the perspective depth of the view.

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

fov

property

fov:Number [read-write]

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

invViewMatrix

property

public var invViewMatrix:MatrixAway3D

lens

property

lens:AbstractLens [read-write]

Defines a lens object used in vertex projection

Implementation
public function get lens():AbstractLens
public function set lens(value:AbstractLens):void

maxblur

property

public var maxblur:Number = 150

Used in DofSprite3D.

See also

away3d.sprites.DofSprite3D

view

property

view:View3D  [read-write]Implementation
    public function get view():View3D
    public function set view(value:View3D):void

viewMatrix

property

viewMatrix:MatrixAway3D [read-only]

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

Implementation
public function get viewMatrix():MatrixAway3D

zoom

property

zoom:Number [read-write]

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)Parameters

init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`fov:Number` (default = _fov)
	`focus:Number` (default = 100)
	`zoom:Number` (default = _zoom)
	`fixedZoom:Boolean` (default = true)
	`lens:Object` (default = AbstractLens)
	`aperture:Number` (default = 22)
	`maxblur:Number` (default = 150)
	`doflevels:Number` (default = 16)
	`dof:Boolean` (default = false)
	`lookat:Position`

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

public override 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

away3d.containers.Scene3D

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):Number3D Parameters

	`mX:Number`

	`mY:Number`

Returns

Number3D

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

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

See also

focus
zoom

Constant detail

toDEGREES

constant

protected const toDEGREES:Number = 57.29577951308232

toRADIANS

constant

protected const toRADIANS:Number = 0.017453292519943295

Wiki link

Click to go to the wiki page for 'away3d.cameras.Camera3D'

Code examples

Comments

Away3D FP10 V3.5.0 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Camera3D		Properties \| Methods \| Events \| Constants

Package	away3d.cameras
Class	public class Camera3D
Inheritance	Camera3D Object3D flash.events.EventDispatcher
Subclasses	SpringCam, TargetCamera3D