|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jme3.asset.DesktopAssetManager
public class DesktopAssetManager
AssetManager
is the primary method for managing and loading
assets inside jME.
Constructor Summary | |
---|---|
DesktopAssetManager()
|
|
DesktopAssetManager(boolean loadDefaults)
Deprecated. |
|
DesktopAssetManager(java.net.URL configFile)
|
Method Summary | ||
---|---|---|
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. |
|
|
addToCache(AssetKey<T> key,
T asset)
|
|
void |
clearAssetEventListeners()
Removes all asset event listeners. |
|
void |
clearCache()
|
|
|
deleteFromCache(AssetKey<T> key)
|
|
java.util.List<java.lang.ClassLoader> |
getClassLoaders()
Retrieve the list of registered ClassLoaders that are used for loading classes from asset files. |
|
|
getFromCache(AssetKey<T> key)
|
|
|
loadAsset(AssetKey<T> key)
Thread-safe. |
|
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)). |
|
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. |
|
BitmapFont |
loadFont(java.lang.String name)
Load a font file. |
|
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. |
|
Shader |
loadShader(ShaderKey key)
Load a vertex/fragment shader combo. |
|
Texture |
loadTexture(java.lang.String name)
Loads texture file, supported types are BMP, JPG, PNG, GIF, TGA and DDS. |
|
Texture |
loadTexture(TextureKey key)
Loads texture file, supported types are BMP, JPG, PNG, GIF, TGA and DDS. |
|
AssetInfo |
locateAsset(AssetKey<?> key)
Manually locates an asset with the given AssetKey . |
|
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)
Registers a loader for the given 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)
Registers an AssetLocator by using a class name. |
|
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)
Set an AssetEventListener to receive events from this
AssetManager . |
|
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 |
---|
public DesktopAssetManager()
@Deprecated public DesktopAssetManager(boolean loadDefaults)
public DesktopAssetManager(java.net.URL configFile)
Method Detail |
---|
public void addClassLoader(java.lang.ClassLoader loader)
AssetManager
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.
addClassLoader
in interface AssetManager
loader
- A ClassLoader that Classes in asset files can be loaded from.public void removeClassLoader(java.lang.ClassLoader loader)
AssetManager
ClassLoader
from the list of registered ClassLoaders
removeClassLoader
in interface AssetManager
public java.util.List<java.lang.ClassLoader> getClassLoaders()
AssetManager
classes
from asset files.
getClassLoaders
in interface AssetManager
public void addAssetEventListener(AssetEventListener listener)
AssetManager
AssetEventListener
to receive events from this
AssetManager
.
addAssetEventListener
in interface AssetManager
listener
- The asset event listener to addpublic void removeAssetEventListener(AssetEventListener listener)
AssetManager
AssetEventListener
from receiving events from this
AssetManager
removeAssetEventListener
in interface AssetManager
listener
- The asset event listener to removepublic void clearAssetEventListeners()
AssetManager
clearAssetEventListeners
in interface AssetManager
AssetManager.addAssetEventListener(com.jme3.asset.AssetEventListener)
public void setAssetEventListener(AssetEventListener listener)
AssetManager
AssetEventListener
to receive events from this
AssetManager
. Any currently added listeners are
cleared and then the given listener is added.
setAssetEventListener
in interface AssetManager
listener
- The listener to setpublic void registerLoader(java.lang.Class<? extends AssetLoader> loader, java.lang.String... extensions)
AssetManager
AssetLoader
by using a class object.
registerLoader
in interface AssetManager
public void registerLoader(java.lang.String clsName, java.lang.String... extensions)
AssetManager
registerLoader
in interface AssetManager
public void unregisterLoader(java.lang.Class<? extends AssetLoader> loaderClass)
AssetManager
AssetLoader
from loading its assigned extensions.
This undoes the effect of calling
AssetManager.registerLoader(java.lang.Class, java.lang.String[])
.
unregisterLoader
in interface AssetManager
loaderClass
- The loader class to unregister.AssetManager.registerLoader(java.lang.Class, java.lang.String[])
public void registerLocator(java.lang.String rootPath, java.lang.Class<? extends AssetLocator> locatorClass)
AssetManager
AssetManager
. AssetLocator
s 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)
.
registerLocator
in interface AssetManager
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.AssetLocator.setRootPath(java.lang.String)
,
AssetLocator.locate(com.jme3.asset.AssetManager, com.jme3.asset.AssetKey)
,
AssetManager.unregisterLocator(java.lang.String, java.lang.Class)
public void registerLocator(java.lang.String rootPath, java.lang.String clsName)
AssetManager
AssetLocator
by using a class name.
See the AssetManager.registerLocator(java.lang.String, java.lang.Class)
method for more information.
registerLocator
in interface AssetManager
rootPath
- The root path from which to locate assets, this
depends on the implementation of the asset locator.
A URL based locator will expect a url folder such as "http://www.example.com/"
while a File based locator will expect a file path (OS dependent).clsName
- The full class name of the AssetLocator
implementation.public void unregisterLocator(java.lang.String rootPath, java.lang.Class<? extends AssetLocator> clazz)
AssetManager
AssetManager.registerLocator(java.lang.String, java.lang.Class)
.
unregisterLocator
in interface AssetManager
rootPath
- Should be the same as the root path specified in AssetManager.registerLocator(java.lang.String, java.lang.Class)
.clazz
- The locator class to unregisterAssetManager.registerLocator(java.lang.String, java.lang.Class)
public AssetInfo locateAsset(AssetKey<?> key)
AssetManager
AssetKey
. This method
should be used for debugging or internal uses. AssetLocator
that are registered with this AssetManager
,
in the same way that the AssetManager.loadAsset(com.jme3.asset.AssetKey)
method locates assets.
locateAsset
in interface AssetManager
key
- The AssetKey
to locate.
AssetInfo
object returned from the AssetLocator
that located the asset, or null if the asset cannot be located.public <T> T getFromCache(AssetKey<T> key)
public <T> void addToCache(AssetKey<T> key, T asset)
public <T> boolean deleteFromCache(AssetKey<T> key)
public void clearCache()
public <T> T loadAsset(AssetKey<T> key)
loadAsset
in interface AssetManager
T
- key
-
public java.lang.Object loadAsset(java.lang.String name)
AssetManager
loadAsset(new AssetKey(name)).
loadAsset
in interface AssetManager
name
- The name of the asset to load.
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public Texture loadTexture(TextureKey key)
AssetManager
loadTexture
in interface AssetManager
key
- The TextureKey
to use for loading.
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public Material loadMaterial(java.lang.String name)
AssetManager
loadMaterial
in interface AssetManager
name
- Asset name of the material to load
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public Texture loadTexture(java.lang.String name)
AssetManager
loadTexture
in interface AssetManager
name
- The name of the texture to load.
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public AudioData loadAudio(AudioKey key)
AssetManager
loadAudio
in interface AssetManager
key
- Asset key of the audio file to load
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public AudioData loadAudio(java.lang.String name)
AssetManager
loadAudio
in interface AssetManager
name
- Asset name of the audio file to load
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public BitmapFont loadFont(java.lang.String name)
AssetManager
loadFont
in interface AssetManager
name
- Asset name of the font to load
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public Spatial loadModel(ModelKey key)
AssetManager
loadModel
in interface AssetManager
key
- Asset key of the model to load
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public Spatial loadModel(java.lang.String name)
AssetManager
loadModel
in interface AssetManager
name
- Asset name of the model to load
AssetManager.loadAsset(com.jme3.asset.AssetKey)
public Shader loadShader(ShaderKey key)
loadShader
in interface AssetManager
key
-
Shader
AssetManager.loadAsset(com.jme3.asset.AssetKey)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |