APIdia Launch Partner
Top Description Inners Fields Constructors Methods
com.badlogic.gdx.graphics.g3d.particles.influencers

public abstract Class ParticleControllerInfluencer

extends Influencer
Class Inheritance
Known Direct Subclasses
com.badlogic.gdx.graphics.g3d.particles.influencers.ParticleControllerInfluencer.Single, com.badlogic.gdx.graphics.g3d.particles.influencers.ParticleControllerInfluencer.Random
Imports
java.util.Iterator, com.badlogic.gdx.assets.AssetDescriptor, .AssetManager, com.badlogic.gdx.graphics.g3d.particles.ParallelArray.ObjectChannel, .ParticleChannels, .ParticleController, .ParticleEffect, .ResourceData, .ResourceData.SaveData, com.badlogic.gdx.utils.Array, .IntArray, .Pool
It's an Influencer which controls which ParticleController will be assigned to a particle.
Author
Inferno

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ParticleControllerInfluencer.Random

Assigns a random controller of ParticleControllerInfluencer#templates to the particles.

public static class
ParticleControllerInfluencer.Single

Assigns the first controller of ParticleControllerInfluencer#templates to the particles.

Field Summary

Modifier and TypeField and Description
pack-priv ParallelArray.ObjectChannel<ParticleController>
particleControllerChannel

public Array<ParticleController>
templates

Constructor Summary

AccessConstructor and Description
public
ParticleControllerInfluencer()

public
ParticleControllerInfluencer(ParticleController... templates)

public
ParticleControllerInfluencer(ParticleControllerInfluencer influencer)

Method Summary

Modifier and TypeMethod and Description
public void
allocateChannels()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Called during initialization to allocate additional particles channels

public void
dispose()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.dispose.

Implements com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

public void
end()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.end.

Called at the end of the simulation.

public void
load(AssetManager manager, ResourceData<T> resources)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.load.

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.load.

public void
save(AssetManager manager, ResourceData<T> resources)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.save.

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.save.

Field Detail

particleControllerChannelback to summary
pack-priv ParallelArray.ObjectChannel<ParticleController> particleControllerChannel
templatesback to summary
public Array<ParticleController> templates

Constructor Detail

ParticleControllerInfluencerback to summary
public ParticleControllerInfluencer()
ParticleControllerInfluencerback to summary
public ParticleControllerInfluencer(ParticleController... templates)
ParticleControllerInfluencerback to summary
public ParticleControllerInfluencer(ParticleControllerInfluencer influencer)

Method Detail

allocateChannelsback to summary
public void allocateChannels()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Called during initialization to allocate additional particles channels

Annotations
@Override
disposeback to summary
public void dispose()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.dispose.

Implements com.badlogic.gdx.utils.Disposable.dispose.

Doc from com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

Annotations
@Override
endback to summary
public void end()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.end.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.end.

Called at the end of the simulation.

Annotations
@Override
loadback to summary
public void load(AssetManager manager, ResourceData<T> resources)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.load.

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.load.

Annotations
@Override
saveback to summary
public void save(AssetManager manager, ResourceData<T> resources)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.save.

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.save.

Annotations
@Override
com.badlogic.gdx.graphics.g3d.particles.influencers back to summary

public Class ParticleControllerInfluencer.Random

extends ParticleControllerInfluencer
Class Inheritance
Assigns a random controller of ParticleControllerInfluencer#templates to the particles.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
ParticleControllerInfluencer.Random.ParticleControllerPool

Field Summary

Modifier and TypeField and Description
pack-priv ParticleControllerInfluencer.Random.ParticleControllerPool
pool

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.ParticleControllerInfluencer:
particleControllerChanneltemplates

Constructor Summary

AccessConstructor and Description
public
Random()

public
Random(ParticleController... templates)

public
Random(ParticleControllerInfluencer.Random particleControllerRandom)

Method Summary

Modifier and TypeMethod and Description
public void
activateParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Called to initialize new emitted particles.

public ParticleControllerInfluencer.Random
copy()

Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

public void
dispose()

Overrides com.badlogic.gdx.graphics.g3d.particles.influencers.ParticleControllerInfluencer.dispose.

Implements com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

public void
init()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Called once during intialization

public void
killParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.killParticles.

Called to notify which particles have been killed.

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.ParticleControllerInfluencer:
allocateChannelsendloadsave

Field Detail

poolback to summary
pack-priv ParticleControllerInfluencer.Random.ParticleControllerPool pool

Constructor Detail

Randomback to summary
public Random()
Randomback to summary
public Random(ParticleController... templates)
Randomback to summary
public Random(ParticleControllerInfluencer.Random particleControllerRandom)

Method Detail

activateParticlesback to summary
public void activateParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Called to initialize new emitted particles.

Annotations
@Override
copyback to summary
public ParticleControllerInfluencer.Random copy()

Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

Annotations
@Override
disposeback to summary
public void dispose()

Overrides com.badlogic.gdx.graphics.g3d.particles.influencers.ParticleControllerInfluencer.dispose.

Implements com.badlogic.gdx.utils.Disposable.dispose.

Doc from com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

Annotations
@Override
initback to summary
public void init()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Called once during intialization

Annotations
@Override
killParticlesback to summary
public void killParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.killParticles.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.killParticles.

Called to notify which particles have been killed.

Annotations
@Override
com.badlogic.gdx.graphics.g3d.particles.influencers back to summary

private Class ParticleControllerInfluencer.Random.ParticleControllerPool

extends Pool<ParticleController>
Class Inheritance

Field Summary

Inherited from com.badlogic.gdx.utils.Pool:
maxpeak

Constructor Summary

AccessConstructor and Description
public
ParticleControllerPool()

Method Summary

Modifier and TypeMethod and Description
public void
clear()

Overrides com.badlogic.gdx.utils.Pool.clear.

Removes and discards all free objects from this pool.

public ParticleController
newObject()

Implements abstract com.badlogic.gdx.utils.Pool.newObject.

Inherited from com.badlogic.gdx.utils.Pool:
discardfillfreefreeAllgetFreeobtainreset

Constructor Detail

ParticleControllerPoolback to summary
public ParticleControllerPool()

Method Detail

clearback to summary
public void clear()

Overrides com.badlogic.gdx.utils.Pool.clear.

Doc from com.badlogic.gdx.utils.Pool.clear.

Removes and discards all free objects from this pool.

Annotations
@Override
newObjectback to summary
public ParticleController newObject()

Implements abstract com.badlogic.gdx.utils.Pool.newObject.

Annotations
@Override
com.badlogic.gdx.graphics.g3d.particles.influencers back to summary

public Class ParticleControllerInfluencer.Single

extends ParticleControllerInfluencer
Class Inheritance
Assigns the first controller of ParticleControllerInfluencer#templates to the particles.

Field Summary

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.ParticleControllerInfluencer:
particleControllerChanneltemplates

Constructor Summary

AccessConstructor and Description
public
Single(ParticleController... templates)

public
Single()

public
Single(ParticleControllerInfluencer.Single particleControllerSingle)

Method Summary

Modifier and TypeMethod and Description
public void
activateParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Called to initialize new emitted particles.

public ParticleControllerInfluencer.Single
copy()

Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

public void
init()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Called once during intialization

public void
killParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.killParticles.

Called to notify which particles have been killed.

Inherited from com.badlogic.gdx.graphics.g3d.particles.influencers.ParticleControllerInfluencer:
allocateChannelsdisposeendloadsave

Constructor Detail

Singleback to summary
public Single(ParticleController... templates)
Singleback to summary
public Single()
Singleback to summary
public Single(ParticleControllerInfluencer.Single particleControllerSingle)

Method Detail

activateParticlesback to summary
public void activateParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Called to initialize new emitted particles.

Annotations
@Override
copyback to summary
public ParticleControllerInfluencer.Single copy()

Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

Annotations
@Override
initback to summary
public void init()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Called once during intialization

Annotations
@Override
killParticlesback to summary
public void killParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.killParticles.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.killParticles.

Called to notify which particles have been killed.

Annotations
@Override