Package com.ardor3d.light

Class DirectionalLight

java.lang.Object

com.ardor3d.light.Light

com.ardor3d.light.DirectionalLight

All Implemented Interfaces:

Savable, Serializable

public class DirectionalLight
extends Light

DirectionalLight defines a light that is assumed to be infinitely far away (something similar to the sun). This means the direction of the light rays are all parallel. The direction field of this class identifies the direction in which the light is traveling, which is opposite how jME works.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ardor3d.light.Light

Light.Type

Field Summary

Fields inherited from class com.ardor3d.light.Light

_shadowCaster, DEFAULT_AMBIENT, DEFAULT_DIFFUSE, DEFAULT_SPECULAR

Constructor Summary

Constructors

Constructor	Description
DirectionalLight()	Constructor instantiates a new DirectionalLight object.

Method Summary

Modifier and Type	Method	Description
ReadOnlyVector3	getDirection()
Light.Type	getType()	getType returns this light's type (Type.Directional).
void	read(InputCapsule capsule)
void	setDirection(double x, double y, double z)
void	setDirection(ReadOnlyVector3 direction)
void	write(OutputCapsule capsule)

Methods inherited from class com.ardor3d.light.Light

copyFrom, getAmbient, getClassTag, getConstant, getDiffuse, getLightMask, getLinear, getName, getQuadratic, getSpecular, isAttenuate, isEnabled, isShadowCaster, popLightMask, pushLightMask, setAmbient, setAttenuate, setConstant, setDiffuse, setEnabled, setLightMask, setLinear, setName, setQuadratic, setShadowCaster, setSpecular

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DirectionalLight

public DirectionalLight()

Constructor instantiates a new DirectionalLight object. The initial light colors are white and the direction the light travels is along the positive z axis (0,0,1).

Method Details

getDirection

public ReadOnlyVector3 getDirection()

Returns:

the direction the light traveling in.

setDirection

public void setDirection(ReadOnlyVector3 direction)

Parameters:

direction - the direction the light is traveling in.

setDirection

public void setDirection(double x,
 double y,
 double z)

Parameters:

x - the direction the light is traveling in on the x axis.

y - the direction the light is traveling in on the y axis.

z - the direction the light is traveling in on the z axis.

getType

public Light.Type getType()

getType returns this light's type (Type.Directional).

Specified by:

getType in class Light

Returns:

the type of light that has been created.

See Also:

• Light.getType()

write

public void write(OutputCapsule capsule)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class Light

Throws:

IOException

read

public void read(InputCapsule capsule)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class Light

Throws:

IOException