Package com.badlogic.gdx.graphics.g3d.particles

Class ParticleEffectLoader

java.lang.Object

com.badlogic.gdx.assets.loaders.AssetLoader<T,P>

com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader<ParticleEffect,ParticleEffectLoader.ParticleEffectLoadParameter>

com.badlogic.gdx.graphics.g3d.particles.ParticleEffectLoader

public class ParticleEffectLoader
extends AsynchronousAssetLoader<ParticleEffect,ParticleEffectLoader.ParticleEffectLoadParameter>

This class can save and load a ParticleEffect. It should be added as AsynchronousAssetLoader to the AssetManager so it will be able to load the effects. It's important to note that the two classes ParticleEffectLoader.ParticleEffectLoadParameter and ParticleEffectLoader.ParticleEffectSaveParameter should be passed in whenever possible, because when present the batches settings will be loaded automatically. When the load and save parameters are absent, once the effect will be created, one will have to set the required batches manually otherwise the ParticleController instances contained inside the effect will not be able to render themselves.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParticleEffectLoader.ParticleEffectLoadParameter
static class	ParticleEffectLoader.ParticleEffectSaveParameter

Field Summary

Fields

Modifier and Type	Field	Description
protected Array<ObjectMap.Entry<java.lang.String,ResourceData<ParticleEffect>>>	items

Constructor Summary

Constructors

Constructor	Description
ParticleEffectLoader(FileHandleResolver resolver)

Method Summary

Modifier and Type	Method	Description
Array<AssetDescriptor>	getDependencies(java.lang.String fileName, FileHandle file, ParticleEffectLoader.ParticleEffectLoadParameter parameter)	Returns the assets this asset requires to be loaded first.
void	loadAsync(AssetManager manager, java.lang.String fileName, FileHandle file, ParticleEffectLoader.ParticleEffectLoadParameter parameter)	Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.
ParticleEffect	loadSync(AssetManager manager, java.lang.String fileName, FileHandle file, ParticleEffectLoader.ParticleEffectLoadParameter parameter)	Loads the OpenGL part of the asset.
void	save(ParticleEffect effect, ParticleEffectLoader.ParticleEffectSaveParameter parameter)	Saves the effect to the given file contained in the passed in parameter.

Methods inherited from class com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader

unloadAsync

Methods inherited from class com.badlogic.gdx.assets.loaders.AssetLoader

resolve

Methods inherited from class java.lang.Object

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

Field Detail

items

protected Array<ObjectMap.Entry<java.lang.String,ResourceData<ParticleEffect>>> items

Constructor Detail

ParticleEffectLoader

public ParticleEffectLoader(FileHandleResolver resolver)

Method Detail

loadAsync

public void loadAsync(AssetManager manager,
                      java.lang.String fileName,
                      FileHandle file,
                      ParticleEffectLoader.ParticleEffectLoadParameter parameter)

Description copied from class: AsynchronousAssetLoader

Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.

Specified by:

loadAsync in class AsynchronousAssetLoader<ParticleEffect,ParticleEffectLoader.ParticleEffectLoadParameter>

fileName - the name of the asset to load

file - the resolved file to load

parameter - the parameters to use for loading the asset

getDependencies

public Array<AssetDescriptor> getDependencies(java.lang.String fileName,
                                              FileHandle file,
                                              ParticleEffectLoader.ParticleEffectLoadParameter parameter)

Description copied from class: AssetLoader

Returns the assets this asset requires to be loaded first. This method may be called on a thread other than the GL thread.

Specified by:

getDependencies in class AssetLoader<ParticleEffect,ParticleEffectLoader.ParticleEffectLoadParameter>

Parameters:

fileName - name of the asset to load

file - the resolved file to load

parameter - parameters for loading the asset

Returns:

other assets that the asset depends on and need to be loaded first or null if there are no dependencies.

save

public void save(ParticleEffect effect,
                 ParticleEffectLoader.ParticleEffectSaveParameter parameter)
          throws java.io.IOException

Saves the effect to the given file contained in the passed in parameter.

Throws:

java.io.IOException

loadSync

public ParticleEffect loadSync(AssetManager manager,
                               java.lang.String fileName,
                               FileHandle file,
                               ParticleEffectLoader.ParticleEffectLoadParameter parameter)

Description copied from class: AsynchronousAssetLoader

Loads the OpenGL part of the asset.

Specified by:

loadSync in class AsynchronousAssetLoader<ParticleEffect,ParticleEffectLoader.ParticleEffectLoadParameter>

file - the resolved file to load