org.spongepowered.api.world.extent

Interface ImmutableBiomeVolume

All Superinterfaces:

BiomeVolume, UnmodifiableBiomeVolume

public interface ImmutableBiomeVolume
extends UnmodifiableBiomeVolume

An volume containing biomes that can be accessed but not modified. The data will never change.

See Also:

BiomeVolume

Method Summary

Modifier and Type	Method and Description
ImmutableBiomeVolume	getBiomeView(DiscreteTransform3 transform) Returns a new volume that is viewed through some transformation.
ImmutableBiomeVolume	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 ImmutableBiomeVolume>	getBiomeWorker() Gets a new biome worker for this biome volume.
default ImmutableBiomeVolume	getImmutableBiomeCopy() Returns an immutable copy of the biomes stored in this volume.
default ImmutableBiomeVolume	getRelativeBiomeView() Returns a new volume that is translated so that BiomeVolume.getBiomeMin() returns Vector3i.ZERO.

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

getUnmodifiableBiomeView

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

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

Method Detail

getBiomeView

ImmutableBiomeVolume 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

Specified by:

getBiomeView in interface UnmodifiableBiomeVolume

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

ImmutableBiomeVolume 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

Specified by:

getBiomeView in interface UnmodifiableBiomeVolume

Parameters:

transform - The transformation to be applied

Returns:

The new volume with the transform

getRelativeBiomeView

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

Specified by:

getRelativeBiomeView in interface UnmodifiableBiomeVolume

Returns:

The new volume with its minimum at zero

getImmutableBiomeCopy

default ImmutableBiomeVolume getImmutableBiomeCopy()

Description copied from interface: BiomeVolume

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

Specified by:

getImmutableBiomeCopy in interface BiomeVolume

Returns:

An immutable copy of the biomes

getBiomeWorker

BiomeVolumeWorker<? extends ImmutableBiomeVolume> getBiomeWorker()

Description copied from interface: BiomeVolume

Gets a new biome worker for this biome volume.

Specified by:

getBiomeWorker in interface BiomeVolume

Specified by:

getBiomeWorker in interface UnmodifiableBiomeVolume

Returns:

The biome worker