Class SurfaceProperties

java.lang.Object
  extended by SurfaceProperties
All Implemented Interfaces:
CloneableEx, java.lang.Cloneable

public class SurfaceProperties
extends java.lang.Object
implements CloneableEx

A class to contain the surface properties of an object.


Constructor Summary
SurfaceProperties()
           
SurfaceProperties(javax.vecmath.Color3f diff, javax.vecmath.Color3f att, double specCoeff, double specExp, double elecPerm, double magPerm)
          Constructs a SurfaceProperties object with the specified parameters.
 
Method Summary
 java.lang.Object clone()
          Returns a copy of the object.
 javax.vecmath.Color3f getAttenuation()
          Returns the attenuation.
 javax.vecmath.Color3f getDiffuse()
          Returns the diffuse color.
 double getElectricPermittivity()
          Returns the electric permittivity.
 double getIndexOfRefraction()
          Returns the index of refraction as defined by the electric permittivity and the magnetic permeability.
 double getMagneticPermeability()
          Returns the magnetic permeability.
 double getSpecularCoefficient()
          Returns the specular coefficient.
 double getSpecularExponent()
          Returns the specular exponent.
 void setAttenuation(javax.vecmath.Color3f attenuation)
          Sets the attenuation.
 void setDiffuse(javax.vecmath.Color3f diffuse)
          Sets the diffuse color.
 void setElectricPermittivity(double electricPermittivity)
          Sets the electric permittivity.
 void setMagneticPermeability(double magneticPermeability)
          Sets the magnetic permeability.
 void setSpecularCoefficient(double specularCoefficient)
          Sets the specular coefficient.
 void setSpecularExponent(double specularExponent)
          Sets the specular exponent.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SurfaceProperties

public SurfaceProperties()

SurfaceProperties

public SurfaceProperties(javax.vecmath.Color3f diff,
                         javax.vecmath.Color3f att,
                         double specCoeff,
                         double specExp,
                         double elecPerm,
                         double magPerm)
Constructs a SurfaceProperties object with the specified parameters.

Parameters:
diff - The diffuse color of the object.
att - The attenuation of a ray caused by the object.
specCoeff - The specular coefficient of the object.
specExp - The specular exponent of the object.
elecPerm - The electric permittivitty of the object.
magPerm - The magnetic permeability of the object.
Method Detail

clone

public java.lang.Object clone()
Description copied from interface: CloneableEx
Returns a copy of the object.

Specified by:
clone in interface CloneableEx
Overrides:
clone in class java.lang.Object
Returns:
A copy of the object.

setDiffuse

public void setDiffuse(javax.vecmath.Color3f diffuse)
Sets the diffuse color.

Parameters:
diffuse - The diffuse color to set.

getDiffuse

public javax.vecmath.Color3f getDiffuse()
Returns the diffuse color.

Returns:
The diffuse color.

setAttenuation

public void setAttenuation(javax.vecmath.Color3f attenuation)
Sets the attenuation.

Parameters:
attenuation - The attenuation to set.

getAttenuation

public javax.vecmath.Color3f getAttenuation()
Returns the attenuation.

Returns:
The attenuation.

setSpecularCoefficient

public void setSpecularCoefficient(double specularCoefficient)
Sets the specular coefficient.

Parameters:
specularCoefficient - The specular coefficient to set.

getSpecularCoefficient

public double getSpecularCoefficient()
Returns the specular coefficient.

Returns:
The specular coefficient.

setSpecularExponent

public void setSpecularExponent(double specularExponent)
Sets the specular exponent.

Parameters:
specularExponent - The specular exponent to set.

getSpecularExponent

public double getSpecularExponent()
Returns the specular exponent.

Returns:
The specular exponent.

setElectricPermittivity

public void setElectricPermittivity(double electricPermittivity)
Sets the electric permittivity.

Parameters:
electricPermittivity - The electric permittivity to set.

getElectricPermittivity

public double getElectricPermittivity()
Returns the electric permittivity.

Returns:
The electric permittivity.

setMagneticPermeability

public void setMagneticPermeability(double magneticPermeability)
Sets the magnetic permeability.

Parameters:
magneticPermeability - The magnetic permeability to set.

getMagneticPermeability

public double getMagneticPermeability()
Returns the magnetic permeability.

Returns:
The magnetic permeability.

getIndexOfRefraction

public double getIndexOfRefraction()
Returns the index of refraction as defined by the electric permittivity and the magnetic permeability.

Returns:
The index of refraction.