org.spongepowered.api.world.extent

Interface ImmutableBlockVolume

All Superinterfaces:

BlockVolume, UnmodifiableBlockVolume

public interface ImmutableBlockVolume
extends UnmodifiableBlockVolume

A volume containing blocks that can be accessed but not modified. The data will never change.

See Also:

BlockVolume

Method Summary

Modifier and Type	Method and Description
ImmutableBlockVolume	getBlockView(DiscreteTransform3 transform) Returns a new volume that is viewed through some transformation.
ImmutableBlockVolume	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 ImmutableBlockVolume>	getBlockWorker() Gets a new block worker for this block volume.
default ImmutableBlockVolume	getImmutableBlockCopy() Returns an immutable copy of the blocks stored in this volume.
default ImmutableBlockVolume	getRelativeBlockView() Returns a new volume that is translated so that BlockVolume.getBlockMin() returns Vector3i.ZERO.

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

getUnmodifiableBlockView

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

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

Method Detail

getBlockView

ImmutableBlockVolume 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

Specified by:

getBlockView in interface UnmodifiableBlockVolume

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

ImmutableBlockVolume 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

Specified by:

getBlockView in interface UnmodifiableBlockVolume

Parameters:

transform - The transformation to be applied

Returns:

The new volume with the transform

getRelativeBlockView

default ImmutableBlockVolume 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

Specified by:

getRelativeBlockView in interface UnmodifiableBlockVolume

Returns:

The new volume with its minimum at zero

getImmutableBlockCopy

default ImmutableBlockVolume getImmutableBlockCopy()

Description copied from interface: BlockVolume

Returns an immutable copy of the blocks stored in this volume. This uses some internal storage solution that is thread-safe by nature.

Specified by:

getImmutableBlockCopy in interface BlockVolume

Returns:

An immutable copy of the blocks

getBlockWorker

BlockVolumeWorker<? extends ImmutableBlockVolume> getBlockWorker()

Description copied from interface: BlockVolume

Gets a new block worker for this block volume.

Specified by:

getBlockWorker in interface BlockVolume

Specified by:

getBlockWorker in interface UnmodifiableBlockVolume

Returns:

The block worker