org.pepsoft.worldpainter.exporting

Class Cursor

java.lang.Object

org.pepsoft.worldpainter.exporting.Cursor

All Implemented Interfaces:

java.lang.Cloneable

public final class Cursor
extends java.lang.Object
implements java.lang.Cloneable

Constructor Summary

Constructors

Constructor and Description
Cursor(MinecraftWorld minecraftWorld, int x, int y, int height, Direction direction)
Cursor(MinecraftWorld minecraftWorld, java.awt.Point location, int height, Direction direction)

Method Summary

Modifier and Type	Method and Description
Cursor	backward()
Cursor	clone()
Cursor	down()
Cursor	forward()
Material	getBlock()
Material	getBlockAbove()
Material	getBlockBehind()
Material	getBlockBelow()
Material	getBlockInFront()
Material	getBlockToTheLeft()
Material	getBlockToTheRight()
Direction	getDirection()
int	getHeight()
int	getX()
int	getY()
boolean	isFree()
boolean	isFreeOrInsubstantial()
Cursor	moveLeft()
Cursor	moveRight()
void	setBlock(Material material)
boolean	setBlockIfFree(Material material)
void	setBlockWithDirection(Material material)
boolean	setBlockWithDirectionIfFree(Material material)
void	setDirection(Direction direction)
void	setHeight(int height)
void	setX(int x)
void	setY(int y)
Cursor	turnAround()
Cursor	turnLeft()
Cursor	turnRight()
Cursor	up()

Methods inherited from class java.lang.Object

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

Constructor Detail

Cursor

public Cursor(MinecraftWorld minecraftWorld,
              int x,
              int y,
              int height,
              Direction direction)

Cursor

public Cursor(MinecraftWorld minecraftWorld,
              java.awt.Point location,
              int height,
              Direction direction)

Method Detail

getDirection

public Direction getDirection()

setDirection

public void setDirection(Direction direction)

getHeight

public int getHeight()

setHeight

public void setHeight(int height)

getX

public int getX()

setX

public void setX(int x)

getY

public int getY()

setY

public void setY(int y)

getBlock

public Material getBlock()

setBlock

public void setBlock(Material material)

isFree

public boolean isFree()

isFreeOrInsubstantial

public boolean isFreeOrInsubstantial()

setBlockIfFree

public boolean setBlockIfFree(Material material)

setBlockWithDirection

public void setBlockWithDirection(Material material)

setBlockWithDirectionIfFree

public boolean setBlockWithDirectionIfFree(Material material)

getBlockInFront

public Material getBlockInFront()

getBlockBehind

public Material getBlockBehind()

getBlockToTheLeft

public Material getBlockToTheLeft()

getBlockToTheRight

public Material getBlockToTheRight()

getBlockAbove

public Material getBlockAbove()

getBlockBelow

public Material getBlockBelow()

forward

public Cursor forward()

Returns:

Moves the cursor forward one block. Returns the cursor as a convenience.

backward

public Cursor backward()

Returns:

Moves the cursor backward one block, while continuing to face in the same direction. Returns the cursor as a convenience.

moveLeft

public Cursor moveLeft()

Returns:

Moves the cursor left one block, while continuing to face in the same direction. Returns the cursor as a convenience.

moveRight

public Cursor moveRight()

Returns:

Moves the cursor right one block, while continuing to face in the same direction. Returns the cursor as a convenience.

turnLeft

public Cursor turnLeft()

Returns:

Rotates the cursor left 90 degrees. Returns the cursor as a convenience.

turnRight

public Cursor turnRight()

Returns:

Rotates the cursor right 90 degrees. Returns the cursor as a convenience.

turnAround

public Cursor turnAround()

Returns:

Rotates the cursor 180 degrees. Returns the cursor as a convenience.

up

public Cursor up()

Returns:

Moves the cursor up one block. Returns the cursor as a convenience.

down

public Cursor down()

Returns:

Moves the cursor down one block. Returns the cursor as a convenience.

clone

public Cursor clone()

Overrides:

clone in class java.lang.Object