edu.mines.jtk.util

Class RTree.Box

java.lang.Object

edu.mines.jtk.util.RTree.Box

All Implemented Interfaces:

RTree.Boxed

Enclosing class:

RTree

public static class RTree.Box
extends java.lang.Object
implements RTree.Boxed

A simple N-dimensional box.

Constructor Summary

Constructors

Constructor and Description
RTree.Box(float[] min, float[] max) Constructs an N-dimensional box with specified min/max bounds.
RTree.Box(float xmin, float ymin, float xmax, float ymax) Constructs a 2-dimensional box with specified min/max bounds.
RTree.Box(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax) Constructs a 3-dimensional box with specified min/max bounds.
RTree.Box(int ndim, RTree.Boxed boxed) Constructs an N-dimensional box for the specified boxed object.

Method Summary

Methods

Modifier and Type	Method and Description
void	getBounds(float[] min, float[] max) Gets the N min/max coordinates for this box.
float	getDistanceSquared(float[] point) Gets the distance-squared from this box to a point.
boolean	overlaps(RTree.Box box) Determines whether this box overlaps the specified box.

Methods inherited from class java.lang.Object

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

Constructor Detail

RTree.Box

public RTree.Box(float xmin,
         float ymin,
         float xmax,
         float ymax)

Constructs a 2-dimensional box with specified min/max bounds.

Parameters:

xmin - the min X coordinate.

ymin - the min Y coordinate.

xmax - the max X coordinate.

ymax - the max Y coordinate.

RTree.Box

public RTree.Box(float xmin,
         float ymin,
         float zmin,
         float xmax,
         float ymax,
         float zmax)

Constructs a 3-dimensional box with specified min/max bounds.

Parameters:

xmin - the min X coordinate.

ymin - the min Y coordinate.

zmin - the min Z coordinate.

xmax - the max X coordinate.

ymax - the max Y coordinate.

zmax - the max Z coordinate.

RTree.Box

public RTree.Box(float[] min,
         float[] max)

Constructs an N-dimensional box with specified min/max bounds. Here, N is the length of the array of min/max coordinates.

Parameters:

min - array of min coordinates.

max - array of max coordinates.

RTree.Box

public RTree.Box(int ndim,
         RTree.Boxed boxed)

Constructs an N-dimensional box for the specified boxed object.

Parameters:

ndim - number N of min/max coordinates.

boxed - the boxed object.

Method Detail

getBounds

public void getBounds(float[] min,
             float[] max)

Gets the N min/max coordinates for this box.

Specified by:

getBounds in interface RTree.Boxed

Parameters:

min - array to contain the min coordinates.

max - array to contain the max coordinates.

getDistanceSquared

public float getDistanceSquared(float[] point)

Gets the distance-squared from this box to a point.

Specified by:

getDistanceSquared in interface RTree.Boxed

Parameters:

point - array of N point coordinates.

Returns:

the distance squared.

overlaps

public boolean overlaps(RTree.Box box)

Determines whether this box overlaps the specified box.

Parameters:

box - the box.

Returns:

true, if overlaps; false, otherwise.