com.mousebird.maply

Class ParticleBatch

java.lang.Object

com.mousebird.maply.ParticleBatch

public class ParticleBatch
extends java.lang.Object

A particle batch adds a set number of particles to the system.
The particle batch holds the number of particles defined in the MaplyParticleSystem batchSize property. Each attribute array is added individually via an NSData object. All attributes must be present or the batch is invalid and won't be passed through the system.

Field Summary

Fields

Modifier and Type	Field and Description
ParticleSystem	partSys

Constructor Summary

Constructors

Constructor and Description
ParticleBatch(ParticleSystem partSys) Initialize with the particle system.

Method Summary

Modifier and Type	Method and Description
boolean	addAttribute(java.lang.String name, char[] data) Add an attribute array of the given name.
boolean	addAttribute(java.lang.String name, float[] data) Add an attribute array of the given name.
void	finalize()
double	getTime() The time basis is used to offset times passed into the particle batch.
boolean	isValid() Tests if the batch is valid.
void	setTime(double time) This will be set by default.

Methods inherited from class java.lang.Object

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

Field Detail

partSys

public ParticleSystem partSys

Constructor Detail

ParticleBatch

public ParticleBatch(ParticleSystem partSys)

Initialize with the particle system. The batch is initialized with its particle system. You must then call addAttributeValues() repeatedly with attribute arrays.

Parameters:

partSys - The particle system this batch belongs to.

Method Detail

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

setTime

public void setTime(double time)

This will be set by default. However, you can control what the time basis for a particle batch is.

getTime

public double getTime()

The time basis is used to offset times passed into the particle batch.

addAttribute

public boolean addAttribute(java.lang.String name,
                            float[] data)

Add an attribute array of the given name.
Each attribute in the MaplyParticleSystem must be filled in here. The name must correspond and the length of the data must match.

Returns:

true if the attribute array was valid, false otherwise.

addAttribute

public boolean addAttribute(java.lang.String name,
                            char[] data)

Add an attribute array of the given name.
Each attribute in the MaplyParticleSystem must be filled in here. The name must correspond and the length of the data must match.

Returns:

true if the attribute array was valid, false otherwise.

isValid

public boolean isValid()

Tests if the batch is valid.
This checks if all the attribute arrays are present and valid.

Returns:

if the batch is valid.