nl.colorize.multimedialib.tool

Class ImageAtlasPacker

java.lang.Object

nl.colorize.multimedialib.tool.CommandLineTool

nl.colorize.multimedialib.tool.ImageAtlasPacker

public class ImageAtlasPacker
extends CommandLineTool

Tool that packs a numer of images into an image atlas. The created image atlas consists of the atlas image and a XML file that contains the metadata for the sub-images. Images are loaded and rendered to the image atlas using Java2D. The dimensions of both the image atlas itself and its cells containing sub-images will be power-of-two, even though the dimensions of the sub-images themselves aren't.

Constructor Summary

Constructors

Constructor and Description
ImageAtlasPacker()

Method Summary

Modifier and Type	Method and Description
protected ImageAtlas	createImageAtlas(java.util.Map<java.lang.String,java.awt.image.BufferedImage> subImages, int atlasWidth) Creates an image atlas from the specified collection of images.
static void	main(java.lang.String[] args)
void	run() Runs this tool.
protected void	saveImageAtlas(ImageAtlas imageAtlas, java.io.File outputDir)

Methods inherited from class nl.colorize.multimedialib.tool.CommandLineTool

getDescription, parseInputDirectory, parseInputFile, parseOutputDirectory, parseOutputFile, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageAtlasPacker

public ImageAtlasPacker()

Method Detail

main

public static void main(java.lang.String[] args)

run

public void run()

Description copied from class: CommandLineTool

Runs this tool. This method is called by CommandLineTool.start(String[]). When this method is called it can be assumed that arguments have already been mapped to fields.

Specified by:

run in class CommandLineTool

createImageAtlas

protected ImageAtlas createImageAtlas(java.util.Map<java.lang.String,java.awt.image.BufferedImage> subImages,
                                      int atlasWidth)

Creates an image atlas from the specified collection of images. The images will be positioned to allow for the smallest image atlas possible.

Parameters:

subImages - Maps from a sub-image's name to its contents.

atlasWidth - Width of the image atlas (the height will be auto-detected).

saveImageAtlas

protected void saveImageAtlas(ImageAtlas imageAtlas,
                              java.io.File outputDir)