org.achtern.AchternEngine.core.resource

Class BasicResourceLoader

java.lang.Object

org.achtern.AchternEngine.core.resource.BasicResourceLoader

All Implemented Interfaces:

ResourceLoaderProvider

public class BasicResourceLoader
extends Object
implements ResourceLoaderProvider

The ResourceLoader is the main entry point to the FileSystem and other Resources. The ResourceLoader allows you to load Meshes and Figures, Shaders (GLSLProgram), Textures and any type of String from a file. You can easily load your own resources from any type of file. You can get URLs and InputStreams for any filename or write your own AsciiFileLoader to load text-based files. The ResourceLoader looks into given ResourceLocations in order to get URLs and InputStreams for the given name. By default the Classpath, Bundled Textures, Meshes, Figures, Shaders and the Local File System are added as ResourceLocation by default. You can add your own by using addResourceLocation(ResourceLocation) or remove all clearResourceLocations(). The ResourceLoader uses a very basic ResourceCaches in order to avoid re-reading data from disk. These caches - however - are not caching object, only the data.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceCache	binaryCache
static String	FIGURE_DECLARATION_EXT Extension used by Figure Declarations
protected ResourceCache<String>	fileCache
protected List<ResourceLocation>	locations This list contains locations to look for resources
static org.slf4j.Logger	LOGGER The Main Logger of the ResourceLoader
static String	SHADER_PROGRAM_EXT Extension used by Shader Programs

Constructor Summary

Constructors

Constructor and Description
BasicResourceLoader() Add default locations: Classpath Bundled Textures Bundled Models Bundled Figures Bundled Shaders Bundled Shader Programs Local File System

Method Summary

Modifier and Type	Method and Description
void	addResourceLocation(ResourceLocation location) Add a ResourceLocation to the search path.
void	clearResourceLocations() Clears all ResourceLocations from the search path.
boolean	exists(String name) Checks if a file exists in one of the search locations
AudioSource	getAudioSource(String name)
AudioSource	getAudioSource(String name, boolean forceLoading)
Figure	getFigure(String name) Loads a Figure from a json declaration file.
Figure	getFigure(String name, boolean forceLoading) Loads a Figure from a json declaration file.
Mesh	getMesh(String name) Loads a .obj file, parses it, optimises it and converts it into renderable Mesh When loading from cache only the data will get reused, not the object itself and it will have to use new buffers (handled automatically).
Mesh	getMesh(String name, boolean forceLoading) Loads a .obj file, parses it, optimises it and converts it into renderable Mesh When loading from cache only the data will get reused, not the object itself and it will have to use new buffers (handled automatically).
List<ResourceLocation>	getResourceLocations() Returns all ResourceLocations.
String	getShader(String name) Loads a shader File and prepares it for OpenGL.
String	getShader(String name, boolean forceLoading) Loads a shader File and prepares it for OpenGL.
String	getShader(String name, boolean forceLoading, LineBasedParser parser) Loads a shader File and prepares it for OpenGL.
GLSLProgram	getShaderProgram(String name) Reads programm file from disk and loads the stated source files (uses a internal cache if the shader has been loaded previously)
GLSLProgram	getShaderProgram(String name, boolean forceLoading) Reads programm file from disk and loads the stated source files Calls load(String, org.achtern.AchternEngine.core.resource.loader.AsciiFileLoader, boolean) internally and uses the GLSLProgramLoader.
InputStream	getStream(String name) Searches through all ResourceLocations and returns readable InputStream NOTE: The first occurrence of an file will get used.
Texture	getTexture(String name) Loads a image file and converts it into a Texture.
Texture	getTexture(String name, Dimension dimension) Loads a image file and converts it into a Texture.
Texture	getTexture(String name, Dimension dimension, boolean forceLoading) Loads a image file and converts it into a Texture.
URL	getURL(String name) Searches through all ResourceLocations and returns the full URL NOTE: The first occurrence of an file will get used.
<T> T	load(String name, AsciiFileLoader<T> loader, boolean forceLoading) Loads a Object from a text-file using a AsciiFileLoader.
<T,C> T	load(String name, BinaryLoader<T,C> loader, boolean forceLoading) Loads a Object from an InputStream using a AsciiFileLoader.
void	preLoadMesh(String name) Pre Load a Mesh, good at startup, to allow getting the Mesh at runtime.
void	preLoadShader(String name) Pre Load a Shader source file.
void	preLoadTexture(String name) Pre Load a Texture, good at startup, to allow getting the Texture at runtime.
void	pushResourceLocation(ResourceLocation location)
String	readFile(String name) Reads a file into a String.
String	readFile(String name, boolean forceLoading) Reads a file into a String.
String	readFile(String name, boolean forceLoading, LineBasedParser parser) Reads a file into a String.
void	removeResourceLocation(ResourceLocation location) Removes a ResourceLocation from the search path

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

The Main Logger of the ResourceLoader

SHADER_PROGRAM_EXT

public static final String SHADER_PROGRAM_EXT

Extension used by Shader Programs

See Also:

Constant Field Values

FIGURE_DECLARATION_EXT

public static final String FIGURE_DECLARATION_EXT

Extension used by Figure Declarations

See Also:

Constant Field Values

binaryCache

protected ResourceCache binaryCache

fileCache

protected ResourceCache<String> fileCache

locations

protected List<ResourceLocation> locations

This list contains locations to look for resources

Constructor Detail

BasicResourceLoader

public BasicResourceLoader()

Add default locations: Classpath Bundled Textures Bundled Models Bundled Figures Bundled Shaders Bundled Shader Programs Local File System

Method Detail

addResourceLocation

public void addResourceLocation(ResourceLocation location)

Add a ResourceLocation to the search path. NOTE: This will insert it to the very end of the List, resulting in the lowest priority when loading files. Add it to the very front (highest priority) with io.github.achtern.AchternEngine.core.resource.ResourceLoader#pushResourceLocation(ResourceLocation)

Specified by:

addResourceLocation in interface ResourceLoaderProvider

Parameters:

location - This will get added to the search path.

pushResourceLocation

public void pushResourceLocation(ResourceLocation location)

Specified by:

pushResourceLocation in interface ResourceLoaderProvider

See Also:

(Prepends)

removeResourceLocation

public void removeResourceLocation(ResourceLocation location)

Removes a ResourceLocation from the search path

Specified by:

removeResourceLocation in interface ResourceLoaderProvider

Parameters:

location - Will get removed from the search path.

clearResourceLocations

public void clearResourceLocations()

Clears all ResourceLocations from the search path.

Specified by:

clearResourceLocations in interface ResourceLoaderProvider

getResourceLocations

public List<ResourceLocation> getResourceLocations()

Returns all ResourceLocations.

Specified by:

getResourceLocations in interface ResourceLoaderProvider

Returns:

List of all ResourceLocations

preLoadMesh

public void preLoadMesh(String name)
                 throws Exception

Pre Load a Mesh, good at startup, to allow getting the Mesh at runtime.

Specified by:

preLoadMesh in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Throws:

IOException - if loading fails

Exception

See Also:

getMesh(String)

preLoadTexture

public void preLoadTexture(String name)
                    throws Exception

Pre Load a Texture, good at startup, to allow getting the Texture at runtime.

Specified by:

preLoadTexture in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Throws:

IOException - if loading fails

Exception

See Also:

getTexture(String)

preLoadShader

public void preLoadShader(String name)
                   throws Exception

Pre Load a Shader source file. Only parses the sourcefile, no binding or uniform adding at this stage!

Specified by:

preLoadShader in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Throws:

IOException - if loading fails

Exception

See Also:

getShader(String)

getFigure

public Figure getFigure(String name)
                 throws Exception

Loads a Figure from a json declaration file. Read more about it here FigureLoader When loading from cache, only the file itself will get reused. This returns a completely independent Figure. An IOException is thrown on read errors and other Exceptions might be thrown from the Figure itself.

Specified by:

getFigure in interface ResourceLoaderProvider

Parameters:

name - The name of the file to load

Returns:

Figure (new instance)

Throws:

Exception - if loading/parsing/processing fails

getFigure

public Figure getFigure(String name,
                        boolean forceLoading)
                 throws Exception

Loads a Figure from a json declaration file. Read more about it here FigureLoader When loading from cache, only the file itself will get reused. This returns a completely independent Figure. An IOException is thrown on read errors and other Exceptions might be thrown from the Figure itself.

Specified by:

getFigure in interface ResourceLoaderProvider

Parameters:

name - The name of the file to load

forceLoading - if set to true the file will get read again and not read from cache

Returns:

Figure (new instance)

Throws:

Exception - if loading/parsing/processing fails

getMesh

public Mesh getMesh(String name)
             throws Exception

Loads a .obj file, parses it, optimises it and converts it into renderable Mesh When loading from cache only the data will get reused, not the object itself and it will have to use new buffers (handled automatically). An IOException is thrown on read errors and other Exceptions might be thrown from the GLSLProgramLoader itself.

Specified by:

getMesh in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Returns:

Mesh (new instance)

Throws:

Exception - if loading/parsing/processing fails

getMesh

public Mesh getMesh(String name,
                    boolean forceLoading)
             throws Exception

Loads a .obj file, parses it, optimises it and converts it into renderable Mesh When loading from cache only the data will get reused, not the object itself and it will have to use new buffers (handled automatically). An IOException is thrown on read errors and other Exceptions might be thrown from the GLSLProgramLoader itself.

Specified by:

getMesh in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

forceLoading - if set to true the file will get read again and not read from cache

Returns:

Mesh (new instance)

Throws:

Exception - if loading/parsing/processing fails

getTexture

public Texture getTexture(String name)
                   throws Exception

Loads a image file and converts it into a Texture. If the same image has been loaded previously the TexturableData will be used to create the new Texture object.

Specified by:

getTexture in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Returns:

A new Texture Object

Throws:

IOException - if resource not found

Exception

getTexture

public Texture getTexture(String name,
                          Dimension dimension)
                   throws Exception

Loads a image file and converts it into a Texture. If the same image has been loaded previously the TexturableData will be used to create the new Texture object. The Dimension can be used to modify the width and height of the Texture. The image will get resized.

Specified by:

getTexture in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

dimension - The dimension of the new texture

Returns:

A new Texture Object

Throws:

IOException - if resource not found

Exception

getTexture

public Texture getTexture(String name,
                          Dimension dimension,
                          boolean forceLoading)
                   throws Exception

Loads a image file and converts it into a Texture. If the same image has been loaded previously the TexturableData will be used to create the new Texture object. The Dimension can be used to modify the width and height of the Texture. The image will get resized.

Specified by:

getTexture in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

dimension - The dimension of the new texture

forceLoading - if set to true the file will get read again and not read from cache

Returns:

A new Texture Object

Throws:

IOException - if resource not found

Exception

getShader

public String getShader(String name)
                 throws Exception

Loads a shader File and prepares it for OpenGL. (uses a internal cache if the shader has been loaded previously)

Specified by:

getShader in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Returns:

A readable Stream | null if not exists

Throws:

IOException - if resource not found

Exception

See Also:

getShader(String, boolean)

getShader

public String getShader(String name,
                        boolean forceLoading)
                 throws Exception

Loads a shader File and prepares it for OpenGL. (uses a internal cache if the shader has been loaded previously) This uses the default LineBasedParser (GLSLParser)

Specified by:

getShader in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

forceLoading - if set to true the file will get read again and not read from cache

Returns:

ShaderSource String

Throws:

Exception - if loading/parsing/processing fails

See Also:

getShader(String, boolean, org.achtern.AchternEngine.core.resource.fileparser.LineBasedParser)

getShader

public String getShader(String name,
                        boolean forceLoading,
                        LineBasedParser parser)
                 throws Exception

Loads a shader File and prepares it for OpenGL. Calls load(String, org.achtern.AchternEngine.core.resource.loader.AsciiFileLoader, boolean) internally and uses the ShaderSourceLoader. An IOException is thrown on read errors and other Exceptions might be thrown from the ShaderSourceLoader itself.

Specified by:

getShader in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

forceLoading - if set to true the file will get read again and not read from cache

parser - The optional parser to modify the shader lines.

Returns:

ShaderSource String

Throws:

Exception - if loading/parsing/processing fails

getShaderProgram

public GLSLProgram getShaderProgram(String name)
                             throws Exception

Reads programm file from disk and loads the stated source files (uses a internal cache if the shader has been loaded previously)

Specified by:

getShaderProgram in interface ResourceLoaderProvider

Parameters:

name - Name of the program declaration

Returns:

A GLSLProgram with loaded shader sources.

Throws:

IOException - if loading fails

Exception

See Also:

getShaderProgram(String, boolean)

getShaderProgram

public GLSLProgram getShaderProgram(String name,
                                    boolean forceLoading)
                             throws Exception

Reads programm file from disk and loads the stated source files Calls load(String, org.achtern.AchternEngine.core.resource.loader.AsciiFileLoader, boolean) internally and uses the GLSLProgramLoader. An IOException is thrown on read errors and other Exceptions might be thrown from the GLSLProgramLoader itself.

Specified by:

getShaderProgram in interface ResourceLoaderProvider

Parameters:

name - Name of the program declaration

forceLoading - if set to true the file will get read again and not read from cache

Returns:

A GLSLProgram with loaded shader sources.

Throws:

Exception - if loading/parsing/processing fails

getAudioSource

public AudioSource getAudioSource(String name)
                           throws Exception

Specified by:

getAudioSource in interface ResourceLoaderProvider

Throws:

Exception

getAudioSource

public AudioSource getAudioSource(String name,
                                  boolean forceLoading)
                           throws Exception

Specified by:

getAudioSource in interface ResourceLoaderProvider

Throws:

Exception

load

public <T> T load(String name,
                  AsciiFileLoader<T> loader,
                  boolean forceLoading)
           throws Exception

Loads a Object from a text-file using a AsciiFileLoader. Calls readFile(String) internally. An IOException is thrown on read errors and other Exceptions might be thrown from the Loader itself.

Specified by:

load in interface ResourceLoaderProvider

Type Parameters:

T - The type of Object to load

Parameters:

name - The name of the file to load

loader - The loader used to convert the file into the Object

forceLoading - if set to true the file will get read again and not read from cache

Returns:

The loaded object

Throws:

Exception - if loading/parsing/processing fails

load

public <T,C> T load(String name,
                    BinaryLoader<T,C> loader,
                    boolean forceLoading)
             throws Exception

Loads a Object from an InputStream using a AsciiFileLoader. Calls getStream(String) internally. An IOException is thrown on read errors and other Exceptions might be thrown from the Loader itself.

Specified by:

load in interface ResourceLoaderProvider

Type Parameters:

T - The type of Object to load

C - The type to cache the data

Parameters:

name - The name of the file to load

loader - The loader used to convert the file into the Object

forceLoading - if set to true the file will get read again and not read from cache

Returns:

The loaded object

Throws:

Exception - if loading/parsing/processing fails

readFile

public String readFile(String name)
                throws IOException

Reads a file into a String. Lines are separated by \n. If a file with the same name (the same file?) a cached value will be used.

Specified by:

readFile in interface ResourceLoaderProvider

Parameters:

name - The name of the file to load

Returns:

The read file

Throws:

IOException - if loading fails

readFile

public String readFile(String name,
                       boolean forceLoading)
                throws IOException

Reads a file into a String. Lines are separated by \n. If a file with the same name (the same file?) a cached value will be used.

Specified by:

readFile in interface ResourceLoaderProvider

Parameters:

name - The name of the file to load

forceLoading - if set to true the file will get read again and not read from cache

Returns:

The read file

Throws:

IOException - if loading fails

readFile

public String readFile(String name,
                       boolean forceLoading,
                       LineBasedParser parser)
                throws IOException

Reads a file into a String. Lines are separated by \n. If a file with the same name (the same file?) a cached value will be used. The LineBasedParser doesn't run when loaded from cache, but any modifications made by the parser are stored into the cache.

Specified by:

readFile in interface ResourceLoaderProvider

Parameters:

name - The name of the file to load

forceLoading - if set to true the file will get read again and not read from cache

parser - The parser gets called on every line (can be null)

Returns:

The read file

Throws:

IOException - if loading fails

exists

public boolean exists(String name)

Checks if a file exists in one of the search locations

Specified by:

exists in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Returns:

True If resource was found in search path

getStream

public InputStream getStream(String name)
                      throws IOException

Searches through all ResourceLocations and returns readable InputStream NOTE: The first occurrence of an file will get used. This depends on the order of ResourceLocations of the list. By default the Classpath takes precedence over bundled stuff and after that the local filesystem getting searched.

Specified by:

getStream in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Returns:

A readable Stream | null if not exists

Throws:

IOException - if resource not found

getURL

public URL getURL(String name)
           throws IOException

Searches through all ResourceLocations and returns the full URL NOTE: The first occurrence of an file will get used. This depends on the order of ResourceLocations of the list. By default the Classpath takes precedence over bundled stuff and after that the local filesystem getting searched.

Specified by:

getURL in interface ResourceLoaderProvider

Parameters:

name - The relative path (to various ResourceLocations) of the filename

Returns:

A readable Stream | null if not exists

Throws:

IOException - if resource not found