graphicslib3D.light

Class Light

java.lang.Object

graphicslib3D.light.Light

Direct Known Subclasses:

DistantLight, PositionalLight

public abstract class Light
extends java.lang.Object

This class is the abstract base class from which different types of Lights are derived. It contains the attributes common to all Lights: a name and a set of ambient, diffuse, and specular reflection coefficients.

Author:

John Clevenger

Constructor Summary

Constructors

Constructor and Description
Light() Constructs a Light with default coefficients ambient = {0,0,0,1}, diffuse = {1,1,1,1}, and specular = {1,1,1,1} and a default name containing a unique trailing integer.

Method Summary

Modifier and Type	Method and Description
float[]	getAmbient() Returns a float [] containing the ambient reflection coefficients of this Light.
float[]	getDiffuse() Returns the diffuse reflection coefficients of this Light.
java.lang.String	getName() Returns the name of this Light.
float[]	getSpecular() Returns the specular reflection coefficients of this Light.
void	setAmbient(float[] amb) Sets the ambient reflection coefficients of this Light to the specified array of values.
void	setDiffuse(float[] diff) Sets the diffuse reflection coefficients of this Light to the specified array of values.
void	setName(java.lang.String newName) Sets the name of this Light to the specified String.
void	setSpecular(float[] spec) Sets the specular reflection coefficients of this Light to the specified array of values.
java.lang.String	toString() Returns a String representation of this Light, including the class name, the Light's name, and the ambient, diffuse, and specular reflection coefficients of the Light.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Light

public Light()

Constructs a Light with default coefficients ambient = {0,0,0,1}, diffuse = {1,1,1,1}, and specular = {1,1,1,1} and a default name containing a unique trailing integer.

Method Detail

getAmbient

public float[] getAmbient()

Returns a float [] containing the ambient reflection coefficients of this Light. The returned array is a clone of the light's coefficients; changing the contents of the returned array does not affect the light.

setAmbient

public void setAmbient(float[] amb)

Sets the ambient reflection coefficients of this Light to the specified array of values. The provided array is cloned; subsequent changes to the provided array do not affect the light values.

getDiffuse

public float[] getDiffuse()

Returns the diffuse reflection coefficients of this Light. The returned array is a clone of the light's coefficients; changing the contents of the returned array does not affect the light.

setDiffuse

public void setDiffuse(float[] diff)

Sets the diffuse reflection coefficients of this Light to the specified array of values. The provided array is cloned; subsequent changes to the provided array do not affect the light values.

getSpecular

public float[] getSpecular()

Returns the specular reflection coefficients of this Light. The returned array is a clone of the light's coefficients; changing the contents of the returned array does not affect the light.

setSpecular

public void setSpecular(float[] spec)

Sets the specular reflection coefficients of this Light to the specified array of values. The provided array is cloned; subsequent changes to the provided array do not affect the light values.

setName

public void setName(java.lang.String newName)

Sets the name of this Light to the specified String.

getName

public java.lang.String getName()

Returns the name of this Light.

toString

public java.lang.String toString()

Returns a String representation of this Light, including the class name, the Light's name, and the ambient, diffuse, and specular reflection coefficients of the Light.

Overrides:

toString in class java.lang.Object