org.spongepowered.api.world.extent

Interface UnmodifiableBiomeVolume

All Superinterfaces:

BiomeVolume

All Known Subinterfaces:

ImmutableBiomeVolume

public interface UnmodifiableBiomeVolume
extends BiomeVolume

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

See Also:

BiomeVolume

Method Summary

Modifier and Type	Method and Description
UnmodifiableBiomeVolume	getBiomeView(DiscreteTransform3 transform) Returns a new volume that is viewed through some transformation.
UnmodifiableBiomeVolume	getBiomeView(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.
BiomeVolumeWorker<? extends UnmodifiableBiomeVolume>	getBiomeWorker() Gets a new biome worker for this biome volume.
default UnmodifiableBiomeVolume	getRelativeBiomeView() Returns a new volume that is translated so that BiomeVolume.getBiomeMin() returns Vector3i.ZERO.
default UnmodifiableBiomeVolume	getUnmodifiableBiomeView() Returns a new volume that cannot be modified through this view.

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

containsBiome, containsBiome, getBiome, getBiome, getBiomeCopy, getBiomeCopy, getBiomeMax, getBiomeMin, getBiomeSize, getImmutableBiomeCopy

Method Detail

getBiomeView

UnmodifiableBiomeVolume getBiomeView(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 biomes, it only provides a new view of the storage.

Specified by:

getBiomeView in interface BiomeVolume

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

getBiomeView

UnmodifiableBiomeVolume getBiomeView(DiscreteTransform3 transform)

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

Specified by:

getBiomeView in interface BiomeVolume

Parameters:

transform - The transformation to be applied

Returns:

The new volume with the transform

getRelativeBiomeView

default UnmodifiableBiomeVolume getRelativeBiomeView()

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

Specified by:

getRelativeBiomeView in interface BiomeVolume

Returns:

The new volume with its minimum at zero

getUnmodifiableBiomeView

default UnmodifiableBiomeVolume getUnmodifiableBiomeView()

Description copied from interface: BiomeVolume

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 biomes, it only provides a new view of the storage.

Specified by:

getUnmodifiableBiomeView in interface BiomeVolume

Returns:

The new volume, which cannot be modified

getBiomeWorker

BiomeVolumeWorker<? extends UnmodifiableBiomeVolume> getBiomeWorker()

Description copied from interface: BiomeVolume

Gets a new biome worker for this biome volume.

Specified by:

getBiomeWorker in interface BiomeVolume

Returns:

The biome worker