com.github.brunothg.game.engine.image

Class InternalImage

java.lang.Object

com.github.brunothg.game.engine.image.InternalImage

public class InternalImage
extends Object

Class for loading images right out the jar file

Author:

Marvin Bruns

Constructor Summary

Constructors

Constructor and Description
InternalImage()

Method Summary

Modifier and Type	Method and Description
static void	clearMemory() All loaded Images will be released.
static void	freeImage(String name) Release a specific image if it exists.
static void	freeImage(String path, String name) Release a specific image if it exists.
static Image	fullLoad(String name) Load an image from given path relative to root folder.
static Image	fullLoadFromPath(String path, String name) Load an image with specific path.
static String	getRootFolder()
static Image	load(String name) Load image from root folder
static Image	loadFromPath(String path, String name) Load an image with specific path.
static Image	reloadFull(String name) Reloads the image using root folder
static Image	reloadFullFromPath(String path, String name) Reloads the image
static void	setRootFolder(String s)
static Image	storeImage(String path, String name, Image img) Manually insert a image

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalImage

public InternalImage()

Method Detail

loadFromPath

public static Image loadFromPath(String path,
                                 String name)

Load an image with specific path. Ignores the root folder.

Parameters:

path - Path to the folder the image is located in

name - Name of the image

Returns:

The loaded image or null, if any error occurred

See Also:

load(String)

fullLoadFromPath

public static Image fullLoadFromPath(String path,
                                     String name)
                              throws IOException

Load an image with specific path. Ignores the root folder.

Parameters:

path - Path to the folder the image is located in

name - Name of the image

Returns:

The loaded image

Throws:

IOException

load

public static Image load(String name)

Load image from root folder

Parameters:

name - Name of the image

Returns:

Image or null if any Exception is thrown

See Also:

loadFromPath(String, String)

reloadFull

public static Image reloadFull(String name)
                        throws IOException

Reloads the image using root folder

Parameters:

name - Name of the image

Returns:

The image

Throws:

IOException - if an error occurs during reading

reloadFullFromPath

public static Image reloadFullFromPath(String path,
                                       String name)
                                throws IOException

Reloads the image

Parameters:

name - Name of the image

path - Path to the folder the image is located in

Returns:

The image

Throws:

IOException - if an error occurs during reading

getRootFolder

public static String getRootFolder()

setRootFolder

public static void setRootFolder(String s)

fullLoad

public static Image fullLoad(String name)
                      throws IOException

Load an image from given path relative to root folder. If it has been loaded before a reference is returned.

Parameters:

name - image name

Returns:

The image

Throws:

IOException - if an error occurs during reading

clearMemory

public static void clearMemory()

All loaded Images will be released. The next call to load a image will read it from file not memory.

freeImage

public static void freeImage(String path,
                             String name)

Release a specific image if it exists.

Parameters:

path - Path to image's folder

name - image's name

freeImage

public static void freeImage(String name)

Release a specific image if it exists.

Parameters:

name - image's name

storeImage

public static Image storeImage(String path,
                               String name,
                               Image img)

Manually insert a image

Parameters:

path - path of the image (Identifier)

name - the name of the image

img - the image that should be stored

Returns:

the image that was previously at this position