org.j3d.aviatrix3d.pipeline.graphics
Class VisualDetails

java.lang.Object
  org.j3d.aviatrix3d.pipeline.graphics.VisualDetails

public class VisualDetails
extends java.lang.Object

Class for passing the detailed rendering information about Renderables that effect the visual output of a specific object.

Visual details are those that are passed down the scene graph in a hierachical manner, such as lights and clip planes. These objects are declared in grouping nodes and effect all the children below them.

Version:

$Revision: 3.2 $

Author:

Justin Couch

Constructor Summary

VisualDetails()
Construct a default instance with just the transform initialised

Method Summary

void	clear() Clear the light reference and reset the entire object back to an empty state.
int	compareTo(java.lang.Object o) Compares this object with the specified object for order.
int	compareTo(VisualDetails vd) Compares this object with the specified object for order.
boolean	equals(java.lang.Object o) Compare the given details to this one to see if they are equal.
Renderable	getRenderable() Get the current clipPlane instance in use.
float[]	getTransform() Return the current transform array.
int	hashCode() Calculate the hashcode for this object.
void	update(Renderable r, float[] tx) Update the details with a new set of values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VisualDetails

public VisualDetails()

Construct a default instance with just the transform initialised

Method Detail

compareTo

public int compareTo(java.lang.Object o)
              throws java.lang.ClassCastException

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters:

o - The object to be compared

Returns:

-1, 0 or 1 depending on order

Throws:

java.lang.ClassCastException - The specified object's type prevents it from being compared to this Object

equals

public boolean equals(java.lang.Object o)

Compare the given details to this one to see if they are equal. Equality is defined as pointing to the same clipPlane source, with the same transformation value.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare against

Returns:

true if these represent identical objects

hashCode

public int hashCode()

Calculate the hashcode for this object.

Overrides:

hashCode in class java.lang.Object

update

public void update(Renderable r,
                   float[] tx)

Update the details with a new set of values.

Parameters:

r - The Renderable instance to be used

tx - The transform array to copy

getTransform

public float[] getTransform()

Return the current transform array. Don't play with the return value.

Returns:

The current transform matrix array

getRenderable

public Renderable getRenderable()

Get the current clipPlane instance in use.

Returns:

A reference to the current clipPlane

clear

public void clear()

Clear the light reference and reset the entire object back to an empty state. Used to clear references so that they are not held when the object is not in use, thus prevent GC.

compareTo

public int compareTo(VisualDetails vd)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters:

vd - The details to be compared

Returns:

-1, 0 or 1 depending on order