org.spongepowered.api.world.extent

Interface UnmodifiableBlockVolume

All Superinterfaces:

BlockVolume

All Known Subinterfaces:

ImmutableBlockVolume

public interface UnmodifiableBlockVolume
extends BlockVolume

A volume containing blocks that can be accessed but not modified. The data may be changed by other processes.

See Also:

BlockVolume

Method Summary

Modifier and Type	Method and Description
UnmodifiableBlockVolume	getBlockView(DiscreteTransform3 transform) Returns a new volume that is viewed through some transformation.
UnmodifiableBlockVolume	getBlockView(com.flowpowered.math.vector.Vector3i newMin, com.flowpowered.math.vector.Vector3i newMax) Returns a new volume that is the same or smaller than the current volume.
BlockVolumeWorker<? extends UnmodifiableBlockVolume>	getBlockWorker() Gets a new block worker for this block volume.
default UnmodifiableBlockVolume	getRelativeBlockView() Returns a new volume that is translated so that BlockVolume.getBlockMin() returns Vector3i.ZERO.
default UnmodifiableBlockVolume	getUnmodifiableBlockView() Returns a new volume that cannot be modified through this view.

Methods inherited from interface org.spongepowered.api.world.extent.BlockVolume

containsBlock, containsBlock, getBlock, getBlock, getBlockCopy, getBlockCopy, getBlockMax, getBlockMin, getBlockSize, getBlockType, getBlockType, getImmutableBlockCopy

Method Detail

getBlockView

UnmodifiableBlockVolume getBlockView(com.flowpowered.math.vector.Vector3i newMin,
                                     com.flowpowered.math.vector.Vector3i newMax)

Returns a new volume that is the same or smaller than the current volume. This does not copy the blocks, it only provides a new view of the storage.

Specified by:

getBlockView in interface BlockVolume

Parameters:

newMin - The new minimum coordinates in this volume

newMax - The new maximum coordinates in this volume

Returns:

The new volume with the new bounds

Throws:

PositionOutOfBoundsException - If the new minimum and maximum are outside the current volume

getBlockView

UnmodifiableBlockVolume getBlockView(DiscreteTransform3 transform)

Returns a new volume that is viewed through some transformation. This does not copy the blocks, it only provides a new view of the storage.

Specified by:

getBlockView in interface BlockVolume

Parameters:

transform - The transformation to be applied

Returns:

The new volume with the transform

getRelativeBlockView

default UnmodifiableBlockVolume getRelativeBlockView()

Returns a new volume that is translated so that BlockVolume.getBlockMin() returns Vector3i.ZERO. This does not copy the blocks, it only provides a new view of the storage.

Specified by:

getRelativeBlockView in interface BlockVolume

Returns:

The new volume with its minimum at zero

getUnmodifiableBlockView

default UnmodifiableBlockVolume getUnmodifiableBlockView()

Description copied from interface: BlockVolume

Returns a new volume that cannot be modified through this view. Unlike immutable storage, it can be changed by holders of mutable views. This does not copy the blocks, it only provides a new view of the storage.

Specified by:

getUnmodifiableBlockView in interface BlockVolume

Returns:

The new volume, which cannot be modified

getBlockWorker

BlockVolumeWorker<? extends UnmodifiableBlockVolume> getBlockWorker()

Description copied from interface: BlockVolume

Gets a new block worker for this block volume.

Specified by:

getBlockWorker in interface BlockVolume

Returns:

The block worker