net.glowstone.util

Class RectangularRegion

java.lang.Object

net.glowstone.util.RectangularRegion

public class RectangularRegion
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RectangularRegion.IterationDirection

Constructor Summary

Constructors

Constructor and Description
RectangularRegion(org.bukkit.Location from, org.bukkit.Location to) Creates a new region bounded by the two opposing locations.

Method Summary

Modifier and Type	Method and Description
Iterable<org.bukkit.Location>	blockLocations(RectangularRegion.IterationDirection directionX, RectangularRegion.IterationDirection directionY, RectangularRegion.IterationDirection directionZ) Returns an iterable over all block locations within the region, with the iterable's directionality determined by the given arguments.
org.bukkit.Location	getHighCorner()
org.bukkit.Location	getLowCorner()
int	getWidthX()
int	getWidthY()
int	getWidthZ()
RectangularRegion	moveTo(org.bukkit.Location lowCorner) Creates a new region at the given corner with the same dimensions as this region.

Methods inherited from class java.lang.Object

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

Constructor Detail

RectangularRegion

public RectangularRegion(org.bukkit.Location from,
                         org.bukkit.Location to)

Creates a new region bounded by the two opposing locations.

Parameters:

from - The first bounding corner.

to - The second bounding corner.

Method Detail

moveTo

public RectangularRegion moveTo(org.bukkit.Location lowCorner)

Creates a new region at the given corner with the same dimensions as this region.

Parameters:

lowCorner - The corner to base the new region off of.

Returns:

The new region.

blockLocations

public Iterable<org.bukkit.Location> blockLocations(RectangularRegion.IterationDirection directionX,
                                                    RectangularRegion.IterationDirection directionY,
                                                    RectangularRegion.IterationDirection directionZ)

Returns an iterable over all block locations within the region, with the iterable's directionality determined by the given arguments.

Parameters:

directionX - The direction of iteration along the X axis.

directionY - The direction of iteration along the Y axis.

directionZ - The direction of iteration along the Z axis.

Returns:

The new iterable.

getLowCorner

public org.bukkit.Location getLowCorner()

getHighCorner

public org.bukkit.Location getHighCorner()

getWidthX

public int getWidthX()

getWidthY

public int getWidthY()

getWidthZ

public int getWidthZ()