Packageaway3d.lights
Classpublic class DirectionalLight
InheritanceDirectionalLight Inheritance LightBase Inheritance Entity Inheritance ObjectContainer3D Inheritance Object3D Inheritance NamedAssetBase 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 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.



Public Properties
 PropertyDefined By
 Inheritedambient : Number
The ambient emission strength of the light.
LightBase
 InheritedambientColor : uint
The ambient emission colour of the light.
LightBase
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[override] [read-only]
LightBase
 InheritedbackVector : Vector3D
[read-only]
Object3D
 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 emission strength of the light.
LightBase
  direction : Vector3D
The direction of the light.
DirectionalLight
 InheriteddownVector : Vector3D
[read-only]
Object3D
 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
 InheritedforwardVector : Vector3D
[read-only]
Object3D
 Inheritedid : String
NamedAssetBase
 InheritedignoreTransform : Boolean
[override]
Entity
 InheritedinverseSceneTransform : Matrix3D
[read-only] The inverse scene transform object that transforms from world to model space.
ObjectContainer3D
 InheritedleftVector : Vector3D
[read-only]
Object3D
 InheritedmaxX : Number
[override] [read-only] The maximum extremum of the object along the X-axis.
Entity
 InheritedmaxY : Number
[override] [read-only] The maximum extremum of the object along the Y-axis.
Entity
 InheritedmaxZ : Number
[override] [read-only] The maximum extremum of the object along the Z-axis.
Entity
 InheritedminX : Number
[override] [read-only] The minimum extremum of the object along the X-axis.
Entity
 InheritedminY : Number
[override] [read-only] The minimum extremum of the object along the Y-axis.
Entity
 InheritedminZ : Number
[override] [read-only] The minimum extremum of the object along the Z-axis.
Entity
 InheritedmouseChildren : Boolean
ObjectContainer3D
 InheritedmouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
ObjectContainer3D
 Inheritedname : String
NamedAssetBase
 InheritednumChildren : uint
[read-only] The amount of child objects of the ObjectContainer3D.
ObjectContainer3D
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
 Inheritedparent : ObjectContainer3D
[read-only] 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
 InheritedpickingCollider : 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
 InheritedpickingCollisionVO : PickingCollisionVO
[read-only] Returns a unique picking collision value object for the entity.
Entity
 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
 InheritedrightVector : Vector3D
[read-only]
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
 Inheritedscene : Scene3D
[override] A reference to the Scene3D object to which this object belongs.
Entity
  sceneDirection : Vector3D
[read-only] The direction of the light in scene coordinates.
DirectionalLight
 InheritedscenePosition : Vector3D
[read-only] The global position of the ObjectContainer3D in the scene.
ObjectContainer3D
 InheritedsceneTransform : Matrix3D
[read-only] The transformation matrix that transforms from model to world space.
ObjectContainer3D
 InheritedshaderPickingDetails : 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
 InheritedshadowMapper : ShadowMapperBase
LightBase
 InheritedshowBounds : Boolean
Entity
 Inheritedspecular : Number
The specular emission strength of the light.
LightBase
 InheritedstaticNode : Boolean
Defines whether or not the object will be moved or animated at runtime.
Entity
 Inheritedtransform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedupVector : Vector3D
[read-only]
Object3D
 Inheritedvisible : Boolean
ObjectContainer3D
 InheritedworldBounds : BoundingVolumeBase
[read-only]
Entity
 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
 InheritedzOffset : int
Object3D
Protected Properties
 PropertyDefined By
 Inherited_bounds : BoundingVolumeBase
Entity
 Inherited_boundsInvalid : Boolean = true
Entity
 Inherited_explicitPartition : Partition3D
ObjectContainer3D
 Inherited_ignoreTransform : Boolean = false
ObjectContainer3D
 Inherited_implicitPartition : Partition3D
ObjectContainer3D
 Inherited_mouseEnabled : Boolean
ObjectContainer3D
 Inherited_parent : ObjectContainer3D
ObjectContainer3D
 Inherited_pivotPoint : Vector3D
Object3D
 Inherited_pivotZero : Boolean = true
Object3D
 Inherited_pos : Vector3D
Object3D
 Inherited_rot : Vector3D
Object3D
 Inherited_sca : Vector3D
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_transform : Matrix3D
Object3D
 Inherited_transformComponents : Vector.<Vector3D>
Object3D
 Inherited_x : Number = 0
Object3D
 Inherited_y : Number = 0
Object3D
 Inherited_z : Number = 0
Object3D
 Inherited_zOffset : int = 0
Object3D
Public Methods
 MethodDefined By
  
DirectionalLight(xDir:Number = 0, yDir:Number = -1, zDir:Number = 1)
Creates a new DirectionalLight object.
DirectionalLight
 Inherited
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
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override]
ObjectContainer3D
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
[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
 Inherited
ObjectContainer3D
 Inherited
dispatchEvent(event:Event):Boolean
[override]
ObjectContainer3D
 Inherited
dispose():void
[override] Cleans up resources used by this asset.
ObjectContainer3D
 Inherited
Object3D
 Inherited
Disposes the current ObjectContainer3D including all of its children.
ObjectContainer3D
 Inherited
Retrieves the child object at the given index.
ObjectContainer3D
 Inherited
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
Entity
 Inherited
isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Boolean
Entity
 Inherited
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
 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
Removes a 3d object from the child array of the container
ObjectContainer3D
 Inherited
removeChildAt(index:uint):void
Removes a 3d object from the child array of the container
ObjectContainer3D
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override]
ObjectContainer3D
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Vector3D, angle:Number):void
[override]
ObjectContainer3D
 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
[override]
ObjectContainer3D
 Inherited
ObjectContainer3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined By
  
[override]
DirectionalLight
  
[override]
DirectionalLight
  
[override] Creates the default bounding box to be used by this type of Entity.
DirectionalLight
 Inherited
Invalidates the bounding volume, causing to be updated when requested.
Entity
 Inherited
[override] Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
Entity
  
[override] Updates the bounding volume for the object.
DirectionalLight
 Inherited
[override]
Entity
  
[override] Updates the scene transformation matrix.
DirectionalLight
 Inherited
Object3D
Events
 Event Summary Defined By
 InheritedDispatched when a user presses the left hand mouse button while the cursor is over the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor while it is over the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor away from the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor over the 3d object.ObjectContainer3D
 InheritedDispatched when a user releases the left hand mouse button while the cursor is over the 3d object.ObjectContainer3D
 InheritedDispatched when the position of the 3d object changes.Object3D
 InheritedDispatched when the rotation of the 3d object changes.Object3D
 InheritedDispatched when the scale of the 3d object changes.Object3D
 InheritedDispatched when the parent scene of the 3d object changes.ObjectContainer3D
 InheritedDispatched when the scene transform matrix of the 3d object changes.ObjectContainer3D
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Property Detail
directionproperty
direction:Vector3D

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)

Creates a new DirectionalLight object.

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.
Method Detail
createEntityPartitionNode()method
override protected function createEntityPartitionNode():EntityNode

Returns
EntityNode
createShadowMapper()method 
override protected function createShadowMapper():ShadowMapperBase

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

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

Returns
BoundingVolumeBase
getObjectProjectionMatrix()method 
override arcane function getObjectProjectionMatrix(renderable:IRenderable, target:Matrix3D = null):Matrix3D

Gets the optimal projection matrix to render a light-based depth map for a single object.

Parameters

renderable:IRenderable — The IRenderable object to render to a depth map.
 
target:Matrix3D (default = null) — An optional target Matrix3D object. If not provided, an instance will be created.

Returns
Matrix3D — A Matrix3D object containing the projection transformation.
updateBounds()method 
override protected function updateBounds():void

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

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

Updates the scene transformation matrix.