org.mini2Dx.ui

Class UiModelLoader

java.lang.Object

org.mini2Dx.ui.UiModelLoader

All Implemented Interfaces:

AssetLoader<UiModel>, AsyncAssetLoader<UiModel>

public class UiModelLoader
extends java.lang.Object
implements AsyncAssetLoader<UiModel>

A AsyncAssetLoader for loading UiModel instances

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UiModelLoader.UiModelAssetProperties the UiModelAssetProperty holds the UiModel instance to be populated

Constructor Summary

Constructors

Constructor and Description
UiModelLoader(FileHandleResolver fileHandleResolver) Constructor

Method Summary

Modifier and Type	Method and Description
org.mini2Dx.gdx.utils.Array<AssetDescriptor>	getDependencies(AssetDescriptor assetDescriptor, AsyncLoadingCache asyncLoadingCache) Returns an Array of assets that the requested asset depends on
void	loadOnAsyncThread(AssetDescriptor assetDescriptor, AsyncLoadingCache asyncLoadingCache) Loads an asset (or partial data) via a non-main thread
boolean	loadOnGameThread(AssetManager assetManager, AssetDescriptor<UiModel> assetDescriptor, AsyncLoadingCache asyncLoadingCache, AssetLoaderResult<UiModel> resultHolder) Loads an asset on the main game thread

Methods inherited from class java.lang.Object

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

Constructor Detail

UiModelLoader

public UiModelLoader(FileHandleResolver fileHandleResolver)

Constructor

Parameters:

fileHandleResolver - The FileHandleResolver to use

Method Detail

loadOnGameThread

public boolean loadOnGameThread(AssetManager assetManager,
                                AssetDescriptor<UiModel> assetDescriptor,
                                AsyncLoadingCache asyncLoadingCache,
                                AssetLoaderResult<UiModel> resultHolder)

Description copied from interface: AssetLoader

Loads an asset on the main game thread

Specified by:

loadOnGameThread in interface AssetLoader<UiModel>

Parameters:

assetManager - The AssetManager executing the loading

assetDescriptor - A descriptor of the asset to be loaded

asyncLoadingCache - Stores values loaded on other threads

resultHolder - Stores the resulting object

Returns:

True if loading is complete

loadOnAsyncThread

public void loadOnAsyncThread(AssetDescriptor assetDescriptor,
                              AsyncLoadingCache asyncLoadingCache)

Description copied from interface: AsyncAssetLoader

Loads an asset (or partial data) via a non-main thread

Specified by:

loadOnAsyncThread in interface AsyncAssetLoader<UiModel>

Parameters:

assetDescriptor - A descriptor of the asset to be loaded

asyncLoadingCache - Stores data in this cache to pass to the game thread loading

getDependencies

public org.mini2Dx.gdx.utils.Array<AssetDescriptor> getDependencies(AssetDescriptor assetDescriptor,
                                                                    AsyncLoadingCache asyncLoadingCache)

Description copied from interface: AssetLoader

Returns an Array of assets that the requested asset depends on

Specified by:

getDependencies in interface AssetLoader<UiModel>

Parameters:

assetDescriptor - A descriptor of the asset to be loaded

asyncLoadingCache - Stores values loaded on other threads

Returns:

An empty instance of Array or null if there's no dependencies