| Package | org.papervision3d.cameras |
| Class | public class FrustumCamera3D |
| Inheritance | FrustumCamera3D  CameraObject3D DisplayObject3D DisplayObjectContainer3D flash.events.EventDispatcher |
| Implements | IObjectCuller |
| Property | Defined by | ||
|---|---|---|---|
 | children : Object
Returns the children object.
| DisplayObjectContainer3D | |
| containerBlendMode : int | DisplayObject3D | |
| containerSortMode : int | DisplayObject3D | |
| culled : Boolean
[internal use] Is this object culled by camera frustum?
| DisplayObject3D | |
| DEFAULT_POS : Number3D
[static]
The default position 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 or sets the distance to far plane.
| FrustumCamera3D | ||
| filters : Array | 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 or sets the field of view in degrees.
| FrustumCamera3D | ||
| geometry : GeometryObject3D
The GeometryObject3D object that contains the 3D definition of this instance.
| DisplayObject3D | |
| id : int
[read-only] Unique id of this instance.
| 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 or sets the distance to near plane (positive number).
| FrustumCamera3D | ||
| numChildren : int
Returns the number of children of this object.
| DisplayObjectContainer3D | |
| parent : DisplayObjectContainer3D
[read-only] Indicates the DisplayObjectContainer3D object that contains this display object.
| DisplayObject3D | |
| planes : Array frustum planes
| FrustumCamera3D | ||
| _projection : Matrix3D
projection matrix
| FrustumCamera3D | ||
| projection : uint Gets or sets the projection type
| FrustumCamera3D | ||
| 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 | |
| transform : Matrix3D
A Matrix3D object containing values that affect the scaling, rotation, and translation of the display object.
| DisplayObject3D | |
| useOwnContainer : Boolean | DisplayObject3D | |
| view : Matrix3D
[internal-use] A camera transformed Matrix3D object.
| DisplayObject3D | |
| viewport : Rectangle | CameraObject3D | |
| viewport3D : Viewport3D | FrustumCamera3D | ||
| 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 | |
| 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 | |
| Method | Defined by | ||
|---|---|---|---|
|
FrustumCamera3D(viewport3D:Viewport3D, fov:Number = 90, near:Number = 10, far:Number = 2000)
Constructor.
| FrustumCamera3D | ||
|
Adds a child DisplayObject3D instance to this DisplayObjectContainer instance.
| DisplayObject3D | |
|
Adds all the children of a DisplayObject3D instance to this DisplayObjectContainer instance.
| DisplayObjectContainer3D | |
|
addCollada(filename:String, materials:MaterialsList = null, scale:Number = 1):void
This method has been deprecated.
| DisplayObjectContainer3D | |
|
addGeometry(geometry:GeometryObject3D = null):void
Adds a geometry definition to the instance.
| DisplayObject3D | |
|
childrenList():String
Returns a string value with the list of objects.
| DisplayObjectContainer3D | |
|
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 | |
|
createOrthoMatrix(left:Number, right:Number, bottom:Number, top:Number, near:Number, far:Number):Matrix3D
[static]
Creates a transformation that produces a parallel projection.
| FrustumCamera3D | ||
|
createPerspectiveMatrix(fov:Number, aspect:Number, near:Number, far:Number):Matrix3D
[static]
Creates a transformation that produces a perspective projection.
| FrustumCamera3D | ||
|
distanceTo(obj:DisplayObject3D):Number
Gets the distance to the position of the given object.
| DisplayObject3D | |
|
extractPlanes(m:Matrix3D):void
Extract the frustum planes.
| FrustumCamera3D | ||
|
getChildByName(name:String):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 | |
|
Make the object look at a specific position.
| DisplayObject3D | |
|
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 | |
|
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 | |
|
[internal-use] Projects three dimensional coordinates onto a two dimensional plane to simulate the relationship of the camera to subject.
| 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 | |
|
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 | |
|
sphereInFrustum(center:Vertex3D, radius:Number):int
Checks whether a sphere is inside, outside or intersecting the frustum.
| FrustumCamera3D | ||
|
testObject(obj:DisplayObject3D):int
| FrustumCamera3D | ||
|
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(trans:Matrix3D = null):void
[internal-use] Transforms world coordinates into camera space.
| FrustumCamera3D | ||
|
Move the object along a given direction.
| DisplayObject3D | |
|
yaw(angle:Number):void
Rotate the display object around about the vertical axis —an axis drawn from top to bottom.
| DisplayObject3D | |
| Constant | Defined by | ||
|---|---|---|---|
| BOTTOM : uint = 4 [static]
| FrustumCamera3D | ||
| FAR : uint = 5 [static]
| FrustumCamera3D | ||
| INSIDE : int = 1 [static]
| FrustumCamera3D | ||
| INTERSECT : int = 0 [static]
| FrustumCamera3D | ||
| LEFT : uint = 1 [static]
| FrustumCamera3D | ||
| 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 | |
| NEAR : uint = 0 [static]
| FrustumCamera3D | ||
| ORTHO_PROJECTION : uint = 1 [static] constant used to set projection type.
| FrustumCamera3D | ||
| OUTSIDE : int = -1 [static]
| FrustumCamera3D | ||
| PERSPECTIVE_PROJECTION : uint = 0 [static] constant used to set projection type.
| FrustumCamera3D | ||
| RIGHT : uint = 2 [static]
| FrustumCamera3D | ||
| TOP : uint = 3 [static]
| FrustumCamera3D | ||
| TYPE : String = "FRUSTRUMCAMERA3D" [static]
| FrustumCamera3D | ||
| far | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesfar:Number [read-write]Gets or sets the distance to far plane.
Implementation public function get far():Number
public function set far(value:Number):void
| fov | property |
fov:Number [read-write]Gets or sets the 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 or sets the distance to near plane (positive number).
Implementation public function get near():Number
public function set near(value:Number):void
| planes | property |
public var planes:Arrayfrustum planes
| _projection | property |
public var _projection:Matrix3Dprojection matrix
| projection | property |
projection:uint [read-write]Gets or sets the projection type
Implementation public function get projection():uint
public function set projection(value:uint):void
| viewport3D | property |
viewport3D:Viewport3D [read-write]Implementation
public function get viewport3D():Viewport3D
public function set viewport3D(value:Viewport3D):void
| FrustumCamera3D | () | constructor |
public function FrustumCamera3D(viewport3D:Viewport3D, fov:Number = 90, near:Number = 10, far:Number = 2000)Constructor.
Parametersviewport3D:Viewport3D — Field of view in degrees.
|
|
fov:Number (default = 90) |
|
near:Number (default = 10) |
|
far:Number (default = 2000) |
See also
| createOrthoMatrix | () | method |
public static function createOrthoMatrix(left:Number, right:Number, bottom:Number, top:Number, near:Number, far:Number):Matrix3DCreates a transformation that produces a parallel projection.
Parametersleft:Number |
|
right:Number |
|
bottom:Number |
|
top:Number |
|
near:Number |
|
far:Number |
Matrix3D |
| createPerspectiveMatrix | () | method |
public static function createPerspectiveMatrix(fov:Number, aspect:Number, near:Number, far:Number):Matrix3DCreates a transformation that produces a perspective projection.
Parametersfov:Number |
|
aspect:Number |
|
near:Number |
|
far:Number |
Matrix3D |
| extractPlanes | () | method |
| sphereInFrustum | () | method |
public function sphereInFrustum(center:Vertex3D, radius:Number):intChecks whether a sphere is inside, outside or intersecting the frustum.
Parameterscenter:Vertex3D — center of sphere
|
|
radius:Number — radius of sphere
|
int |
| testObject | () | method |
| transformView | () | method |
public override function transformView(trans:Matrix3D = null):void[internal-use] Transforms world coordinates into camera space.
Parameterstrans:Matrix3D (default = null) |
| BOTTOM | constant |
public static const BOTTOM:uint = 4
| FAR | constant |
public static const FAR:uint = 5
| INSIDE | constant |
public static const INSIDE:int = 1
| INTERSECT | constant |
public static const INTERSECT:int = 0
| LEFT | constant |
public static const LEFT:uint = 1
| NEAR | constant |
public static const NEAR:uint = 0
| ORTHO_PROJECTION | constant |
public static const ORTHO_PROJECTION:uint = 1constant used to set projection type.
See also
| OUTSIDE | constant |
public static const OUTSIDE:int = -1
| PERSPECTIVE_PROJECTION | constant |
public static const PERSPECTIVE_PROJECTION:uint = 0constant used to set projection type.
See also
| RIGHT | constant |
public static const RIGHT:uint = 2
| TOP | constant |
public static const TOP:uint = 3
| TYPE | constant |
public static const TYPE:String = "FRUSTRUMCAMERA3D"