org.spongepowered.api.world.extent.worker

Interface BlockVolumeWorker<V extends BlockVolume>

Type Parameters:

V - The type of volume being worked on

All Known Subinterfaces:

MutableBlockVolumeWorker<V>

public interface BlockVolumeWorker<V extends BlockVolume>

A worker for a block volume. Used to perform operations on all the blocks it contains. When operations are done on multiple volumes, they are aligned on their minimum coordinates. The other volumes must be at least as big as the backing one.

Method Summary

Modifier and Type	Method and Description
V	getVolume() Returns the volume this worker operates on.
void	iterate(BlockVolumeVisitor<V> visitor) Iterates this block volume, calling the visitor on each coordinate triplet.
void	map(BlockVolumeMapper mapper, MutableBlockVolume destination) Applies a mapping operation to all the blocks in the volume and saves the results to the destination volume.
void	merge(BlockVolume second, BlockVolumeMerger merger, MutableBlockVolume destination) Applies a merging operation to the blocks of the operating volume and an external one.
<T> T	reduce(BlockVolumeReducer<T> reducer, BiFunction<T,T,T> merge, T identity) Applies a reduction operation to the volume.

Method Detail

getVolume

V getVolume()

Returns the volume this worker operates on.

Returns:

The backing volume

map

void map(BlockVolumeMapper mapper,
         MutableBlockVolume destination)

Applies a mapping operation to all the blocks in the volume and saves the results to the destination volume.

Parameters:

mapper - The mapping operation

destination - The destination volume

merge

void merge(BlockVolume second,
           BlockVolumeMerger merger,
           MutableBlockVolume destination)

Applies a merging operation to the blocks of the operating volume and an external one. Saves the results to the destination volume.

Parameters:

second - The volume to merge with

merger - The merging operation

destination - The destination volume

iterate

void iterate(BlockVolumeVisitor<V> visitor)

Iterates this block volume, calling the visitor on each coordinate triplet.

Parameters:

visitor - The visitor

reduce

<T> T reduce(BlockVolumeReducer<T> reducer,
             BiFunction<T,T,T> merge,
             T identity)

Applies a reduction operation to the volume. The identity should be the result of no reduction being applied. For example, the additive identity is 0, the multiplicative one is 1 and the set union one is the empty set.

Type Parameters:

T - The type of the reduction

Parameters:

reducer - The reducing operation

merge - Merges two reductions into one

identity - The identity of the operation

Returns:

The reduction