away3d.cameras.Camera3D - Away3D API Reference

A Camera3D object represents a virtual camera through which we view the scene.

Constructor

`@:value({ lens : null })new(?lens:LensBase)`

Creates a new Camera3D object

Parameters:

`lens`	An optional lens object that will perform the projection. Defaults to PerspectiveLens.

Variables

`read onlyfrustumPlanes:Vector<Plane3D>`

`lens:LensBase`

`read onlyviewProjection:Matrix3D`

Methods

`@:value({ v : null })getRay(nX:Float, nY:Float, sZ:Float, ?v:Vector3D):Vector3D`

Calculates the ray in scene space from the camera to the given normalized coordinates in screen space.

Parameters:

`nX`	The normalised x coordinate in screen space, -1 corresponds to the left edge of the viewport, 1 to the right.
`nY`	The normalised y coordinate in screen space, -1 corresponds to the top edge of the viewport, 1 to the bottom.
`sZ`	The z coordinate in screen space, representing the distance into the screen.
`v`	The destination Vector3D object

Returns:

The ray from the camera to the scene space position of the given screen coordinates.

`@:value({ v : null })project(point3d:Vector3D, ?v:Vector3D):Vector3D`

Calculates the normalised position in screen space of the given scene position.

Parameters:

`point3d`	the position vector of the scene coordinates to be projected.
`v`	The destination Vector3D object

Returns:

The normalised screen position of the given scene coordinates.

`@:value({ v : null })unproject(nX:Float, nY:Float, sZ:Float, ?v:Vector3D):Vector3D`

Calculates the scene position of the given normalized coordinates in screen space.

Parameters:

`nX`	The normalised x coordinate in screen space, -1 corresponds to the left edge of the viewport, 1 to the right.
`nY`	The normalised y coordinate in screen space, -1 corresponds to the top edge of the viewport, 1 to the bottom.
`sZ`	The z coordinate in screen space, representing the distance into the screen.
`v`	The destination Vector3D object

Returns:

The scene position of the given screen coordinates.

Inherited Variables

Defined by Entity

Defined by ObjectContainer3D

Defined by Object3D

Defined by NamedAssetBase

Inherited Methods

Defined by Entity

Defined by ObjectContainer3D

`child`	The object to be added as a child.

`...childarray`	An array of 3d objects to be added

`index`	The index of the object to be retrieved.

`child`	The 3d object to be removed

`Error`	ObjectContainer3D.removeChild(null)

`index`	Index of 3d object to be removed

Defined by Object3D

`disposeAsset():Void`

@inheritDoc

`@:value({ v : null })getPosition(?v:Vector3D):Vector3D`

Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. @return

Parameters:

`v`	the destination Vector3D

`moveBackward(distance:Float):Void`

Moves the 3d object backwards along it's local z axis

Parameters:

`distance`	The length of the movement

`moveDown(distance:Float):Void`

Moves the 3d object backwards along it's local y axis

Parameters:

`distance`	The length of the movement

`moveForward(distance:Float):Void`

Moves the 3d object forwards along it's local z axis

Parameters:

`distance`	The length of the movement

`moveLeft(distance:Float):Void`

Moves the 3d object backwards along it's local x axis

Parameters:

`distance`	The length of the movement

`movePivot(dx:Float, dy:Float, dz:Float):Void`

Moves the local point around which the object rotates.

Parameters:

`dx`	The amount of movement along the local x axis.
`dy`	The amount of movement along the local y axis.
`dz`	The amount of movement along the local z axis.

`moveRight(distance:Float):Void`

Moves the 3d object forwards along it's local x axis

Parameters:

`distance`	The length of the movement

`moveTo(dx:Float, dy:Float, dz:Float):Void`

Moves the 3d object directly to a point in space

Parameters:

`dx`	The amount of movement along the local x axis.
`dy`	The amount of movement along the local y axis.
`dz`	The amount of movement along the local z axis.

`moveUp(distance:Float):Void`

Moves the 3d object forwards along it's local y axis

Parameters:

`distance`	The length of the movement

`pitch(angle:Float):Void`

Rotates the 3d object around it's local x-axis

Parameters:

`angle`	The amount of rotation in degrees

`roll(angle:Float):Void`

Rotates the 3d object around it's local z-axis

Parameters:

`angle`	The amount of rotation in degrees

`rotateTo(ax:Float, ay:Float, az:Float):Void`

Rotates the 3d object directly to a euler angle

Parameters:

`ax`	The angle in degrees of the rotation around the x axis.
`ay`	The angle in degrees of the rotation around the y axis.
`az`	The angle in degrees of the rotation around the z axis.

`scale(value:Float):Void`

Appends a uniform scale to the current transformation.

Parameters:

`value`	The amount by which to scale.

`translate(axis:Vector3D, distance:Float):Void`

Moves the 3d object along a vector by a defined length

Parameters:

`axis`	The vector defining the axis of movement
`distance`	The length of the movement

`yaw(angle:Float):Void`

Rotates the 3d object around it's local y-axis

Parameters:

`angle`	The amount of rotation in degrees

class Camera3D

package away3d.cameras

extends Entity › ObjectContainer3D › Object3D › NamedAssetBase

extended by StereoCamera3D

Constructor

@:value({ lens : null })new(?lens:LensBase)

Variables

read onlyfrustumPlanes:Vector<Plane3D>

lens:LensBase

read onlyviewProjection:Matrix3D

Methods

@:value({ v : null })getRay(nX:Float, nY:Float, sZ:Float, ?v:Vector3D):Vector3D

@:value({ v : null })project(point3d:Vector3D, ?v:Vector3D):Vector3D

@:value({ v : null })unproject(nX:Float, nY:Float, sZ:Float, ?v:Vector3D):Vector3D

Inherited Variables

Defined by Entity

bounds:BoundingVolumeBase

pickingCollider:IPickingCollider

read onlypickingCollisionVO:PickingCollisionVO

shaderPickingDetails:Bool

showBounds:Bool

staticNode:Bool

read onlyworldBounds:BoundingVolumeBase

Defined by ObjectContainer3D

read onlyassetType:String

ignoreTransform:Bool

read onlyinverseSceneTransform:Matrix3D

read onlymaxX:Float

read onlymaxY:Float

read onlymaxZ:Float

read onlyminX:Float

read onlyminY:Float

read onlyminZ:Float

mouseChildren:Bool

mouseEnabled:Bool

read onlynumChildren:Int

read onlyparent:ObjectContainer3D

partition:Partition3D

scene:Scene3D

read onlyscenePosition:Vector3D

read onlysceneTransform:Matrix3D

visible:Bool

Defined by Object3D

read onlybackVector:Vector3D

read onlydownVector:Vector3D

eulers:Vector3D

extra:Dynamic

read onlyforwardVector:Vector3D

read onlyleftVector:Vector3D

pivotPoint:Vector3D

position:Vector3D

read onlyrightVector:Vector3D

rotationX:Float

rotationY:Float

rotationZ:Float

scaleX:Float

scaleY:Float

scaleZ:Float

transform:Matrix3D

read onlyupVector:Vector3D

x:Float

y:Float

z:Float

zOffset:Int

Defined by NamedAssetBase

read onlyassetFullPath:Array<Dynamic>

read onlyassetNamespace:String

id:String

name:String

read onlyoriginalName:String

Inherited Methods

Defined by Entity

getEntityPartitionNode():EntityNode

internalUpdate():Void

isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Bool

Defined by ObjectContainer3D

addChild(child:ObjectContainer3D):ObjectContainer3D

addChildren(childarray:Vector<ObjectContainer3D>):Void

clone():Object3D

contains(child:ObjectContainer3D):Bool

`@:value({ lens : null })new(?lens:LensBase)`

`read onlyfrustumPlanes:Vector<Plane3D>`

`lens:LensBase`

`read onlyviewProjection:Matrix3D`

`@:value({ v : null })getRay(nX:Float, nY:Float, sZ:Float, ?v:Vector3D):Vector3D`

`@:value({ v : null })project(point3d:Vector3D, ?v:Vector3D):Vector3D`

`@:value({ v : null })unproject(nX:Float, nY:Float, sZ:Float, ?v:Vector3D):Vector3D`

`bounds:BoundingVolumeBase`

`pickingCollider:IPickingCollider`

`read onlypickingCollisionVO:PickingCollisionVO`

`shaderPickingDetails:Bool`

`showBounds:Bool`

`staticNode:Bool`

`read onlyworldBounds:BoundingVolumeBase`

`read onlyassetType:String`

`ignoreTransform:Bool`

`read onlyinverseSceneTransform:Matrix3D`

`read onlymaxX:Float`

`read onlymaxY:Float`

`read onlymaxZ:Float`

`read onlyminX:Float`

`read onlyminY:Float`

`read onlyminZ:Float`

`mouseChildren:Bool`

`mouseEnabled:Bool`

`read onlynumChildren:Int`

`read onlyparent:ObjectContainer3D`

`partition:Partition3D`

`scene:Scene3D`

`read onlyscenePosition:Vector3D`

`read onlysceneTransform:Matrix3D`

`visible:Bool`

`read onlybackVector:Vector3D`

`read onlydownVector:Vector3D`

`eulers:Vector3D`

`extra:Dynamic`

`read onlyforwardVector:Vector3D`

`read onlyleftVector:Vector3D`

`pivotPoint:Vector3D`

`position:Vector3D`

`read onlyrightVector:Vector3D`

`rotationX:Float`

`rotationY:Float`

`rotationZ:Float`

`scaleX:Float`

`scaleY:Float`

`scaleZ:Float`

`transform:Matrix3D`

`read onlyupVector:Vector3D`

`x:Float`

`y:Float`

`z:Float`

`zOffset:Int`

`read onlyassetFullPath:Array<Dynamic>`

`read onlyassetNamespace:String`

`id:String`

`name:String`

`read onlyoriginalName:String`

`getEntityPartitionNode():EntityNode`

`internalUpdate():Void`

`isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Bool`

`addChild(child:ObjectContainer3D):ObjectContainer3D`

`addChildren(childarray:Vector<ObjectContainer3D>):Void`

`clone():Object3D`

`contains(child:ObjectContainer3D):Bool`

`dispatchEvent(event:Event):Bool`

`dispose():Void`

`disposeWithChildren():Void`

`getChildAt(index:Int):ObjectContainer3D`

`@:value({ upAxis : null })lookAt(target:Vector3D, ?upAxis:Vector3D):Void`

`removeChild(child:ObjectContainer3D):Void`

`removeChildAt(index:Int):Void`

`updateImplicitVisibility():Void`

`disposeAsset():Void`

`@:value({ v : null })getPosition(?v:Vector3D):Vector3D`

`moveBackward(distance:Float):Void`

`moveDown(distance:Float):Void`

`moveForward(distance:Float):Void`

`moveLeft(distance:Float):Void`

`movePivot(dx:Float, dy:Float, dz:Float):Void`