Package org.web3d.util.spatial

Class TunnelRegion

java.lang.Object

org.web3d.util.spatial.TunnelRegion

All Implemented Interfaces:

Region

public class TunnelRegion
extends Object
implements Region

A structure which describes a region of space described by a tunnel.

Version:

$Id: $

Author:

Alan Hudson.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TunnelRegion.Axis

Constructor Summary

Constructors

Constructor	Description
TunnelRegion(TunnelRegion.Axis dir, int loc1, int loc2, int height)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compare this object for equality to the given object.
boolean	equals(TunnelRegion ta)	Compares this object with the specified object to check for equivalence.
TunnelRegion.Axis	getDir()	Get the direction
int	getHeight()	Get the height
int	getLoc1()	Get the location1
int	getLoc2()	Get the location2
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TunnelRegion

public TunnelRegion(TunnelRegion.Axis dir,
 int loc1,
 int loc2,
 int height)

Constructor.

Parameters:

dir - The axis of the slice

loc1 - The location in grid coordinates

loc2 - The location in grid coordinates

height - The number of cells high

Method Details

getDir

public TunnelRegion.Axis getDir()

Get the direction

Returns:

the value

getLoc1

public int getLoc1()

Get the location1

Returns:

the value

getLoc2

public int getLoc2()

Get the location2

Returns:

the value

getHeight

public int getHeight()

Get the height

Returns:

the value

equals

public boolean equals(Object o)

Compare this object for equality to the given object.

Overrides:

equals in class Object

Parameters:

o - The object to be compared

Returns:

True if these represent the same values

equals

public boolean equals(TunnelRegion ta)

Compares this object with the specified object to check for equivalence.

Parameters:

ta - The geometry instance to be compared

Returns:

true if the objects represent identical values

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object