Xj3D 2.0 VRML/X3D Code API

org.web3d.vrml.nodes
Interface VRMLTextNodeType

All Superinterfaces:
FrameStateListener, VRMLGeometryNodeType, VRMLNode, VRMLNodeType
All Known Subinterfaces:
OGLTextNodeType

public interface VRMLTextNodeType
extends VRMLGeometryNodeType

Describes a Text string output geometry node in VRML .

Version:
$Revision: 1.1 $
Author:
Alan Hudson, Justin Couch

Method Summary
 VRMLNodeType getFontStyle()
          Get the currently set fontstyle.
 java.lang.String[] getText()
          Get the current text being rendered.
 void setFontStyle(VRMLNodeType fs)
          Set the new fontstyle to render the text with.
 void setText(java.lang.String[] text)
          Change the text to the new value.
 
Methods inherited from interface org.web3d.vrml.nodes.VRMLGeometryNodeType
addLocalColorsListener, addTexCoordGenModeChanged, getNumSets, getTexCoordGenMode, hasLocalColorAlpha, hasLocalColors, isCCW, isLightingEnabled, isSolid, removeLocalColorsListener, removeTexCoordGenModeChanged
 
Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType
addNodeListener, clearRemovedLayerIds, getFieldValue, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount
 
Methods inherited from interface org.web3d.vrml.lang.VRMLNode
getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion
 
Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener
allEventsComplete
 

Method Detail

setFontStyle

void setFontStyle(VRMLNodeType fs)
                  throws InvalidFieldValueException
Set the new fontstyle to render the text with. A null value will clear the fontstyle and return the text to default rendering.

Parameters:
fs - The new fonstyle to use
Throws:
InvalidFieldValueException - The node passed in is not a fontstyle or fontstyle proto.

getFontStyle

VRMLNodeType getFontStyle()
Get the currently set fontstyle. If none is set, null is returned.

Returns:
The current fontstyle information

setText

void setText(java.lang.String[] text)
Change the text to the new value. A null value will clear the current text.

Parameters:
text - The new text to see

getText

java.lang.String[] getText()
Get the current text being rendered. If no text is available, returns null.

Returns:
The text being rendered

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium