away3d.lights.PointLight

Public Properties

	Property		Defined by
		bounds : BoundingVolumeBase The bounding volume approximating the volume occupied by the Entity.	Entity
		castsShadows : Boolean	LightBase
		color : uint The color of the light.	LightBase
		diffuse : Number The diffuse reflection strength of the light.	LightBase
		eulers : Vector3D Defines the rotation of the 3d object as a `Vector3D` object containing euler angles for rotation around x, y and z axis.	Object3D
		extra : Object An object that can contain any extra data.	Object3D
		fallOff : Number The fallOff component of the light.	PointLight
		inverseSceneTransform : Matrix3D The inverse scene transform object that transforms from world to model space.	ObjectContainer3D
		maxX : Number The maximum extremum of the object along the X-axis.	Entity
		maxY : Number The maximum extremum of the object along the Y-axis.	Entity
		maxZ : Number The maximum extremum of the object along the Z-axis.	Entity
		minX : Number The minimum extremum of the object along the X-axis.	Entity
		minY : Number The minimum extremum of the object along the Y-axis.	Entity
		minZ : Number The minimum extremum of the object along the Z-axis.	Entity
		modelViewProjection : 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
		mouseEnabled : Boolean Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.	Entity
		name : String The name of the object.	Object3D
		numChildren : uint The amount of child objects of the ObjectContainer3D.	ObjectContainer3D
		parent : ObjectContainer3D The parent ObjectContainer3D to which this object's transformation is relative.	ObjectContainer3D
		partition : 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
		pivotPoint : Vector3D Defines the local point around which the object rotates.	Object3D
		position : Vector3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		radius : Number The maximum distance of the light's reach.	PointLight
		rotationX : 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
		rotationY : 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
		rotationZ : 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
		scaleX : Number Defines the scale of the 3d object along the x-axis, relative to local coordinates.	Object3D
		scaleY : Number Defines the scale of the 3d object along the y-axis, relative to local coordinates.	Object3D
		scaleZ : Number Defines the scale of the 3d object along the z-axis, relative to local coordinates.	Object3D
		scenePosition : Vector3D The global position of the ObjectContainer3D in the scene.	ObjectContainer3D
		sceneTransform : Matrix3D The transformation matrix that transforms from model to world space.	ObjectContainer3D
		shadowMapper : ShadowMapperBase	LightBase
		specular : Number The specular reflection strength of the light.	LightBase
		transform : Matrix3D The local transformation matrix that transforms to the parent object's space.	ObjectContainer3D
		x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		zIndex : Number The distance of the IRenderable object to the view, used to sort per object.	Entity

	Property	Defined by
		_bounds : BoundingVolumeBase	Entity
		_boundsInvalid : Boolean = true	Entity
		_explicitPartition : Partition3D	ObjectContainer3D
		_fallOff : Number = 1.7976931348623157E308	PointLight
		_fragmentDirReg : ShaderRegisterElement	LightBase
		_implicitPartition : Partition3D	ObjectContainer3D
		_mvpIndex : int = -1	Entity
		_mvpTransformStack : Vector	Entity
		_parent : ObjectContainer3D	ObjectContainer3D
		_pivotPoint : Vector3D	Object3D
		_pivotZero : Boolean = true	Object3D
		_pos : Vector3D A calculation placeholder.	Object3D
		_radius : Number = 1.7976931348623157E308	PointLight
		_scaleX : Number = 1	Object3D
		_scaleY : Number = 1	Object3D
		_scaleZ : Number = 1	Object3D
		_scene : Scene3D	ObjectContainer3D
		_sceneTransform : Matrix3D	ObjectContainer3D
		_sceneTransformDirty : Boolean = true	ObjectContainer3D
		_shaderConstantIndex : uint	LightBase
		_stackLen : uint	Entity
		_transform : Matrix3D	Object3D
		_x : Number = 0	Object3D
		_y : Number = 0	Object3D
		_z : Number = 0	Object3D
		_zIndices : Vector	Entity

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		PointLight () Creates a new PointLight object.	PointLight
		addChild(child:ObjectContainer3D):ObjectContainer3D Adds a child ObjectContainer3D to the current object.	ObjectContainer3D
		addChildren(... childarray):void Adds an array of 3d objects to the scene as children of the container	ObjectContainer3D
		clone():Object3D	Object3D
		dispose(deep:Boolean):void Cleans up any resources used by the current object.	ObjectContainer3D
		getChildAt(index:uint):ObjectContainer3D Retrieves the child object at the given index.	ObjectContainer3D
		getEntityPartitionNode():EntityNode Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance	Entity
		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
		moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
		moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
		moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
		moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
		movePivot(dx:Number, dy:Number, dz:Number):void Moves the local point around which the object rotates.	Object3D
		moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
		moveTo(dx:Number, dy:Number, dz:Number):void Moves the 3d object directly to a point in space	Object3D
		moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
		pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
		popModelViewProjection():void Removes a model view projection matrix from the stack, used when leaving a render.	Entity
		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
		removeChild(child:ObjectContainer3D):void Removes a 3d object from the child array of the container	ObjectContainer3D
		roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
		rotate(axis:Vector3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
		rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
		scale(value:Number):void Appends a uniform scale to the current transformation.	Object3D
		translate(axis:Vector3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
		translateLocal(axis:Vector3D, distance:Number):void	ObjectContainer3D
		yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

	Method	Defined by
		createEntityPartitionNode():EntityNode Factory method that returns the current partition node.	LightBase
		createShadowMapper():ShadowMapperBase	LightBase
		getDefaultBoundingVolume():BoundingVolumeBase Creates the default bounding box to be used by this type of Entity.	PointLight
		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.	Entity
		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.	PointLight
		updateSceneTransform():void	PointLight
		updateTransform():void	Object3D

Property detail

_fallOff

property

protected var _fallOff:Number = 1.7976931348623157E308

fallOff

property

fallOff:Number [read-write]

The fallOff component of the light.

Implementation
public function get fallOff():Number
public function set fallOff(value:Number):void

positionBased

property

positionBased:Boolean [read-only]Implementation
arcane function get positionBased():Boolean

_radius

property

protected var _radius:Number = 1.7976931348623157E308

radius

property

radius:Number [read-write]

The maximum distance of the light's reach.

Implementation
public function get radius():Number
public function set radius(value:Number):void

Constructor detail

PointLight

()

constructor

public function PointLight() Init Parameters

Method detail

getAttenuationCode

()

method

arcane override function getAttenuationCode(regCache:ShaderRegisterCache, targetReg:ShaderRegisterElement):String Parameters

	`regCache:ShaderRegisterCache`

	`targetReg:ShaderRegisterElement`

Returns

String

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

getObjectProjectionMatrix

()

method

arcane override 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.

getVertexCode

()

method

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

Parameters

	`regCache:ShaderRegisterCache`

	`globalPositionRegister:ShaderRegisterElement`

Returns

String

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

Wiki link

Click to go to the wiki page for 'away3d.lights.PointLight'

Code examples

Comments

Broomstick FP11 Trunk (as on 30-Mar-2011)	All Packages \| All Classes \| Index \| Frames No Frames
Class PointLight		Properties \| Methods

Package	away3d.lights
Class	public class PointLight
Inheritance	PointLight LightBase Entity ObjectContainer3D Object3D flash.events.EventDispatcher