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

// $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;

import com.sk89q.worldedit.BlockVector;
import com.sk89q.worldedit.LocalWorld;
import com.sk89q.worldedit.Vector;
import com.sk89q.worldedit.Vector2D;
import java.util.Set;

/**
 *
 * @author sk89q
 */
public interface Region extends Iterable<BlockVector> {
    /**
     * Get the lower point of a region.
     *
     * @return min. point
     */
    public Vector getMinimumPoint();

    /**
     * Get the upper point of a region.
     *
     * @return max. point
     */
    public Vector getMaximumPoint();

    /**
     * Get the number of blocks in the region.
     *
     * @return number of blocks
     */
    public int getArea();

    /**
     * Get X-size.
     *
     * @return width
     */
    public int getWidth();

    /**
     * Get Y-size.
     *
     * @return height
     */
    public int getHeight();

    /**
     * Get Z-size.
     *
     * @return length
     */
    public int getLength();

    /**
     * Expand the region.
     *
     * @deprecated will be seamlessly replaced by {@link #expand(Vector...)
     * @param change
     * @throws RegionOperationException
     */
    @Deprecated
    public void expand(Vector change) throws RegionOperationException;

    /**
     * Expand the region.
     *
     * @param changes array/arguments with multiple related changes
     * @throws RegionOperationException
     */
    public void expand(Vector... changes) throws RegionOperationException;

    /**
     * Contract the region.
     *
     * @deprecated will be seamlessly replaced by {@link #contract(Vector...)
     * @param change
     * @throws RegionOperationException
     */
    @Deprecated
    public void contract(Vector change) throws RegionOperationException;

    /**
     * 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;

    /**
     * Returns true based on whether the region contains the point,
     *
     * @param pt
     * @return
     */
    public boolean contains(Vector pt);

    /**
     * Get a list of chunks.
     *
     * @return
     */
    public Set<Vector2D> getChunks();

    /**
     * Return a list of 16*16*16 chunks in a region
     *
     * @return The chunk cubes this region overlaps with
     */
    public Set<Vector> getChunkCubes();

    /**
     * Get the world the selection is in
     *
     * @return
     */
    public LocalWorld getWorld();

    /**
     * Sets the world the selection is in
     *
     * @return
     */
    public void setWorld(LocalWorld world);
}