com.badlogic.gdx.graphics.g3d.particles

Class ParallelArray

java.lang.Object

com.badlogic.gdx.graphics.g3d.particles.ParallelArray

public class ParallelArray
extends java.lang.Object

This class represents an group of elements like an array, but the properties of the elements are stored as separate arrays. These arrays are called ParallelArray.Channel and are represented by ParallelArray.ChannelDescriptor. It's not necessary to store primitive types in the channels but doing so will "exploit" data locality in the JVM, which is ensured for primitive types. Use ParallelArray.FloatChannel, ParallelArray.IntChannel, ParallelArray.ObjectChannel to store the data.

Author:

inferno

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ParallelArray.Channel This class represents a container of values for all the elements for a given property
static class	ParallelArray.ChannelDescriptor This class describes the content of a ParallelArray.Channel
static interface	ParallelArray.ChannelInitializer<T extends ParallelArray.Channel> This interface is used to provide custom initialization of the ParallelArray.Channel data
class	ParallelArray.FloatChannel
class	ParallelArray.IntChannel
class	ParallelArray.ObjectChannel<T>

Field Summary

Fields

Modifier and Type	Field and Description
int	capacity the maximum amount of elements that this array can hold
int	size the current amount of defined elements, do not change manually unless you know what you are doing.

Constructor Summary

Constructors

Constructor and Description
ParallelArray(int capacity)

Method Summary

Modifier and Type	Method and Description
<T extends ParallelArray.Channel> T	addChannel(ParallelArray.ChannelDescriptor channelDescriptor) Adds and returns a channel described by the channel descriptor parameter.
<T extends ParallelArray.Channel> T	addChannel(ParallelArray.ChannelDescriptor channelDescriptor, ParallelArray.ChannelInitializer<T> initializer) Adds and returns a channel described by the channel descriptor parameter.
void	addElement(java.lang.Object... values) Adds an element considering the values in the same order as the current channels in the array.
void	clear() Removes all the channels and sets size to 0
<T extends ParallelArray.Channel> T	getChannel(ParallelArray.ChannelDescriptor descriptor)
<T> void	removeArray(int id) Removes the channel with the given id
void	removeElement(int index) Removes the element at the given index and swaps it with the last available element
void	setCapacity(int requiredCapacity) Sets the capacity.

Methods inherited from class java.lang.Object

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

Field Detail

capacity

public int capacity

the maximum amount of elements that this array can hold

size

public int size

the current amount of defined elements, do not change manually unless you know what you are doing.

Constructor Detail

ParallelArray

public ParallelArray(int capacity)

Method Detail

addChannel

public <T extends ParallelArray.Channel> T addChannel(ParallelArray.ChannelDescriptor channelDescriptor)

Adds and returns a channel described by the channel descriptor parameter. If a channel with the same id already exists, no allocation is performed and that channel is returned.

addChannel

public <T extends ParallelArray.Channel> T addChannel(ParallelArray.ChannelDescriptor channelDescriptor,
                                                      ParallelArray.ChannelInitializer<T> initializer)

Adds and returns a channel described by the channel descriptor parameter. If a channel with the same id already exists, no allocation is performed and that channel is returned. Otherwise a new channel is allocated and initialized with the initializer.

removeArray

public <T> void removeArray(int id)

Removes the channel with the given id

addElement

public void addElement(java.lang.Object... values)

Adds an element considering the values in the same order as the current channels in the array. The n_th value must have the same type and stride of the given channel at position n

removeElement

public void removeElement(int index)

Removes the element at the given index and swaps it with the last available element

getChannel

public <T extends ParallelArray.Channel> T getChannel(ParallelArray.ChannelDescriptor descriptor)

Returns:

the channel with the same id as the one in the descriptor

clear

public void clear()

Removes all the channels and sets size to 0

setCapacity

public void setCapacity(int requiredCapacity)

Sets the capacity. Each contained channel will be resized to match the required capacity and the current data will be preserved.