org.papervision3d.core.proto.CameraObject3D

Public Properties

	Property		Defined by
		alpha : Number = 1	DisplayObject3D
		autoCalcScreenCoords : Boolean	DisplayObject3D
		blendMode : String = "normal"	DisplayObject3D
		children : Object Returns the children object.	DisplayObjectContainer3D
		container : ViewportLayer	DisplayObject3D
		culled : Boolean [internal use] Is this object culled by camera frustum?	DisplayObject3D
		culler : IObjectCuller	CameraObject3D
		cullTest : Number = 0	DisplayObject3D
		DEFAULT_POS : Number3D [static] The default position for new cameras.	CameraObject3D
		DEFAULT_UP : Number3D [static] The default UP vector for new cameras.	CameraObject3D
		DEFAULT_VIEWPORT : Rectangle [static] The default viewport for new cameras.	CameraObject3D
		extra : Object An object that contains user defined properties.	DisplayObject3D
		eye : Matrix3D	CameraObject3D
		faceLevelMode : Boolean [static] This allows objects faces to have their own containers.	DisplayObject3D
		faces : Array [internal-use]	DisplayObject3D
		far : Number Gets the distance to the far plane.	CameraObject3D
		filters : Array	DisplayObject3D
		flipLightDirection : Boolean = false	DisplayObject3D
		focus : 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
		fov : Number Gets the vertical Field Of View in degrees.	CameraObject3D
		frustumTestMethod : int = 0	DisplayObject3D
		geometry : GeometryObject3D The GeometryObject3D object that contains the 3D definition of this instance.	DisplayObject3D
		id : int [read-only] Unique id of this instance.	DisplayObject3D
		localRotationX : Number	DisplayObject3D
		localRotationY : Number	DisplayObject3D
		localRotationZ : Number	DisplayObject3D
		material : MaterialObject3D	DisplayObject3D
		materials : MaterialsList The list of materials for this instance.	DisplayObject3D
		meshSort : uint = 1 tells Mesh3D's render() method to compare the measurement choice of the user for a triangle's sorting	DisplayObject3D
		name : String An optional object name.	DisplayObject3D
		near : Number Gets the distance to the near plane (note that this simply is an alias for #focus).	CameraObject3D
		numChildren : int Returns the number of children of this object.	DisplayObjectContainer3D
		ortho : Boolean Whether the camera uses orthographic projection.	CameraObject3D
		orthoScale : Number The scale of projection when in orthographic mode.	CameraObject3D
		parent : DisplayObjectContainer3D [read-only] Indicates the DisplayObjectContainer3D object that contains this display object.	DisplayObject3D
		parentContainer : DisplayObject3D	DisplayObject3D
		position : Number3D A Number3D containing the current x, y, and z of the DisplayObject3D	DisplayObject3D
		root : DisplayObjectContainer3D [read-only] [read-only] The scene, which is the top-most displayObjectContainer3D in the tree structure.	DisplayObjectContainer3D
		rotationX : Number Specifies the rotation around the X axis from its original orientation.	DisplayObject3D
		rotationY : Number Specifies the rotation around the Y axis from its original orientation.	DisplayObject3D
		rotationZ : Number Specifies the rotation around the Z axis from its original orientation.	DisplayObject3D
		scale : Number Sets the 3D scale as applied from the registration point of the object.	DisplayObject3D
		scaleX : Number Sets the scale along the local X axis as applied from the registration point of the object.	DisplayObject3D
		scaleY : Number Sets the scale along the local Y axis as applied from the registration point of the object.	DisplayObject3D
		scaleZ : Number Sets the scale along the local Z axis as applied from the registration point of the object.	DisplayObject3D
		scene : SceneObject3D	DisplayObject3D
		sceneX : Number The X coordinate of a object relative to the scene coordinate system.	DisplayObject3D
		sceneY : Number The Y coordinate of a object relative to the scene coordinate system.	DisplayObject3D
		sceneZ : Number The Z coordinate of a object relative to the scene coordinate system.	DisplayObject3D
		screen : Number3D [read-only] The coordinate of the object on screen.	DisplayObject3D
		screenZ : Number [internal-use] The average depth of the object faces center.	DisplayObject3D
		sort : Boolean A Boolean value that determines whether the 3D objects are z-depth sorted between themselves when rendering.	CameraObject3D
		sortedArray : Array [static]	DisplayObject3D
		target : DisplayObject3D Gets the target for this camera, if any.	CameraObject3D
		testQuad : Boolean = true	DisplayObject3D
		transform : Matrix3D A Matrix3D object containing values that affect the scaling, rotation, and translation of the display object.	DisplayObject3D
		useClipping : Boolean = true	DisplayObject3D
		useCulling : Boolean Whether this camera uses culling.	CameraObject3D
		useOwnContainer : Boolean	DisplayObject3D
		useProjectionMatrix : Boolean Whether this camera uses a projection matrix.	CameraObject3D
		userData : UserData	DisplayObject3D
		view : Matrix3D [internal-use] A camera transformed Matrix3D object.	DisplayObject3D
		viewport : Rectangle	CameraObject3D
		visible : Boolean Whether or not the display object is visible.	DisplayObject3D
		world : Matrix3D World transformation.	DisplayObject3D
		x : Number An Number that sets the X coordinate of a object relative to the origin of its parent.	DisplayObject3D
		y : Number An Number that sets the Y coordinate of a object relative to the origin of its parent.	DisplayObject3D
		yUP : Boolean	CameraObject3D
		z : Number An Number that sets the Z coordinate of a object relative to the origin of its parent.	DisplayObject3D
		ZERO : DisplayObject3D [static] Returns an empty DiplayObject3D object positioned in the center of the 3D coordinate system (0, 0 ,0).	DisplayObject3D
		zoom : Number This value specifies the scale at which the 3D objects are rendered.	CameraObject3D

	Property	Defined by
		_children : Dictionary [internal-use] Names indexed by children.	DisplayObjectContainer3D
		_childrenByName : Object [internal-use] Children indexed by name.	DisplayObjectContainer3D
		_far : Number	CameraObject3D
		_ortho : Boolean	CameraObject3D
		_orthoScale : Number = 1	CameraObject3D
		_orthoScaleMatrix : Matrix3D	CameraObject3D
		_scene : SceneObject3D = null The scene where the object belongs.	DisplayObject3D
		_sorted : Array	DisplayObject3D
		_target : DisplayObject3D	CameraObject3D
		_transformDirty : Boolean = false [internal-use]	DisplayObject3D
		_useCulling : Boolean	CameraObject3D
		_useOwnContainer : Boolean = false	DisplayObject3D
		_useProjectionMatrix : Boolean	CameraObject3D
		_userData : UserData	DisplayObject3D

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		CameraObject3D(focus:Number = 500, zoom:Number = 3) The CameraObject3D constructor lets you create cameras for setting up the view from which a scene will be rendered.	CameraObject3D
		addChild(child:DisplayObject3D, name:String = null):DisplayObject3D Adds a child DisplayObject3D instance to this DisplayObjectContainer instance.	DisplayObject3D
		addChildren(parent:DisplayObject3D):DisplayObjectContainer3D Adds all the children of a DisplayObject3D instance to this DisplayObjectContainer instance.	DisplayObjectContainer3D
		addChildrenToLayer(do3d:DisplayObject3D, layer:ViewportLayer):void	DisplayObject3D
		addGeometry(geometry:GeometryObject3D = null):void Adds a geometry definition to the instance.	DisplayObject3D
		calculateScreenCoords(camera:CameraObject3D):void	DisplayObject3D
		childrenList():String Returns a string value with the list of objects.	DisplayObjectContainer3D
		clone():DisplayObject3D Clones this object.	DisplayObject3D
		copyPosition(reference:*):void Copies the position information (x, y and z coordinates) from another object or Matrix3D.	DisplayObject3D
		copyTransform(reference:*):void Copies the transformation information (position, rotation and scale) from another object or Matrix3D.	DisplayObject3D
		createViewportLayer(viewport:Viewport3D, recurse:Boolean = true):ViewportLayer	DisplayObject3D
		distanceTo(obj:DisplayObject3D):Number Gets the distance to the position of the given object.	DisplayObject3D
		getChildByName(name:String, recursive:Boolean = false):DisplayObject3D Returns the child display object that exists with the specified name.	DisplayObjectContainer3D
		getMaterialByName(name:String):MaterialObject3D Returns the material that exists with the specified name in the materials list.	DisplayObject3D
		hitTestObject(obj:DisplayObject3D, multiplier:Number = 1):Boolean Evaluates the display object to see if it overlaps or intersects with the obj display object.	DisplayObject3D
		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
		lookAt(targetObject:DisplayObject3D, upAxis:Number3D = null):void Lookat.	CameraObject3D
		materialsList():String Returns a string value with the list of material names of the materials list.	DisplayObject3D
		moveBackward(distance:Number):void Translate the display object in the opposite direction it is facing, i.e.	DisplayObject3D
		moveDown(distance:Number):void Translate the display object downwards, with respect to the direction it is facing, i.e.	DisplayObject3D
		moveForward(distance:Number):void Translate the display object in the direction it is facing, i.e.	DisplayObject3D
		moveLeft(distance:Number):void Translate the display object lateraly, to the left of the direction it is facing, i.e.	DisplayObject3D
		moveRight(distance:Number):void Translate the display object lateraly, to the right of the direction it is facing, i.e.	DisplayObject3D
		moveUp(distance:Number):void Translate the display object upwards, with respect to the direction it is facing, i.e.	DisplayObject3D
		orbit(pitch:Number, yaw:Number, useDegrees:Boolean = true, target:DisplayObject3D = null):void Orbits the camera around the specified target.	CameraObject3D
		pan(angle:Number):void Rotate the camera in its horizontal plane.	CameraObject3D
		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
		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
		projectFaces(faces:Array, object:DisplayObject3D, renderSessionData:RenderSessionData):Number	CameraObject3D
		projectVertices(vertices:Array, object:DisplayObject3D, renderSessionData:RenderSessionData):Number Projects vertices.	CameraObject3D
		removeChild(child:DisplayObject3D):DisplayObject3D Removes the specified child DisplayObject3D instance from the child list of the DisplayObjectContainer3D instance.	DisplayObjectContainer3D
		removeChildByName(name:String):DisplayObject3D Removes the child DisplayObject3D instance that exists with the specified name, from the child list of the DisplayObjectContainer3D instance.	DisplayObjectContainer3D
		replaceMaterialByName(material:MaterialObject3D, name:String):void Replaces a material by its name.	DisplayObject3D
		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
		setChildMaterial(child:DisplayObject3D, material:MaterialObject3D, existingMaterial:MaterialObject3D = null):void Sets the material for a child DisplayObject3D.	DisplayObject3D
		setChildMaterialByName(childName:String, material:MaterialObject3D):void Sets the material for a child DisplayObject3D by the child's name.	DisplayObject3D
		tilt(angle:Number):void Rotate the camera in its vertical plane.	CameraObject3D
		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.	CameraObject3D
		translate(distance:Number, axis:Number3D):void Move the object along a given direction.	DisplayObject3D
		unproject(mX:Number, mY:Number):Number3D Unproject.	CameraObject3D
		updateTransform():void [internal-use] Updates the transform Matrix3D with the current rotation and scale values.	DisplayObject3D
		yaw(angle:Number):void Rotate the display object around about the vertical axis —an axis drawn from top to bottom.	DisplayObject3D

	Method	Defined by
		setParentContainer(parent:DisplayObject3D, assign:Boolean = true):void	DisplayObject3D

	Constant	Defined by
		MESH_SORT_CENTER : uint = 1 [static] tells Mesh3D's render() method to sort by measuring from the center of a triangle	DisplayObject3D
		MESH_SORT_CLOSE : uint = 3 [static] tells Mesh3D's render() method to sort by measuring from the closest point of a triangle	DisplayObject3D
		MESH_SORT_FAR : uint = 2 [static] tells Mesh3D's render() method to sort by measuring from the farthest point of a triangle	DisplayObject3D

Property detail

culler

property

public var culler:IObjectCuller

DEFAULT_POS

property

public static var DEFAULT_POS:Number3D

The default position for new cameras.

DEFAULT_UP

property

public static var DEFAULT_UP:Number3D

The default UP vector for new cameras.

DEFAULT_VIEWPORT

property

public static var DEFAULT_VIEWPORT:Rectangle

The default viewport for new cameras.

eye

property

public var eye:Matrix3D

_far

property

protected var _far:Number

far

property

far:Number [read-write]

Gets the distance to the far plane.

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

focus

property

public var focus: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. Use it in conjunction with zoom.

Higher focus values tend to magnify distance between objects while allowing greater depth of field, as if the camera had a wider lenses. One result of using a wide angle lens in proximity to the subject is an apparent perspective distortion: parallel lines may appear to converge and with a fisheye lens, straight edges will appear to bend.

Different lenses generally require a different camera to subject distance to preserve the size of a subject. Changing the angle of view can indirectly distort perspective, modifying the apparent relative size of the subject and foreground.

fov

property

fov:Number [read-write]

Gets the vertical Field Of View in degrees.

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

near

property

near:Number [read-write]

Gets the distance to the near plane (note that this simply is an alias for #focus).

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

_ortho

property

protected var _ortho:Boolean

ortho

property

ortho:Boolean [read-write]

Whether the camera uses orthographic projection.

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

_orthoScale

property

protected var _orthoScale:Number = 1

orthoScale

property

orthoScale:Number [read-write]

The scale of projection when in orthographic mode.

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

_orthoScaleMatrix

property

protected var _orthoScaleMatrix:Matrix3D

sort

property

public var sort:Boolean

A Boolean value that determines whether the 3D objects are z-depth sorted between themselves when rendering.

_target

property

protected var _target:DisplayObject3D

target

property

target:DisplayObject3D [read-write]

Gets the target for this camera, if any.

Implementation
public function get target():DisplayObject3D
public function set target(value:DisplayObject3D):void

_useCulling

property

protected var _useCulling:Boolean

useCulling

property

useCulling:Boolean [read-write]

Whether this camera uses culling.

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

_useProjectionMatrix

property

protected var _useProjectionMatrix:Boolean

useProjectionMatrix

property

useProjectionMatrix:Boolean [read-write]

Whether this camera uses a projection matrix.

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

viewport

property

public var viewport:Rectangle

yUP

property

public var yUP:Boolean

zoom

property

public var zoom:Number

This value specifies the scale at which the 3D objects are rendered. Higher values magnify the scene, compressing distance. Use it in conjunction with focus.

Constructor detail

CameraObject3D

()

constructor

public function CameraObject3D(focus:Number = 500, zoom:Number = 3)

The CameraObject3D constructor lets you create cameras for setting up the view from which a scene will be rendered.

Parameters

	`focus:Number` (default = `500`) — 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. Use it in conjunction with zoom.

	`zoom:Number` (default = `3`) — This value specifies the scale at which the 3D objects are rendered. Higher values magnify the scene, compressing distance. Use it in conjunction with focus.

Method detail

lookAt

()

method

public override function lookAt(targetObject:DisplayObject3D, upAxis:Number3D = null):void

Lookat.

Parameters

	`targetObject:DisplayObject3D`

	`upAxis:Number3D` (default = `null`)

orbit

()

method

public function orbit(pitch:Number, yaw:Number, useDegrees:Boolean = true, target:DisplayObject3D = null):void

Orbits the camera around the specified target. If no target is specified the camera's #target property is used. If this camera's #target property equals null the camera orbits the origin (0, 0, 0).

Parameters

	`pitch:Number` — Rotation around X=axis (looking up or down).

	`yaw:Number` — Rotation around Y-axis (looking left or right).

	`useDegrees:Boolean` (default = `true`) — Whether to use degrees for pitch and yaw (defaults to 'true').

	`target:DisplayObject3D` (default = `null`) — An optional target to orbit around.

pan

()

method

public function pan(angle:Number):void

Rotate 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.

projectFaces

()

method

public function projectFaces(faces:Array, object:DisplayObject3D, renderSessionData:RenderSessionData):NumberParameters

	`faces:Array`

	`object:DisplayObject3D`

	`renderSessionData:RenderSessionData`

Returns

Number

projectVertices

()

method

public function projectVertices(vertices:Array, object:DisplayObject3D, renderSessionData:RenderSessionData):Number

Projects vertices.

Parameters

	`vertices:Array`

	`object:DisplayObject3D`

	`renderSessionData:RenderSessionData`

Returns

Number

tilt

()

method

public function tilt(angle:Number):void

Rotate 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.

transformView

()

method

public function transformView(transform:Matrix3D = null):void

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

Parameters

transform:Matrix3D (default = null)

unproject

()

method

public function unproject(mX:Number, mY:Number):Number3D

Unproject.

Parameters

	`mX:Number`

	`mY:Number`

Returns

Number3D

http://blog.papervision3d.org

Papervision3D Official Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class CameraObject3D	Properties \| Methods \| Constants

Package	org.papervision3d.core.proto
Class	public class CameraObject3D
Inheritance	CameraObject3D DisplayObject3D DisplayObjectContainer3D flash.events.EventDispatcher
Subclasses	Camera3D