net.sf.j3d.threeD.raytracer.shaders
Class RefractionShader

java.lang.Object
  net.sf.j3d.threeD.raytracer.shaders.RefractionShader

All Implemented Interfaces:

ColorProducer, Shader, Editable, Producer

public class RefractionShader
extends Object
implements Shader, Editable

A RefractionShader object provides a shading method for dielectric surfaces.

Author:

Mike Murray

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.j3d.threeD.raytracer.util.Editable

Editable.Selection

Field Summary

static Vector	lastRay
static boolean	produceOutput

Constructor Summary

RefractionShader()
Constructs a new RefractionShader object.

Method Summary

boolean	checkEntering(Vector d, Vector n)
RGB	evaluate(Object[] args) Produces a color using the specified arguments.
double[]	getAttenuationFactors() Returns the 3 attenuation factors (RGB) used by this RefractionShader object.
double	getIndexOfRefraction() Returns the index of refraction value used by this RefractionShader object.
Producer[]	getInputPropertyValues()
String[]	getPropertyDescriptions() Returns an array of String objects with descriptions for each editable property of this RefractionShader object.
String[]	getPropertyNames() Returns an array of String objects with names for each editable property of this RefractionShader object.
Class[]	getPropertyTypes() Returns an array of Class objects representing the class types of each editable property of this RefractionShader object.
Object[]	getPropertyValues() Returns the values of the properties of this ReflectionShader object as an Object array.
Vector	refract(Vector n, Vector d, double rindex, double eindex)
double	sampleDensity(AbstractSurface s, Vector p, Vector n, double sd, int samples, boolean entering)
void	setAttenuationFactors(double r, double g, double b) Sets the attenuation factors used by this RefractionShader object.
void	setIndexOfRefraction(double n) Sets the index of refraction value used by this RefractionShader object.
void	setInputPropertyValue(int index, Producer p) Does nothing.
void	setPropertyValue(Object value, int index) Sets the value of the property of this RefractionShader object at the specified index to the specified value.
void	setPropertyValues(Object[] values) Sets the values of editable properties of this ReflectionShader object to those specified.
RGB	shade(ShaderParameters p) Method specified by the Shader interface.
RGB	shade(Vector point, Vector viewerDirection, Vector lightDirection, Light light, Light[] otherLights, Surface surface, Surface[] otherSurfaces, Vector n, ShaderParameters p)
String	toString() Returns "Refraction Shader".

Methods inherited from class java.lang.Object

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

Field Detail

lastRay

public static Vector lastRay

produceOutput

public static boolean produceOutput

Constructor Detail

RefractionShader

public RefractionShader()

Constructs a new RefractionShader object.

Method Detail

shade

public RGB shade(ShaderParameters p)

Method specified by the Shader interface.

Specified by:

shade in interface Shader

shade

public RGB shade(Vector point,
                 Vector viewerDirection,
                 Vector lightDirection,
                 Light light,
                 Light[] otherLights,
                 Surface surface,
                 Surface[] otherSurfaces,
                 Vector n,
                 ShaderParameters p)

sampleDensity

public double sampleDensity(AbstractSurface s,
                            Vector p,
                            Vector n,
                            double sd,
                            int samples,
                            boolean entering)

checkEntering

public boolean checkEntering(Vector d,
                             Vector n)

refract

public Vector refract(Vector n,
                      Vector d,
                      double rindex,
                      double eindex)

evaluate

public RGB evaluate(Object[] args)

Description copied from interface: ColorProducer

Produces a color using the specified arguments.

Specified by:

evaluate in interface ColorProducer

Parameters:

args - Arguments.

Returns:

this.shade(args[0]).

Throws:

IllegalArgumentException - If args[0] is not a ShaderParameters object.

setIndexOfRefraction

public void setIndexOfRefraction(double n)

Sets the index of refraction value used by this RefractionShader object.

setAttenuationFactors

public void setAttenuationFactors(double r,
                                  double g,
                                  double b)

Sets the attenuation factors used by this RefractionShader object.

getIndexOfRefraction

public double getIndexOfRefraction()

Returns the index of refraction value used by this RefractionShader object.

getAttenuationFactors

public double[] getAttenuationFactors()

Returns the 3 attenuation factors (RGB) used by this RefractionShader object.

getPropertyNames

public String[] getPropertyNames()

Returns an array of String objects with names for each editable property of this RefractionShader object.

Specified by:

getPropertyNames in interface Editable

getPropertyDescriptions

public String[] getPropertyDescriptions()

Returns an array of String objects with descriptions for each editable property of this RefractionShader object.

Specified by:

getPropertyDescriptions in interface Editable

getPropertyTypes

public Class[] getPropertyTypes()

Returns an array of Class objects representing the class types of each editable property of this RefractionShader object.

Specified by:

getPropertyTypes in interface Editable

getPropertyValues

public Object[] getPropertyValues()

Returns the values of the properties of this ReflectionShader object as an Object array.

Specified by:

getPropertyValues in interface Editable

setPropertyValue

public void setPropertyValue(Object value,
                             int index)

Sets the value of the property of this RefractionShader object at the specified index to the specified value.

Specified by:

setPropertyValue in interface Editable

Throws:

IllegalArgumentException - If the object specified is not of the correct type.

IndexOutOfBoundsException - If the index specified does not correspond to an editable property of this RefractionShader object.

getInputPropertyValues

public Producer[] getInputPropertyValues()

Specified by:

getInputPropertyValues in interface Editable

Returns:

An empty array.

setInputPropertyValue

public void setInputPropertyValue(int index,
                                  Producer p)

Does nothing.

Specified by:

setInputPropertyValue in interface Editable

Parameters:

index - Index of input property (array index from this.getInputPropertyValue).

p - Producer object to use for input property.

setPropertyValues

public void setPropertyValues(Object[] values)

Sets the values of editable properties of this ReflectionShader object to those specified.

Specified by:

setPropertyValues in interface Editable

Throws:

IllegalArgumentException - If one of the objects specified is not of the correct type. (Note: none of the values after the erroneous value will be set)

IndexOutOfBoundsException - If the length of the specified array is longer than permitted.

toString

public String toString()

Returns "Refraction Shader".

Overrides:

toString in class Object