com.mousebird.maply

Class ParticleSystem

java.lang.Object

com.mousebird.maply.ParticleSystem

public class ParticleSystem
extends java.lang.Object

A particle system is used to spawn large numbers of small moving objects.
The particle system defines what the objects are and how they're controlled. Actual data is handled through the ParticleBatch.
You set up a particle system and then add ParticleBatches via a view controller.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParticleSystem.Type

Constructor Summary

Constructors

Constructor and Description
ParticleSystem(java.lang.String name) The particle system name is used for performance debugging.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, Shader.AttributeType type) Add an attribute that will appear in each batch.
void	addTexture(MaplyTexture tex) Add a texture to the particle system.
void	addTextureID(long texID) Add a texture to the shader by ID.
void	addVarying(java.lang.String name, java.lang.String inputName, Shader.AttributeType type) For two stage shaders, these are the varying outputs from one shader to the next.
void	finalize()
double	getBasetime() Particles move over time, but current time is a large number.
int	getBatchSize() Size of the individual batches you add when adding particles.
long	getID() Returns the unique ID used by the renderer.
int	getTotalParticles() Total number of particles to display at once.
void	setBasetime(double basetime) Particles move over time, but current time is a large number.
void	setBatchSize(int batchSize) Size of the individual batches you add when adding particles.
void	setContinuousUpdate(boolean cRender) Turn the continuous render on or off.
void	setDrawPriority(int drawPriority) Set the draw priority for the particles
void	setLifetime(double lifetime) Sets the particle lifetime.
void	setParticleSystemType(ParticleSystem.Type type) At present particle systems are just point geometry.
void	setPointSize(float pointSize) Set the point size if the particle system is points.
void	setPositionShader(Shader shader) Assign a shader to the position stage of this particle system.
void	setPositionShaderID(long shaderID) Assign a shader to the position stage of this particle system.
void	setRenderShader(Shader shader) Assign a shader to the render stage of this particle system.
void	setRenderShaderID(long shaderID) Assign a shader to the render stage of this particle system.
void	setRenderTarget(RenderTarget target) If the particle system is drawing to a render target, set it here.
void	setTotalParticles(int totalParticles) The total number of particles to display at once.
void	setZBufferRead(boolean zBufferRead) If set we'll compare against the z buffer.
void	setZBufferWrite(boolean zBufferWrite) If set, we'll write to the z buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleSystem

public ParticleSystem(java.lang.String name)

The particle system name is used for performance debugging.

Parameters:

name - Name of the particle system.

Method Detail

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

getID

public long getID()

Returns the unique ID used by the renderer.

setParticleSystemType

public void setParticleSystemType(ParticleSystem.Type type)

At present particle systems are just point geometry.

Parameters:

type - The type of the particle system.

setPositionShader

public void setPositionShader(Shader shader)

Assign a shader to the position stage of this particle system.

setPositionShaderID

public void setPositionShaderID(long shaderID)

Assign a shader to the position stage of this particle system.

Parameters:

shaderID - The unique ID of the shader

setRenderShader

public void setRenderShader(Shader shader)

Assign a shader to the render stage of this particle system.

setRenderShaderID

public void setRenderShaderID(long shaderID)

Assign a shader to the render stage of this particle system.

Parameters:

shaderID - The unique ID of the shader

setLifetime

public void setLifetime(double lifetime)

Sets the particle lifetime. The system will try to keep particles around for this long. Individual particle lifetime.
The created particles will last only a certain amount of time.

Parameters:

lifetime -

setBasetime

public void setBasetime(double basetime)

Particles move over time, but current time is a large number. This is the base time you can use to subtract from current time values.
Individual particles will measure their own lifetime against this base value.

Parameters:

basetime -

getBasetime

public double getBasetime()

Particles move over time, but current time is a large number. This is the base time you can use to subtract from current time values.

Returns:

The base that particle time is measured from.

setTotalParticles

public void setTotalParticles(int totalParticles)

The total number of particles to display at once. These will be broken up into batchSized chunks.
This is the most particles we'll have on the screen at any time. Space will be allocated for them, so don't overdo it.

Parameters:

totalParticles - Total number of particles to be represented at once.

getTotalParticles

public int getTotalParticles()

Total number of particles to display at once.

setBatchSize

public void setBatchSize(int batchSize)

Size of the individual batches you add when adding particles. The total number of particles should be a multiple of this.
Particles need to be created in large batches for efficiency. This is the size of individual batches.

Parameters:

batchSize - Batch size for ParticleBatch.

getBatchSize

public int getBatchSize()

Size of the individual batches you add when adding particles.

Returns:

Total number of particles to be represented at once.

setContinuousUpdate

public void setContinuousUpdate(boolean cRender)

Turn the continuous render on or off. By default the particle system is going to move all the particles all the time. This means the renderer must execute every frame. There are times where this is not appropriate (e.g. stars) and so we can turn it off.

setDrawPriority

public void setDrawPriority(int drawPriority)

Set the draw priority for the particles

setPointSize

public void setPointSize(float pointSize)

Set the point size if the particle system is points.

addAttribute

public void addAttribute(java.lang.String name,
                         Shader.AttributeType type)

Add an attribute that will appear in each batch. Attributes are data values that go into each and every particle.

Parameters:

name - The name of the attribute we'll look for in each batch.

type - Type of the attribute.

addVarying

public void addVarying(java.lang.String name,
                       java.lang.String inputName,
                       Shader.AttributeType type)

For two stage shaders, these are the varying outputs from one shader to the next.
Two stage shaders run a position shader and then a regular render shader from the position output. Add any varying values you want to share per vertex from the former to the latter.

Parameters:

name - The name of the varying output

inputName - Name of the input to the next shader

type - Data type of the varying

addTexture

public void addTexture(MaplyTexture tex)

Add a texture to the particle system.
All the textures will be handed over to the shader.

addTextureID

public void addTextureID(long texID)

Add a texture to the shader by ID.

setZBufferRead

public void setZBufferRead(boolean zBufferRead)

If set we'll compare against the z buffer.

setZBufferWrite

public void setZBufferWrite(boolean zBufferWrite)

If set, we'll write to the z buffer.

setRenderTarget

public void setRenderTarget(RenderTarget target)

If the particle system is drawing to a render target, set it here.