com.bonzaiengine.model.asset

Class ModelLibrary

java.lang.Object

com.bonzaiengine.model.asset.AssetLibrary<ModelReaderSettings,AsyncModel>

com.bonzaiengine.model.asset.ModelLibrary

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<ModelReaderSettings,AsyncModel>>

public class ModelLibrary
extends AssetLibrary<ModelReaderSettings,AsyncModel>

Library to stored AsyncModel

Constructor Summary

Constructors

Constructor and Description
ModelLibrary()
ModelLibrary(boolean concurrent)
ModelLibrary(boolean concurrent, boolean soft)

Method Summary

Modifier and Type	Method and Description
void	add(ModelReaderSettings assetKey, AsyncModel asset) Add an asset to the library.
boolean	contains(java.lang.String id)
void	destroy(IGL gl, AsyncModel asyncModel) Destroy the specified model from this ModelLibrary
void	destroyAll(IGL gl) Destroy (unload + remove) all models from this ModelLibrary
void	destroyUnreferenced(IGL gl) Destroy (unload + remove) unreferenced models from this ModelLibrary
AsyncModel	get(java.lang.String id)
ModelReaderSettings	getKey(java.lang.String id)
void	onContextLost()
AsyncModel	remove(java.lang.String id) Remove the AsyncModel with the specified id.
void	unloadAll(IGL gl) Unload all models from this ModelLibrary
void	unloadUnreferenced(IGL gl) Unload unreferenced models from this ModelLibrary
AsyncModel	use(AssetManager assets, ModelReaderSettings settings) AsyncModel.release() must be called on the result returned when it's not used anymore.

Methods inherited from class com.bonzaiengine.model.asset.AssetLibrary

assets, clear, contains, get, getKey, iterator, remove, removeValue, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ModelLibrary

public ModelLibrary()

ModelLibrary

public ModelLibrary(boolean concurrent)

ModelLibrary

public ModelLibrary(boolean concurrent,
                    boolean soft)

Method Detail

add

public void add(ModelReaderSettings assetKey,
                AsyncModel asset)
         throws java.lang.IllegalArgumentException

Description copied from class: AssetLibrary

Add an asset to the library.

Overrides:

add in class AssetLibrary<ModelReaderSettings,AsyncModel>

Parameters:

assetKey - asset key, usually the loading information

asset - asset to store in the library

Throws:

java.lang.IllegalArgumentException - when the asset is already in the library

use

public AsyncModel use(AssetManager assets,
                      ModelReaderSettings settings)

AsyncModel.release() must be called on the result returned when it's not used anymore.

Parameters:

assets - AssetManager

settings - ModelReaderSettings of the model to register

Returns:

existing or new AsyncModel, with reference count incremented

get

public AsyncModel get(java.lang.String id)

Parameters:

id - name identifier for the key

Returns:

the asset key, null if not found

getKey

public ModelReaderSettings getKey(java.lang.String id)

Parameters:

id - name identifier for the key

Returns:

the asset key, null if not found

remove

public AsyncModel remove(java.lang.String id)

Remove the AsyncModel with the specified id.
The AsyncModel is not destroy.

Parameters:

id - name of the asset to remove

Returns:

the asset removed, null if nothing removed

contains

public boolean contains(java.lang.String id)

Returns:

true if the library contains the asset key associated to the name

destroyAll

public final void destroyAll(IGL gl)

Destroy (unload + remove) all models from this ModelLibrary

destroyUnreferenced

public final void destroyUnreferenced(IGL gl)

Destroy (unload + remove) unreferenced models from this ModelLibrary

unloadAll

public final void unloadAll(IGL gl)

Unload all models from this ModelLibrary

unloadUnreferenced

public final void unloadUnreferenced(IGL gl)

Unload unreferenced models from this ModelLibrary

destroy

public final void destroy(IGL gl,
                          AsyncModel asyncModel)

Destroy the specified model from this ModelLibrary

onContextLost

public final void onContextLost()