com.sk89q.worldedit

Class CuboidClipboard

java.lang.Object

com.sk89q.worldedit.CuboidClipboard

public class CuboidClipboard
extends Object

The clipboard remembers the state of a cuboid region.

Author:

sk89q

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CuboidClipboard.FlipDirection Flip direction.

Constructor Summary

Constructors

Constructor and Description
CuboidClipboard(Vector size) Constructs the clipboard.
CuboidClipboard(Vector size, Vector origin) Constructs the clipboard.
CuboidClipboard(Vector size, Vector origin, Vector offset) Constructs the clipboard.

Method Summary

Methods

Modifier and Type	Method and Description
void	copy(EditSession editSession) Copies blocks to the clipboard.
void	copy(EditSession editSession, Region region) Copies blocks to the clipboard.
void	flip(CuboidClipboard.FlipDirection dir) Flip the clipboard.
void	flip(CuboidClipboard.FlipDirection dir, boolean aroundPlayer) Flip the clipboard.
BaseBlock	getBlock(Vector pos) Get one point in the copy.
List<Countable<Integer>>	getBlockDistribution() Get the block distribution inside a clipboard.
List<Countable<BaseBlock>>	getBlockDistributionWithData() Get the block distribution inside a clipboard with data values.
int	getHeight() Get the height (Y-direction) of the clipboard.
int	getLength() Get the length (Z-direction) of the clipboard.
Vector	getOffset()
Vector	getOrigin()
BaseBlock	getPoint(Vector pos) Deprecated. Use getBlock(Vector) instead
Vector	getSize() Get the size of the copy.
int	getWidth() Get the width (X-direction) of the clipboard.
static CuboidClipboard	loadSchematic(File path) Deprecated.
void	paste(EditSession editSession, Vector newOrigin, boolean noAir)
void	paste(EditSession editSession, Vector newOrigin, boolean noAir, boolean entities) Paste from the clipboard.
LocalEntity[]	pasteEntities(Vector pos)
void	place(EditSession editSession, Vector pos, boolean noAir) Places the blocks in a position from the minimum corner.
void	rotate2D(int angle) Rotate the clipboard in 2D.
void	saveSchematic(File path) Deprecated.
void	setBlock(Vector pt, BaseBlock block) Set one point in the copy.
void	setOffset(Vector offset)
void	setOrigin(Vector origin)
void	storeEntity(LocalEntity entity)

Methods inherited from class java.lang.Object

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

Constructor Detail

CuboidClipboard

public CuboidClipboard(Vector size)

Constructs the clipboard.

Parameters:

size -

CuboidClipboard

public CuboidClipboard(Vector size,
               Vector origin)

Constructs the clipboard.

Parameters:

size -

origin -

CuboidClipboard

public CuboidClipboard(Vector size,
               Vector origin,
               Vector offset)

Constructs the clipboard.

Parameters:

size -

origin -

offset -

Method Detail

getWidth

public int getWidth()

Get the width (X-direction) of the clipboard.

Returns:

width

getLength

public int getLength()

Get the length (Z-direction) of the clipboard.

Returns:

length

getHeight

public int getHeight()

Get the height (Y-direction) of the clipboard.

Returns:

height

rotate2D

public void rotate2D(int angle)

Rotate the clipboard in 2D. It can only rotate by angles divisible by 90.

Parameters:

angle - in degrees

flip

public void flip(CuboidClipboard.FlipDirection dir)

Flip the clipboard.

Parameters:

dir - direction to flip

flip

public void flip(CuboidClipboard.FlipDirection dir,
        boolean aroundPlayer)

Flip the clipboard.

Parameters:

dir - direction to flip

aroundPlayer - flip the offset around the player

copy

public void copy(EditSession editSession)

Copies blocks to the clipboard.

Parameters:

editSession - The EditSession from which to take the blocks

copy

public void copy(EditSession editSession,
        Region region)

Copies blocks to the clipboard.

Parameters:

editSession - The EditSession from which to take the blocks

region - A region that further constrains which blocks to take.

paste

public void paste(EditSession editSession,
         Vector newOrigin,
         boolean noAir)
           throws MaxChangedBlocksException

Throws:

MaxChangedBlocksException

paste

public void paste(EditSession editSession,
         Vector newOrigin,
         boolean noAir,
         boolean entities)
           throws MaxChangedBlocksException

Paste from the clipboard.

Parameters:

editSession -

newOrigin - Position to paste it from

noAir - True to not paste air

Throws:

MaxChangedBlocksException

place

public void place(EditSession editSession,
         Vector pos,
         boolean noAir)
           throws MaxChangedBlocksException

Places the blocks in a position from the minimum corner.

Parameters:

editSession -

pos -

noAir -

Throws:

MaxChangedBlocksException

pasteEntities

public LocalEntity[] pasteEntities(Vector pos)

storeEntity

public void storeEntity(LocalEntity entity)

getPoint

public BaseBlock getPoint(Vector pos)
                   throws ArrayIndexOutOfBoundsException

Deprecated. Use getBlock(Vector) instead

Get one point in the copy.

Parameters:

The - point, relative to the origin of the copy (0, 0, 0) and not to the actual copy origin.

Returns:

air, if this block was outside the (non-cuboid) selection while copying

Throws:

ArrayIndexOutOfBoundsException - if the position is outside the bounds of the CuboidClipboard

getBlock

public BaseBlock getBlock(Vector pos)
                   throws ArrayIndexOutOfBoundsException

Get one point in the copy.

Parameters:

The - point, relative to the origin of the copy (0, 0, 0) and not to the actual copy origin.

Returns:

null, if this block was outside the (non-cuboid) selection while copying

Throws:

ArrayIndexOutOfBoundsException - if the position is outside the bounds of the CuboidClipboard

setBlock

public void setBlock(Vector pt,
            BaseBlock block)

Set one point in the copy. Pass null to remove the block.

Parameters:

The - point, relative to the origin of the copy (0, 0, 0) and not to the actual copy origin.

Throws:

ArrayIndexOutOfBoundsException - if the position is outside the bounds of the CuboidClipboard

getSize

public Vector getSize()

Get the size of the copy.

Returns:

saveSchematic

@Deprecated
public void saveSchematic(File path)
                   throws IOException,
                          DataException

Deprecated.

Saves the clipboard data to a .schematic-format file.

Parameters:

path -

Throws:

IOException

DataException

loadSchematic

@Deprecated
public static CuboidClipboard loadSchematic(File path)
                                     throws DataException,
                                            IOException

Deprecated.

Load a .schematic file into a clipboard.

Parameters:

path -

Returns:

clipboard

Throws:

DataException

IOException

getOrigin

public Vector getOrigin()

Returns:

the origin

setOrigin

public void setOrigin(Vector origin)

Parameters:

origin - the origin to set

getOffset

public Vector getOffset()

Returns:

the offset

setOffset

public void setOffset(Vector offset)

Parameters:

offset -

getBlockDistribution

public List<Countable<Integer>> getBlockDistribution()

Get the block distribution inside a clipboard.

Returns:

getBlockDistributionWithData

public List<Countable<BaseBlock>> getBlockDistributionWithData()

Get the block distribution inside a clipboard with data values.

Returns: