com.badlogic.gdx.maps.tiled

Class TmxMapLoader

java.lang.Object

com.badlogic.gdx.assets.loaders.AssetLoader<T,P>

com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader<TiledMap,P>

com.badlogic.gdx.maps.tiled.BaseTmxMapLoader<TmxMapLoader.Parameters>

com.badlogic.gdx.maps.tiled.TmxMapLoader

public class TmxMapLoader
extends BaseTmxMapLoader<TmxMapLoader.Parameters>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TmxMapLoader.Parameters

Constructor Summary

Constructors

Constructor and Description
TmxMapLoader()
TmxMapLoader(FileHandleResolver resolver) Creates loader

Method Summary

Methods

Modifier and Type	Method and Description
Array<AssetDescriptor>	getDependencies(String fileName, FileHandle tmxFile, TmxMapLoader.Parameters parameter) Retrieves TiledMap resource dependencies
TiledMap	load(String fileName) Loads the TiledMap from the given file.
TiledMap	load(String fileName, TmxMapLoader.Parameters parameters) Loads the TiledMap from the given file.
void	loadAsync(AssetManager manager, String fileName, FileHandle tmxFile, TmxMapLoader.Parameters parameter) Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.
TiledMap	loadSync(AssetManager manager, String fileName, FileHandle file, TmxMapLoader.Parameters parameter) Loads the OpenGL part of the asset.

Methods inherited from class com.badlogic.gdx.maps.tiled.BaseTmxMapLoader

getTileIds

Methods inherited from class com.badlogic.gdx.assets.loaders.AssetLoader

resolve

Methods inherited from class java.lang.Object

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

Constructor Detail

TmxMapLoader

public TmxMapLoader()

TmxMapLoader

public TmxMapLoader(FileHandleResolver resolver)

Creates loader

Parameters:

resolver -

Method Detail

load

public TiledMap load(String fileName)

Loads the TiledMap from the given file. The file is resolved via the FileHandleResolver set in the constructor of this class. By default it will resolve to an internal file. The map will be loaded for a y-up coordinate system.

Parameters:

fileName - the filename

Returns:

the TiledMap

load

public TiledMap load(String fileName,
            TmxMapLoader.Parameters parameters)

Loads the TiledMap from the given file. The file is resolved via the FileHandleResolver set in the constructor of this class. By default it will resolve to an internal file.

Parameters:

fileName - the filename

parameters - specifies whether to use y-up, generate mip maps etc.

Returns:

the TiledMap

loadAsync

public void loadAsync(AssetManager manager,
             String fileName,
             FileHandle tmxFile,
             TmxMapLoader.Parameters parameter)

Description copied from class: AsynchronousAssetLoader

Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.

Specified by:

loadAsync in class AsynchronousAssetLoader<TiledMap,TmxMapLoader.Parameters>

fileName - the name of the asset to load

tmxFile - the resolved file to load

parameter - the parameters to use for loading the asset

loadSync

public TiledMap loadSync(AssetManager manager,
                String fileName,
                FileHandle file,
                TmxMapLoader.Parameters parameter)

Description copied from class: AsynchronousAssetLoader

Loads the OpenGL part of the asset.

Specified by:

loadSync in class AsynchronousAssetLoader<TiledMap,TmxMapLoader.Parameters>

file - the resolved file to load

getDependencies

public Array<AssetDescriptor> getDependencies(String fileName,
                                     FileHandle tmxFile,
                                     TmxMapLoader.Parameters parameter)

Retrieves TiledMap resource dependencies

Specified by:

getDependencies in class AssetLoader<TiledMap,TmxMapLoader.Parameters>

Parameters:

fileName -

parameter - not used for now

tmxFile - the resolved file to load

Returns:

dependencies for the given .tmx file