net.risingworld.api.utils

Class WorldEditBatch

java.lang.Object

net.risingworld.api.utils.WorldEditBatch

public class WorldEditBatch
extends java.lang.Object

Batch class to proceed multiple world edits at once (greatly improves the performance if you want to perform multiple world edits).

Constructor Summary

Constructors

Constructor and Description
WorldEditBatch() Creates a new WorldEditBatch with a default batch size of 10 (i.e.
WorldEditBatch(int initialCapacity) Creates a new WorldEditBatch with the given initial capacity, in other words, the internal batch will be initialized with the specified size, i.e. you can add that many block edit sequences before the internal batch array will be resized.

Method Summary

Modifier and Type	Method and Description
void	addToBatch(int id, int cx, int cy, int cz, int bx, int by, int bz) Adds a new "edit sequence" to the batch.
void	addToBatch(int id, Vector3f globalPosition) Adds a new "edit sequence" to the batch.
void	clearBatch() Clears the batch.
int[]	getBatchData() Used internally.
int	position() Used internally.
void	setBatchData(int[] data, int pos) Used internally.
int	size() Gets the current size of the batch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorldEditBatch

public WorldEditBatch()

Creates a new WorldEditBatch with a default batch size of 10 (i.e. you can add 10 block edit sequences before the internal batch array will be resized.

WorldEditBatch

public WorldEditBatch(int initialCapacity)

Creates a new WorldEditBatch with the given initial capacity, in other words, the internal batch will be initialized with the specified size, i.e. you can add that many block edit sequences before the internal batch array will be resized. It's hightly recommended to provide an accurate (or at least approximate) capacity, in order to avoid unnecessary internal array enlargements.

Parameters:

initialCapacity - the initial capacity, i.e. the initial size of the batch.

Method Detail

addToBatch

public void addToBatch(int id,
                       Vector3f globalPosition)

Adds a new "edit sequence" to the batch. Uses a global position as coordinate.

Parameters:

id - the block/terrain id (0 == air).

globalPosition - the global target position.

See Also:

addToBatch(int, int, int, int, int, int, int)

addToBatch

public void addToBatch(int id,
                       int cx,
                       int cy,
                       int cz,
                       int bx,
                       int by,
                       int bz)

Adds a new "edit sequence" to the batch.

Parameters:

id - the block/terrain id (0 == air).

cx - the x chunk position.

cy - the y chunk position.

cz - the z chunk position.

bx - the x block position.

by - the y block position.

bz - the z block position.

clearBatch

public void clearBatch()

Clears the batch.

size

public int size()

Gets the current size of the batch.

Returns:

the current batch size.

position

public int position()

Used internally. Gets the internal batch array position.

Returns:

the internal batch position.

getBatchData

public int[] getBatchData()

Used internally. Gets the internal batch array, used for serialization.

Returns:

the internal batch array.

setBatchData

public void setBatchData(int[] data,
                         int pos)

Used internally. Sets the internal batch array, used for serialization.

Parameters:

data - the batch data.

pos - the current batch position.