com.sk89q.worldedit.extent.transform

Class BlockTransformExtent

java.lang.Object

com.sk89q.worldedit.extent.AbstractDelegateExtent

com.sk89q.worldedit.extent.transform.BlockTransformExtent

All Implemented Interfaces:

Extent, InputExtent, OutputExtent

public class BlockTransformExtent
extends AbstractDelegateExtent

Transforms blocks themselves (but not their position) according to a given transform.

Constructor Summary

Constructors

Constructor and Description
BlockTransformExtent(Extent extent, Transform transform, BlockRegistry blockRegistry) Create a new instance.

Method Summary

Modifier and Type	Method and Description
BaseBlock	getBlock(Vector position) Get a snapshot of the block at the given location.
BaseBlock	getLazyBlock(Vector position) Get a lazy, immutable snapshot of the block at the given location that only immediately contains information about the block's type (and metadata).
Transform	getTransform() Get the transform.
boolean	setBlock(Vector location, BaseBlock block) Change the block at the given location to the given block.
static BaseBlock	transform(BaseBlock block, Transform transform, BlockRegistry registry) Transform the given block using the given transform.

Methods inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent

commit, commitBefore, createEntity, getBiome, getEntities, getEntities, getExtent, getMaximumPoint, getMinimumPoint, setBiome

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockTransformExtent

public BlockTransformExtent(Extent extent,
                            Transform transform,
                            BlockRegistry blockRegistry)

Create a new instance.

Parameters:

extent - the extent

blockRegistry - the block registry used for block direction data

Method Detail

getTransform

public Transform getTransform()

Get the transform.

Returns:

the transform

getBlock

public BaseBlock getBlock(Vector position)

Description copied from interface: InputExtent

Get a snapshot of the block at the given location.

If the given position is out of the bounds of the extent, then the behavior is undefined (an air block could be returned). However, null should not be returned.

The returned block is mutable and is a snapshot of the block at the time of call. It has no position attached to it, so it could be reused in Patterns and so on.

Calls to this method can actually be quite expensive, so cache results whenever it is possible, while being aware of the mutability aspect. The cost, however, depends on the implementation and particular extent. If only basic information about the block is required, then use of InputExtent.getLazyBlock(Vector) is recommended.

Specified by:

getBlock in interface InputExtent

Overrides:

getBlock in class AbstractDelegateExtent

Parameters:

position - position of the block

Returns:

the block

getLazyBlock

public BaseBlock getLazyBlock(Vector position)

Description copied from interface: InputExtent

Get a lazy, immutable snapshot of the block at the given location that only immediately contains information about the block's type (and metadata).

Further information (such as NBT data) will be available by the time of access. Therefore, it is not recommended that this method is used if the world is being simulated at the time of call. If the block needs to be stored for future use, then this method should definitely not be used. Moreover, the block that is returned is immutable (or should be), and therefore modifications should not be attempted on it. If a modifiable copy is required, then the block should be cloned.

This method exists because it is sometimes important to inspect the block at a given location, but InputExtent.getBlock(Vector) may be too expensive in the underlying implementation. It is also not possible to implement caching if the returned object is mutable, so this methods allows caching implementations to be used.

Specified by:

getLazyBlock in interface InputExtent

Overrides:

getLazyBlock in class AbstractDelegateExtent

Parameters:

position - position of the block

Returns:

the block

setBlock

public boolean setBlock(Vector location,
                        BaseBlock block)
                 throws WorldEditException

Description copied from interface: OutputExtent

Change the block at the given location to the given block. The operation may not tie the given BaseBlock to the world, so future changes to the BaseBlock do not affect the world until this method is called again.

The return value of this method indicates whether the change was probably successful. It may not be successful if, for example, the location is out of the bounds of the extent. It may be unsuccessful if the block passed is the same as the one in the world. However, the return value is only an estimation and it may be incorrect, but it could be used to count, for example, the approximate number of changes.

Specified by:

setBlock in interface OutputExtent

Overrides:

setBlock in class AbstractDelegateExtent

Parameters:

location - position of the block

block - block to set

Returns:

true if the block was successfully set (return value may not be accurate)

Throws:

WorldEditException - thrown on an error

transform

public static BaseBlock transform(BaseBlock block,
                                  Transform transform,
                                  BlockRegistry registry)

Transform the given block using the given transform.

The provided block is modified.

Parameters:

block - the block

transform - the transform

registry - the registry

Returns:

the same block