Package org.ngengine

Class AsyncAssetManager

java.lang.Object

org.ngengine.AsyncAssetManager

All Implemented Interfaces:

AssetManager, Closeable, AutoCloseable

public class AsyncAssetManager
extends Object
implements AssetManager, Closeable

An asynchronous wrapper for the JME AssetManager that allows loading assets in a separate thread and provides callbacks for when the asset is loaded. This is useful to avoid blocking the main thread during asset loading.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AssetManager	assetManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AsyncAssetManager(AssetManager assetManager)
protected	AsyncAssetManager(AssetManager assetManager, Runner callbackRunner)

Method Summary

Modifier and Type	Method	Description
void	addAssetEventListener(AssetEventListener listener)	Add an AssetEventListener to receive events from this AssetManager.
<T> void	addToCache(AssetKey<T> key, T asset)	Inject an asset into the asset cache.
protected <T, E> void	async(E key, Function<E,T> function, BiConsumer<T,Throwable> callback)
void	clearAssetEventListeners()	Removes all asset event listeners.
void	clearCache()	Clears the asset cache.
void	close()
<T> boolean	deleteFromCache(AssetKey<T> key)	Delete an asset from the asset cache.
<T> T	getFromCache(AssetKey<T> key)	Retrieve an asset from the asset cache.
ShaderGenerator	getShaderGenerator(EnumSet<Caps> caps)	Returns the shaderGenerator responsible for generating the shaders
<T> T	loadAsset(AssetKey<T> key)	Load an asset from a key, the asset will be located by one of the AssetLocator implementations provided in the AssetManager.registerLocator(java.lang.String, java.lang.Class) call.
Object	loadAsset(String name)	Load an asset by name, calling this method is the same as calling loadAsset(new AssetKey(name)).
<T> void	loadAssetAsync(AssetKey<T> key, BiConsumer<T,Throwable> callback)
void	loadAssetAsync(String name, BiConsumer<Object,Throwable> callback)
<T> T	loadAssetFromStream(AssetKey<T> key, InputStream inputStream)	Load an asset from an InputStream.
<T> void	loadAssetFromStreamAsync(AssetKey<T> key, InputStream inputStream, BiConsumer<T,Throwable> callback)
AudioData	loadAudio(AudioKey key)	Load audio file, supported types are WAV or OGG.
AudioData	loadAudio(String name)	Load audio file, supported types are WAV or OGG.
void	loadAudioAsync(AudioKey key, BiConsumer<AudioData,Throwable> callback)
void	loadAudioAsync(String name, BiConsumer<AudioData,Throwable> callback)
FilterPostProcessor	loadFilter(FilterKey key)	Loads a filter *.j3f file with a FilterKey.
FilterPostProcessor	loadFilter(String name)	Loads a filter *.j3f file with a FilterKey.
void	loadFilterAsync(FilterKey key, BiConsumer<FilterPostProcessor,Throwable> callback)
void	loadFilterAsync(String name, BiConsumer<FilterPostProcessor,Throwable> callback)
BitmapFont	loadFont(String name)	Load a font file.
void	loadFontAsync(String name, BiConsumer<BitmapFont,Throwable> callback)
Material	loadMaterial(String name)	Load a material instance (J3M) file.
void	loadMaterialAsync(String name, BiConsumer<Material,Throwable> callback)
Spatial	loadModel(ModelKey key)	Loads a 3D model with a ModelKey.
Spatial	loadModel(String name)	Loads a 3D model.
void	loadModelAsync(ModelKey key, BiConsumer<Spatial,Throwable> callback)
void	loadModelAsync(String name, BiConsumer<Spatial,Throwable> callback)
Texture	loadTexture(TextureKey key)	Loads texture file, supported types are BMP, JPG, PNG, GIF, TGA, DDS, PFM, and HDR.
Texture	loadTexture(String name)	Loads texture file, supported types are BMP, JPG, PNG, GIF, TGA, DDS, PFM, and HDR.
void	loadTextureAsync(TextureKey key, BiConsumer<Texture,Throwable> callback)
void	loadTextureAsync(String name, BiConsumer<Texture,Throwable> callback)
AssetInfo	locateAsset(AssetKey<?> key)	Manually locates an asset with the given AssetKey.
void	locateAssetAsync(AssetKey<?> key, BiConsumer<AssetInfo,Throwable> callback)
static AsyncAssetManager	of(AssetManager assetManager, Application app)
void	registerLoader(Class<? extends AssetLoader> loaderClass, String... extensions)	Register an AssetLoader by using a class object.
void	registerLocator(String rootPath, Class<? extends AssetLocator> locatorClass)	Registers the given locator class for locating assets with this AssetManager.
void	removeAssetEventListener(AssetEventListener listener)	Remove an AssetEventListener from receiving events from this AssetManager
<T> void	runInLoaderThread(Function<AsyncAssetManager,T> function, BiConsumer<T,Throwable> callback)
void	setShaderGenerator(ShaderGenerator generator)	Sets the shaderGenerator to generate shaders based on shaderNodes.
void	unregisterLoader(Class<? extends AssetLoader> loaderClass)	Unregister a AssetLoader from loading its assigned extensions.
void	unregisterLocator(String rootPath, Class<? extends AssetLocator> locatorClass)	Unregisters the given locator class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jme3.asset.AssetManager

addClassLoader, getClassLoaders, removeClassLoader

Field Details

assetManager

protected final AssetManager assetManager

Constructor Details

AsyncAssetManager

protected AsyncAssetManager(AssetManager assetManager)

AsyncAssetManager

protected AsyncAssetManager(AssetManager assetManager,
 Runner callbackRunner)

Method Details

of

public static AsyncAssetManager of(AssetManager assetManager,
 Application app)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

runInLoaderThread

public <T> void runInLoaderThread(Function<AsyncAssetManager,T> function,
 BiConsumer<T,Throwable> callback)

async

protected <T,
E> void async(E key,
 Function<E,T> function,
 BiConsumer<T,Throwable> callback)

loadAssetAsync

public <T> void loadAssetAsync(AssetKey<T> key,
 BiConsumer<T,Throwable> callback)

loadAsset

public <T> T loadAsset(AssetKey<T> key)

Description copied from interface: AssetManager

Load an asset from a key, the asset will be located by one of the AssetLocator implementations provided in the AssetManager.registerLocator(java.lang.String, java.lang.Class) call. If located successfully, it will be loaded via the appropriate AssetLoader implementation based on the file's extension, as specified in the call AssetManager.registerLoader(java.lang.Class, java.lang.String[]).

Specified by:

loadAsset in interface AssetManager

Type Parameters:

T - The object type that will be loaded from the AssetKey instance.

Parameters:

key - The AssetKey

Returns:

The loaded asset.

loadAssetAsync

public void loadAssetAsync(String name,
 BiConsumer<Object,Throwable> callback)

loadAsset

public Object loadAsset(String name)

Description copied from interface: AssetManager

Load an asset by name, calling this method is the same as calling loadAsset(new AssetKey(name)).

Specified by:

loadAsset in interface AssetManager

Parameters:

name - The name of the asset to load.

Returns:

The loaded asset, or null if failed to be loaded.

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadTextureAsync

public void loadTextureAsync(TextureKey key,
 BiConsumer<Texture,Throwable> callback)

loadTexture

public Texture loadTexture(TextureKey key)

Description copied from interface: AssetManager

Loads texture file, supported types are BMP, JPG, PNG, GIF, TGA, DDS, PFM, and HDR.

Specified by:

loadTexture in interface AssetManager

Parameters:

key - The TextureKey to use for loading.

Returns:

The loaded texture, or null if failed to be loaded.

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadTextureAsync

public void loadTextureAsync(String name,
 BiConsumer<Texture,Throwable> callback)

loadTexture

public Texture loadTexture(String name)

Description copied from interface: AssetManager

Loads texture file, supported types are BMP, JPG, PNG, GIF, TGA, DDS, PFM, and HDR. The texture will be loaded with mip-mapping enabled.

Specified by:

loadTexture in interface AssetManager

Parameters:

name - The name of the texture to load.

Returns:

The texture that was loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadAudioAsync

public void loadAudioAsync(AudioKey key,
 BiConsumer<AudioData,Throwable> callback)

loadAudio

public AudioData loadAudio(AudioKey key)

Description copied from interface: AssetManager

Load audio file, supported types are WAV or OGG.

Specified by:

loadAudio in interface AssetManager

Parameters:

key - Asset key of the audio file to load

Returns:

The audio data loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadAudioAsync

public void loadAudioAsync(String name,
 BiConsumer<AudioData,Throwable> callback)

loadAudio

public AudioData loadAudio(String name)

Description copied from interface: AssetManager

Load audio file, supported types are WAV or OGG. The file is loaded without stream-mode.

Specified by:

loadAudio in interface AssetManager

Parameters:

name - Asset name of the audio file to load

Returns:

The audio data loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadModelAsync

public void loadModelAsync(ModelKey key,
 BiConsumer<Spatial,Throwable> callback)

loadModel

public Spatial loadModel(ModelKey key)

Description copied from interface: AssetManager

Loads a 3D model with a ModelKey. Models can be jME3 object files (J3O), OgreXML (mesh.xml), BLEND, FBX and OBJ files.

Specified by:

loadModel in interface AssetManager

Parameters:

key - Asset key of the model to load

Returns:

The model that was loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadModelAsync

public void loadModelAsync(String name,
 BiConsumer<Spatial,Throwable> callback)

loadModel

public Spatial loadModel(String name)

Description copied from interface: AssetManager

Loads a 3D model. Models can be jME3 object files (J3O), OgreXML (mesh.xml), BLEND, FBX and OBJ files.

Specified by:

loadModel in interface AssetManager

Parameters:

name - Asset name of the model to load

Returns:

The model that was loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadMaterialAsync

public void loadMaterialAsync(String name,
 BiConsumer<Material,Throwable> callback)

loadMaterial

public Material loadMaterial(String name)

Description copied from interface: AssetManager

Load a material instance (J3M) file.

Specified by:

loadMaterial in interface AssetManager

Parameters:

name - Asset name of the material to load

Returns:

The material that was loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadFontAsync

public void loadFontAsync(String name,
 BiConsumer<BitmapFont,Throwable> callback)

loadFont

public BitmapFont loadFont(String name)

Description copied from interface: AssetManager

Load a font file. Font files are in AngelCode text format, and are with the extension "fnt".

Specified by:

loadFont in interface AssetManager

Parameters:

name - Asset name of the font to load

Returns:

The font loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadFilterAsync

public void loadFilterAsync(FilterKey key,
 BiConsumer<FilterPostProcessor,Throwable> callback)

loadFilter

public FilterPostProcessor loadFilter(FilterKey key)

Description copied from interface: AssetManager

Loads a filter *.j3f file with a FilterKey.

Specified by:

loadFilter in interface AssetManager

Parameters:

key - Asset key of the filter file to load

Returns:

The filter that was loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

loadFilterAsync

public void loadFilterAsync(String name,
 BiConsumer<FilterPostProcessor,Throwable> callback)

loadFilter

public FilterPostProcessor loadFilter(String name)

Description copied from interface: AssetManager

Loads a filter *.j3f file with a FilterKey.

Specified by:

loadFilter in interface AssetManager

Parameters:

name - Asset name of the filter file to load

Returns:

The filter that was loaded

See Also:

• AssetManager.loadAsset(com.jme3.asset.AssetKey)

locateAssetAsync

public void locateAssetAsync(AssetKey<?> key,
 BiConsumer<AssetInfo,Throwable> callback)

locateAsset

public AssetInfo locateAsset(AssetKey<?> key)

Description copied from interface: AssetManager

Manually locates an asset with the given AssetKey. This method should be used for debugging or internal uses.
The call will attempt to locate the asset by invoking the AssetLocator that are registered with this AssetManager, in the same way that the AssetManager.loadAsset(com.jme3.asset.AssetKey) method locates assets.

Specified by:

locateAsset in interface AssetManager

Parameters:

key - The AssetKey to locate.

Returns:

The AssetInfo object returned from the AssetLocator that located the asset, or null if the asset cannot be located.

loadAssetFromStreamAsync

public <T> void loadAssetFromStreamAsync(AssetKey<T> key,
 InputStream inputStream,
 BiConsumer<T,Throwable> callback)

loadAssetFromStream

public <T> T loadAssetFromStream(AssetKey<T> key,
 InputStream inputStream)

Description copied from interface: AssetManager

Load an asset from an InputStream. In some cases it may be required to load an asset from memory or arbitrary streams so that registering a custom locator and key type is not necessary.

Specified by:

loadAssetFromStream in interface AssetManager

Type Parameters:

T - The object type that will be loaded from the AssetKey instance.

Parameters:

key - The AssetKey. Note that the asset will not be cached - following the same behavior as if AssetKey.getCacheType() returned null.

inputStream - The input stream from which the asset shall be loaded.

Returns:

The loaded asset.

registerLoader

public void registerLoader(Class<? extends AssetLoader> loaderClass,
 String... extensions)

Description copied from interface: AssetManager

Register an AssetLoader by using a class object.

Specified by:

registerLoader in interface AssetManager

Parameters:

loaderClass - The loader class to register.

extensions - Which extensions this loader is responsible for loading, if there are already other loaders registered for that extension, they will be overridden - there should only be one loader for each extension.

unregisterLoader

public void unregisterLoader(Class<? extends AssetLoader> loaderClass)

Description copied from interface: AssetManager

Unregister a AssetLoader from loading its assigned extensions. This undoes the effect of calling AssetManager.registerLoader(java.lang.Class, java.lang.String[]).

Specified by:

unregisterLoader in interface AssetManager

Parameters:

loaderClass - The loader class to unregister.

See Also:

• AssetManager.registerLoader(java.lang.Class, java.lang.String[])

registerLocator

public void registerLocator(String rootPath,
 Class<? extends AssetLocator> locatorClass)

Description copied from interface: AssetManager

Registers the given locator class for locating assets with this AssetManager. AssetLocators are invoked in the order they were registered, to locate the asset by the AssetKey. Once an AssetLocator returns a non-null AssetInfo, it is sent to the AssetLoader to load the asset. Once a locator is registered, it can be removed via AssetManager.unregisterLocator(java.lang.String, java.lang.Class).

Specified by:

registerLocator in interface AssetManager

Parameters:

rootPath - Specifies the root path from which to locate assets for the given AssetLocator. The purpose of this parameter depends on the type of the AssetLocator.

locatorClass - The class type of the AssetLocator to register.

See Also:

• AssetLocator.setRootPath(java.lang.String)
• AssetLocator.locate(com.jme3.asset.AssetManager, com.jme3.asset.AssetKey)
• AssetManager.unregisterLocator(java.lang.String, java.lang.Class)

unregisterLocator

public void unregisterLocator(String rootPath,
 Class<? extends AssetLocator> locatorClass)

Description copied from interface: AssetManager

Unregisters the given locator class. This essentially undoes the operation done by AssetManager.registerLocator(java.lang.String, java.lang.Class).

Specified by:

unregisterLocator in interface AssetManager

Parameters:

rootPath - Should be the same as the root path specified in AssetManager.registerLocator(java.lang.String, java.lang.Class).

locatorClass - The locator class to unregister

See Also:

• AssetManager.registerLocator(java.lang.String, java.lang.Class)

addAssetEventListener

public void addAssetEventListener(AssetEventListener listener)

Description copied from interface: AssetManager

Add an AssetEventListener to receive events from this AssetManager.

Specified by:

addAssetEventListener in interface AssetManager

Parameters:

listener - The asset event listener to add

removeAssetEventListener

public void removeAssetEventListener(AssetEventListener listener)

Description copied from interface: AssetManager

Remove an AssetEventListener from receiving events from this AssetManager

Specified by:

removeAssetEventListener in interface AssetManager

Parameters:

listener - The asset event listener to remove

clearAssetEventListeners

public void clearAssetEventListeners()

Description copied from interface: AssetManager

Removes all asset event listeners.

Specified by:

clearAssetEventListeners in interface AssetManager

See Also:

• AssetManager.addAssetEventListener(com.jme3.asset.AssetEventListener)

setShaderGenerator

public void setShaderGenerator(ShaderGenerator generator)

Description copied from interface: AssetManager

Sets the shaderGenerator to generate shaders based on shaderNodes.

Specified by:

setShaderGenerator in interface AssetManager

Parameters:

generator - the shaderGenerator

getShaderGenerator

public ShaderGenerator getShaderGenerator(EnumSet<Caps> caps)

Description copied from interface: AssetManager

Returns the shaderGenerator responsible for generating the shaders

Specified by:

getShaderGenerator in interface AssetManager

Parameters:

caps - a set of required capabilities

Returns:

the shaderGenerator

getFromCache

public <T> T getFromCache(AssetKey<T> key)

Description copied from interface: AssetManager

Retrieve an asset from the asset cache. NOTE: Do not modify the returned asset! It is the same reference as what is stored in the cache, therefore any modifications to it will leak onto assets loaded from the same key in the future.

Specified by:

getFromCache in interface AssetManager

Type Parameters:

T - The object type that will be retrieved from the AssetKey instance.

Parameters:

key - The AssetKey to get from the cache.

Returns:

The cached asset, if found. Otherwise, null.

addToCache

public <T> void addToCache(AssetKey<T> key,
 T asset)

Description copied from interface: AssetManager

Inject an asset into the asset cache. NOTE: Do not modify the cached asset after storing! It is the same reference as what is stored in the cache, therefore any modifications to it will leak onto assets loaded from the same key in the future.

Specified by:

addToCache in interface AssetManager

Type Parameters:

T - The object type of the asset.

Parameters:

key - The key where the asset shall be stored.

asset - The asset to inject into the cache.

deleteFromCache

public <T> boolean deleteFromCache(AssetKey<T> key)

Description copied from interface: AssetManager

Delete an asset from the asset cache.

Specified by:

deleteFromCache in interface AssetManager

Type Parameters:

T - The object type of the AssetKey instance.

Parameters:

key - The asset key to remove from the cache.

Returns:

True if the asset key was found in the cache and was removed successfully. False if the asset key was not present in the cache.

clearCache

public void clearCache()

Description copied from interface: AssetManager

Clears the asset cache.

Specified by:

clearCache in interface AssetManager