From 67ec86e539a3db0d06e5cc3550db453589594384 Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Thu, 27 Feb 2014 23:56:13 +0100 Subject: Bug 801: Graph TextRenderer Cleanup Part-4: Text[Render->Region]Util API: Better separation of cached and uncached regions --- .../jogamp/graph/curve/opengl/TextRegionUtil.java | 262 +++++++++++++++++++++ 1 file changed, 262 insertions(+) create mode 100644 src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java (limited to 'src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java') diff --git a/src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java b/src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java new file mode 100644 index 000000000..e7ed335ec --- /dev/null +++ b/src/jogl/classes/com/jogamp/graph/curve/opengl/TextRegionUtil.java @@ -0,0 +1,262 @@ +/** + * Copyright 2014 JogAmp Community. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, are + * permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this list of + * conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, this list + * of conditions and the following disclaimer in the documentation and/or other materials + * provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND + * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * The views and conclusions contained in the software and documentation are those of the + * authors and should not be interpreted as representing official policies, either expressed + * or implied, of JogAmp Community. + */ +package com.jogamp.graph.curve.opengl; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Iterator; + +import javax.media.opengl.GL2ES2; +import javax.media.opengl.GLException; + +import jogamp.graph.geom.plane.AffineTransform; + +import com.jogamp.graph.curve.OutlineShape; +import com.jogamp.graph.curve.Region; +import com.jogamp.graph.font.Font; +import com.jogamp.graph.font.Font.Glyph; +import com.jogamp.graph.geom.Vertex; +import com.jogamp.graph.geom.Vertex.Factory; + +/** + * Text {@link GLRegion} Utility Class + */ +public class TextRegionUtil { + + public final RegionRenderer renderer; + + public TextRegionUtil(final RegionRenderer renderer) { + this.renderer = renderer; + } + + /** + * Add the string in 3D space w.r.t. the font and pixelSize at the end of the {@link GLRegion}. + * @param region the {@link GLRegion} sink + * @param vertexFactory vertex impl factory {@link Factory} + * @param font the target {@link Font} + * @param str string text + * @param pixelSize + */ + public static void addStringToRegion(final GLRegion region, final Factory vertexFactory, + final Font font, final CharSequence str, final int pixelSize) { + final int charCount = str.length(); + + // region.setFlipped(true); + final Font.Metrics metrics = font.getMetrics(); + final float lineHeight = font.getLineHeight(pixelSize); + + final float scale = metrics.getScale(pixelSize); + final AffineTransform transform = new AffineTransform(vertexFactory); + final AffineTransform t = new AffineTransform(vertexFactory); + + float y = 0; + float advanceTotal = 0; + + for(int i=0; i< charCount; i++) { + final char character = str.charAt(i); + if( '\n' == character ) { + y -= lineHeight; + advanceTotal = 0; + } else if (character == ' ') { + advanceTotal += font.getAdvanceWidth(Glyph.ID_SPACE, pixelSize); + } else { + if(Region.DEBUG_INSTANCE) { + System.err.println("XXXXXXXXXXXXXXx char: "+character+", scale: "+scale+"; translate: "+advanceTotal+", "+y); + } + t.setTransform(transform); // reset transform + t.translate(advanceTotal, y); + t.scale(scale, scale); + + final Font.Glyph glyph = font.getGlyph(character); + final OutlineShape glyphShape = glyph.getShape(); + if( null == glyphShape ) { + continue; + } + region.addOutlineShape(glyphShape, t); + + advanceTotal += glyph.getAdvance(pixelSize, true); + } + } + } + + /** + * Render the string in 3D space w.r.t. the font and pixelSize + * using a cached {@link GLRegion} for reuse. + *

+ * Cached {@link GLRegion}s will be destroyed w/ {@link #clear(GL2ES2)} or to free memory. + *

+ * @param gl the current GL state + * @param font {@link Font} to be used + * @param str text to be rendered + * @param pixelSize font size + * @param texSize desired texture width for multipass-rendering. + * The actual used texture-width is written back when mp rendering is enabled, otherwise the store is untouched. + * @throws Exception if TextRenderer not initialized + */ + public void drawString3D(final GL2ES2 gl, + final Font font, final CharSequence str, final int pixelSize, + final int[/*1*/] texSize) { + if( !renderer.isInitialized() ) { + throw new GLException("TextRendererImpl01: not initialized!"); + } + final RenderState rs = renderer.getRenderState(); + GLRegion region = getCachedRegion(font, str, pixelSize); + if(null == region) { + region = GLRegion.create(renderer.getRenderModes()); + addStringToRegion(region, rs.getVertexFactory(), font, str, pixelSize); + addCachedRegion(gl, font, str, pixelSize, region); + } + region.draw(gl, renderer, texSize); + } + + /** + * Render the string in 3D space w.r.t. the font and pixelSize + * using a temporary {@link GLRegion}, which will be destroyed afterwards. + * @param gl the current GL state + * @param font {@link Font} to be used + * @param str text to be rendered + * @param fontSize font size + * @param texWidth desired texture width for multipass-rendering. + * The actual used texture-width is written back when mp rendering is enabled, otherwise the store is untouched. + * @throws Exception if TextRenderer not initialized + */ + public static void drawString3D(final RegionRenderer renderer, final GL2ES2 gl, + final Font font, final CharSequence str, final int fontSize, + final int[/*1*/] texSize) { + if(!renderer.isInitialized()){ + throw new GLException("TextRendererImpl01: not initialized!"); + } + final RenderState rs = renderer.getRenderState(); + final GLRegion region = GLRegion.create(renderer.getRenderModes()); + addStringToRegion(region, rs.getVertexFactory(), font, str, fontSize); + region.draw(gl, renderer, texSize); + region.destroy(gl, renderer); + } + + /** + * Clear all cached {@link GLRegions}. + */ + public void clear(GL2ES2 gl) { + // fluchCache(gl) already called + final Iterator iterator = stringCacheMap.values().iterator(); + while(iterator.hasNext()){ + final GLRegion region = iterator.next(); + region.destroy(gl, renderer); + } + stringCacheMap.clear(); + stringCacheArray.clear(); + } + + /** + *

Sets the cache limit for reusing GlyphString's and their Region. + * Default is {@link #DEFAULT_CACHE_LIMIT}, -1 unlimited, 0 turns cache off, >0 limited

+ * + *

The cache will be validate when the next string rendering happens.

+ * + * @param newLimit new cache size + * + * @see #DEFAULT_CACHE_LIMIT + */ + public final void setCacheLimit(int newLimit ) { stringCacheLimit = newLimit; } + + /** + * Sets the cache limit, see {@link #setCacheLimit(int)} and validates the cache. + * + * @see #setCacheLimit(int) + * + * @param gl current GL used to remove cached objects if required + * @param newLimit new cache size + */ + public final void setCacheLimit(GL2ES2 gl, int newLimit ) { stringCacheLimit = newLimit; validateCache(gl, 0); } + + /** + * @return the current cache limit + */ + public final int getCacheLimit() { return stringCacheLimit; } + + /** + * @return the current utilized cache size, <= {@link #getCacheLimit()} + */ + public final int getCacheSize() { return stringCacheArray.size(); } + + protected final void validateCache(GL2ES2 gl, int space) { + if ( getCacheLimit() > 0 ) { + while ( getCacheSize() + space > getCacheLimit() ) { + removeCachedRegion(gl, 0); + } + } + } + + protected final GLRegion getCachedRegion(Font font, CharSequence str, int fontSize) { + return stringCacheMap.get(getKey(font, str, fontSize)); + } + + protected final void addCachedRegion(GL2ES2 gl, Font font, CharSequence str, int fontSize, GLRegion glyphString) { + if ( 0 != getCacheLimit() ) { + final String key = getKey(font, str, fontSize); + final GLRegion oldRegion = stringCacheMap.put(key, glyphString); + if ( null == oldRegion ) { + // new entry .. + validateCache(gl, 1); + stringCacheArray.add(stringCacheArray.size(), key); + } /// else overwrite is nop .. + } + } + + protected final void removeCachedRegion(GL2ES2 gl, Font font, CharSequence str, int fontSize) { + final String key = getKey(font, str, fontSize); + GLRegion region = stringCacheMap.remove(key); + if(null != region) { + region.destroy(gl, renderer); + } + stringCacheArray.remove(key); + } + + protected final void removeCachedRegion(GL2ES2 gl, int idx) { + final String key = stringCacheArray.remove(idx); + if( null != key ) { + final GLRegion region = stringCacheMap.remove(key); + if(null != region) { + region.destroy(gl, renderer); + } + } + } + + protected final String getKey(Font font, CharSequence str, int fontSize) { + final StringBuilder sb = new StringBuilder(); + return font.getName(sb, Font.NAME_UNIQUNAME) + .append(".").append(str.hashCode()).append(".").append(fontSize).toString(); + } + + /** Default cache limit, see {@link #setCacheLimit(int)} */ + public static final int DEFAULT_CACHE_LIMIT = 256; + + private final HashMap stringCacheMap = new HashMap(DEFAULT_CACHE_LIMIT); + private final ArrayList stringCacheArray = new ArrayList(DEFAULT_CACHE_LIMIT); + private int stringCacheLimit = DEFAULT_CACHE_LIMIT; +} \ No newline at end of file -- cgit v1.2.3