Package com.metsci.glimpse.jogamp.opengl.util.awt.text

Class GlyphRendererGL2

java.lang.Object

com.metsci.glimpse.jogamp.opengl.util.awt.text.GlyphRendererGL2

All Implemented Interfaces:

GlyphRenderer, QuadPipeline.EventListener

public final class GlyphRendererGL2
extends Object

GlyphRenderer for use with OpenGL 2.

Nested Class Summary

Nested classes/interfaces inherited from interface com.metsci.glimpse.jogamp.opengl.util.awt.text.GlyphRenderer

GlyphRenderer.EventListener, GlyphRenderer.EventType

Constructor Summary

Constructors

Constructor	Description
GlyphRendererGL2()	Constructs a GlyphRendererGL2.

Method Summary

Modifier and Type	Method	Description
void	addListener(GlyphRenderer.EventListener listener)	Registers an GlyphRenderer.EventListener with this GlyphRenderer.
void	beginRendering(com.jogamp.opengl.GL gl, boolean ortho, int width, int height, boolean disableDepthTest)	Starts a render cycle with this GlyphRenderer.
void	dispose(com.jogamp.opengl.GL gl)	Frees resources used by this GlyphRenderer.
float	drawGlyph(com.jogamp.opengl.GL gl, Glyph glyph, float x, float y, float z, float scale, com.jogamp.opengl.util.texture.TextureCoords coords)	Draws a glyph with this GlyphRenderer.
void	endRendering(com.jogamp.opengl.GL gl)	Finishes a render cycle with this GlyphRenderer.
void	flush(com.jogamp.opengl.GL gl)	Forces all stored text to be rendered.
boolean	getUseVertexArrays()	Checks if this GlyphRenderer is using vertex arrays.
void	onQuadPipelineEvent(QuadPipeline.EventType type)	Responds to an event from a QuadPipeline.
void	setColor(float r, float g, float b, float a)	Changes the color used to draw the text.
void	setTransform(float[] value, boolean transpose)	Changes the transformation matrix for drawing in 3D.
void	setUseVertexArrays(boolean useVertexArrays)	Changes whether vertex arrays are in use.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlyphRendererGL2

public GlyphRendererGL2()

Constructs a GlyphRendererGL2.

Method Detail

getUseVertexArrays

public boolean getUseVertexArrays()

Description copied from interface: GlyphRenderer

Checks if this GlyphRenderer is using vertex arrays.

Returns:

True if this renderer is using vertex arrays

setUseVertexArrays

public void setUseVertexArrays(boolean useVertexArrays)

Description copied from interface: GlyphRenderer

Changes whether vertex arrays are in use.

Parameters:

useVertexArrays - true to use vertex arrays

addListener

public final void addListener(GlyphRenderer.EventListener listener)

Description copied from interface: GlyphRenderer

Registers an GlyphRenderer.EventListener with this GlyphRenderer.

Specified by:

addListener in interface GlyphRenderer

Parameters:

listener - Listener to register

beginRendering

public final void beginRendering(com.jogamp.opengl.GL gl,
                                 boolean ortho,
                                 int width,
                                 int height,
                                 boolean disableDepthTest)

Description copied from interface: GlyphRenderer

Starts a render cycle with this GlyphRenderer.

Specified by:

beginRendering in interface GlyphRenderer

Parameters:

gl - Current OpenGL context

ortho - True if using orthographic projection

width - Width of current OpenGL viewport

height - Height of current OpenGL viewport

disableDepthTest - True if should ignore depth values

dispose

public final void dispose(com.jogamp.opengl.GL gl)

Description copied from interface: GlyphRenderer

Frees resources used by this GlyphRenderer.

Specified by:

dispose in interface GlyphRenderer

Parameters:

gl - Current OpenGL context

drawGlyph

public final float drawGlyph(com.jogamp.opengl.GL gl,
                             Glyph glyph,
                             float x,
                             float y,
                             float z,
                             float scale,
                             com.jogamp.opengl.util.texture.TextureCoords coords)

Description copied from interface: GlyphRenderer

Draws a glyph with this GlyphRenderer.

Specified by:

drawGlyph in interface GlyphRenderer

Parameters:

gl - Current OpenGL context

glyph - Visual representation of a character

x - Position to draw on X axis, which may be negative

y - Position to draw on Y axis, which may be negative

z - Position to draw on Z axis, which may be negative

scale - Relative size of glyph, which may be negative

coords - Texture coordinates of glyph

Returns:

Distance to next character, which may be negative

endRendering

public final void endRendering(com.jogamp.opengl.GL gl)

Description copied from interface: GlyphRenderer

Finishes a render cycle with this GlyphRenderer.

Specified by:

endRendering in interface GlyphRenderer

Parameters:

gl - Current OpenGL context

flush

public final void flush(com.jogamp.opengl.GL gl)

Description copied from interface: GlyphRenderer

Forces all stored text to be rendered.

Specified by:

flush in interface GlyphRenderer

Parameters:

gl - Current OpenGL context

onQuadPipelineEvent

public final void onQuadPipelineEvent(QuadPipeline.EventType type)

Description copied from interface: QuadPipeline.EventListener

Responds to an event from a QuadPipeline.

Specified by:

onQuadPipelineEvent in interface QuadPipeline.EventListener

Parameters:

type - Type of event

setColor

public final void setColor(float r,
                           float g,
                           float b,
                           float a)

Description copied from interface: GlyphRenderer

Changes the color used to draw the text.

Specified by:

setColor in interface GlyphRenderer

Parameters:

r - Red component of color

g - Green component of color

b - Blue component of color

a - Alpha component of color

setTransform

public final void setTransform(float[] value,
                               boolean transpose)

Description copied from interface: GlyphRenderer

Changes the transformation matrix for drawing in 3D.

Specified by:

setTransform in interface GlyphRenderer

Parameters:

value - Matrix as float array

transpose - True if array is in in row-major order