Bouncy Castle Rendering Toolkit 1.0

org.bouncycastle.graphics.rt.objects
Class DistantLight

java.lang.Object
  |
  +--org.bouncycastle.graphics.rt.objects.DistantLight
All Implemented Interfaces:
Light

public class DistantLight
extends java.lang.Object
implements Light

a distant light. Basically this emulates a point light source so far away that, to the world, the rays coming from the light source are parallel - it's kind of like the sun! By default is affects all objects unless the addAffected method is used, in which case it only affects those objects specified.

Example:

      <DistantLight direction="0, 0, -1" color="0.8, 0.7, 1"/>
 

Document Type Definition:

     <!ENTITY %Float    "CDATA">
     <!ENTITY %Color3f  "CDATA">
     <!ENTITY %Vector3f "CDATA">

     <!ELEMENT DistantLight EMPTY>
     <!ATTLIST DistantLight
         color        %Color3f;  "1, 1, 1"
         direction    %Vector3f; "0, 0, 1">
 


Constructor Summary
DistantLight(Vector3f dir, Color3f col)
          basic constructor.
 
Method Summary
 void addAffected(Renderable obj)
           
static Light getInstance(RMLReader in)
           
 LightData getLightData(Hit hit, Illuminated world)
           
 void setShadows(boolean shadows)
          set whether or not this light can be occluded.
 void transform(Transform trans)
          transform the location of the light.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DistantLight

public DistantLight(Vector3f dir,
                    Color3f col)
basic constructor.
Parameters:
dir - the direction of the incoming light.
col - the color of the incoming light.
Method Detail

getInstance

public static Light getInstance(RMLReader in)
                         throws java.io.IOException

setShadows

public void setShadows(boolean shadows)
set whether or not this light can be occluded.
Specified by:
setShadows in interface Light

transform

public void transform(Transform trans)
transform the location of the light.
Specified by:
transform in interface Light

addAffected

public void addAffected(Renderable obj)
Specified by:
addAffected in interface Light

getLightData

public LightData getLightData(Hit hit,
                              Illuminated world)
Specified by:
getLightData in interface Light

Bouncy Castle Rendering Toolkit 1.0