Plex-FAWE/src/main/java/com/sk89q/worldedit/regions/Region.java

144 lines
3.2 KiB
Java
Raw Normal View History

// $Id$
/*
* WorldEdit
* Copyright (C) 2010 sk89q <http://www.sk89q.com> and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.sk89q.worldedit.regions;
2011-02-20 01:44:39 +00:00
import com.sk89q.worldedit.BlockVector;
2011-12-13 03:20:31 +00:00
import com.sk89q.worldedit.LocalWorld;
import com.sk89q.worldedit.Vector;
2010-10-28 17:27:30 +00:00
import com.sk89q.worldedit.Vector2D;
import java.util.Set;
/**
*
2011-02-20 01:44:39 +00:00
* @author sk89q
*/
2011-02-20 01:44:39 +00:00
public interface Region extends Iterable<BlockVector> {
/**
* Get the lower point of a region.
2011-09-24 19:32:03 +00:00
*
2010-10-11 15:56:19 +00:00
* @return min. point
*/
public Vector getMinimumPoint();
2011-11-23 01:29:48 +00:00
/**
* Get the upper point of a region.
2011-09-24 19:32:03 +00:00
*
2010-10-11 15:56:19 +00:00
* @return max. point
*/
public Vector getMaximumPoint();
2011-11-23 01:29:48 +00:00
/**
* Get the number of blocks in the region.
2011-09-24 19:32:03 +00:00
*
2010-10-11 15:56:19 +00:00
* @return number of blocks
*/
2011-02-20 01:44:39 +00:00
public int getArea();
2011-11-23 01:29:48 +00:00
/**
* Get X-size.
*
2010-10-11 15:56:19 +00:00
* @return width
*/
public int getWidth();
2011-11-23 01:29:48 +00:00
/**
* Get Y-size.
*
2010-10-11 15:56:19 +00:00
* @return height
*/
public int getHeight();
2011-11-23 01:29:48 +00:00
/**
* Get Z-size.
*
2010-10-11 15:56:19 +00:00
* @return length
*/
public int getLength();
2011-11-23 01:29:48 +00:00
2010-10-13 04:41:06 +00:00
/**
* Expand the region.
*
* @param change
2011-09-24 19:32:03 +00:00
* @throws RegionOperationException
2010-10-13 04:41:06 +00:00
*/
2011-02-20 01:44:39 +00:00
public void expand(Vector change) throws RegionOperationException;
2011-11-23 01:29:48 +00:00
/**
* Expand the region.
*
* @param changes array/arguments with multiple related changes
* @throws RegionOperationException
*/
public void expand(Vector... changes) throws RegionOperationException;
2010-10-13 04:41:06 +00:00
/**
* Contract the region.
*
* @param change
2011-09-24 19:32:03 +00:00
* @throws RegionOperationException
2010-10-13 04:41:06 +00:00
*/
2011-02-20 01:44:39 +00:00
public void contract(Vector change) throws RegionOperationException;
2011-11-23 01:29:48 +00:00
/**
* Contract the region.
*
* @param changes array/arguments with multiple related changes
* @throws RegionOperationException
*/
public void contract(Vector... changes) throws RegionOperationException;
/**
* Shift the region.
*
* @param change
* @throws RegionOperationException
*/
public void shift(Vector multiply) throws RegionOperationException;
2011-02-20 01:44:39 +00:00
/**
* Returns true based on whether the region contains the point,
*
* @param pt
2011-09-24 19:32:03 +00:00
* @return
2011-02-20 01:44:39 +00:00
*/
public boolean contains(Vector pt);
2011-11-23 01:29:48 +00:00
2010-10-28 17:27:30 +00:00
/**
* Get a list of chunks.
2011-09-24 19:32:03 +00:00
*
2010-10-28 17:27:30 +00:00
* @return
*/
public Set<Vector2D> getChunks();
2011-12-13 03:20:31 +00:00
/**
* Get the world the selection is in
*
* @return
*/
public LocalWorld getWorld();
/**
* Sets the world the selection is in
*
* @return
*/
public void setWorld(LocalWorld world);
}