A B C D E F G I K L M N O P R S T U V W X Y Z

A

add(Colour) - Method in class Colour

Add the given colour to this colour

add(Colour, Colour) - Static method in class Colour

Static implementation of colour add function that creates a new colour object from the result.

add(Colour, Colour, Colour) - Static method in class Colour

Static implementation of colour add function that write the result of the addition to a given colour object.

add(Point, Point, Vector) - Static method in class Point

Static function that write addition of a point by adding a vector to a given destiation point

add(Point, Vector) - Static method in class Point

Static function create a new point by adding a vector to a point.

add(Vector) - Method in class Point

Add the given offset vector to this point

add(Vector) - Method in class Vector

Add the given vector to this vector

add(Vector, Vector) - Static method in class Vector

Static function to sum two vector and write it to a given destination vector.

add(Vector, Vector, Vector) - Static method in class Vector

Static function to sum two vectors and write it to a given destination vector.

Ambient - Variable in class Material

Holds the ambient component of this surface

Ambient - Variable in class Scene

B

B - Variable in class Colour

Holds the blue component of the colour

C

Camera - class Camera.

Camera extends simple camera with the ability to specify the VPN, VUV and VRP.

Camera() - Constructor for class Camera

Create a default camera that behaves as a SimpleCamera

Camera(Camera) - Constructor for class Camera

Create a camera by copying an existing camera

Centre - Variable in class Sphere

Holds the point that defines the sphere centre

clamp() - Method in class Colour

Clamp each component of the colour to lie within the range 0.0 to 1.0

close() - Method in class SceneReader

Close the file when finished

close() - Method in class SceneWriter

Close the file when finished

Colour - class Colour.

Colour stores a RGB triple and supports several operations to manipulate colour values

Colour() - Constructor for class Colour

Create a new colour and set it to the default colour (black)

Colour(Colour) - Constructor for class Colour

Create a new colour by copying an existing colour

Colour(double, double, double) - Constructor for class Colour

Create a new colour with the given red green and blue values

Constant - Variable in class Plane

Holds the constant of the plane equation

copy(Colour) - Method in class Colour

Copying an existing colour to this colour

copy(Point) - Method in class Point

Copy an existing point to this point

copy(Vector) - Method in class Vector

Copy an existing vector to this vector

cross(Vector) - Method in class Vector

Cross product the given vector with this vector

cross(Vector, Vector) - Static method in class Vector

Static cross product methods that creates a new vector with the cross product of the two given vectors.

cross(Vector, Vector, Vector) - Static method in class Vector

Static cross product methods that write the cross product of the two given vectors to the given desination vector.

D

Diffuse - Variable in class Material

Holds the ambient component of this surface

Direction - Variable in class DirectionalLight

Stores the direction the light travels in.

Direction - Variable in class Ray

Holds the ray direction

DirectionalLight - class DirectionalLight.

DirectionalLight represents a light source that illuminates along parallel rays.

DirectionalLight() - Constructor for class DirectionalLight

Create a default light.

DirectionalLight(Vector) - Constructor for class DirectionalLight

Create a new directional light that shines along given direction vector.

dot(Point) - Method in class Vector

Dot product the given vector with a point

dot(Vector) - Method in class Vector

Dot product the given vector with this vector

dot(Vector, Vector) - Static method in class Vector

Static method that returns the dot product of the two given * vectors.

E

eof() - Method in class SceneReader

Return true if the end of file has been reached.

equals(Point) - Method in class Point

Test if two points are equal

F

flush() - Method in class SceneWriter

Flush the writer

G

G - Variable in class Colour

Holds the green component of the colour

getColor() - Method in class Colour

Create a standard java Color object from this colour for rendering purposes.

getInvViewMatrix() - Method in class Camera

Get the VC to WC mapping matrix Note the matrix is copied not referenced.

getNumberLights() - Method in class Scene

getNumberObjects() - Method in class Scene

getPointAt(double) - Method in class Ray

Get a point along a ray.

getValue(int, int) - Method in class Matrix

getViewMatrix() - Method in class Camera

Get the WC to VC mapping matrix Note the matrix is copied not referenced.

getVPN() - Method in class Camera

Get the view plane normal.

getVRP() - Method in class Camera

Get the view reference point Note the point is copied not referenced.

getVUV() - Method in class Camera

Get the view up vector Note the vector is copied not referenced.

I

init() - Method in class SimpleRay

Method for applet initialise The scene to read is taken from the "scene" property in the applet tag on the web page.

initBasic(int, int) - Method in class SimpleCamera

Intensity - Variable in class Light

Holds the colour of this light

intersect(Ray) - Method in class Object

Find the intersection of an object and a given ray.

intersect(Ray) - Method in class Plane

Find the intersection of the plane and a given ray.

intersect(Ray) - Method in class Sphere

Find the intersection of the plane and a given ray.

intersect(Ray, Colour, int) - Method in class Scene

isBlack() - Method in class Colour

Test if the colour is black

K

keyPressed(KeyEvent) - Method in class SimpleRay

keyReleased(KeyEvent) - Method in class SimpleRay

keyTyped(KeyEvent) - Method in class SimpleRay

L

Light - class Light.

Light superclass Each type of light must extend and implement this class.

Light() - Constructor for class Light

M

main(String[]) - Static method in class SimpleRay

The main method is called when an application version starts.

Material - class Material.

Material describes the surface properties of an object using ambient, diffuse and specular components.

Material() - Constructor for class Material

Create a default material

Material(Material) - Constructor for class Material

Create a new material by copying an existing material.

Matrix - class Matrix.

Matrix represent and provides operations on 4 by 4 matrices.

Matrix() - Constructor for class Matrix

Matrix(Matrix) - Constructor for class Matrix

mult(Colour) - Method in class Colour

Multiply the given colour to this colour

mult(Colour, Colour) - Static method in class Colour

Static implementation of colour mult function that creates a new colour object from the result.

mult(Colour, Colour, Colour) - Static method in class Colour

Static implementation of colour mult function that write the result of the multiplication to a given colour object.

multiplyMatrix(Matrix, Matrix) - Method in class Matrix

N

negate() - Method in class Vector

Negate this vector

negate(Vector) - Static method in class Vector

Static negate method that creates a new vector from a given vector.

norm() - Method in class Vector

Find the length of this vector

Normal - Variable in class Plane

Holds the normal that defines this plane

normal(Point) - Method in class Object

Find the normal of an object at the given point on its surface.

normal(Point) - Method in class Plane

Find the normal of an object at the given point on its surface.

normal(Point) - Method in class Sphere

Find the normal of an object at the given point on its surface.

normalise() - Method in class Vector

Normalise this vector

normalised() - Method in class Vector

Create a new vector as the normalisation of this vector

O

Object - class Object.

Object superclass Each type of object must extend and implement this class.

Object() - Constructor for class Object

Origin - Variable in class PointLight

Stores the origin of the point light.

Origin - Variable in class Ray

Holds the ray origin

P

paint(Graphics) - Method in class SimpleRay

Paints the screen

Plane - class Plane.

Plane represents an infinite plane object

Plane() - Constructor for class Plane

Create a default plane

Plane(Material, Vector, double) - Constructor for class Plane

Create a plane with the given material and plane equation Note values are referenced not copied in the new object

Point - class Point.

Point stores and manipulates xyz triples representing 3 space points.

Point() - Constructor for class Point

Create a new point and set it to zero

Point(double, double, double) - Constructor for class Point

Create a new point with the given x,y and z values

Point(Point) - Constructor for class Point

Create a new point by copying an existing point

PointLight - class PointLight.

PointLight represents a light sources that illuminates from a fixed origin

PointLight() - Constructor for class PointLight

Create a default light.

PointLight(Point) - Constructor for class PointLight

Create a new point light that at the given point.

print(SceneWriter) - Method in class Colour

Print a human readable version of the colour definition to the given destination

print(SceneWriter) - Method in class DirectionalLight

Print a human readable version of the light definition to the given destination

print(SceneWriter) - Method in class Light

Print a human readable version of the light definition to the given destination

print(SceneWriter) - Method in class Material

Print a human readable version of the material definition to the given destination

print(SceneWriter) - Method in class Object

Print a human readable version of the object definition to the given destination

print(SceneWriter) - Method in class Plane

Print a human readable version of the plane definition to the given destination

print(SceneWriter) - Method in class Point

Print a human readable version of the point definition to the given destination

print(SceneWriter) - Method in class PointLight

Print a human readable version of the light definition to the given destination

print(SceneWriter) - Method in class Scene

print(SceneWriter) - Method in class Sphere

Print a human readable version of the sphere definition to the given destination

print(SceneWriter) - Method in class Vector

Print a human readable version of the vector definition to the given destination

R

R - Variable in class Colour

Holds the red component of the colour

Radius - Variable in class Sphere

Holds the radius of the sphere

Ray - class Ray.

Ray stores a ray origin point and direction vector.

ray(int, int) - Method in class SimpleCamera

Get the ray number i, j from the camera model

read(SceneReader) - Method in class Colour

Read the colour from the given source

read(SceneReader) - Method in class DirectionalLight

Read the light from the given source.

read(SceneReader) - Method in class Light

Read the light from the given source

read(SceneReader) - Method in class Material

Read the material from the given source

read(SceneReader) - Method in class Object

Read the object from the given source

read(SceneReader) - Method in class Plane

Read the plane from the given source

read(SceneReader) - Method in class Point

Read the point from the given source

read(SceneReader) - Method in class PointLight

Read the light from the given source

read(SceneReader) - Method in class Scene

read(SceneReader) - Method in class Sphere

Read the sphere from the given source

read(SceneReader) - Method in class Vector

Read the vector from the given source

readChar() - Method in class SceneReader

Read a char value from file.

readDouble() - Method in class SceneReader

Read a double value from file.

readFloat() - Method in class SceneReader

Read a float value from file.

readInt() - Method in class SceneReader

Read an int value from file.

readLong() - Method in class SceneReader

Read a long value from file.

readString() - Method in class SceneReader

Read an String value from file.

reset() - Method in class Colour

Reset the colour to the default colour (black)

run() - Method in class SimpleRay

Run method is called by the "kicker" thread.

S

scale(Colour, Colour, double) - Static method in class Colour

Static scale function that writes the colour scaled by the given factor to a given destination

scale(Colour, double) - Static method in class Colour

Static scale function that returns a new colour scaled by the given factor

scale(double) - Method in class Colour

Scale this colour by the given factor

scale(double) - Method in class Vector

Scale this vector by the given factor

scale(Vector, double) - Static method in class Vector

Static scale method that creates a new vector from a given vector and scale factor.

scale(Vector, Vector, double) - Static method in class Vector

Static scale method that writes a scaled vector based upon the given vector and scale factor.

Scene - class Scene.

Scene() - Constructor for class Scene

SceneReader - class SceneReader.

A class to read values from a file, URL or stream

SceneWriter - class SceneWriter.

A simple output class to write values to a file.

SceneWriter(File) - Constructor for class SceneWriter

Construct SceneWriter object given a file.

SceneWriter(OutputStream) - Constructor for class SceneWriter

Create a SceneWriter from a stream

set(double, double, double) - Method in class Point

Set this point to the given x,y and z values

set(double, double, double) - Method in class Vector

Set this vector to the given x,y and z values

setCOP(double) - Method in class SimpleCamera

Set the centre of projection on the Z axis

setLight(int, Light) - Method in class Scene

setNumberLights(int) - Method in class Scene

setNumberObjects(int) - Method in class Scene

setObject(int, Object) - Method in class Scene

setResolution(int, int) - Method in class SimpleCamera

Set the resolution of the camera in terms of the number of rays to cast.

setToIdentity() - Method in class Matrix

setToScaling(Vector) - Method in class Matrix

setToTranslation(Vector) - Method in class Matrix

setToXRotation(double) - Method in class Matrix

setToYRotation(double) - Method in class Matrix

setToZRotation(double) - Method in class Matrix

setValue(int, int, double) - Method in class Matrix

setVPN(Vector) - Method in class Camera

Set the view plane normal.

setVPWindow(double, double, double, double) - Method in class SimpleCamera

Set the viewport window on the XY plane

setVRP(Point) - Method in class Camera

Set the view reference point Note the point is copied not referenced.

setVUV(Vector) - Method in class Camera

Set the view up vector.

Shininess - Variable in class Material

Holds the shininess factor this surface

SimpleCamera - class SimpleCamera.

SimpleCamera implements the simple camera where the VPN is along -Z, VUV is Y and the COP is on Z.

SimpleCamera() - Constructor for class SimpleCamera

Create a basic camera with resolution of 100 by 100

SimpleCamera(int, int) - Constructor for class SimpleCamera

Create a basic camera with given resolution

SimpleRay - class SimpleRay.

SimpleRay implements the a framework for the ray-tracing.

SimpleRay() - Constructor for class SimpleRay

Specular - Variable in class Material

Holds the specular component of this surface

Sphere - class Sphere.

Sphere represents a spherical object

Sphere() - Constructor for class Sphere

Create a default sphere

Sphere(Material, Point, double) - Constructor for class Sphere

Create a sphere with the given material, centre and radius Note values are referenced not copied in the new object

squarednorm() - Method in class Vector

Find the squared length of this vector

start() - Method in class SimpleRay

Method called to start an applet after initialisation.

stop() - Method in class SimpleRay

Method called to stop an applet after initialisation.

subtract(Point, Point) - Static method in class Vector

Static function to create a new vector as the difference between two points.

subtract(Vector) - Method in class Vector

Subtract the given vector from this vector

subtract(Vector, Point, Point) - Static method in class Vector

Static function to find the difference between two points and write it to a given destination vector.

subtract(Vector, Vector) - Static method in class Vector

Static function to create a new vector as the difference between two vectors.

subtract(Vector, Vector, Vector) - Static method in class Vector

Static function to find the difference between two vectors and write it to a given destination vector.

SurfaceMaterial - Variable in class Object

Holds the material of this object

T

toString() - Method in class Point

toString() - Method in class Vector

U

update(Graphics) - Method in class SimpleRay

V

Vector - class Vector.

Vector stores and manipulates xyz triples representing 3 space vectors.

Vector() - Constructor for class Vector

Create a new vector and set it to zero

Vector(double, double, double) - Constructor for class Vector

Create a new vector with the given x,y and z values

Vector(Point) - Constructor for class Vector

Create a new vector by converting a Point object

Vector(Vector) - Constructor for class Vector

Create a new vector by copying an existing vector

W

write(SceneWriter) - Method in class Colour

Write the colour to the given destination

write(SceneWriter) - Method in class DirectionalLight

Write the light to the given destination

write(SceneWriter) - Method in class Light

Write the light to the given destination

write(SceneWriter) - Method in class Material

Write the material to the given destination

write(SceneWriter) - Method in class Object

Write the object to the given destination

write(SceneWriter) - Method in class Plane

Write the plane to the given destination

write(SceneWriter) - Method in class Point

Write the point to the given destination

write(SceneWriter) - Method in class PointLight

Write the light to the given destination

write(SceneWriter) - Method in class Scene

write(SceneWriter) - Method in class Sphere

Write the sphere to the given destination

write(SceneWriter) - Method in class Vector

Write the vector to the given destination

writeChar(char) - Method in class SceneWriter

Write a char value to a file.

writeDouble(double) - Method in class SceneWriter

Write a double value.

writeFloat(float) - Method in class SceneWriter

Write a float value.

writeInt(int) - Method in class SceneWriter

Write an int value to a file.

writeLong(long) - Method in class SceneWriter

Write a long value.

writeNewline() - Method in class SceneWriter

Write a newline to a file.

writeString(String) - Method in class SceneWriter

Write a String value to a file.

X

X - Variable in class Point

Holds the X component

X - Variable in class Vector

Holds the X component

Y

Y - Variable in class Point

Holds the Y component

Y - Variable in class Vector

Holds the Y component

Z

Z - Variable in class Point

Holds the Z component

Z - Variable in class Vector

Holds the Z component

A B C D E F G I K L M N O P R S T U V W X Y Z