org.j3d.aviatrix3d
Class DirectionalLight

java.lang.Object
  org.j3d.aviatrix3d.SceneGraphObject
      org.j3d.aviatrix3d.Node
          org.j3d.aviatrix3d.Leaf
              org.j3d.aviatrix3d.Light
                  org.j3d.aviatrix3d.DirectionalLight

All Implemented Interfaces:

java.lang.Comparable, CascadeRenderable, ComponentRenderable, Cullable, EffectRenderable, LeafCullable, Renderable

public class DirectionalLight
extends Light

Representation of a directional light source.

A directional light has a direction, but no location. This implementation uses the OpenGL convention of having the light vector pointed in the opposite direction to where you think the light is pointing.

Version:

$Revision: 1.19 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.j3d.aviatrix3d.Light

AMBIENT_TYPE, ambientColor, diffuseColor, DIRECTIONAL_TYPE, effectBounds, enabled, globalOnly, INVALID_ALPHA_PROP, INVALID_BLUE_PROP, INVALID_GREEN_PROP, INVALID_RED_PROP, POINT_TYPE, specularColor, SPOT_TYPE

Fields inherited from class org.j3d.aviatrix3d.Node

bounds, implicitBounds, INVALID_BOUNDS, parent

Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject

alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler

Fields inherited from interface org.j3d.aviatrix3d.rendering.LeafCullable

AUDIO_CULLABLE, CLIP_CULLABLE, FOG_CULLABLE, GEOMETRY_CULLABLE, LIGHT_CULLABLE, OVERRIDE_CULLABLE

Constructor Summary

DirectionalLight()
Creates a light with the colour set to black.

DirectionalLight(float[] col)
Create a light with the given base colour.Colour must be in the range [0, 1] otherwise an exception is generated.

DirectionalLight(float[] col, float[] dir)
Create a light with the given base colour.Colour must be in the range [0, 1] otherwise an exception is generated.

Method Summary

int	compareTo(Light l) Compares this object with the specified object for order.
void	getDirection(float[] dir) Retrieve the current direction vector from the light.
protected void	markBoundsDirty() Mark this node as having dirty bounds due to one of it's children having their bounds changed.
void	postRender(javax.media.opengl.GL gl, java.lang.Object lightId)
void	render(javax.media.opengl.GL gl, java.lang.Object lightId) Overloaded form of the render() method to render the light details given the specific Light ID used by OpenGL.
void	setDirection(float[] dir) Set the direction to the new value.
void	setDirection(float x, float y, float z) Set the direction to the new value.

Methods inherited from class org.j3d.aviatrix3d.Light

compareColor3, compareTo, getAmbientColor, getCullableType, getDiffuseColor, getEffectBounds, getRenderable, getSpecularColor, isEnabled, isGlobalOnly, setAmbientColor, setDiffuseColor, setEffectBounds, setEnabled, setGlobalOnly, setSpecularColor

Methods inherited from class org.j3d.aviatrix3d.Node

boundsChanged, checkForCyclicParent, getBounds, getParent, recomputeBounds, removeParent, requestBoundsUpdate, setBounds, setParent, updateBounds, updateParentBounds

Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject

checkForCyclicChild, dataChanged, getAppUpdateWriteTimingMessage, getBoundsWriteTimingMessage, getDataWriteTimingMessage, getUserData, isLive, setLive, setUpdateHandler, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.j3d.aviatrix3d.rendering.LeafCullable

getBounds

Methods inherited from interface org.j3d.aviatrix3d.rendering.Renderable

equals

Constructor Detail

DirectionalLight

public DirectionalLight()

Creates a light with the colour set to black.

DirectionalLight

public DirectionalLight(float[] col)
                 throws java.lang.IllegalArgumentException

Create a light with the given base colour.Colour must be in the range [0, 1] otherwise an exception is generated.

Parameters:

col - The new colour value to use

Throws:

java.lang.IllegalArgumentException

DirectionalLight

public DirectionalLight(float[] col,
                        float[] dir)
                 throws java.lang.IllegalArgumentException

Create a light with the given base colour.Colour must be in the range [0, 1] otherwise an exception is generated.

Parameters:

col - The new colour value to use

dir - The direction of the light

Throws:

java.lang.IllegalArgumentException

Method Detail

render

public void render(javax.media.opengl.GL gl,
                   java.lang.Object lightId)

Overloaded form of the render() method to render the light details given the specific Light ID used by OpenGL. Since the active light ID for this node may vary over time, a fixed ID cannot be used by OpenGL. The renderer will always call this method rather than the normal render() method. The normal post render will still be called

Parameters:

gl - The GL context to render with

lightId - the ID of the light to make GL calls with

postRender

public void postRender(javax.media.opengl.GL gl,
                       java.lang.Object lightId)

markBoundsDirty

protected void markBoundsDirty()

Mark this node as having dirty bounds due to one of it's children having their bounds changed.

Overrides:

markBoundsDirty in class Node

setDirection

public void setDirection(float[] dir)
                  throws InvalidWriteTimingException

Set the direction to the new value. Direction is a vector that the light is shining.

Parameters:

dir - The new direction value to use

Throws:

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

setDirection

public void setDirection(float x,
                         float y,
                         float z)
                  throws InvalidWriteTimingException

Set the direction to the new value. Direction is a vector that the light is shining.

Parameters:

x - The x component of the direction value to use

y - The y component of the direction value to use

z - The z component of the direction value to use

Throws:

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

getDirection

public void getDirection(float[] dir)

Retrieve the current direction vector from the light.

Parameters:

dir - An array to copy the direction into

compareTo

public int compareTo(Light l)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Overrides:

compareTo in class Light

Parameters:

l - The light instance to be compared

Returns:

-1, 0 or 1 depending on order