Packageaway3d.lights
Classpublic class DirectionalLight
InheritanceDirectionalLight Inheritance LightBase Inheritance Entity Inheritance ObjectContainer3D Inheritance Object3D Inheritance flash.events.EventDispatcher

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

Public Properties
 PropertyDefined by
 Inheritedbounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity.
Entity
 InheritedcastsShadows : Boolean
LightBase
 Inheritedcolor : uint
The color of the light.
LightBase
 Inheriteddiffuse : Number
The diffuse reflection strength of the light.
LightBase
  direction : Vector3D
The direction of the light.
DirectionalLight
 Inheritedeulers : Vector3D
Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis.
Object3D
 Inheritedextra : Object
An object that can contain any extra data.
Object3D
 InheritedinverseSceneTransform : Matrix3D
The inverse scene transform object that transforms from world to model space.
ObjectContainer3D
 InheritedmaxX : Number
The maximum extremum of the object along the X-axis.
Entity
 InheritedmaxY : Number
The maximum extremum of the object along the Y-axis.
Entity
 InheritedmaxZ : Number
The maximum extremum of the object along the Z-axis.
Entity
 InheritedminX : Number
The minimum extremum of the object along the X-axis.
Entity
 InheritedminY : Number
The minimum extremum of the object along the Y-axis.
Entity
 InheritedminZ : Number
The minimum extremum of the object along the Z-axis.
Entity
 InheritedmodelViewProjection : Matrix3D
The current model-view-projection (MVP) matrix - the one on the top of the stack - used to transform from model to homogeneous projection space.
Entity
 InheritedmouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
Entity
 Inheritedname : String
The name of the object.
Object3D
 InheritednumChildren : uint
The amount of child objects of the ObjectContainer3D.
ObjectContainer3D
 Inheritedparent : ObjectContainer3D
The parent ObjectContainer3D to which this object's transformation is relative.
ObjectContainer3D
 Inheritedpartition : 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
 InheritedpivotPoint : Vector3D
Defines the local point around which the object rotates.
Object3D
 Inheritedposition : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationX : 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
 InheritedrotationY : 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
 InheritedrotationZ : 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
 InheritedscaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
Object3D
 InheritedscaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
Object3D
 InheritedscaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
Object3D
  sceneDirection : Vector3D
[read-only] The direction of the light in scene coordinates.
DirectionalLight
 InheritedscenePosition : Vector3D
The global position of the ObjectContainer3D in the scene.
ObjectContainer3D
 InheritedsceneTransform : Matrix3D
The transformation matrix that transforms from model to world space.
ObjectContainer3D
 InheritedshadowMapper : ShadowMapperBase
LightBase
 Inheritedspecular : Number
The specular reflection strength of the light.
LightBase
 Inheritedtransform : Matrix3D
The local transformation matrix that transforms to the parent object's space.
ObjectContainer3D
 Inheritedx : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedy : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedz : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedzIndex : Number
The distance of the IRenderable object to the view, used to sort per object.
Entity
Protected Properties
 PropertyDefined by
 Inherited_bounds : BoundingVolumeBase
Entity
 Inherited_boundsInvalid : Boolean = true
Entity
 Inherited_explicitPartition : Partition3D
ObjectContainer3D
 Inherited_fragmentDirReg : ShaderRegisterElement
LightBase
 Inherited_implicitPartition : Partition3D
ObjectContainer3D
 Inherited_mvpIndex : int = -1
Entity
 Inherited_mvpTransformStack : Vector
Entity
 Inherited_parent : ObjectContainer3D
ObjectContainer3D
 Inherited_pivotPoint : Vector3D
Object3D
 Inherited_pivotZero : Boolean = true
Object3D
 Inherited_pos : Vector3D
A calculation placeholder.
Object3D
 Inherited_scaleX : Number = 1
Object3D
 Inherited_scaleY : Number = 1
Object3D
 Inherited_scaleZ : Number = 1
Object3D
 Inherited_scene : Scene3D
ObjectContainer3D
 Inherited_sceneTransform : Matrix3D
ObjectContainer3D
 Inherited_sceneTransformDirty : Boolean = true
ObjectContainer3D
 Inherited_shaderConstantIndex : uint
LightBase
 Inherited_stackLen : uint
Entity
 Inherited_transform : Matrix3D
Object3D
 Inherited_x : Number = 0
Object3D
 Inherited_y : Number = 0
Object3D
 Inherited_z : Number = 0
Object3D
 Inherited_zIndices : Vector
Entity
Public Methods
 MethodDefined by
  
DirectionalLight
(xDir:Number = 0, yDir:Number = -1, zDir:Number = 1)
Creates a new DirectionalLight object.
DirectionalLight
 Inherited
addChild(child:ObjectContainer3D):ObjectContainer3D
Adds a child ObjectContainer3D to the current object.
ObjectContainer3D
 Inherited
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
ObjectContainer3D
 Inherited
clone():Object3D
Object3D
 Inherited
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
ObjectContainer3D
 Inherited
getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index.
ObjectContainer3D
 Inherited
getEntityPartitionNode():EntityNode
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
Entity
 Inherited
lookAt(target:Vector3D, upAxis:Vector3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
ObjectContainer3D
 Inherited
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
Object3D
 Inherited
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
Object3D
 Inherited
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
Object3D
 Inherited
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
Object3D
 Inherited
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates.
Object3D
 Inherited
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Object3D
 Inherited
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
Object3D
 Inherited
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
Object3D
 Inherited
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
Object3D
 Inherited
popModelViewProjection():void
Removes a model view projection matrix from the stack, used when leaving a render.
Entity
 Inherited
pushModelViewProjection(camera:Camera3D):void
Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space and places it on the stack.
Entity
 Inherited
removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
ObjectContainer3D
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Vector3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
Object3D
 Inherited
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
Object3D
 Inherited
scale(value:Number):void
Appends a uniform scale to the current transformation.
Object3D
 Inherited
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
 Inherited
translateLocal(axis:Vector3D, distance:Number):void
ObjectContainer3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined by
 Inherited
createEntityPartitionNode():EntityNode
Factory method that returns the current partition node.
LightBase
  
createShadowMapper():ShadowMapperBase
DirectionalLight
  
getDefaultBoundingVolume():BoundingVolumeBase
Creates the default bounding box to be used by this type of Entity.
DirectionalLight
 Inherited
invalidateBounds():void
Invalidates the bounding volume, causing to be updated when requested.
Entity
  
invalidateSceneTransform():void
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
DirectionalLight
 Inherited
invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
ObjectContainer3D
  
updateBounds():void
Updates the bounding volume for the object.
DirectionalLight
  
updateSceneTransform():void
Updates the scene transformation matrix.
DirectionalLight
 Inherited
updateTransform():void
Object3D
Property detail
directionproperty
direction:Vector3D  [read-write]

The direction of the light.

Implementation
    public function get direction():Vector3D
    public function set direction(value:Vector3D):void
sceneDirectionproperty 
sceneDirection:Vector3D  [read-only]

The direction of the light in scene coordinates.

Implementation
    public function get sceneDirection():Vector3D
Constructor detail
DirectionalLight()constructor
public function DirectionalLight(xDir:Number = 0, yDir:Number = -1, zDir:Number = 1)Parameters
xDir:Number (default = 0) — The x-component of the light's directional vector.
 
yDir:Number (default = -1) — The y-component of the light's directional vector.
 
zDir:Number (default = 1) — The z-component of the light's directional vector.
Init Parameters
Method detail
createShadowMapper()method
protected override function createShadowMapper():ShadowMapperBase

Returns
ShadowMapperBase
getDefaultBoundingVolume()method 
protected override function getDefaultBoundingVolume():BoundingVolumeBase

Creates the default bounding box to be used by this type of Entity.

Returns
BoundingVolumeBase
getFragmentCode()method 
arcane override function getFragmentCode(regCache:ShaderRegisterCache):String Parameters
regCache:ShaderRegisterCache

Returns
String
getVertexCode()method 
arcane override function getVertexCode(regCache:ShaderRegisterCache, globalPositionRegister:ShaderRegisterElement):String Parameters
regCache:ShaderRegisterCache
 
globalPositionRegister:ShaderRegisterElement

Returns
String
invalidateSceneTransform()method 
protected override function invalidateSceneTransform():void

Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.

setRenderState()method 
arcane override function setRenderState(context:Context3D, inputIndex:int):void Parameters
context:Context3D
 
inputIndex:int
updateBounds()method 
protected override function updateBounds():void

Updates the bounding volume for the object. Overriding methods need to set invalid flag to false!

updateSceneTransform()method 
protected override function updateSceneTransform():void

Updates the scene transformation matrix.

Wiki link
Click to go to the wiki page for 'away3d.lights.DirectionalLight'

Code examples

Comments