com.jme3.light

Class DirectionalLight

java.lang.Object

com.jme3.light.Light

com.jme3.light.DirectionalLight

All Implemented Interfaces:

Savable, java.lang.Cloneable

public class DirectionalLight
extends Light

DirectionalLight is a light coming from a certain direction in world space. E.g. sun or moon light.

Directional lights have no specific position in the scene, they always come from their direction regardless of where an object is placed.

Nested Class Summary

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

Light.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector3f	direction

Fields inherited from class com.jme3.light.Light

color, enabled, lastDistance, name

Constructor Summary

Constructors

Constructor and Description
DirectionalLight() Creates a DirectionalLight
DirectionalLight(Vector3f direction) Creates a DirectionalLight with the given direction
DirectionalLight(Vector3f direction, ColorRGBA color) Creates a DirectionalLight with the given direction and the given color

Method Summary

Modifier and Type	Method and Description
DirectionalLight	clone()
void	computeLastDistance(Spatial owner) Used internally to compute the last distance value.
Vector3f	getDirection() Returns the direction vector of the light.
Light.Type	getType() Returns the light type
boolean	intersectsBox(BoundingBox box, TempVars vars) Determines if the light intersects with the given bounding box.
boolean	intersectsFrustum(Camera camera, TempVars vars) Determines if the light intersects with the given camera frustum.
boolean	intersectsSphere(BoundingSphere sphere, TempVars vars) Determines if the light intersects with the given bounding sphere.
void	read(JmeImporter im)
void	setDirection(Vector3f dir) Sets the direction of the light.
java.lang.String	toString()
void	write(JmeExporter ex)

Methods inherited from class com.jme3.light.Light

getColor, getName, isEnabled, isFrustumCheckNeeded, isIntersectsFrustum, setColor, setEnabled, setFrustumCheckNeeded, setIntersectsFrustum, setName

Methods inherited from class java.lang.Object

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

Field Detail

direction

protected Vector3f direction

Constructor Detail

DirectionalLight

public DirectionalLight()

Creates a DirectionalLight

DirectionalLight

public DirectionalLight(Vector3f direction)

Creates a DirectionalLight with the given direction

Parameters:

direction - the light's direction

DirectionalLight

public DirectionalLight(Vector3f direction,
                        ColorRGBA color)

Creates a DirectionalLight with the given direction and the given color

Parameters:

direction - the light's direction

color - the light's color

Method Detail

computeLastDistance

public void computeLastDistance(Spatial owner)

Description copied from class: Light

Used internally to compute the last distance value.

Specified by:

computeLastDistance in class Light

Parameters:

owner - the Spatial whose distance is to be determined

getDirection

public Vector3f getDirection()

Returns the direction vector of the light.

Returns:

The direction vector of the light.

See Also:

setDirection(com.jme3.math.Vector3f)

setDirection

public final void setDirection(Vector3f dir)

Sets the direction of the light.

Represents the direction the light is shining. (1, 0, 0) would represent light shining in the +X direction.

Parameters:

dir - the direction of the light.

intersectsBox

public boolean intersectsBox(BoundingBox box,
                             TempVars vars)

Description copied from class: Light

Determines if the light intersects with the given bounding box.

For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.

Specified by:

intersectsBox in class Light

Parameters:

box - The box to check intersection against.

vars - TempVars in case it is needed.

Returns:

True if the light intersects the box, false otherwise.

intersectsSphere

public boolean intersectsSphere(BoundingSphere sphere,
                                TempVars vars)

Description copied from class: Light

Determines if the light intersects with the given bounding sphere.

For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.

Specified by:

intersectsSphere in class Light

Parameters:

sphere - The sphere to check intersection against.

vars - TempVars in case it is needed.

Returns:

True if the light intersects the sphere, false otherwise.

intersectsFrustum

public boolean intersectsFrustum(Camera camera,
                                 TempVars vars)

Description copied from class: Light

Determines if the light intersects with the given camera frustum. For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.

Specified by:

intersectsFrustum in class Light

Parameters:

camera - The camera frustum to check intersection against.

vars - TempVars in case it is needed.

Returns:

True if the light intersects the frustum, false otherwise.

getType

public Light.Type getType()

Description copied from class: Light

Returns the light type

Specified by:

getType in class Light

Returns:

the light type

See Also:

Light.Type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

write

public void write(JmeExporter ex)
           throws java.io.IOException

Specified by:

write in interface Savable

Overrides:

write in class Light

Throws:

java.io.IOException

read

public void read(JmeImporter im)
          throws java.io.IOException

Specified by:

read in interface Savable

Overrides:

read in class Light

Throws:

java.io.IOException

clone

public DirectionalLight clone()

Overrides:

clone in class Light