org.web3d.vrml.renderer.common.nodes.surface.BaseText2D

All Implemented Interfaces:: VRMLNode, FrameStateListener, VRMLNodeType, VRMLSurfaceChildNodeType

Direct Known Subclasses:: NRText2D

public abstract class BaseText2D extends BaseSurfaceChildNode implements VRMLSurfaceChildNodeType

Common implementation of a Text2D node.

The transparency field of the text node follows the standard alpha channel values for 3D colour. A value of 0 means opaque, and a value of 1 means fully transparent. The value only applies to the background color and not the text rendering. The default value is 1.

Version:: $Revision: 1.14 $
Author:: Justin Couch

Field Summary

Fields

Modifier and Type

Field

Description

protected static final boolean

ANTIALIAS

The set, working font size.

protected static final int

FIELD_BGCOLOR

The field index for enabled.

protected static final int

FIELD_FIXED_SIZE

The field index for fixedSize.

protected static final int

FIELD_FONTSTYLE

Index of the fontstyle node field

protected static final int

FIELD_STRING

The field index for texture.

protected static final int

FIELD_TEXTCOLOR

The field index for isActive.

protected static final int

FIELD_TRANSPARENCY

The field index for isOvery.

protected static final int

LAST_TEXT2D_INDEX

The last field index used by this class

protected static final int

NUM_FIELDS

Number of fields constant

protected VRMLProtoInstance

pFontStyle

The proto version of the fontstyle

protected float[]

vfBackgroundColor

exposedField SFColor backgroundColor

protected boolean

vfFixedSize

field SFBool fixedSize

protected VRMLFontStyleNodeType

vfFontStyle

exposedField SFNode fontStyle NULL

protected String

vfString

exposedField SFString string

protected float[]

vfTextColor

exposedField SFColor textColor

protected float

vfTransparency

exposedField SFFloat transparency

Fields inherited from class org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceChildNode
FIELD_BBOX_SIZE, FIELD_VISIBLE, LAST_SURFACE_CHILD_INDEX, listener, parentVisibility, screenBounds, screenLocation, vfBboxSize, vfVisible

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

BaseText2D()

Construct a new default Overlay object

protected

BaseText2D(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node.
Method Summary

Modifier and Type

Method

Description

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.

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

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 a 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, VRMLNodeType child)

Set the value of the field at the given index as a node.

protected void

updateSurface(int index)

Notification by the base class to the derived class that the node should be updated because one of the fields changed.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceChildNode
copy, fireSizeChange, getBboxSize, getParentVisible, getPrimaryType, getRealBounds, isVisible, setBboxSize, setLayoutListener, setLocation, setParentVisible, setVisible

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, 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
getPrimaryType, 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, setValue, updateRefCount

Methods inherited from interface org.web3d.vrml.nodes.VRMLSurfaceChildNodeType
getBboxSize, getParentVisible, getRealBounds, isVisible, setLayoutListener, setLocation, setParentVisible, setVisible

Field Details
- ANTIALIAS
  
  protected static final boolean ANTIALIAS
  
  The set, working font size. Set in the static constructor
- FIELD_FIXED_SIZE
  protected static final int FIELD_FIXED_SIZE
  
  The field index for fixedSize.
  
  See Also:
  
  Constant Field Values
- FIELD_STRING
  protected static final int FIELD_STRING
  
  The field index for texture.
  
  See Also:
  
  Constant Field Values
- FIELD_TEXTCOLOR
  protected static final int FIELD_TEXTCOLOR
  
  The field index for isActive.
  
  See Also:
  
  Constant Field Values
- FIELD_BGCOLOR
  protected static final int FIELD_BGCOLOR
  
  The field index for enabled.
  
  See Also:
  
  Constant Field Values
- FIELD_TRANSPARENCY
  protected static final int FIELD_TRANSPARENCY
  
  The field index for isOvery.
  
  See Also:
  
  Constant Field Values
- FIELD_FONTSTYLE
  protected static final int FIELD_FONTSTYLE
  
  Index of the fontstyle node field
  
  See Also:
  
  Constant Field Values
- LAST_TEXT2D_INDEX
  protected static final int LAST_TEXT2D_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
- vfFixedSize
  
  protected boolean vfFixedSize
  
  field SFBool fixedSize
- vfString
  
  protected String vfString
  
  exposedField SFString string
- vfTextColor
  
  protected float[] vfTextColor
  
  exposedField SFColor textColor
- vfBackgroundColor
  
  protected float[] vfBackgroundColor
  
  exposedField SFColor backgroundColor
- vfTransparency
  
  protected float vfTransparency
  
  exposedField SFFloat transparency
- vfFontStyle
  
  protected VRMLFontStyleNodeType vfFontStyle
  
  exposedField SFNode fontStyle NULL
- pFontStyle
  
  protected VRMLProtoInstance pFontStyle
  
  The proto version of the fontstyle
Constructor Details
- BaseText2D
  
  protected BaseText2D()
  
  Construct a new default Overlay object
- BaseText2D
  
  protected BaseText2D(VRMLNodeType node)
  
  Construct a new instance of this node based on the details from the given node. If the node is not the same type, an exception will be thrown.
  
  Parameters:
  
  node - The node to copy
  
  Throws:
  
  IllegalArgumentException - The node is not the same type
Method Details
- 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.
- 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 BaseSurfaceChildNode
  
  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 BaseSurfaceChildNode
  
  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.
- 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 BaseSurfaceChildNode
- setValue
  
  public void setValue(int index, boolean value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as a boolean. This would be used to set SFBool field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class BaseSurfaceChildNode
  
  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 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 out of range for the field type.
- 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 MFFloat, SFVec2f, SFVec3f and SFRotation field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class BaseSurfaceChildNode
  
  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 out of range for the field type.
- 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 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.
- 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.
- setFontStyle
  
  public void setFontStyle(VRMLNodeType newFont) throws InvalidFieldValueException
  
  Convenience method to set a node child for the fontstyle.
  
  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.
  
  Returns:
  
  The current fontstyle information
- updateSurface
  
  protected void updateSurface(int index)
  
  Notification by the base class to the derived class that the node should be updated because one of the fields changed. The index is the field index of the value that changed.
  
  Parameters:
  
  index - The index of the field that changed

Class BaseText2D

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceChildNode

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

Constructor Summary

Method Summary

Methods inherited from class org.web3d.vrml.renderer.common.nodes.surface.BaseSurfaceChildNode

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

Methods inherited from class java.lang.Object

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

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

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

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

Field Details

ANTIALIAS

FIELD_FIXED_SIZE

FIELD_STRING

FIELD_TEXTCOLOR

FIELD_BGCOLOR

FIELD_TRANSPARENCY

FIELD_FONTSTYLE

LAST_TEXT2D_INDEX

NUM_FIELDS

vfFixedSize

vfString

vfTextColor

vfBackgroundColor

vfTransparency

vfFontStyle

pFontStyle

Constructor Details

BaseText2D

BaseText2D

Method Details

getFieldIndex

getNodeFieldIndices

getFieldDeclaration

getNumFields

getFieldValue

sendRoute

setupFinished

setValue

setValue

setValue

setValue

setValue

setFontStyle

getFontStyle

updateSurface