Package com.jogamp.graph.ui.shapes

Class GlyphShape

java.lang.Object

com.jogamp.graph.ui.Shape

com.jogamp.graph.ui.GraphShape

com.jogamp.graph.ui.shapes.GlyphShape

public class GlyphShape
extends GraphShape

Representing a single Font.Glyph as a GraphShape A GlyphShape is represented in font em-size [0..1] unscaled w/ bottom-left origin at 0/0 while preserving an intended position, see getOrigPos() and getOrigPos(float). Scaling, if any, should be applied via Shape.setScale(float, float, float) etc.

Nested Class Summary

Nested classes/interfaces inherited from class com.jogamp.graph.ui.Shape

Shape.EventInfo, Shape.Listener, Shape.ListenerBool, Shape.MouseGestureAdapter, Shape.MouseGestureListener, Shape.Visitor1, Shape.Visitor2

Field Summary

Fields inherited from class com.jogamp.graph.ui.Shape

ZAscendingComparator

Constructor Summary

Constructors

Constructor	Description
GlyphShape(int renderModes, char symbol, Font.Glyph glyph, float x, float y)	Creates a new GlyphShape
GlyphShape(int renderModes, Font font, char symbol, float x, float y)	Creates a new GlyphShape

Method Summary

Modifier and Type	Method	Description
Font	getFont()	Returns the Font used to render the text
Font.Glyph	getGlyph()	Returns the Font.Glyph to be rendered.
float	getLineHeight()	Returns Font.getLineHeight().
Vec3f	getOrigPos()	Returns the unscaled original position of this glyph, e.g.
Vec3f	getOrigPos(float scale)	Returns a copy of the scaled original position of this glyph, see getOrigPos(Vec3f)
Vec3f	getOrigPos(Vec3f s)	Returns the unscaled original position of this glyph, e.g.
Vec3f	getOrigPos(Vec3f s, float scale)	Returns the scaled original position of this glyph, see getOrigPos(float)
String	getSubString()
char	getSymbol()	Returns the char symbol to be rendered.
static AABBox	processString(List<GlyphShape> res, int renderModes, Font font, String text)	Process the given text resulting in a list of GlyphShapes with stored original position #getOrigX() and #getOrigY() each at font em-size [0..1].
void	resetPos(float scale)	Resets this Shape's position to the scaled original position, see getOrigPos(float).
void	resetPosAndScale(float scale)	Resets this Shape's position to the scaled original position and set scale, see resetPos(float).

Methods inherited from class com.jogamp.graph.ui.GraphShape

getQuality, getRenderModes, getSharpness, hasColorChannel, setQuality, setSharpness, setTextureUnit

Methods inherited from class com.jogamp.graph.ui.Shape

addMouseListener, clear, destroy, draw, drawToSelect, getBorderColor, getBorderThickness, getBounds, getBounds, getColor, getName, getPadding, getPixelPerShapeUnit, getPixelPerShapeUnit, getPosition, getRotation, getRotationPivot, getScale, getScaledHeight, getScaledWidth, getSurfacePort, getSurfaceSize, getSurfaceSize, getSurfaceSize, hasBorder, hasPadding, isDraggable, isEnabled, isInteractive, isPressed, isResizable, isToggleable, isToggleOn, markShapeDirty, markStateDirty, move, move, moveTo, moveTo, onClicked, onInit, onMove, onToggle, removeMouseListener, scale, setBorder, setBorderColor, setBorderColor, setColor, setColor, setDragAndResizeable, setDraggable, setEnabled, setInteractive, setName, setPaddding, setPressed, setPressedColorMod, setResizable, setRotationPivot, setRotationPivot, setScale, setToggle, setToggleable, setToggleOffColorMod, setToggleOnColorMod, setTransform, shapeToWinCoord, shapeToWinCoord, shapeToWinCoord, toggle, toString, validate, validate, winToShapeCoord, winToShapeCoord, winToShapeCoord

Methods inherited from class java.lang.Object

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

Constructor Detail

GlyphShape

public GlyphShape(int renderModes,
                  char symbol,
                  Font.Glyph glyph,
                  float x,
                  float y)

Creates a new GlyphShape

Parameters:

renderModes - Graph's Region render modes, see create(..).

symbol - the represented character

glyph - the Font.Glyph

x - the intended unscaled X position of this Glyph, e.g. if part of a string - otherwise use zero.

y - the intended unscaled Y position of this Glyph, e.g. if part of a string - otherwise use zero.

See Also:

processString(List, int, Font, String)

GlyphShape

public GlyphShape(int renderModes,
                  Font font,
                  char symbol,
                  float x,
                  float y)

Creates a new GlyphShape

Parameters:

renderModes - Graph's Region render modes, see create(..).

font - the Font to lookup the symbol's Font.Glyph

symbol - the represented character

x - the intended unscaled X position of this Glyph, e.g. if part of a string - otherwise use zero.

y - the intended unscaled Y position of this Glyph, e.g. if part of a string - otherwise use zero.

Method Detail

getSymbol

public char getSymbol()

Returns the char symbol to be rendered.

getGlyph

public Font.Glyph getGlyph()

Returns the Font.Glyph to be rendered.

getFont

public Font getFont()

Returns the Font used to render the text

getOrigPos

public Vec3f getOrigPos()

Returns the unscaled original position of this glyph, e.g. if part of a string, otherwise zero. Method borrows and returns the internal instance.

See Also:

processString(List, int, Font, String)

getOrigPos

public Vec3f getOrigPos(Vec3f s)

Returns the unscaled original position of this glyph, e.g. if part of a string, otherwise zero.

Parameters:

s - Vec3f storage to be returned

Returns:

storage containing the unscaled original position

See Also:

processString(List, int, Font, String)

getOrigPos

public Vec3f getOrigPos(float scale)

Returns a copy of the scaled original position of this glyph, see getOrigPos(Vec3f)

See Also:

processString(List, int, Font, String)

getOrigPos

public Vec3f getOrigPos(Vec3f s,
                        float scale)

Returns the scaled original position of this glyph, see getOrigPos(float)

Parameters:

s - Vec3f storage to be returned

Returns:

storage containing the scaled original position

See Also:

processString(List, int, Font, String)

resetPos

public void resetPos(float scale)

Resets this Shape's position to the scaled original position, see getOrigPos(float).

resetPosAndScale

public void resetPosAndScale(float scale)

Resets this Shape's position to the scaled original position and set scale, see resetPos(float).

getLineHeight

public float getLineHeight()

Returns Font.getLineHeight().

processString

public static final AABBox processString(List<GlyphShape> res,
                                         int renderModes,
                                         Font font,
                                         String text)

Process the given text resulting in a list of GlyphShapes with stored original position #getOrigX() and #getOrigY() each at font em-size [0..1].

Parameters:

res - storage for resulting GlyphShapes.

renderModes - Graph's Region render modes, see create(..).

font - Font used

text - text to be represented

Returns:

the bounding box of the given string by taking each glyph's font em-sized [0..1] OutlineShape into account.

See Also:

#getOrigX(), #getOrigY()

getSubString

public String getSubString()

Overrides:

getSubString in class Shape