Package org.web3d.vrml.renderer.common.nodes.text

Class BaseText

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.text.BaseText

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLGeometryNodeType, VRMLNodeType, VRMLTextNodeType

Direct Known Subclasses:

NRText, OGLText

public abstract class BaseText
extends AbstractNode
implements VRMLTextNodeType

Common base implementation of a Text node.

This base class provides a number of convenience methods for generating the visible text. It is not required that the derived implementation make use of them, but it assumes that you know when you create the class whether you will need them or not.

Text generation is provided by a texture that is an alpha mask over the stock texture and geometry. VRML requires that a text object be fully textured using the normal appearance node information, so this is just used as an alpha mask to control what geometry is actually visible.

The texture generation does not do the full rendering of the text. It assumes that the derived class will also contribute to the process by playing with texture coordinates. The following fields from the FontStyle require the derived class to do something.

• leftToRight: If set to FALSE, then reverse the texture coordinates to render in the mirror image.

The image generated is drawn from the bottom of the image upwards, rather that from the top (0, 0 in image coordinates). This is so that texture coordinates look sane and you can take the right part of the image as needed without any extra calculation.

Properties

The following properties are used by this class

• org.web3d.vrml.nodes.fontstyle.font.antialiased Boolean to indicate the rendering should use antialiased text rather than normal rendering. The default is false.

Version:

$Revision: 1.28 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_FONTSTYLE	Index of the fontstyle node field
protected static final int	FIELD_LENGTH	Index of the length field
protected static final int	FIELD_MAXEXTENT	Index of the maxExtents field
protected static final int	FIELD_SOLID	Index of the solid field
protected static final int	FIELD_STRING	Index of the string field
protected int	imgHeight	The height of the texture image
protected int	imgWidth	The width of the texture image
protected static final int	LAST_TEXT_INDEX	The last field index used by this class
protected int	linePixelHeight	The number of pixels a single line of text takes up on the image
protected int	linePixelSpacing	The number of pixels of spacing between the bottom of one line and the top of the next.
protected static final int	NUM_FIELDS	Number of fields constant
protected int	numLength	Number of valid values in vfLength
protected int	numString	Number of valid values in vfString
protected VRMLProtoInstance	pFontStyle	The proto version of the fontstyle
protected TextLayout[]	stringTextLayoutArray	The stringTextLayoutArray matching the appropriate string in the order list depending on the fontstyle topToBottom field.
protected BufferedImage	texturedImage	The texture currently being displayed
protected int	usedPixelHeight	The number of pixels actually used in the height of the texture.
protected int	usedPixelWidth	The number of pixels actually used in the width of the texture.
protected VRMLFontStyleNodeType	vfFontStyle	exposedField SFNode fontStyle NULL
protected float[]	vfLength	exposedField MFFloat length []
protected float	vfMaxExtent	exposedField SFFloat maxExtent
protected boolean	vfSolid	field SFBool solid
protected String[]	vfString	exposedField MFString string []

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseText(boolean useTexture)	Construct a new default instance of this class.
protected	BaseText(VRMLNodeType node, boolean useTexture)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
void	addLocalColorsListener(LocalColorsListener l)	Add a listener for local color changes.
void	addTexCoordGenModeChanged(TexCoordGenModeListener l)	Add a listener for texture coordinate generation mode changes.
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
VRMLNodeType	getFontStyle()	Get the currently set fontstyle.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
int	getNumSets()	Get the number of texture coordinate sets contained by this node
int	getPrimaryType()	Get the primary type of this node.
String	getTexCoordGenMode(int setNum)	Get the texture coordinate generation mode.
String[]	getText()	Get the current text being rendered.
boolean	hasLocalColorAlpha()	Specified whether this node has alpha values in the local colour information.
boolean	hasLocalColors()	Specified whether this node has color information.
boolean	isCCW()	Get the value of the CCW field.
boolean	isLightingEnabled()	Specifies whether this node requires lighting.
boolean	isSolid()	Specifies whether a geometry object is a solid object.
void	removeLocalColorsListener(LocalColorsListener l)	Remove a listener for local color changes.
void	removeTexCoordGenModeChanged(TexCoordGenModeListener l)	Remove a listener for texture coordinate generation mode changes.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setFontStyle(VRMLNodeType newFont)	Convenience method to set a node child for the fontstyle.
void	setText(String[] str)	Convenience method to set the text information.
void	setTextureCount(int count)	Set the number of textures that were found on the accompanying Appearance node.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, boolean value)	Set the value of the field at the given index as an boolean.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setValue(int index, String value)	Set the value of the field at the given index as a string.
void	setValue(int index, String[] value, int numValid)	Set the value of the field at the given index as an array of strings.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
protected void	textUpdated(boolean sizeChanged)	Notification by the base class to the derived class that the texture representing the text has been changed.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_STRING

protected static final int FIELD_STRING

Index of the string field

See Also:

• Constant Field Values

FIELD_FONTSTYLE

protected static final int FIELD_FONTSTYLE

Index of the fontstyle node field

See Also:

• Constant Field Values

FIELD_LENGTH

protected static final int FIELD_LENGTH

Index of the length field

See Also:

• Constant Field Values

FIELD_MAXEXTENT

protected static final int FIELD_MAXEXTENT

Index of the maxExtents field

See Also:

• Constant Field Values

FIELD_SOLID

protected static final int FIELD_SOLID

Index of the solid field

See Also:

• Constant Field Values

LAST_TEXT_INDEX

protected static final int LAST_TEXT_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfString

protected String[] vfString

exposedField MFString string []

numString

protected int numString

Number of valid values in vfString

vfFontStyle

protected VRMLFontStyleNodeType vfFontStyle

exposedField SFNode fontStyle NULL

pFontStyle

protected VRMLProtoInstance pFontStyle

The proto version of the fontstyle

vfLength

protected float[] vfLength

exposedField MFFloat length []

numLength

protected int numLength

Number of valid values in vfLength

vfMaxExtent

protected float vfMaxExtent

exposedField SFFloat maxExtent

vfSolid

protected boolean vfSolid

field SFBool solid

texturedImage

protected BufferedImage texturedImage

The texture currently being displayed

imgWidth

protected int imgWidth

The width of the texture image

imgHeight

protected int imgHeight

The height of the texture image

usedPixelWidth

protected int usedPixelWidth

The number of pixels actually used in the width of the texture.

usedPixelHeight

protected int usedPixelHeight

The number of pixels actually used in the height of the texture.

linePixelHeight

protected int linePixelHeight

The number of pixels a single line of text takes up on the image

linePixelSpacing

protected int linePixelSpacing

The number of pixels of spacing between the bottom of one line and the top of the next. Based on the bounding box and therefore the line height.

stringTextLayoutArray

protected TextLayout[] stringTextLayoutArray

The stringTextLayoutArray matching the appropriate string in the order list depending on the fontstyle topToBottom field.

Constructor Details

BaseText

protected BaseText(boolean useTexture)

Construct a new default instance of this class.

Parameters:

useTexture - True if the derived class wants textures generated

BaseText

protected BaseText(VRMLNodeType node,
 boolean useTexture)

Construct a new instance of this node based on the details from the given node. If the node is not a light node, an exception will be thrown.

Parameters:

node - The node to copy

useTexture - True if the derived class wants textures generated

Throws:

IllegalArgumentException - Incorrect Node Type

Method Details

hasLocalColors

public boolean hasLocalColors()

Specified whether this node has color information. If so, then it will be used for diffuse terms instead of materials.

Specified by:

hasLocalColors in interface VRMLGeometryNodeType

Returns:

true Use local color information for diffuse lighting.

hasLocalColorAlpha

public boolean hasLocalColorAlpha()

Specified whether this node has alpha values in the local colour information. If so, then it will be used for to override the material's transparency value.

Specified by:

hasLocalColorAlpha in interface VRMLGeometryNodeType

Returns:

true when the local color value has inbuilt alpha

addLocalColorsListener

public void addLocalColorsListener(LocalColorsListener l)

Add a listener for local color changes. Nulls and duplicates will be ignored.

Specified by:

addLocalColorsListener in interface VRMLGeometryNodeType

Parameters:

l - The listener.

removeLocalColorsListener

public void removeLocalColorsListener(LocalColorsListener l)

Remove a listener for local color changes. Nulls will be ignored.

Specified by:

removeLocalColorsListener in interface VRMLGeometryNodeType

Parameters:

l - The listener.

addTexCoordGenModeChanged

public void addTexCoordGenModeChanged(TexCoordGenModeListener l)

Add a listener for texture coordinate generation mode changes. Nulls and duplicates will be ignored.

Specified by:

addTexCoordGenModeChanged in interface VRMLGeometryNodeType

Parameters:

l - The listener.

removeTexCoordGenModeChanged

public void removeTexCoordGenModeChanged(TexCoordGenModeListener l)

Remove a listener for texture coordinate generation mode changes. Nulls will be ignored.

Specified by:

removeTexCoordGenModeChanged in interface VRMLGeometryNodeType

Parameters:

l - The listener.

getTexCoordGenMode

public String getTexCoordGenMode(int setNum)

Get the texture coordinate generation mode. NULL is returned if the texture coordinates are not generated.

Specified by:

getTexCoordGenMode in interface VRMLGeometryNodeType

Parameters:

setNum - The set which this tex gen mode refers

Returns:

The mode or NULL

setTextureCount

public void setTextureCount(int count)

Set the number of textures that were found on the accompanying Appearance node. Used to set the number of texture coordinates that need to be passed in to the renderer when no explicit texture coordinates were given. * @param count The number of texture coordinate sets to add

Specified by:

setTextureCount in interface VRMLGeometryNodeType

Parameters:

count - The number of texture coordinate sets to add

getNumSets

public int getNumSets()

Get the number of texture coordinate sets contained by this node

Specified by:

getNumSets in interface VRMLGeometryNodeType

Returns:

the number of texture coordinate sets

isSolid

public boolean isSolid()

Specifies whether a geometry object is a solid object. If true, then back-face culling can be performed

Specified by:

isSolid in interface VRMLGeometryNodeType

Returns:

The current value of solid

isCCW

public boolean isCCW()

Get the value of the CCW field. If the node does not have one, this will return true.

Specified by:

isCCW in interface VRMLGeometryNodeType

Returns:

true if the vertices are CCW ordered

isLightingEnabled

public boolean isLightingEnabled()

Specifies whether this node requires lighting.

Specified by:

isLightingEnabled in interface VRMLGeometryNodeType

Returns:

Should lighting be enabled

setFontStyle

public void setFontStyle(VRMLNodeType newFont)
                  throws InvalidFieldValueException

Convenience method to set a node child for the fontstyle.

Specified by:

setFontStyle in interface VRMLTextNodeType

Parameters:

newFont - the new node to set

Throws:

InvalidFieldValueException - The node passed in is not a fontstyle or fontstyle proto.

getFontStyle

public VRMLNodeType getFontStyle()

Get the currently set fontstyle. If none is set, null is returned.

Specified by:

getFontStyle in interface VRMLTextNodeType

Returns:

The current fontstyle information

setText

public void setText(String[] str)

Convenience method to set the text information. May be overridden by the derived class, but should call this method first to ensure the field values are properly set.

Specified by:

setText in interface VRMLTextNodeType

Parameters:

str - The string(s) to set

getText

public String[] getText()

Get the current text being rendered. If no text is available, returns null.

Specified by:

getText in interface VRMLTextNodeType

Returns:

The text being rendered

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Specified by:

getFieldIndex in interface VRMLNode

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Specified by:

getFieldDeclaration in interface VRMLNode

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class AbstractNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class AbstractNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 boolean value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an boolean. This would be used to set SFBool field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not know

InvalidFieldValueException - The value provided is out of range for the field type.

setValue

public void setValue(int index,
 float value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an array of floats. This would be used to set SFColor and SFVec3f field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 String value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a string. This would be used to set SFString field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The raw value string to be parsed

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

setValue

public void setValue(int index,
 String[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an array of strings. This would be used to set MFString field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The strings to be rendered

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a node. This would be used to set SFNode field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

child - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

textUpdated

protected void textUpdated(boolean sizeChanged)

Notification by the base class to the derived class that the texture representing the text has been changed. The derived should now change their texture representation.

Parameters:

sizeChanged - true if the underlying texture size changed