de.verygame.surface.resource

Class ResourceHandler

java.lang.Object

de.verygame.surface.event.EventHandler

de.verygame.surface.resource.ResourceHandler

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable

public class ResourceHandler
extends EventHandler
implements com.badlogic.gdx.utils.Disposable

Constructor Summary

Constructors

Constructor and Description
ResourceHandler() Creates a resource handler.

Method Summary

Modifier and Type	Method and Description
void	addResource(ResourceType resourceType, java.lang.String pathToFile) Add a whole folder, which contains resources of the given type.
com.badlogic.gdx.graphics.g2d.BitmapFont	createCachedFont(Resource freeTypeFont, com.badlogic.gdx.graphics.g2d.freetype.FreeTypeFontGenerator.FreeTypeFontParameter parameter) Create or simply get a cached font.
com.badlogic.gdx.graphics.g2d.BitmapFont	createFont(ResourceUnit freeTypeFont, com.badlogic.gdx.graphics.g2d.freetype.FreeTypeFontGenerator.FreeTypeFontParameter parameter) Create a font with the help of font parameters.
boolean	destroyCachedFont(com.badlogic.gdx.graphics.g2d.BitmapFont font) Destroy a cached font.
void	dispose()
<T> T	get(Resource res, java.lang.Class<T> type) Generic method to retrieve a previously loaded resource.
<T> T	get(java.lang.String res, java.lang.Class<T> type) Generic method to retrieve a previously loaded resource.
com.badlogic.gdx.graphics.g2d.BitmapFont	getFont(ResourceUnit fontUnit) Returns font mapped to the given resource unit.
float	getProgress()
com.badlogic.gdx.graphics.g2d.TextureRegion	getRegion(ResourceUnit region) Returns region identified by the given resource unit.
java.lang.String	getString(java.lang.String stringId) Retrieves string mapped to the given id.
java.lang.String	getXML(Resource xmlResource) Returns loaded xml as string identified by a Resource.
java.lang.String	getXML(java.lang.String xmlName) Returns a whole xml file as string.
java.io.InputStream	getXMLAsStream(Resource xmlResource)
void	increaseCachedFontReferenceCount(com.badlogic.gdx.graphics.g2d.BitmapFont font) Increase the reference count of the given cached font or does nothing if the given font is not cached.
void	loadLanguage(java.util.Locale lang) Load available language.
void	loadResource(Resource... resources) Load given resources.
void	loadResourceExcept(Resource[] resources, Resource... excludeResources) Load given resources except the defined exception.
void	loadSkin(Resource res, Resource atlas, com.badlogic.gdx.utils.ObjectMap<java.lang.String,java.lang.Object> oMap) Loads a skin with the specified oMap
void	loadSkin(Resource res, Resource atlas, ResourceUnit fontUnit) Loads akin with the specified fontUnit as attached object.
void	scaleNinePatchesIn(Resource skinRes, float scale) Scales all ninpatches of the given skin by scale.
boolean	update() Makes the resource handler update his internal state.
void	waitFor(Resource resource) Waits for the given resource to be loaded.
void	waitForAssets() Waits for all loaded assets.

Methods inherited from class de.verygame.surface.event.EventHandler

emitEvent, isRegistered, register, register, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceHandler

public ResourceHandler()

Creates a resource handler.

Method Detail

loadResource

public void loadResource(Resource... resources)

Load given resources.

Parameters:

resources - resources to be loaded

loadResourceExcept

public void loadResourceExcept(Resource[] resources,
                               Resource... excludeResources)

Load given resources except the defined exception. (Made for the use of Enum.values()).

Parameters:

resources - resources to be loaded

excludeResources - exceptions

addResource

public void addResource(ResourceType resourceType,
                        java.lang.String pathToFile)

Add a whole folder, which contains resources of the given type.

Parameters:

resourceType - type of the resources in the folder

pathToFile - path to the folder

loadLanguage

public void loadLanguage(java.util.Locale lang)

Load available language. Resource handler emits an event after calling this method successfully.

Parameters:

lang - new language

getString

public java.lang.String getString(java.lang.String stringId)

Retrieves string mapped to the given id. String will obtained via current language bundle. To change the language call loadLanguage(Locale).

Parameters:

stringId - id of the string

Returns:

mapped string

getXML

public java.lang.String getXML(java.lang.String xmlName)

Returns a whole xml file as string.

Parameters:

xmlName - name of the xml file

Returns:

content of the file

getRegion

public com.badlogic.gdx.graphics.g2d.TextureRegion getRegion(ResourceUnit region)

Returns region identified by the given resource unit.

Parameters:

region - region mapped to the given unit

Returns:

region or null if the region does not exist.

getXML

public java.lang.String getXML(Resource xmlResource)

Returns loaded xml as string identified by a Resource.

Parameters:

xmlResource - identifier

Returns:

content of the file as string

getXMLAsStream

public java.io.InputStream getXMLAsStream(Resource xmlResource)

createFont

public com.badlogic.gdx.graphics.g2d.BitmapFont createFont(ResourceUnit freeTypeFont,
                                                           com.badlogic.gdx.graphics.g2d.freetype.FreeTypeFontGenerator.FreeTypeFontParameter parameter)

Create a font with the help of font parameters. This will map the given resource unit to the generated font. If you generate a new font with the same resource unit, the old one will get disposed.

Parameters:

freeTypeFont - unit the created font should get mapped to

parameter - FreeTypeFontGenerator.FreeTypeFontParameter

Returns:

created font

increaseCachedFontReferenceCount

public void increaseCachedFontReferenceCount(com.badlogic.gdx.graphics.g2d.BitmapFont font)

Increase the reference count of the given cached font or does nothing if the given font is not cached.

Parameters:

font - cached font, created by createCachedFont(Resource, FreeTypeFontGenerator.FreeTypeFontParameter)

destroyCachedFont

public boolean destroyCachedFont(com.badlogic.gdx.graphics.g2d.BitmapFont font)

Destroy a cached font. It might happen that the font won't get destroyed if there are more references to the font. You can just use the method with fonts generated with createCachedFont(Resource, FreeTypeFontGenerator.FreeTypeFontParameter).

Parameters:

font - font generated by createCachedFont

Returns:

false if the given font is not cached

createCachedFont

public com.badlogic.gdx.graphics.g2d.BitmapFont createCachedFont(Resource freeTypeFont,
                                                                 com.badlogic.gdx.graphics.g2d.freetype.FreeTypeFontGenerator.FreeTypeFontParameter parameter)

Create or simply get a cached font. Please always use this method to obtain a reference to the a cached font, otherwise it might end up in a native exception.

Parameters:

freeTypeFont - font generator resource

parameter - parameter to use for generation

Returns:

font

getFont

public com.badlogic.gdx.graphics.g2d.BitmapFont getFont(ResourceUnit fontUnit)

Returns font mapped to the given resource unit.

Parameters:

fontUnit - identifier

Returns:

retrieved font

loadSkin

public void loadSkin(Resource res,
                     Resource atlas,
                     ResourceUnit fontUnit)

Loads akin with the specified fontUnit as attached object.

Parameters:

res - resource

atlas - atlas of the skin

fontUnit - font unit

loadSkin

public void loadSkin(Resource res,
                     Resource atlas,
                     com.badlogic.gdx.utils.ObjectMap<java.lang.String,java.lang.Object> oMap)

Loads a skin with the specified oMap

Parameters:

res - resources

atlas - atlas of the skin

oMap - map

scaleNinePatchesIn

public void scaleNinePatchesIn(Resource skinRes,
                               float scale)

Scales all ninpatches of the given skin by scale.

Parameters:

skinRes - skin

scale - scale-factor

get

public <T> T get(Resource res,
                 java.lang.Class<T> type)

Generic method to retrieve a previously loaded resource.

Type Parameters:

T - for generic usage

Parameters:

res - resource identifier

type - type of the resource

Returns:

resource or null

get

public <T> T get(java.lang.String res,
                 java.lang.Class<T> type)

Generic method to retrieve a previously loaded resource.

Type Parameters:

T - for generic usage

Parameters:

res - path to the resource

type - type of the resource

Returns:

resource or null

update

public boolean update()

Makes the resource handler update his internal state.

Returns:

true when the handler has finished

getProgress

public float getProgress()

Returns:

progress of loading resources in percent (0 to 1)

waitForAssets

public void waitForAssets()

Waits for all loaded assets.

waitFor

public void waitFor(Resource resource)

Waits for the given resource to be loaded.

Parameters:

resource - resource to wait for

dispose

public void dispose()

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable