j3d.org Aviatrix3D

org.j3d.aviatrix3d
Class DirectionalLight

java.lang.Object
  extended byorg.j3d.aviatrix3d.SceneGraphObject
      extended byorg.j3d.aviatrix3d.Node
          extended byorg.j3d.aviatrix3d.Leaf
              extended byorg.j3d.aviatrix3d.Light
                  extended byorg.j3d.aviatrix3d.DirectionalLight

public class DirectionalLight
extends Light

Representation of a directional light source.

A directional light has a direction, but no location.

Version:
$Revision: 1.7 $
Author:
Justin Couch

Field Summary
 
Fields inherited from class org.j3d.aviatrix3d.Light
diffuseColor, enabled, specularColor
 
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
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
 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(net.java.games.jogl.GL gl, net.java.games.jogl.GLU glu)
           
 void postRender(net.java.games.jogl.GL gl, net.java.games.jogl.GLU glu, int lightId)
           
 void render(net.java.games.jogl.GL gl, net.java.games.jogl.GLU glu)
          This method is called to render this node.
 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 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
getDiffuseColor, getSpecularColor, isEnabled, setDiffuseColor, setEnabled, setSpecularColor
 
Methods inherited from class org.j3d.aviatrix3d.Node
boundsChanged, checkForCyclicParent, getBounds, getParent, recomputeBounds, removeParent, 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
 

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

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
Method Detail

render

public 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

Specified by:
render in class Light
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 void postRender(net.java.games.jogl.GL gl,
                       net.java.games.jogl.GLU glu,
                       int lightId)
Specified by:
postRender in class Light

render

public void render(net.java.games.jogl.GL gl,
                   net.java.games.jogl.GLU glu)
This method is called to render this node. All openGL commands needed to render the node should be executed. Any transformations needed should be added to the transformation stack premultiplied. This method must be re-entrant as it can be called from multiple places at once.

Overrides:
render in class Node
Parameters:
gl - The GL context to render with
glu - The GL utility context to render with

postRender

public void postRender(net.java.games.jogl.GL gl,
                       net.java.games.jogl.GLU glu)
Overrides:
postRender in class Node

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 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 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

j3d.org Aviatrix3D

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