j3d.org Aviatrix3D

org.j3d.aviatrix3d
Class Light

java.lang.Object
  extended byorg.j3d.aviatrix3d.SceneGraphObject
      extended byorg.j3d.aviatrix3d.Node
          extended byorg.j3d.aviatrix3d.Leaf
              extended byorg.j3d.aviatrix3d.Light
All Implemented Interfaces:
java.lang.Comparable
Direct Known Subclasses:
AmbientLight, DirectionalLight, PointLight, SpotLight

public abstract class Light
extends Leaf
implements java.lang.Comparable

Base representation of a light source that corresponds to the base set of capabilities that all lights in OpenGL have.

By default a light is not enabled and the colour is set to black. Lights also have a secondary specular value that can be provided. By default it is black (ie has no effect). An ambient component can also be provided with this light source in addition to it's derived effects.

Version:
$Revision: 1.10 $
Author:
Justin Couch

Field Summary
protected static int AMBIENT_TYPE
          Internal type to describe that this is a pure ambient light type
protected  float[] ambientColor
          The colour of the light
protected  float[] diffuseColor
          The colour of the light
protected static int DIRECTIONAL_TYPE
          Internal type to describe that this is a directional light type
protected  boolean enabled
          The enabled state
protected static int POINT_TYPE
          Internal type to describe that this is a point light type
protected  float[] specularColor
          The colour of the light
protected static int SPOT_TYPE
          Internal type to describe that this is a spotlight light type
 
Fields inherited from class org.j3d.aviatrix3d.Node
bounds, implicitBounds, INVALID_BOUNDS, parent
 
Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject
alive, updateHandler, WRITE_TIMING_MSG
 
Constructor Summary
protected Light(int type)
          Creates a light with the colour and specular colour set to black.
protected Light(int type, float[] diffuse)
          Create a light with the given base diffuse colour.Colour must be in the range [0, 1] otherwise an exception is generated.
 
Method Summary
protected  int compareColor3(float[] a, float[] b)
          Compare 2 color arrays of length 3 for equality
 int compareTo(Light l)
          Compares this object with the specified object for order.
 int compareTo(java.lang.Object o)
          Compares this object with the specified object for order.
 void getAmbientColor(float[] col)
          Retrieve the current colour value from the light.
 void getDiffuseColor(float[] col)
          Retrieve the current diffuse colour value from the light.
 void getSpecularColor(float[] col)
          Retrieve the current colour value from the light.
 boolean isEnabled()
          Get the current enabled state of the light.
abstract  void postRender(net.java.games.jogl.GL gl, net.java.games.jogl.GLU glu, int lightId)
           
abstract  void render(net.java.games.jogl.GL gl, net.java.games.jogl.GLU glu, int lightId)
          Overloaded form of the render() method to render the light details given the specific Light ID used by OpenGL.
 void setAmbientColor(float[] col)
          Set the ambient colour to the new value.
 void setDiffuseColor(float[] col)
          Set the diffuse colour component to the new value.
 void setEnabled(boolean state)
          Set the enabled state of the light.
 void setSpecularColor(float[] col)
          Set the colour to the new value.
 
Methods inherited from class org.j3d.aviatrix3d.Node
boundsChanged, checkForCyclicParent, getBounds, getParent, markBoundsDirty, postRender, recomputeBounds, removeParent, render, setBounds, setLive, setParent, updateBounds
 
Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject
checkForCyclicChild, dataChanged, getUserData, isLive, setUpdateHandler, setUserData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SPOT_TYPE

protected static final int SPOT_TYPE
Internal type to describe that this is a spotlight light type

See Also:
Constant Field Values

POINT_TYPE

protected static final int POINT_TYPE
Internal type to describe that this is a point light type

See Also:
Constant Field Values

DIRECTIONAL_TYPE

protected static final int DIRECTIONAL_TYPE
Internal type to describe that this is a directional light type

See Also:
Constant Field Values

AMBIENT_TYPE

protected static final int AMBIENT_TYPE
Internal type to describe that this is a pure ambient light type

See Also:
Constant Field Values

ambientColor

protected float[] ambientColor
The colour of the light


diffuseColor

protected float[] diffuseColor
The colour of the light


specularColor

protected float[] specularColor
The colour of the light


enabled

protected boolean enabled
The enabled state

Constructor Detail

Light

protected Light(int type)
Creates a light with the colour and specular colour set to black.

Parameters:
type - The type of light that this one is

Light

protected Light(int type,
                float[] diffuse)
         throws java.lang.IllegalArgumentException
Create a light with the given base diffuse colour.Colour must be in the range [0, 1] otherwise an exception is generated.

Parameters:
type - The type of light that this one is
Throws:
java.lang.IllegalArgumentException - The colour value is out of range
Method Detail

compareTo

public int compareTo(java.lang.Object o)
              throws java.lang.ClassCastException
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.

Derived classes should extend this one to add the extra comparisons needed.

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
o - The object to be compared
Returns:
-1, 0 or 1 depending on order
Throws:
java.lang.ClassCastException - The specified object's type prevents it from being compared to this Object

render

public abstract void render(net.java.games.jogl.GL gl,
                            net.java.games.jogl.GLU glu,
                            int 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
glu - The GL utility context to render with
lightId - the ID of the light to make GL calls with

postRender

public abstract void postRender(net.java.games.jogl.GL gl,
                                net.java.games.jogl.GLU glu,
                                int lightId)

setEnabled

public void setEnabled(boolean state)
                throws InvalidWriteTimingException
Set the enabled state of the light. Can use this to turn it on and off in a general fashion.

Parameters:
state - The new state of the light
Throws:
InvalidWriteTimingException

isEnabled

public boolean isEnabled()
Get the current enabled state of the light.

Returns:
The current state

setAmbientColor

public void setAmbientColor(float[] col)
                     throws java.lang.IllegalArgumentException,
                            InvalidWriteTimingException
Set the ambient colour to the new value. 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 - The colour value is out of range
InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener callback method
InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener callback method

getAmbientColor

public void getAmbientColor(float[] col)
Retrieve the current colour value from the light.

Parameters:
col - An array to copy the colour value into

setDiffuseColor

public void setDiffuseColor(float[] col)
                     throws java.lang.IllegalArgumentException,
                            InvalidWriteTimingException
Set the diffuse colour component to the new value. 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 - The colour value is out of range
InvalidWriteTimingException

getDiffuseColor

public void getDiffuseColor(float[] col)
Retrieve the current diffuse colour value from the light.

Parameters:
col - An array to copy the colour value into

setSpecularColor

public void setSpecularColor(float[] col)
                      throws java.lang.IllegalArgumentException,
                             InvalidWriteTimingException
Set the colour to the new value. 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 - The colour value is out of range
InvalidWriteTimingException

getSpecularColor

public void getSpecularColor(float[] col)
Retrieve the current colour value from the light.

Parameters:
col - An array to copy the colour value 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.

Parameters:
l - The light instance to be compared
Returns:
-1, 0 or 1 depending on order

compareColor3

protected int compareColor3(float[] a,
                            float[] b)
Compare 2 color arrays of length 3 for equality

Parameters:
a - The first colour array to check
b - The first colour array to check
Returns:
-1 if a[i] < b[i], +1 if a[i] > b[i], otherwise 0

j3d.org Aviatrix3D

Latest Info from http://aviatrix3d.j3d.org/
Copyright © 2003 - j3d.org