Package com.sk89q.worldedit.extent.transform

Class BlockTransformExtent

java.lang.Object

com.sk89q.worldedit.extent.AbstractDelegateExtent

com.fastasyncworldedit.core.extent.ResettableExtent

com.sk89q.worldedit.extent.transform.BlockTransformExtent

All Implemented Interfaces:

Extent, InputExtent, OutputExtent, Serializable

Direct Known Subclasses:

TransformExtent

public class BlockTransformExtent
extends ResettableExtent

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

See Also:

• Serialized Form

Field Summary

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

extent

Constructor Summary

Constructors

Constructor	Description
BlockTransformExtent(Extent parent)
BlockTransformExtent(Extent extent, Transform transform)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
BlockState	getBlock(int x, int y, int z)
BlockState	getBlock(BlockVector3 position)	Get a snapshot of the block at the given location.
BaseBlock	getFullBlock(int x, int y, int z)
BaseBlock	getFullBlock(BlockVector3 position)	Get an immutable snapshot of the block at the given location.
Transform	getTransform()	Get the transform.
<T extends BlockStateHolder<T>> boolean	setBlock(int x, int y, int z, T block)
<B extends BlockStateHolder<B>> boolean	setBlock(BlockVector3 location, B block)	Change the block at the given location to the given block.
void	setTransform(Transform affine)
static <B extends BlockStateHolder<B>> B	transform(B block, Transform transform)	Transform the given block using the given transform.
final BlockState	transform(BlockState block)
final BaseBlock	transform(BlockStateHolder<BaseBlock> block)
protected final BlockStateHolder	transformInverse(BlockStateHolder block)

Methods inherited from class com.fastasyncworldedit.core.extent.ResettableExtent

init, setExtent, setOrigin

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

addPostProcessor, addProcessor, cancel, commit, commitBefore, createEntity, disableHistory, disableQueue, enableQueue, fullySupports3DBiomes, getBiome, getBiomeType, getBrightness, getEmittedLight, getEntities, getEntities, getExtent, getMaximumPoint, getMaxY, getMinimumPoint, getMinY, getSkyLight, isQueueEnabled, relight, relightBlock, relightSky, removeEntity, setBiome, setBiome, setBlockLight, setChangeSet, setSkyLight, setTile, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.extent.Extent

addCaves, addOre, addOres, addSchems, apply, apply, center, contains, contains, countBlocks, countBlocks, enableHistory, generate, getBlockDistribution, getBlockDistributionWithData, getHighestTerrainBlock, getHighestTerrainBlock, getNearestSurfaceLayer, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, isWorld, lazyCopy, regenerateChunk, replaceBlocks, replaceBlocks, replaceBlocks, setBlocks, setBlocks, setBlocks, spawnResource

Methods inherited from interface com.sk89q.worldedit.extent.InputExtent

getBiome, getBrightness, getEmittedLight, getHeightMap, getOpacity, getOpacity, getSkyLight

Methods inherited from interface com.sk89q.worldedit.extent.OutputExtent

setBiome, setBlockLight, setHeightMap, setSkyLight

Constructor Details

BlockTransformExtent

public BlockTransformExtent(Extent parent)

BlockTransformExtent

public BlockTransformExtent(Extent extent,
 Transform transform)

Create a new instance.

Parameters:

extent - the extent

Method Details

getTransform

public Transform getTransform()

Get the transform.

Returns:

the transform

getBlock

public BlockState getBlock(BlockVector3 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 immutable 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.

Specified by:

getBlock in interface InputExtent

Overrides:

getBlock in class AbstractDelegateExtent

Parameters:

position - position of the block

Returns:

the block

getBlock

public BlockState getBlock(int x,
 int y,
 int z)

Specified by:

getBlock in interface InputExtent

Overrides:

getBlock in class AbstractDelegateExtent

getFullBlock

public BaseBlock getFullBlock(BlockVector3 position)

Description copied from interface: InputExtent

Get an immutable snapshot of the block at the given location.

Specified by:

getFullBlock in interface InputExtent

Overrides:

getFullBlock in class AbstractDelegateExtent

Parameters:

position - position of the block

Returns:

the block

getFullBlock

public BaseBlock getFullBlock(int x,
 int y,
 int z)

Specified by:

getFullBlock in interface InputExtent

Overrides:

getFullBlock in class AbstractDelegateExtent

setBlock

public <B extends BlockStateHolder<B>> boolean setBlock(BlockVector3 location,
 B 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 BlockStateHolder to the world, so future changes to the BlockStateHolder 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

setBlock

public <T extends BlockStateHolder<T>> boolean setBlock(int x,
 int y,
 int z,
 T block)
                                                 throws WorldEditException

Specified by:

setBlock in interface OutputExtent

Overrides:

setBlock in class AbstractDelegateExtent

Throws:

WorldEditException

setTransform

public void setTransform(Transform affine)

transform

public static <B extends BlockStateHolder<B>> B transform(@Nonnull
 B block,
 @Nonnull
 Transform transform)

Transform the given block using the given transform.

The provided block is not modified.

Parameters:

block - the block

transform - the transform

Returns:

the same block

transform

public final BaseBlock transform(BlockStateHolder<BaseBlock> block)

transformInverse

protected final BlockStateHolder transformInverse(BlockStateHolder block)

transform

public final BlockState transform(BlockState block)