Packageorg.papervision3d.cameras
Classpublic class Camera3D
InheritanceCamera3D Inheritance CameraObject3D Inheritance DisplayObject3D Inheritance DisplayObjectContainer3D Inheritance flash.events.EventDispatcher

The Camera3D class creates a camera that views the area around a target object.

A camera defines the view from which a scene will be rendered. Different camera settings would present a scene from different points of view.

3D cameras simulate still-image, motion picture, or video cameras of the real world. When rendering, the scene is drawn as if you were looking through the camera lens.


Public Properties
 PropertyDefined by
 Inheritedchildren : Object
Returns the children object.
DisplayObjectContainer3D
 InheritedcontainerBlendMode : int
DisplayObject3D
 InheritedcontainerSortMode : int
DisplayObject3D
 Inheritedculled : Boolean
[internal use] Is this object culled by camera frustum?
DisplayObject3D
 InheritedDEFAULT_POS : Number3D
[static] The default position for new cameras.
CameraObject3D
 Inheritedextra : Object
An object that contains user defined properties.
DisplayObject3D
 Inheritedeye : Matrix3D
CameraObject3D
 InheritedfaceLevelMode : Boolean
[static] This allows objects faces to have their own containers.
DisplayObject3D
 Inheritedfaces : Array
[internal-use]
DisplayObject3D
 Inheritedfilters : Array
DisplayObject3D
 Inheritedfocus : Number
This value is a positive number representing the distance of the observer from the front clipping plane, which is the closest any object can be to the camera.
CameraObject3D
 Inheritedgeometry : GeometryObject3D
The GeometryObject3D object that contains the 3D definition of this instance.
DisplayObject3D
  goto : Number3D
A Number3D object that specifies the desired position of the camera in 3D space.
Camera3D
 Inheritedid : int
[read-only] Unique id of this instance.
DisplayObject3D
 Inheritedmaterial : MaterialObject3D
DisplayObject3D
 Inheritedmaterials : MaterialsList
The list of materials for this instance.
DisplayObject3D
 InheritedmeshSort : uint = 1
tells Mesh3D's render() method to compare the measurement choice of the user for a triangle's sorting
DisplayObject3D
 Inheritedname : String
An optional object name.
DisplayObject3D
 InheritednumChildren : int
Returns the number of children of this object.
DisplayObjectContainer3D
 Inheritedparent : DisplayObjectContainer3D
[read-only] Indicates the DisplayObjectContainer3D object that contains this display object.
DisplayObject3D
 Inheritedroot : DisplayObjectContainer3D
[read-only] [read-only] The scene, which is the top-most displayObjectContainer3D in the tree structure.
DisplayObjectContainer3D
 InheritedrotationX : Number
Specifies the rotation around the X axis from its original orientation.
DisplayObject3D
 InheritedrotationY : Number
Specifies the rotation around the Y axis from its original orientation.
DisplayObject3D
 InheritedrotationZ : Number
Specifies the rotation around the Z axis from its original orientation.
DisplayObject3D
 Inheritedscale : Number
Sets the 3D scale as applied from the registration point of the object.
DisplayObject3D
 InheritedscaleX : Number
Sets the scale along the local X axis as applied from the registration point of the object.
DisplayObject3D
 InheritedscaleY : Number
Sets the scale along the local Y axis as applied from the registration point of the object.
DisplayObject3D
 InheritedscaleZ : Number
Sets the scale along the local Z axis as applied from the registration point of the object.
DisplayObject3D
 Inheritedscene : SceneObject3D
DisplayObject3D
 InheritedsceneX : Number
The X coordinate of a object relative to the scene coordinate system.
DisplayObject3D
 InheritedsceneY : Number
The Y coordinate of a object relative to the scene coordinate system.
DisplayObject3D
 InheritedsceneZ : Number
The Z coordinate of a object relative to the scene coordinate system.
DisplayObject3D
 Inheritedscreen : Number3D
[read-only] The coordinate of the object on screen.
DisplayObject3D
 InheritedscreenZ : Number
[internal-use] The average depth of the object faces center.
DisplayObject3D
 Inheritedsort : Boolean
A Boolean value that determines whether the 3D objects are z-depth sorted between themselves when rendering.
CameraObject3D
 InheritedsortedArray : Array
[static]
DisplayObject3D
  target : DisplayObject3D
A DisplayObject3D object that specifies the current position the camera is looking at.
Camera3D
 Inheritedtransform : Matrix3D
A Matrix3D object containing values that affect the scaling, rotation, and translation of the display object.
DisplayObject3D
 InheriteduseOwnContainer : Boolean
DisplayObject3D
 Inheritedview : Matrix3D
[internal-use] A camera transformed Matrix3D object.
DisplayObject3D
 Inheritedviewport : Rectangle
CameraObject3D
 Inheritedvisible : Boolean
Whether or not the display object is visible.
DisplayObject3D
 Inheritedworld : Matrix3D
World transformation.
DisplayObject3D
 Inheritedx : Number
An Number that sets the X coordinate of a object relative to the origin of its parent.
DisplayObject3D
 Inheritedy : Number
An Number that sets the Y coordinate of a object relative to the origin of its parent.
DisplayObject3D
 Inheritedz : Number
An Number that sets the Z coordinate of a object relative to the origin of its parent.
DisplayObject3D
 InheritedZERO : DisplayObject3D
[static] Returns an empty DiplayObject3D object positioned in the center of the 3D coordinate system (0, 0 ,0).
DisplayObject3D
 Inheritedzoom : Number
This value specifies the scale at which the 3D objects are rendered.
CameraObject3D
Protected Properties
 PropertyDefined by
 Inherited_children : Dictionary
[internal-use] Names indexed by children.
DisplayObjectContainer3D
 Inherited_childrenByName : Object
[internal-use] Children indexed by name.
DisplayObjectContainer3D
 Inherited_containerBlendMode : int
DisplayObject3D
 Inherited_containerSortMode : int
DisplayObject3D
 Inherited_filters : Array
DisplayObject3D
 Inherited_scene : SceneObject3D = null
The scene where the object belongs.
DisplayObject3D
 Inherited_sorted : Array
DisplayObject3D
 Inherited_transformDirty : Boolean = false
[internal-use]
DisplayObject3D
 Inherited_useOwnContainer : Boolean
DisplayObject3D
Public Methods
 MethodDefined by
  
Camera3D(target:DisplayObject3D = null, zoom:Number = 2, focus:Number = 100, initObject:Object = null)
A Number3D object that specifies the desired rotation of the camera in 3D space.
Camera3D
 Inherited
addChild(child:DisplayObject3D, name:String = null):DisplayObject3D
Adds a child DisplayObject3D instance to this DisplayObjectContainer instance.
DisplayObject3D
 Inherited
addChildren(parent:DisplayObject3D):DisplayObjectContainer3D
Adds all the children of a DisplayObject3D instance to this DisplayObjectContainer instance.
DisplayObjectContainer3D
 Inherited
addCollada(filename:String, materials:MaterialsList = null, scale:Number = 1):void
This method has been deprecated.
DisplayObjectContainer3D
 Inherited
addGeometry(geometry:GeometryObject3D = null):void
Adds a geometry definition to the instance.
DisplayObject3D
 Inherited
childrenList():String
Returns a string value with the list of objects.
DisplayObjectContainer3D
 Inherited
copyPosition(reference:*):void
Copies the position information (x, y and z coordinates) from another object or Matrix3D.
DisplayObject3D
 Inherited
copyTransform(reference:*):void
Copies the transformation information (position, rotation and scale) from another object or Matrix3D.
DisplayObject3D
 Inherited
distanceTo(obj:DisplayObject3D):Number
Gets the distance to the position of the given object.
DisplayObject3D
 Inherited
getChildByName(name:String):DisplayObject3D
Returns the child display object that exists with the specified name.
DisplayObjectContainer3D
 Inherited
getMaterialByName(name:String):MaterialObject3D
Returns the material that exists with the specified name in the materials list.
DisplayObject3D
 Inherited
hitTestObject(obj:DisplayObject3D, multiplier:Number = 1):Boolean
Evaluates the display object to see if it overlaps or intersects with the obj display object.
DisplayObject3D
 Inherited
hitTestPoint(x:Number, y:Number, z:Number):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x, y and z parameters.
DisplayObject3D
  
hover(type:Number, mouseX:Number, mouseY:Number):void
[experimental] Hovers the camera around as the user moves the mouse, without changing the distance to the target.
Camera3D
 Inherited
lookAt(targetObject:DisplayObject3D, upAxis:Number3D = null):void
Make the object look at a specific position.
DisplayObject3D
 Inherited
materialsList():String
Returns a string value with the list of material names of the materials list.
DisplayObject3D
 Inherited
moveBackward(distance:Number):void
Translate the display object in the opposite direction it is facing, i.e.
DisplayObject3D
 Inherited
moveDown(distance:Number):void
Translate the display object downwards, with respect to the direction it is facing, i.e.
DisplayObject3D
 Inherited
moveForward(distance:Number):void
Translate the display object in the direction it is facing, i.e.
DisplayObject3D
 Inherited
moveLeft(distance:Number):void
Translate the display object lateraly, to the left of the direction it is facing, i.e.
DisplayObject3D
 Inherited
moveRight(distance:Number):void
Translate the display object lateraly, to the right of the direction it is facing, i.e.
DisplayObject3D
 Inherited
moveUp(distance:Number):void
Translate the display object upwards, with respect to the direction it is facing, i.e.
DisplayObject3D
 Inherited
pan(angle:Number):void
Rotate the camera in its horizontal plane.
CameraObject3D
 Inherited
pitch(angle:Number):void
Rotate the display object around its lateral or transverse axis —an axis running from the pilot's left to right in piloted aircraft, and parallel to the wings of a winged aircraft; thus the nose pitches up and the tail down, or vice-versa.
DisplayObject3D
 Inherited
project(parent:DisplayObject3D, renderSessionData:RenderSessionData):Number
[internal-use] Projects three dimensional coordinates onto a two dimensional plane to simulate the relationship of the camera to subject.
DisplayObject3D
 Inherited
removeChild(child:DisplayObject3D):DisplayObject3D
Removes the specified child DisplayObject3D instance from the child list of the DisplayObjectContainer3D instance.
DisplayObjectContainer3D
 Inherited
removeChildByName(name:String):DisplayObject3D
Removes the child DisplayObject3D instance that exists with the specified name, from the child list of the DisplayObjectContainer3D instance.
DisplayObjectContainer3D
 Inherited
roll(angle:Number):void
Rotate the display object around the longitudinal axis —an axis drawn through the body of the vehicle from tail to nose in the normal direction of flight, or the direction the object is facing.
DisplayObject3D
 Inherited
tilt(angle:Number):void
Rotate the camera in its vertical plane.
CameraObject3D
 Inherited
toString():String
Returns a string value representing the three-dimensional position values of the display object instance.
DisplayObject3D
  
transformView(transform:Matrix3D = null):void
[internal-use] Transforms world coordinates into camera space.
Camera3D
 Inherited
translate(distance:Number, axis:Number3D):void
Move the object along a given direction.
DisplayObject3D
 Inherited
yaw(angle:Number):void
Rotate the display object around about the vertical axis —an axis drawn from top to bottom.
DisplayObject3D
Protected Methods
 MethodDefined by
 Inherited
updateTransform():void
[internal-use] Updates the transform Matrix3D with the current rotation and scale values.
DisplayObject3D
Public Constants
 ConstantDefined by
 InheritedMESH_SORT_CENTER : uint = 1
[static] tells Mesh3D's render() method to sort by measuring from the center of a triangle
DisplayObject3D
 InheritedMESH_SORT_CLOSE : uint = 3
[static] tells Mesh3D's render() method to sort by measuring from the closest point of a triangle
DisplayObject3D
 InheritedMESH_SORT_FAR : uint = 2
[static] tells Mesh3D's render() method to sort by measuring from the farthest point of a triangle
DisplayObject3D
  TYPE : String = "CAMERA3D"
[static]
Camera3D
Property detail
gotoproperty
public var goto:Number3D

A Number3D object that specifies the desired position of the camera in 3D space. Only used when calling update().

targetproperty 
public var target:DisplayObject3D

A DisplayObject3D object that specifies the current position the camera is looking at.

Constructor detail
Camera3D()constructor
public function Camera3D(target:DisplayObject3D = null, zoom:Number = 2, focus:Number = 100, initObject:Object = null)

A Number3D object that specifies the desired rotation of the camera in 3D space. Only used when calling update().

Parameters
target:DisplayObject3D (default = null)
 
zoom:Number (default = 2)
 
focus:Number (default = 100)
 
initObject:Object (default = null)
Method detail
hover()method
public function hover(type:Number, mouseX:Number, mouseY:Number):void

[experimental] Hovers the camera around as the user moves the mouse, without changing the distance to the target. This greatly enhances the 3D illusion.

Parameters
type:Number — Type of movement.
 
mouseX:Number — Indicates the x coordinate of the mouse position in relation to the canvas MovieClip.
 
mouseY:Number — Indicates the y coordinate of the mouse position in relation to the canvas MovieClip.
transformView()method 
public override function transformView(transform:Matrix3D = null):void

[internal-use] Transforms world coordinates into camera space.

Parameters
transform:Matrix3D (default = null)
Constant detail
TYPEconstant
public static const TYPE:String = "CAMERA3D"