Packageaway3d.lights
Classpublic class PointLight3D
InheritancePointLight3D Inheritance AbstractLight

Lightsource that colors all shaded materials proportional to the dot product of the distance vector with the normal vector. The scalar value of the distance is used to calulate intensity using the inverse square law of attenuation.

Public Properties
 PropertyDefined by
  ambient : Number
Defines a coefficient for the ambient light intensity.
PointLight3D
  brightness : Number
Defines a coefficient for the overall light intensity.
PointLight3D
 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.
PointLight3D
  fallOff : Number
Defines the max length of the light rays, beyond this distance, light doesn't have influence the light values are from radius 100% to falloff 0%
PointLight3D
 Inheritedparent : ObjectContainer3D
Defines the parent of the light.
AbstractLight
  position : Number3D
Defines the position of the light relative to the local coordinates of the parent ObjectContainer3D.
PointLight3D
  radius : Number
Defines the radius of the light at full intensity, infleunced object get within this range full color of the light
PointLight3D
  scenePosition : Number3D
[read-only]
PointLight3D
  specular : Number
Defines a coefficient for the specular light intensity.
PointLight3D
  x : Number
Defines the x coordinate of the light relative to the local coordinates of the parent ObjectContainer3D.
PointLight3D
  y : Number
Defines the y coordinate of the light relative to the local coordinates of the parent ObjectContainer3D.
PointLight3D
  z : Number
Defines the z coordinate of the light relative to the local coordinates of the parent ObjectContainer3D.
PointLight3D
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
  
PointLight3D
(init:Object = null)
Creates a new PointLight3D object.
PointLight3D
  
clone(light:AbstractLight = null):AbstractLight
Duplicates the light object's properties to another PointLight3D object
PointLight3D
  
light(consumer:ILightConsumer):void
Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object
PointLight3D
Property detail
ambientproperty
public var ambient:Number

Defines a coefficient for the ambient light intensity.

brightnessproperty 
public var brightness:Number

Defines a coefficient for the overall light intensity.

diffuseproperty 
public var diffuse:Number

Defines a coefficient for the diffuse light intensity.

fallOffproperty 
fallOff:Number  [read-write]

Defines the max length of the light rays, beyond this distance, light doesn't have influence the light values are from radius 100% to falloff 0%

Implementation
    public function get fallOff():Number
    public function set fallOff(value:Number):void
positionproperty 
position:Number3D  [read-write]

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

Implementation
    public function get position():Number3D
    public function set position(value:Number3D):void
radiusproperty 
radius:Number  [read-write]

Defines the radius of the light at full intensity, infleunced object get within this range full color of the light

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
scenePositionproperty 
scenePosition:Number3D  [read-only]Implementation
    public function get scenePosition():Number3D
specularproperty 
public var specular:Number

Defines a coefficient for the specular light intensity.

xproperty 
x:Number  [read-write]

Defines the x coordinate of the light relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number  [read-write]

Defines the y coordinate of the light relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get y():Number
    public function set y(value:Number):void
zproperty 
z:Number  [read-write]

Defines the z coordinate of the light relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get z():Number
    public function set z(value:Number):void
Constructor detail
PointLight3D()constructor
public function PointLight3D(init:Object = null)Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 x:Number (default = 0)
 y:Number (default = 0)
 z:Number (default = 0)
 ambient:Number (default = 1)
 diffuse:Number (default = 1)
 specular:Number (default = 1)
 brightness:Number (default = 1)
 radius:Number (default = 50)
 fallOff:Number (default = 1000)
Method detail
clone()method
public override function clone(light:AbstractLight = null):AbstractLight

Duplicates the light object's properties to another PointLight3D 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
light()method 
public override function light(consumer:ILightConsumer):void

Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object

Parameters
consumer:ILightConsumer
Wiki link
Click to go to the wiki page for 'away3d.lights.PointLight3D'

Code examples

Comments