maspack.render

Class TextImageStore

java.lang.Object

maspack.render.TextImageStore

public class TextImageStore
extends java.lang.Object

Stores text characters in an image, potentially to be used by texture maps for drawing text.

Author:

Antonio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextImageStore.Glyph A Glyph, with an associated GlyphVector from which it came.
static class	TextImageStore.GlyphLoc
static class	TextImageStore.GlyphStore Glyph with storage location in backed image

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG

Constructor Summary

Constructors

Constructor and Description
TextImageStore(RectanglePacker packer, boolean antialiasing)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the backing image, increments the storage Id so that any existing external storage glyphs become invalid
static javax.swing.JFrame	createDisplayFrame(TextImageStore store)
TextImageStore.Glyph[]	createGlyphs(java.awt.font.GlyphVector glyphvec, TextImageStore.Glyph[] out) Creates an array of Glyphs, each containing identifying information, as well as location information, so they can be processed glyph by glyph.
TextImageStore.Glyph[]	createGlyphs(java.lang.String str, TextImageStore.Glyph[] out) Creates an array of Glyphs, each containing identifying information, as well as location information, so they can be processed glyph by glyph.
java.awt.font.GlyphVector	createGlyphVector(java.awt.Font font, java.lang.String str) Creates a glyph vector using the current font and image context
java.awt.font.GlyphVector	createGlyphVector(java.lang.String str) Creates a glyph vector using the current font and image context
TextImageStore.GlyphStore	get(TextImageStore.Glyph glyph) Checks to see if the glyph is already in the backing image, returning the storage information if present, or null otherwise.
void	getData(java.nio.ByteBuffer out) Retrieves image data for the entire backing array, rasterized row-major with pixels starting at bottom-left of image
void	getData(Rectangle region, java.nio.ByteBuffer out) Retrieves all bytes for the given region in a rasterized way, row-major, starting with bottom left.
Rectangle	getDirty() Get the region marked as dirty
Rectangle	getDirtyData(java.nio.ByteBuffer out) Get bytes from the dirty region in a rasterized way, row-major, starting with bottom-left;
java.awt.Font	getFont()
java.awt.FontMetrics	getFontMetrics()
java.awt.FontMetrics	getFontMetrics(java.awt.Font font)
java.awt.Graphics2D	getGraphics()
int	getHeight() Height of image
java.awt.image.BufferedImage	getImage() The backing image
int	getImageType() Type of image
int	getPixelSize() Size of a pixel in bytes
int	getStorageId() ID for identifying valid glyph stores.
int	getStorageVersion() Version number for checking if backing image has been updated
int	getWidth() Width of image
boolean	isValid(TextImageStore.GlyphStore storage) Checks whether glyph storage is still valid
static void	main(java.lang.String[] args)
void	markClean() Mark the dirty region as now cleaned
void	markDirty(Rectangle rect) Mark a region of the backing image as "dirty" (i.e.
void	saveImage(java.lang.String type, java.io.File dest) Save backing image to a file (convenience method)
void	setAntialiasing(boolean set) Enable or disable antialiasing in the graphics pipeline
void	setFont(java.awt.Font font)
boolean	upload(java.awt.font.GlyphVector vec) Attempts to upload glyphs for an entire string.
boolean	upload(java.lang.String str) Attempts to upload glyphs for an entire string.
TextImageStore.GlyphStore	upload(TextImageStore.Glyph glyph) Attempts to store a glyph into the backing image store, returning the storage information.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

Constructor Detail

TextImageStore

public TextImageStore(RectanglePacker packer,
                      boolean antialiasing)

Method Detail

setFont

public void setFont(java.awt.Font font)

getFont

public java.awt.Font getFont()

getFontMetrics

public java.awt.FontMetrics getFontMetrics(java.awt.Font font)

getFontMetrics

public java.awt.FontMetrics getFontMetrics()

setAntialiasing

public void setAntialiasing(boolean set)

Enable or disable antialiasing in the graphics pipeline

createGlyphs

public TextImageStore.Glyph[] createGlyphs(java.lang.String str,
                                           TextImageStore.Glyph[] out)

Creates an array of Glyphs, each containing identifying information, as well as location information, so they can be processed glyph by glyph. If the input array is not sufficiently large to accommodate all glyphs, a new array is constructed.

Parameters:

str - input string

out - array to populate, or null to create a new array

Returns:

populated glyph array

createGlyphVector

public java.awt.font.GlyphVector createGlyphVector(java.lang.String str)

Creates a glyph vector using the current font and image context

Returns:

vector

createGlyphVector

public java.awt.font.GlyphVector createGlyphVector(java.awt.Font font,
                                                   java.lang.String str)

Creates a glyph vector using the current font and image context

Returns:

vector

createGlyphs

public TextImageStore.Glyph[] createGlyphs(java.awt.font.GlyphVector glyphvec,
                                           TextImageStore.Glyph[] out)

Creates an array of Glyphs, each containing identifying information, as well as location information, so they can be processed glyph by glyph. If the input array is not sufficiently large to accommodate all glyphs, a new array is constructed.

Parameters:

glyphvec - glyph vector

out - array to populate, or null to create a new array

Returns:

populated glyph array

get

public TextImageStore.GlyphStore get(TextImageStore.Glyph glyph)

Checks to see if the glyph is already in the backing image, returning the storage information if present, or null otherwise.

Returns:

storage info

upload

public boolean upload(java.lang.String str)

Attempts to upload glyphs for an entire string.

Returns:

true if successful, false if some glyphs failed

getGraphics

public java.awt.Graphics2D getGraphics()

upload

public boolean upload(java.awt.font.GlyphVector vec)

Attempts to upload glyphs for an entire string.

Returns:

true if successful, false if some glyphs failed

markDirty

public void markDirty(Rectangle rect)

Mark a region of the backing image as "dirty" (i.e. modified)

getDirtyData

public Rectangle getDirtyData(java.nio.ByteBuffer out)

Get bytes from the dirty region in a rasterized way, row-major, starting with bottom-left;

Parameters:

out - buffer to fill with RGBA bytes

Returns:

rectangular region to update

getData

public void getData(Rectangle region,
                    java.nio.ByteBuffer out)

Retrieves all bytes for the given region in a rasterized way, row-major, starting with bottom left.

Parameters:

region - pixel region from which to obtain bytes

out - buffer to fill with RGBA bytes

getData

public void getData(java.nio.ByteBuffer out)

Retrieves image data for the entire backing array, rasterized row-major with pixels starting at bottom-left of image

Parameters:

out - buffer to fill with content

getPixelSize

public int getPixelSize()

Size of a pixel in bytes

Returns:

pixel size

getImageType

public int getImageType()

Type of image

See Also:

BufferedImage.getType()

getWidth

public int getWidth()

Width of image

Returns:

width

getHeight

public int getHeight()

Height of image

Returns:

height

getDirty

public Rectangle getDirty()

Get the region marked as dirty

markClean

public void markClean()

Mark the dirty region as now cleaned

upload

public TextImageStore.GlyphStore upload(TextImageStore.Glyph glyph)

Attempts to store a glyph into the backing image store, returning the storage information. If the glyph is already stored, then the existing backing store is returned. Otherwise, the RectanglePacker will attempt to place the glyph in the backing store.

Parameters:

glyph - glyph to try to upload to the backing store (if not already present)

Returns:

the resulting storage information, or null if it doesn't fit

saveImage

public void saveImage(java.lang.String type,
                      java.io.File dest)

Save backing image to a file (convenience method)

getImage

public java.awt.image.BufferedImage getImage()

The backing image

Returns:

image

clear

public void clear()

Clears the backing image, increments the storage Id so that any existing external storage glyphs become invalid

getStorageId

public int getStorageId()

ID for identifying valid glyph stores. As long as the glyph store's Storage ID matches this number, the store is valid.

Returns:

storage id number

isValid

public boolean isValid(TextImageStore.GlyphStore storage)

Checks whether glyph storage is still valid

Returns:

true if still valid

getStorageVersion

public int getStorageVersion()

Version number for checking if backing image has been updated

createDisplayFrame

public static javax.swing.JFrame createDisplayFrame(TextImageStore store)

main

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

Throws:

java.lang.Exception