com.jme3.asset

Class DesktopAssetManager

java.lang.Object

com.jme3.asset.DesktopAssetManager

All Implemented Interfaces:

AssetManager

public class DesktopAssetManager
extends java.lang.Object
implements AssetManager

AssetManager is the primary method for managing and loading assets inside jME.

Constructor Summary

Constructors

Constructor and Description
DesktopAssetManager()
DesktopAssetManager(boolean usePlatformConfig)
DesktopAssetManager(java.net.URL configFile)

Method Summary

Modifier and Type	Method and Description
void	addAssetEventListener(AssetEventListener listener) Add an AssetEventListener to receive events from this AssetManager.
void	addClassLoader(java.lang.ClassLoader loader) Adds a ClassLoader that is used to load classes that are needed for finding and loading Assets.
<T> void	addToCache(AssetKey<T> key, T asset) Inject an asset into the asset cache.
void	clearAssetEventListeners() Removes all asset event listeners.
void	clearCache() Clears the asset cache.
<T> boolean	deleteFromCache(AssetKey<T> key) Delete an asset from the asset cache.
java.util.List<java.lang.ClassLoader>	getClassLoaders() Retrieve the list of registered ClassLoaders that are used for loading classes from asset files.
<T> T	getFromCache(AssetKey<T> key) Retrieve an asset from the asset cache.
ShaderGenerator	getShaderGenerator(java.util.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.
java.lang.Object	loadAsset(java.lang.String name) Load an asset by name, calling this method is the same as calling loadAsset(new AssetKey(name)).
<T> T	loadAssetFromStream(AssetKey<T> key, java.io.InputStream inputStream) Load an asset from an InputStream.
AudioData	loadAudio(AudioKey key) Load audio file, supported types are WAV or OGG.
AudioData	loadAudio(java.lang.String name) Load audio file, supported types are WAV or OGG.
FilterPostProcessor	loadFilter(FilterKey key) Loads a filter *.j3f file with a FilterKey.
FilterPostProcessor	loadFilter(java.lang.String name) Loads a filter *.j3f file with a FilterKey.
BitmapFont	loadFont(java.lang.String name) Load a font file.
protected <T> T	loadLocatedAsset(AssetKey<T> key, AssetInfo info, AssetProcessor proc, AssetCache cache) Loads an asset that has already been located.
Material	loadMaterial(java.lang.String name) Load a material instance (J3M) file.
Spatial	loadModel(ModelKey key) Loads a 3D model with a ModelKey.
Spatial	loadModel(java.lang.String name) Loads a 3D model.
Texture	loadTexture(java.lang.String name) Loads texture file, supported types are BMP, JPG, PNG, GIF, TGA, DDS, PFM, and HDR.
Texture	loadTexture(TextureKey key) Loads texture file, supported types are BMP, JPG, PNG, GIF, TGA, DDS, PFM, and HDR.
AssetInfo	locateAsset(AssetKey<?> key) Manually locates an asset with the given AssetKey.
protected <T> T	registerAndCloneSmartAsset(AssetKey<T> key, T obj, AssetProcessor proc, AssetCache cache) Clones the asset using the given processor and registers the clone with the cache.
void	registerLoader(java.lang.Class<? extends AssetLoader> loader, java.lang.String... extensions) Register an AssetLoader by using a class object.
void	registerLoader(java.lang.String clsName, java.lang.String... extensions)
void	registerLocator(java.lang.String rootPath, java.lang.Class<? extends AssetLocator> locatorClass) Registers the given locator class for locating assets with this AssetManager.
void	registerLocator(java.lang.String rootPath, java.lang.String clsName)
void	removeAssetEventListener(AssetEventListener listener) Remove an AssetEventListener from receiving events from this AssetManager
void	removeClassLoader(java.lang.ClassLoader loader) Remove a ClassLoader from the list of registered ClassLoaders
void	setAssetEventListener(AssetEventListener listener)
void	setShaderGenerator(ShaderGenerator shaderGenerator) Sets the shaderGenerator to generate shaders based on shaderNodes.
void	unregisterLoader(java.lang.Class<? extends AssetLoader> loaderClass) Unregister a AssetLoader from loading its assigned extensions.
void	unregisterLocator(java.lang.String rootPath, java.lang.Class<? extends AssetLocator> clazz) Unregisters the given locator class.

Methods inherited from class java.lang.Object

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

Constructor Detail

DesktopAssetManager

public DesktopAssetManager()

DesktopAssetManager

public DesktopAssetManager(boolean usePlatformConfig)

DesktopAssetManager

public DesktopAssetManager(java.net.URL configFile)

Method Detail

addClassLoader

public void addClassLoader(java.lang.ClassLoader loader)

Description copied from interface: AssetManager

Adds a ClassLoader that is used to load classes that are needed for finding and loading Assets. This does not allow loading assets from that classpath, use registerLocator for that.

Specified by:

addClassLoader in interface AssetManager

Parameters:

loader - A ClassLoader that Classes in asset files can be loaded from.

removeClassLoader

public void removeClassLoader(java.lang.ClassLoader loader)

Description copied from interface: AssetManager

Remove a ClassLoader from the list of registered ClassLoaders

Specified by:

removeClassLoader in interface AssetManager

Parameters:

loader - the ClassLoader to be removed

getClassLoaders

public java.util.List<java.lang.ClassLoader> getClassLoaders()

Description copied from interface: AssetManager

Retrieve the list of registered ClassLoaders that are used for loading classes from asset files.

Specified by:

getClassLoaders in interface AssetManager

Returns:

an unmodifiable list

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)

setAssetEventListener

public void setAssetEventListener(AssetEventListener listener)

registerLoader

public void registerLoader(java.lang.Class<? extends AssetLoader> loader,
                           java.lang.String... extensions)

Description copied from interface: AssetManager

Register an AssetLoader by using a class object.

Specified by:

registerLoader in interface AssetManager

Parameters:

loader - 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.

registerLoader

public void registerLoader(java.lang.String clsName,
                           java.lang.String... extensions)

unregisterLoader

public void unregisterLoader(java.lang.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(java.lang.String rootPath,
                            java.lang.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)

registerLocator

public void registerLocator(java.lang.String rootPath,
                            java.lang.String clsName)

unregisterLocator

public void unregisterLocator(java.lang.String rootPath,
                              java.lang.Class<? extends AssetLocator> clazz)

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).

clazz - The locator class to unregister

See Also:

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

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.

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

loadLocatedAsset

protected <T> T loadLocatedAsset(AssetKey<T> key,
                                 AssetInfo info,
                                 AssetProcessor proc,
                                 AssetCache cache)

Loads an asset that has already been located.

Type Parameters:

T - The asset type

Parameters:

key - The asset key

info - The AssetInfo from the locator

proc - AssetProcessor to use, or null to disable processing

cache - The cache to store the asset in, or null to disable caching

Returns:

The loaded asset

Throws:

AssetLoadException - If failed to load asset due to exception or other error.

registerAndCloneSmartAsset

protected <T> T registerAndCloneSmartAsset(AssetKey<T> key,
                                           T obj,
                                           AssetProcessor proc,
                                           AssetCache cache)

Clones the asset using the given processor and registers the clone with the cache.

Type Parameters:

T - The asset type

Parameters:

key - The asset key

obj - The asset to clone / register, must implement CloneableSmartAsset.

proc - The processor which will generate the clone, cannot be null

cache - The cache to register the clone with, cannot be null.

Returns:

The cloned asset, cannot be the same as the given asset since it is a clone.

Throws:

java.lang.IllegalStateException - If asset does not implement CloneableSmartAsset, if the cache is null, or if the processor did not clone the asset.

loadAssetFromStream

public <T> T loadAssetFromStream(AssetKey<T> key,
                                 java.io.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.

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.

loadAsset

public java.lang.Object loadAsset(java.lang.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)

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)

loadMaterial

public Material loadMaterial(java.lang.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)

loadTexture

public Texture loadTexture(java.lang.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)

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)

loadAudio

public AudioData loadAudio(java.lang.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)

loadFont

public BitmapFont loadFont(java.lang.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)

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)

loadModel

public Spatial loadModel(java.lang.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)

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)

loadFilter

public FilterPostProcessor loadFilter(java.lang.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)

getShaderGenerator

public ShaderGenerator getShaderGenerator(java.util.EnumSet<Caps> caps)

Returns the shaderGenerator responsible for generating the shaders

Specified by:

getShaderGenerator in interface AssetManager

Parameters:

caps - a set of required capabilities

Returns:

the shaderGenerator

setShaderGenerator

public void setShaderGenerator(ShaderGenerator shaderGenerator)

Sets the shaderGenerator to generate shaders based on shaderNodes.

Specified by:

setShaderGenerator in interface AssetManager

Parameters:

shaderGenerator - the shaderGenerator