Package | away3d.cameras |
Class | public class Camera3D |
Inheritance | Camera3D Object3D flash.events.EventDispatcher |
Subclasses | SpringCam, TargetCamera3D |
See also
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 [read-only]
Returns the bounding radius of the 3d object
| 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 [read-only] | Object3D | ||
debugBoundingSphere : WireSphere [read-only] | 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 : Vector3D
Defines the rotation of the 3d object as a Vector3D 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 [read-only] | Object3D | ||
inverseSceneTransform : Matrix3D
Returns the inverse of sceneTransform. | Object3D | ||
invViewMatrix : Matrix3D | Camera3D | ||
lens : AbstractLens
Defines a lens object used in vertex projection
| Camera3D | ||
materialLibrary : MaterialLibrary
Reference container for all materials used in the container. | Object3D | ||
maxblur : Number = 150
Used in DofSprite3D. | Camera3D | ||
maxX : Number [read-only]
Returns the maximum x value of the 3d object
| Object3D | ||
maxY : Number [read-only]
Returns the maximum y value of the 3d object
| Object3D | ||
maxZ : Number [read-only]
Returns the maximum z value of the 3d object
| Object3D | ||
minX : Number [read-only]
Returns the minimum x value of the 3d object
| Object3D | ||
minY : Number [read-only]
Returns the minimum y value of the 3d object
| Object3D | ||
minZ : Number [read-only]
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 [read-only]
Boundary depth of the 3d object
return The depth of the mesh
| Object3D | ||
objectHeight : Number [read-only]
Boundary height of the 3d object
return The height of the mesh
| Object3D | ||
objectWidth : Number [read-only]
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 | ||
ownSession : AbstractSession
Defines a unique render session for the 3d object. | Object3D | ||
parent : ObjectContainer3D
Defines the parent of the 3d object. | Object3D | ||
pivotPoint : Vector3D
Defines the local point around which the object rotates. | Object3D | ||
pivotZero : Boolean [read-only] | Object3D | ||
position : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | 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 : Renderer
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 [read-only]
Returns the parent scene of the 3d object
| Object3D | ||
scenePivotPoint : Vector3D [read-only] | Object3D | ||
scenePosition : Vector3D [read-only]
Returns the position of the 3d object, relative to the global coordinates of the Scene3D object. | Object3D | ||
sceneTransform : Matrix3D [read-only]
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 : AbstractSession [read-only]
The render session used by the 3d object
| Object3D | ||
transform : Matrix3D
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 : Matrix3D [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 |
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 | ||
addOnPositionChange(listener:Function):void
Default method for adding a positionchanged 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 | ||
addOnScaleChange(listener:Function):void
Default method for adding a scalechanged 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 | ||
addOnVisibilityUpdate(listener:Function):void
Default method for adding a visibilityUpdated 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 | ||
[override]
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: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 | ||
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 | ||
removeOnPositionChange(listener:Function):void
Default method for removing a positionchanged 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 | ||
removeOnScaleChange(listener:Function):void
Default method for removing a scalechanged 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 | ||
removeOnVisibilityUpdate(listener:Function):void
Default method for removing a visibilityUpdated event listener
| Object3D | ||
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | ||
rotate(axis:Vector3D, 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 | ||
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 [override]
Used to trace the values of a 3d object. | Object3D | ||
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | ||
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 | ||
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the focus or zoom properties of a camera update. | Camera3D | |||
Dispatched when the contents of the 3d object updates. | Object3D | |||
Dispatched when the bounding dimensions of the 3d object changes. | Object3D | |||
Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object. | Object3D | |||
Dispatched when a user moves the cursor while it is over the 3d object. | Object3D | |||
Dispatched when a user moves the cursor away from the 3d object. | Object3D | |||
Dispatched when a user moves the cursor over the 3d object. | Object3D | |||
Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object. | Object3D | |||
Dispatched when a user rolls out of the 3d object. | Object3D | |||
Dispatched when a user rolls over the 3d object. | Object3D | |||
Dispatched when the parent scene of the 3d object changes. | Object3D | |||
Dispatched when the scene transform matrix of the 3d object changes. | Object3D | |||
Dispatched when the render session property of the 3d object changes. | Object3D | |||
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 |
aperture | property |
aperture:Number
Used in DofSprite3D
.
public function get aperture():Number
public function set aperture(value:Number):void
See also
dof | property |
dof:Boolean
Used in DofSprite3D
.
public function get dof():Boolean
public function set dof(value:Boolean):void
See also
doflevels | property |
public var doflevels:Number = 16
Used in DofSprite3D
.
See also
fixedZoom | property |
public var fixedZoom:Boolean
focus | property |
focus:Number
A divisor value for the perspective depth of the view.
public function get focus():Number
public function set focus(value:Number):void
fov | property |
fov:Number
Defines the field of view of the camera in a vertical direction.
public function get fov():Number
public function set fov(value:Number):void
invViewMatrix | property |
public var invViewMatrix:Matrix3D
lens | property |
lens:AbstractLens
Defines a lens object used in vertex projection
public function get lens():AbstractLens
public function set lens(value:AbstractLens):void
maxblur | property |
public var maxblur:Number = 150
Used in DofSprite3D
.
See also
view | property |
view:View3D
public function get view():View3D
public function set view(value:View3D):void
viewMatrix | property |
viewMatrix:Matrix3D
[read-only]
Returns the transformation matrix used to resolve the scene to the view.
Used in the ProjectionTraverser
class
public function get viewMatrix():Matrix3D
See also
zoom | property |
zoom:Number
Provides an overall scale value to the view
public function get zoom():Number
public function set zoom(value:Number):void
Camera3D | () | Constructor |
public function Camera3D(init:Object = null)
Creates a new Camera3D
object.
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties.
|
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.
|
Object3D — The new object instance with duplicated properties applied.
|
disableDof | () | method |
public function disableDof():void
Used in DofSprite3D
See also
enableDof | () | method |
public function enableDof():void
Used in DofSprite3D
.
See also
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.
|
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 |
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
cameraUpdated | Event |
away3d.events.CameraEvent
away3d.events.CameraEvent
Dispatched when the focus or zoom properties of a camera update.
See also
toDEGREES | Constant |
protected const toDEGREES:Number = 57.29577951308232
toRADIANS | Constant |
protected const toRADIANS:Number = 0.017453292519943295