com.jme3.font

Class BitmapText

java.lang.Object

com.jme3.scene.Spatial

com.jme3.scene.Node

com.jme3.font.BitmapText

All Implemented Interfaces:

HasLocalTransform, CloneableSmartAsset, Collidable, Savable, JmeCloneable, java.lang.Cloneable

public class BitmapText
extends Node

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.scene.Spatial

Spatial.BatchHint, Spatial.CullHint, Spatial.DFSMode

Field Summary

Fields inherited from class com.jme3.scene.Node

children

Fields inherited from class com.jme3.scene.Spatial

batchHint, controls, cullHint, frustrumIntersects, key, localLights, localOverrides, localTransform, name, parent, queueBucket, queueDistance, refreshFlags, RF_BOUND, RF_CHILD_LIGHTLIST, RF_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors

Constructor and Description
BitmapText(BitmapFont font)
BitmapText(BitmapFont font, boolean rightToLeft) Deprecated. The "rightToLeft" flag should be specified in the font. Use BitmapText(com.jme3.font.BitmapFont)
BitmapText(BitmapFont font, boolean rightToLeft, boolean arrayBased)

Method Summary

Modifier and Type	Method and Description
BitmapText	clone() Creates a clone of the asset.
void	cloneFields(Cloner cloner, java.lang.Object original) Called internally by com.jme3.util.clone.Cloner.
BitmapFont.Align	getAlignment()
float	getAlpha()
ColorRGBA	getColor()
BitmapFont	getFont()
float	getHeight()
int	getLineCount()
float	getLineHeight()
float	getLineWidth()
LineWrapMode	getLineWrapMode()
float	getSize()
java.lang.String	getText()
BitmapFont.VAlign	getVerticalAlignment()
void	render(RenderManager rm, ColorRGBA color)
void	setAlignment(BitmapFont.Align align) Set horizontal alignment.
void	setAlpha(float alpha) Sets an overall alpha that will be applied to all letters.
void	setBox(Rectangle rect) Define the area where the BitmapText will be rendered.
void	setColor(ColorRGBA color) changes text color.
void	setColor(int start, int end, ColorRGBA color) Set the color of substring.
void	setColor(java.lang.String regexp, ColorRGBA color) Set the color of substring.
void	setEllipsisChar(char c) for setLineWrapType(LineWrapType.NoWrap), set the last character when the text exceeds the bound.
void	setLineWrapMode(LineWrapMode wrap) Available only when bounding is set.
void	setSize(float size) Changes text size
void	setStyle(int start, int end, int style) Set the font style of substring.
void	setStyle(java.lang.String regexp, int style) Set the font style of substring.
void	setTabPosition(float... tabs)
void	setTabWidth(float width) used for the tabs over the last tab position.
void	setText(java.lang.CharSequence text)
void	setText(java.lang.String text)
void	setVerticalAlignment(BitmapFont.VAlign align) Set vertical alignment.
void	updateLogicalState(float tpf) updateLogicalState calls the update() method for all controls attached to this Spatial.

Methods inherited from class com.jme3.scene.Node

attachChild, attachChildAt, breadthFirstTraversal, clone, collideWith, deepClone, depthFirstTraversal, descendantMatches, descendantMatches, descendantMatches, detachAllChildren, detachChild, detachChildAt, detachChildNamed, getChild, getChild, getChildIndex, getChildren, getQuantity, getTriangleCount, getVertexCount, hasChild, oldDeepClone, read, setLightListRefresh, setLodLevel, setMaterial, setMatParamOverrideRefresh, setModelBound, setParent, setTransformRefresh, swapChildren, updateGeometricState, updateModelBound, updateWorldBound, write

Methods inherited from class com.jme3.scene.Spatial

addControl, addControlAt, addLight, addMatParamOverride, breadthFirstTraversal, center, checkCulling, clearMatParamOverrides, depthFirstTraversal, forceRefresh, getBatchHint, getControl, getControl, getCullHint, getKey, getLastFrustumIntersection, getLocalBatchHint, getLocalCullHint, getLocalLightList, getLocalMatParamOverrides, getLocalQueueBucket, getLocalRotation, getLocalScale, getLocalShadowMode, getLocalToWorldMatrix, getLocalTransform, getLocalTranslation, getName, getNumControls, getParent, getQueueBucket, getShadowMode, getUserData, getUserDataKeys, getWorldBound, getWorldLightList, getWorldMatParamOverrides, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, jmeClone, localToWorld, lookAt, matches, move, move, oldClone, removeControl, removeControl, removeFromParent, removeLight, removeMatParamOverride, rotate, rotate, rotateUpTo, runControlRender, scale, scale, setBatchHint, setBoundRefresh, setCullHint, setKey, setLastFrustumIntersection, setLocalRotation, setLocalRotation, setLocalScale, setLocalScale, setLocalScale, setLocalTransform, setLocalTranslation, setLocalTranslation, setName, setQueueBucket, setRequiresUpdates, setShadowMode, setUserData, toString, updateMatParamOverrides, updateWorldLightList, updateWorldTransforms, worldToLocal

Methods inherited from class java.lang.Object

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

Constructor Detail

BitmapText

public BitmapText(BitmapFont font)

BitmapText

@Deprecated
public BitmapText(BitmapFont font,
                              boolean rightToLeft)

Deprecated. The "rightToLeft" flag should be specified in the font. Use BitmapText(com.jme3.font.BitmapFont)

Parameters:

font - the font to use (not null, alias created)

rightToLeft - true → right-to-left, false → left-to-right (default=false)

BitmapText

public BitmapText(BitmapFont font,
                  boolean rightToLeft,
                  boolean arrayBased)

Method Detail

clone

public BitmapText clone()

Description copied from interface: CloneableSmartAsset

Creates a clone of the asset. Please see Object.clone() for more info on how this method should be implemented.

Specified by:

clone in interface CloneableSmartAsset

Overrides:

clone in class Spatial

Returns:

A clone of this Spatial, the scene graph in its entirety is cloned and can be altered independently of the original scene graph. Note that meshes of geometries are not cloned explicitly, they are shared if static, or specially cloned if animated.

See Also:

Mesh.cloneForAnim()

cloneFields

public void cloneFields(Cloner cloner,
                        java.lang.Object original)

Called internally by com.jme3.util.clone.Cloner. Do not call directly.

Specified by:

cloneFields in interface JmeCloneable

Overrides:

cloneFields in class Node

Parameters:

cloner - The cloner that is performing the cloning operation. The cloneFields method can call back into the cloner to make clones of its subordinate fields.

original - The original object from which this object was cloned. This is provided for the very rare case that this object needs to refer to its original for some reason. In general, all of the relevant values should have been transferred during the shallow clone, and this object need only clone what it wants.

getFont

public BitmapFont getFont()

setSize

public void setSize(float size)

Changes text size

Parameters:

size - text size

getSize

public float getSize()

setText

public void setText(java.lang.CharSequence text)

Parameters:

text - charsequence to change text to

setText

public void setText(java.lang.String text)

Parameters:

text - String to change text to

getText

public java.lang.String getText()

Returns:

returns text

getColor

public ColorRGBA getColor()

Returns:

color of the text

setColor

public void setColor(ColorRGBA color)

changes text color. all substring colors are deleted.

Parameters:

color - new color of text

setAlpha

public void setAlpha(float alpha)

Sets an overall alpha that will be applied to all letters. If the alpha passed is -1 then alpha reverts to default... which will be 1 for anything unspecified and color tags will be reset to 1 or their encoded alpha.

Parameters:

alpha - the desired alpha, or -1 to revert to the default

getAlpha

public float getAlpha()

setBox

public void setBox(Rectangle rect)

Define the area where the BitmapText will be rendered.

Parameters:

rect - position and size box where text is rendered

getLineHeight

public float getLineHeight()

Returns:

height of the line

getHeight

public float getHeight()

Returns:

height of whole text block

getLineWidth

public float getLineWidth()

Returns:

width of line

getLineCount

public int getLineCount()

Returns:

line count

getLineWrapMode

public LineWrapMode getLineWrapMode()

setAlignment

public void setAlignment(BitmapFont.Align align)

Set horizontal alignment. Applicable only when text bound is set.

Parameters:

align - the desired alignment (such as Align.Left)

setVerticalAlignment

public void setVerticalAlignment(BitmapFont.VAlign align)

Set vertical alignment. Applicable only when text bound is set.

Parameters:

align - the desired alignment (such as Align.Top)

getAlignment

public BitmapFont.Align getAlignment()

getVerticalAlignment

public BitmapFont.VAlign getVerticalAlignment()

setStyle

public void setStyle(int start,
                     int end,
                     int style)

Set the font style of substring. If font doesn't contain style, default style is used

Parameters:

start - start index to set style. inclusive.

end - end index to set style. EXCLUSIVE.

style - the style to apply

setStyle

public void setStyle(java.lang.String regexp,
                     int style)

Set the font style of substring. If font doesn't contain style, default style is applied

Parameters:

regexp - regular expression

style - the style to apply

setColor

public void setColor(int start,
                     int end,
                     ColorRGBA color)

Set the color of substring.

Parameters:

start - start index to set style. inclusive.

end - end index to set style. EXCLUSIVE.

color - the desired color

setColor

public void setColor(java.lang.String regexp,
                     ColorRGBA color)

Set the color of substring.

Parameters:

regexp - regular expression

color - the desired color

setTabPosition

public void setTabPosition(float... tabs)

Parameters:

tabs - tab positions

setTabWidth

public void setTabWidth(float width)

used for the tabs over the last tab position.

Parameters:

width - tab size

setEllipsisChar

public void setEllipsisChar(char c)

for setLineWrapType(LineWrapType.NoWrap), set the last character when the text exceeds the bound.

Parameters:

c - the character to indicate truncated text

setLineWrapMode

public void setLineWrapMode(LineWrapMode wrap)

Available only when bounding is set. setBox() method call is needed in advance. true when

Parameters:

wrap - NoWrap : Letters over the text bound is not shown. the last character is set to '...'(0x2026) Character: Character is split at the end of the line. Word : Word is split at the end of the line. Clip : The text is hard-clipped at the border including showing only a partial letter if it goes beyond the text bound.

updateLogicalState

public void updateLogicalState(float tpf)

Description copied from class: Spatial

updateLogicalState calls the update() method for all controls attached to this Spatial.

Overrides:

updateLogicalState in class Node

Parameters:

tpf - Time per frame.

See Also:

Spatial.addControl(com.jme3.scene.control.Control)

render

public void render(RenderManager rm,
                   ColorRGBA color)