Package | away3d.cameras |
Class | public class Camera3D |
Inheritance | Camera3D Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher |
Subclasses | StereoCamera3D |
Property | Defined By | ||
---|---|---|---|
assetFullPath : Array [read-only] | NamedAssetBase | ||
assetNamespace : String [read-only] | NamedAssetBase | ||
assetType : String [override] [read-only] | Camera3D | ||
backVector : Vector3D [read-only]
| Object3D | ||
bounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity. | Entity | ||
downVector : Vector3D [read-only]
| Object3D | ||
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 object that can contain any extra data. | Object3D | ||
forwardVector : Vector3D [read-only]
| Object3D | ||
frustumPlanes : Vector.<Plane3D> [read-only]
| Camera3D | ||
id : String | NamedAssetBase | ||
ignoreTransform : Boolean [override] | Entity | ||
inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space. | ObjectContainer3D | ||
leftVector : Vector3D [read-only]
| Object3D | ||
lens : LensBase
The lens used by the camera to perform the projection;
| Camera3D | ||
maxX : Number [override] [read-only]
The maximum extremum of the object along the X-axis. | Entity | ||
maxY : Number [override] [read-only]
The maximum extremum of the object along the Y-axis. | Entity | ||
maxZ : Number [override] [read-only]
The maximum extremum of the object along the Z-axis. | Entity | ||
minX : Number [override] [read-only]
The minimum extremum of the object along the X-axis. | Entity | ||
minY : Number [override] [read-only]
The minimum extremum of the object along the Y-axis. | Entity | ||
minZ : Number [override] [read-only]
The minimum extremum of the object along the Z-axis. | Entity | ||
mouseChildren : Boolean | ObjectContainer3D | ||
mouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing. | ObjectContainer3D | ||
name : String | NamedAssetBase | ||
numChildren : uint [read-only]
The amount of child objects of the ObjectContainer3D. | ObjectContainer3D | ||
originalName : String [read-only]
The original name used for this asset in the resource (e.g. | NamedAssetBase | ||
parent : ObjectContainer3D [read-only]
The parent ObjectContainer3D to which this object's transformation is relative. | ObjectContainer3D | ||
partition : Partition3D
The space partition to be used by the object container and all its recursive children, unless it has its own
space partition assigned. | ObjectContainer3D | ||
pickingCollider : IPickingCollider
Used by the raycast-based picking system to determine how the geometric contents of an entity are processed
in order to offer more details for the picking collision object, including local position, normal vector and uv value. | Entity | ||
pickingCollisionVO : PickingCollisionVO [read-only]
Returns a unique picking collision value object for the entity. | Entity | ||
pivotPoint : Vector3D
Defines the local point around which the object rotates. | Object3D | ||
position : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
rightVector : Vector3D [read-only]
| 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 [override]
A reference to the Scene3D object to which this object belongs. | Entity | ||
scenePosition : Vector3D [read-only]
The global position of the ObjectContainer3D in the scene. | ObjectContainer3D | ||
sceneTransform : Matrix3D [read-only]
The transformation matrix that transforms from model to world space. | ObjectContainer3D | ||
shaderPickingDetails : Boolean
Used by the shader-based picking system to determine whether a separate render pass is made in order
to offer more details for the picking collision object, including local position, normal vector and uv value. | Entity | ||
showBounds : Boolean | Entity | ||
staticNode : Boolean
Defines whether or not the object will be moved or animated at runtime. | Entity | ||
transform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
upVector : Vector3D [read-only]
| Object3D | ||
viewProjection : Matrix3D [read-only]
The view projection matrix of the camera. | Camera3D | ||
visible : Boolean | ObjectContainer3D | ||
worldBounds : BoundingVolumeBase [read-only] | Entity | ||
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 | ||
zOffset : int | Object3D |
Method | Defined By | ||
---|---|---|---|
Creates a new Camera3D object
| Camera3D | ||
Adds a child ObjectContainer3D to the current object. | ObjectContainer3D | ||
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
| ObjectContainer3D | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] | ObjectContainer3D | ||
assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | ||
[override]
Clones this ObjectContainer3D instance along with all it's children, and
returns the result (which will be a copy of this container, containing copies
of all it's children.)
| ObjectContainer3D | ||
contains(child:ObjectContainer3D):Boolean | ObjectContainer3D | ||
dispatchEvent(event:Event):Boolean [override]
| ObjectContainer3D | ||
dispose():void [override]
Cleans up resources used by this asset. | ObjectContainer3D | ||
disposeAsset():void | Object3D | ||
disposeWithChildren():void
Disposes the current ObjectContainer3D including all of its children. | ObjectContainer3D | ||
getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index. | ObjectContainer3D | ||
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
| Entity | ||
getRay(nX:Number, nY:Number, sZ:Number):Vector3D
Calculates the ray in scene space from the camera to the given normalized coordinates in screen space. | Camera3D | ||
isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Boolean | Entity | ||
lookAt(target:Vector3D, upAxis:Vector3D = null):void [override]
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D. | ObjectContainer3D | ||
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 | ||
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
| Object3D | ||
project(point3d:Vector3D):Vector3D
Calculates the normalised position in screen space of the given scene position. | Camera3D | ||
removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | ||
removeChildAt(index:uint):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override] | ObjectContainer3D | ||
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase | ||
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | ||
rotate(axis:Vector3D, angle:Number):void [override] | ObjectContainer3D | ||
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
| Object3D | ||
scale(value:Number):void
Appends a uniform scale to the current transformation. | Object3D | ||
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | ||
translateLocal(axis:Vector3D, distance:Number):void [override] | ObjectContainer3D | ||
unproject(nX:Number, nY:Number, sZ:Number):Vector3D
Calculates the scene position of the given normalized coordinates in screen space. | Camera3D | ||
updateImplicitVisibility():void | ObjectContainer3D | ||
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Method | Defined By | ||
---|---|---|---|
[override]
Factory method that returns the current partition node. | Camera3D | ||
[override] | Camera3D | ||
invalidateBounds():void
Invalidates the bounding volume, causing to be updated when requested. | Entity | ||
invalidateSceneTransform():void [override]
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested. | Camera3D | ||
updateBounds():void [override]
Updates the bounding volume for the object. | Camera3D | ||
updateMouseChildren():void [override] | Entity | ||
updateSceneTransform():void
Updates the scene transformation matrix. | ObjectContainer3D | ||
updateTransform():void | Object3D |
assetType | property |
assetType:String
[read-only] [override] public function get assetType():String
frustumPlanes | property |
frustumPlanes:Vector.<Plane3D>
[read-only]
public function get frustumPlanes():Vector.<Plane3D>
lens | property |
lens:LensBase
The lens used by the camera to perform the projection;
public function get lens():LensBase
public function set lens(value:LensBase):void
viewProjection | property |
viewProjection:Matrix3D
[read-only] The view projection matrix of the camera.
public function get viewProjection():Matrix3D
Camera3D | () | Constructor |
public function Camera3D(lens:LensBase = null)
Creates a new Camera3D object
Parameterslens:LensBase (default = null ) — An optional lens object that will perform the projection. Defaults to PerspectiveLens.
|
See also
createEntityPartitionNode | () | method |
override protected function createEntityPartitionNode():EntityNode
Factory method that returns the current partition node. Needs to be overridden by concrete subclasses such as Mesh to return the correct concrete subtype of EntityPartition3DNode (for Mesh = MeshPartition3DNode, most IRenderables (particles fe) would return RenderablePartition3DNode, I suppose)
ReturnsEntityNode |
getDefaultBoundingVolume | () | method |
getRay | () | method |
public function getRay(nX:Number, nY:Number, sZ:Number):Vector3D
Calculates the ray in scene space from the camera to the given normalized coordinates in screen space.
Parameters
nX:Number — The normalised x coordinate in screen space, -1 corresponds to the left edge of the viewport, 1 to the right.
| |
nY:Number — The normalised y coordinate in screen space, -1 corresponds to the top edge of the viewport, 1 to the bottom.
| |
sZ:Number — The z coordinate in screen space, representing the distance into the screen.
|
Vector3D — The ray from the camera to the scene space position of the given screen coordinates.
|
invalidateSceneTransform | () | method |
override protected function invalidateSceneTransform():void
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
project | () | method |
public function project(point3d:Vector3D):Vector3D
Calculates the normalised position in screen space of the given scene position.
Parameters
point3d:Vector3D — the position vector of the scene coordinates to be projected.
|
Vector3D — The normalised screen position of the given scene coordinates.
|
unproject | () | method |
public function unproject(nX:Number, nY:Number, sZ:Number):Vector3D
Calculates the scene position of the given normalized coordinates in screen space.
Parameters
nX:Number — The normalised x coordinate in screen space, -1 corresponds to the left edge of the viewport, 1 to the right.
| |
nY:Number — The normalised y coordinate in screen space, -1 corresponds to the top edge of the viewport, 1 to the bottom.
| |
sZ:Number — The z coordinate in screen space, representing the distance into the screen.
|
Vector3D — The scene position of the given screen coordinates.
|
updateBounds | () | method |
override protected function updateBounds():void
Updates the bounding volume for the object. Overriding methods need to set invalid flag to false!