org.j3d.aviatrix3d
Class ClipDetails

java.lang.Object
  org.j3d.aviatrix3d.ClipDetails

public class ClipDetails

extends java.lang.Object

Class for passing the detailed rendering information about a clip plane through the pipeline.

Version:

$Revision: 1.4 $

Author:

Justin Couch

Constructor Summary

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

Method Summary

int	compareTo(ClipDetails cd) Compares this object with the specified object for order.
int	compareTo(java.lang.Object o) 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.
ClipPlane	getClipPlane() Get the current clipPlane instance in use.
float[]	getTransform() Return the current transform array.
int	hashCode() Calculate the hashcode for this object.
void	update(ClipPlane cp, 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

ClipDetails

public ClipDetails()

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.

Derived classes should extend this one to add the extra comparisons needed.

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.

Parameters:

o - The object to compare against

Returns:

true if these represent identical objects

hashCode

public int hashCode()

Calculate the hashcode for this object.

update

public void update(ClipPlane cp,
                   float[] tx)

Update the details with a new set of values.

Parameters:

cp - The clipPlane 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

getClipPlane

public ClipPlane getClipPlane()

Get the current clipPlane instance in use.

Returns:

A reference to the current clipPlane

compareTo

public int compareTo(ClipDetails cd)

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:

cd - The details to be compared

Returns:

-1, 0 or 1 depending on order