away3d.lights.DirectionalLight - Away3D API Reference

DirectionalLight represents an idealized light "at infinity", to be used for distant light sources such as the sun. In any position in the scene, the light raytracing will always be parallel. Although the position of the light does not impact its effect, it can be used along with lookAt to intuitively create day cycles by orbiting the position around a center point and using lookAt at that position.

Constructor

`@:value({ zDir : 1, yDir : -1, xDir : 0 })new(xDir:Float = 0, yDir:Float = -1, zDir:Float = 1)`

Creates a new DirectionalLight object.

Parameters:

`xDir`	The x-component of the light's directional vector.
`yDir`	The y-component of the light's directional vector.
`zDir`	The z-component of the light's directional vector.

Variables

`direction:Vector3D`

`read onlysceneDirection:Vector3D`

Inherited Variables

Defined by LightBase

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 DirectionalLight

package away3d.lights

extends LightBase › Entity › ObjectContainer3D › Object3D › NamedAssetBase

Constructor

@:value({ zDir : 1, yDir : -1, xDir : 0 })new(xDir:Float = 0, yDir:Float = -1, zDir:Float = 1)

Variables

direction:Vector3D

read onlysceneDirection:Vector3D

Inherited Variables

Defined by LightBase

_castsShadows:Bool

_shadowMapper:ShadowMapperBase

ambient:Float

ambientColor:Int

castsShadows:Bool

color:Int

diffuse:Float

shadowMapper:ShadowMapperBase

specular:Float

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

`@:value({ zDir : 1, yDir : -1, xDir : 0 })new(xDir:Float = 0, yDir:Float = -1, zDir:Float = 1)`

`direction:Vector3D`

`read onlysceneDirection:Vector3D`

`_castsShadows:Bool`

`_shadowMapper:ShadowMapperBase`

`ambient:Float`

`ambientColor:Int`

`castsShadows:Bool`

`color:Int`

`diffuse:Float`

`shadowMapper:ShadowMapperBase`

`specular:Float`

`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`