All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class vlc.vrml.generic.geometry.Text 

java.lang.Object
   |
   +----vlc.vrml.generic.geometry.VrmlObject
           |
           +----vlc.vrml.generic.geometry.Geometry
                   |
                   +----vlc.vrml.generic.geometry.Text
public class Text
extends Geometry
JVerge

Version:
0.8 (beta 4) Copyright 1997 The Virtual Light Company under the GNU LGPL

The latest information and bugs in JVerge can be found at http://www.vlc.com.au/JVerge

For definition of the Anchor node please see the VRML 97 Anchor specification

Author:
Justin Couch justin@vlc.com.au

Constructor Index

o Text()
Default Constructor.

Method Index

o cleanup()
Call when about to remove the node from the scenegraph.
o clone()
Make a clone of this object
o get_fontStyle()
Get the current FontStyle node.
o get_length()
Get the current length of each string in the local coordinate system.
o get_maxExtent()
Get the absolute maximum length of all strings to be displayed in the local coordinate system.
o get_string()
Get the currently set string values.
o set_fontStyle(FontStyle)
Set the FontStyle node to be used.
o set_length(float[])
Set the length of each string in the local coordinate system.
o set_maxExtent(float)
Set the absolute maximum length of all strings to be displayed in the local coordinate system.
o set_string(String[])
Set the text strings to be rendered.
o writeReset()
Used for maintaining the reference counting when trying to do DEF/USE in the write to stream method.
o writeToStream(int)
Prints the formatted contents of this node to the given stream.

Constructors

o Text 
 public Text()
Default Constructor. Creates a default Text node

Methods

o cleanup 
 public void cleanup()
Call when about to remove the node from the scenegraph.

Overrides:
cleanup in class VrmlObject
o writeReset 
 public void writeReset()
Used for maintaining the reference counting when trying to do DEF/USE in the write to stream method.

Overrides:
writeReset in class VrmlObject
o writeToStream 
 public void writeToStream(int indent)
Prints the formatted contents of this node to the given stream.

Parameters:
indent - The number of spaces to indent this node in the string
Overrides:
writeToStream in class VrmlObject
o set_fontStyle 
 public void set_fontStyle(FontStyle fontStyle)
Set the FontStyle node to be used.

Parameters:
A - valid JVerge FontStyle node or null to remove the current.
See Also:
FontStyle
o get_fontStyle 
 public FontStyle get_fontStyle()
Get the current FontStyle node.

Returns:
A FontStyle node or null if none set.
o set_string 
 public void set_string(String string[])
Set the text strings to be rendered.

Parameters:
strings - List of strings to be shown. One string represents one line of text.
o get_string 
 public String[] get_string()
Get the currently set string values.

Returns:
The strings being shown. One per line.
o set_length 
 public void set_length(float length[])
Set the length of each string in the local coordinate system.

Parameters:
lengths - The extents for each line of text
o get_length 
 public float[] get_length()
Get the current length of each string in the local coordinate system.

Parameters:
lengths - The extents for each line of text
o set_maxExtent 
 public void set_maxExtent(float maxExtent)
Set the absolute maximum length of all strings to be displayed in the local coordinate system. Anything greater than this will scale the string lenght back to fit

Parameters:
maxExtent - maximum length from 0 to infinity
o get_maxExtent 
 public float get_maxExtent()
Get the absolute maximum length of all strings to be displayed in the local coordinate system.

Returns:
The maximum length from 0 to infinity
o clone 
 public Object clone()
Make a clone of this object

Returns:
A deep clone copy of this object
Overrides:
clone in class VrmlObject 
All Packages  Class Hierarchy  This Package  Previous  Next  Index