com.ardor3d.renderer.lwjgl.LwjglFont.java Source code

Introduction

Here is the source code for com.ardor3d.renderer.lwjgl.LwjglFont.java

Source

/**
 * Copyright (c) 2008-2009 Ardor Labs, Inc.
 *
 * This file is part of Ardor3D.
 *
 * Ardor3D is free software: you can redistribute it and/or modify it 
 * under the terms of its license which may be found in the accompanying
 * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
 */

package com.ardor3d.renderer.lwjgl;

import java.nio.ByteBuffer;

import org.lwjgl.opengl.GL11;

import com.ardor3d.math.ColorRGBA;
import com.ardor3d.math.type.ReadOnlyVector3;
import com.ardor3d.renderer.ContextManager;
import com.ardor3d.renderer.Renderer;
import com.ardor3d.renderer.state.record.RendererRecord;
import com.ardor3d.scene.state.lwjgl.util.LwjglRendererUtil;
import com.ardor3d.util.geom.BufferUtils;

public class LwjglFont {

    /**
     * Sets the style of the font to normal.
     */
    public static final int NORMAL = 0;

    /**
     * Sets the style of the font to italics.
     */
    public static final int ITALICS = 1;

    // display list offset.
    private int base;

    // buffer that holds the text.
    private ByteBuffer scratch;

    // Color to render the font.
    private final ColorRGBA fontColor;

    /**
     * Constructor instantiates a new LwjglFont object. The initial color is set to white.
     * 
     */
    public LwjglFont() {
        fontColor = new ColorRGBA(1, 1, 1, 1);
        scratch = BufferUtils.createByteBuffer(1);
        buildDisplayList();
    }

    /**
     * <code>deleteFont</code> deletes the current display list of font objects. The font will be useless until a call
     * to <code>buildDisplayLists</code> is made.
     */
    public void deleteFont() {
        GL11.glDeleteLists(base, 256);
    }

    /**
     * <code>setColor</code> sets the RGBA values to render the font as. By default the color is white with no
     * transparency.
     * 
     * @param color
     *            the color to set.
     */
    public void setColor(final ColorRGBA color) {
        fontColor.set(color);
    }

    /**
     * <code>print</code> renders the specified string to a given (x,y) location. The x, y location is in terms of
     * screen coordinates. There are currently two sets of fonts supported: NORMAL and ITALICS.
     * 
     * @param r
     * 
     * @param x
     *            the x screen location to start the string render.
     * @param y
     *            the y screen location to start the string render.
     * @param text
     *            the String to render.
     * @param set
     *            the mode of font: NORMAL or ITALICS.
     */
    public void print(final Renderer r, final double x, final double y, final ReadOnlyVector3 scale,
            final StringBuffer text, int set) {
        final RendererRecord matRecord = ContextManager.getCurrentContext().getRendererRecord();
        if (set > 1) {
            set = 1;
        } else if (set < 0) {
            set = 0;
        }

        final boolean alreadyOrtho = r.isInOrthoMode();
        if (!alreadyOrtho) {
            r.setOrtho();
        } else {
            LwjglRendererUtil.switchMode(matRecord, GL11.GL_MODELVIEW);
            GL11.glPushMatrix();
            GL11.glLoadIdentity();
        }
        GL11.glTranslated(x, y, 0);
        GL11.glScaled(scale.getX(), scale.getY(), scale.getZ());
        GL11.glListBase(base - 32 + (128 * set));

        // Put the string into a "pointer"
        if (text.length() > scratch.capacity()) {
            scratch = BufferUtils.createByteBuffer(text.length());
        } else {
            scratch.clear();
        }

        final int charLen = text.length();
        for (int z = 0; z < charLen; z++) {
            scratch.put((byte) text.charAt(z));
        }
        scratch.flip();
        GL11.glColor4f(fontColor.getRed(), fontColor.getGreen(), fontColor.getBlue(), fontColor.getAlpha());
        // call the list for each letter in the string.
        GL11.glCallLists(scratch);
        // set color back to white
        GL11.glColor4f(1, 1, 1, 1);

        if (!alreadyOrtho) {
            r.unsetOrtho();
        } else {
            LwjglRendererUtil.switchMode(matRecord, GL11.GL_MODELVIEW);
            GL11.glPopMatrix();
        }
    }

    /**
     * <code>buildDisplayList</code> sets up the 256 display lists that are used to render each font character. Each
     * list quad is 16x16, as defined by the font image size.
     */
    public void buildDisplayList() {
        float cx;
        float cy;

        base = GL11.glGenLists(256);

        for (int loop = 0; loop < 256; loop++) {
            cx = (loop % 16) / 16.0f;
            cy = (loop / 16) / 16.0f;

            GL11.glNewList(base + loop, GL11.GL_COMPILE);
            GL11.glBegin(GL11.GL_QUADS);
            GL11.glTexCoord2f(cx, 1 - cy - 0.0625f);
            GL11.glVertex2i(0, 0);
            GL11.glTexCoord2f(cx + 0.0625f, 1 - cy - 0.0625f);
            GL11.glVertex2i(16, 0);
            GL11.glTexCoord2f(cx + 0.0625f, 1 - cy);
            GL11.glVertex2i(16, 16);
            GL11.glTexCoord2f(cx, 1 - cy);
            GL11.glVertex2i(0, 16);
            GL11.glEnd();
            GL11.glTranslatef(10, 0, 0);
            GL11.glEndList();
        }
    }

    @Override
    public String toString() {
        String string = super.toString();
        string += "\nColor: " + fontColor.toString();

        return string;
    }
}