Packageaway3d.lights
Classpublic class DirectionalLight3D
InheritanceDirectionalLight3D Inheritance AbstractLight

Lightsource that colors all shaded materials proportional to the dot product of the offset vector with the normal vector. The scalar value of distance does not affect the resulting light intensity, it is calulated as if the source is an infinite distance away with an infinite brightness.

Public Properties
 PropertyDefined by
  ambient : Number
Defines a coefficient for the ambient light intensity.
DirectionalLight3D
 InheritedambientBitmap : BitmapData
Lightmap for ambient intensity.
AbstractLight
 InheritedambientColorTransform : ColorTransform
Color transform used in cached shading materials for combined ambient and diffuse color intensities.
AbstractLight
 InheritedambientDiffuseBitmap : BitmapData
Combined lightmap for ambient and diffuse intensities.
AbstractLight
  brightness : Number
Defines a coefficient for the overall light intensity.
DirectionalLight3D
 Inheritedcolor : uint
Defines the color of the light object.
AbstractLight
 Inheriteddebug : Boolean
Toggles debug mode: light object is visualised in the scene.
AbstractLight
  diffuse : Number
Defines a coefficient for the diffuse light intensity.
DirectionalLight3D
 InheriteddiffuseBitmap : BitmapData
Lightmap for diffuse intensity.
AbstractLight
 InheriteddiffuseColorTransform : ColorTransform
Color transform used in cached shading materials for ambient intensities.
AbstractLight
  direction : Number3D
Defines the direction of the light relative to the local coordinates of the parent ObjectContainer3D.
DirectionalLight3D
 Inheritedparent : ObjectContainer3D
Defines the parent of the light.
AbstractLight
  sceneDirection : Number3D
[read-only]
DirectionalLight3D
  specular : Number
Defines a coefficient for the specular light intensity.
DirectionalLight3D
 InheritedspecularBitmap : BitmapData
Lightmap for specular intensity.
AbstractLight
Protected Properties
 PropertyDefined by
 Inheritedini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
AbstractLight
Public Methods
 MethodDefined by
  
DirectionalLight3D
(init:Object = null)
Creates a new DirectionalLight3D object.
DirectionalLight3D
  
clone(light:AbstractLight = null):AbstractLight
Duplicates the light object's properties to another DirectionalLight3D object
DirectionalLight3D
Protected Methods
 MethodDefined by
  
onSceneTransformChange(event:Object3DEvent = null):void
DirectionalLight3D
  
updateAmbientDiffuse():void
Updates the bitmapData object used as the lightmap for the combined ambient and diffue light shading.
DirectionalLight3D
Property detail
ambientproperty
ambient:Number  [read-write]

Defines a coefficient for the ambient light intensity.

Implementation
    public function get ambient():Number
    public function set ambient(value:Number):void
brightnessproperty 
brightness:Number  [read-write]

Defines a coefficient for the overall light intensity.

Implementation
    public function get brightness():Number
    public function set brightness(value:Number):void
diffuseproperty 
diffuse:Number  [read-write]

Defines a coefficient for the diffuse light intensity.

Implementation
    public function get diffuse():Number
    public function set diffuse(value:Number):void
directionproperty 
direction:Number3D  [read-write]

Defines the direction of the light relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get direction():Number3D
    public function set direction(value:Number3D):void
sceneDirectionproperty 
sceneDirection:Number3D  [read-only]Implementation
    public function get sceneDirection():Number3D
specularproperty 
specular:Number  [read-write]

Defines a coefficient for the specular light intensity.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
DirectionalLight3D()constructor
public function DirectionalLight3D(init:Object = null)Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 direction:Number3D
 ambient:Number (default = 0.5, min:0, max:1)
 diffuse:Number (default = 0.5, min:0, max:10)
 specular:Number (default = 1, min:0, max:1)
 brightness:Number (default = 1)
 debug:Boolean (default = false)
Method detail
clone()method
public override function clone(light:AbstractLight = null):AbstractLight

Duplicates the light object's properties to another DirectionalLight3D object

Parameters
light:AbstractLight (default = null) — [optional] The new light instance into which all properties are copied

Returns
AbstractLight — The new light instance with duplicated properties applied
onSceneTransformChange()method 
protected override function onSceneTransformChange(event:Object3DEvent = null):void Parameters
event:Object3DEvent (default = null)
updateAmbientDiffuse()method 
protected override function updateAmbientDiffuse():void

Updates the bitmapData object used as the lightmap for the combined ambient and diffue light shading.

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

Code examples

Comments