|
| |
|
| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.NodeComponent
javax.media.j3d.Geometry
javax.media.j3d.Text3D
| Text3D | | public class Text3D extends Geometry (Code) | | A Text3D object is a text string that has been converted to 3D
geometry. The Font3D object determines the appearance of the
Text3D NodeComponent object. Each Text3D object has the following
parameters:
- Font3D object - describes the font style of the text string,
such as the font family (Helvetica, Courier, etc.), style (Italic,
bold, etc.), and point size. The size of the resulting characters will
be equal to the point size. For example, a 12 point font will result in
a Font3D with characters 12 meters tall.
- Text string - the text string to be written.
- Position - determines the initial placement of the Text3D string
in three-space.
- Alignment - specifies how glyphs in the string are placed in
relation to the position parameter. Valid values are:
- ALIGN_CENTER - the center of the string is placed on the
position point.
- ALIGN_FIRST - the first character of the string is placed on
the
position point.
- ALIGN_LAST - the last character of the string is placed on the
position point.
- Path - specifies how succeeding glyphs in the string are placed
in relation to the previous glyph. Valid values are:
- PATH_LEFT - succeeding glyphs are placed to the left of the
current glyph.
- PATH_RIGHT - succeeding glyphs are placed to the right of the
current glyph.
- PATH_UP - succeeding glyphs are placed above the current glyph.
- PATH_DOWN - succeeding glyphs are placed below the current glyph.
- Character spacing - the space between characters. This spacing is
in addition to the regular spacing between glyphs as defined in the
Font object.
See Also: Font3D |
| Field Summary | |
| final public static int | ALIGN_CENTER
alignment: the center of the string is placed on the
position point. | | final public static int | ALIGN_FIRST
alignment: the first character of the string is placed
on the position point. | | final public static int | ALIGN_LAST
alignment: the last character of the string is placed
on the position point. | | final public static int | ALLOW_ALIGNMENT_READ
Specifies that this Text3D object allows
reading the text alignment value. | | final public static int | ALLOW_ALIGNMENT_WRITE
Specifies that this Text3D object allows
writing the text alignment value. | | final public static int | ALLOW_BOUNDING_BOX_READ
| | final public static int | ALLOW_CHARACTER_SPACING_READ
Specifies that this Text3D object allows
reading the text character spacing value. | | final public static int | ALLOW_CHARACTER_SPACING_WRITE
Specifies that this Text3D object allows
writing the text character spacing value. | | final public static int | ALLOW_FONT3D_READ
Specifies that this Text3D object allows
reading the Font3D component information. | | final public static int | ALLOW_FONT3D_WRITE
Specifies that this Text3D object allows
writing the Font3D component information. | | final public static int | ALLOW_PATH_READ
Specifies that this Text3D object allows
reading the text path value. | | final public static int | ALLOW_PATH_WRITE
Specifies that this Text3D object allows
writing the text path value. | | final public static int | ALLOW_POSITION_READ
Specifies that this Text3D object allows
reading the text position value. | | final public static int | ALLOW_POSITION_WRITE
Specifies that this Text3D object allows
writing the text position value. | | final public static int | ALLOW_STRING_READ
Specifies that this Text3D object allows
reading the String object. | | final public static int | ALLOW_STRING_WRITE
Specifies that this Text3D object allows
writing the String object. | | final public static int | PATH_DOWN
path: succeeding glyphs are placed below the
current glyph. | | final public static int | PATH_LEFT
path: succeeding glyphs are placed to the left of
the current glyph. | | final public static int | PATH_RIGHT
path: succeeding glyphs are placed to the left of
the current glyph. | | final public static int | PATH_UP
path: succeeding glyphs are placed above the
current glyph. |
| Constructor Summary | |
| public | Text3D()
Constructs a Text3D object with default parameters. | | public | Text3D(Font3D font3D)
Creates a Text3D object with the given Font3D object. | | public | Text3D(Font3D font3D, String string)
Creates a Text3D object given a Font3D object and a string. | | public | Text3D(Font3D font3D, String string, Point3f position)
Creates a Text3D object given a Font3D, a string and position. | | public | Text3D(Font3D font3D, String string, Point3f position, int alignment, int path)
Creates a Text3D object given a Font3D, string, position, alignment
and path along which string is to be placed. |
| Method Summary | |
| public NodeComponent | cloneNodeComponent()
| | void | createRetained()
Creates the retained mode Text3DRetained object that this
Text3D component object will point to. | | void | duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)
Copies all node information from originalNodeComponent into
the current node. | | public int | getAlignment()
Retrieves the text alignment policy for this Text3D NodeComponent
object. | | public void | getBoundingBox(BoundingBox bounds)
Retrieves the 3D bounding box that encloses this Text3D object. | | public float | getCharacterSpacing()
Retrieves the character spacing used to construct the Text3D string.
This spacing is in addition to the regular spacing between glyphs as
defined in the Font object. | | public Font3D | getFont3D()
Returns the Font3D objects used by this Text3D NodeComponent object. | | public int | getPath()
Retrieves the node's path field. | | public void | getPosition(Point3f position)
Copies the node's position field into the supplied
parameter. | | public String | getString()
Copies the character string used in the construction of the
Text3D node into the supplied parameter. | | public void | setAlignment(int alignment)
Sets the text alignment policy for this Text3D NodeComponent
object. | | public void | setCharacterSpacing(float characterSpacing)
Sets the character spacing used when constructing the Text3D string.
This spacing is in addition to the regular spacing between glyphs as
defined in the Font object. | | public void | setFont3D(Font3D font3d)
Sets the Font3D object used by this Text3D NodeComponent object. | | public void | setPath(int path)
Sets the node's path field. | | public void | setPosition(Point3f position)
Sets the node's position field to the supplied
parameter. | | public void | setString(String string)
Copies the character string from the supplied parameter into the
Text3D node. |
| ALIGN_CENTER | | final public static int ALIGN_CENTER(Code) | | alignment: the center of the string is placed on the
position point.
See Also: Text3D.getAlignment |
| ALIGN_FIRST | | final public static int ALIGN_FIRST(Code) | | alignment: the first character of the string is placed
on the position point.
See Also: Text3D.getAlignment |
| ALIGN_LAST | | final public static int ALIGN_LAST(Code) | | alignment: the last character of the string is placed
on the position point.
See Also: Text3D.getAlignment |
| ALLOW_ALIGNMENT_READ | | final public static int ALLOW_ALIGNMENT_READ(Code) | | Specifies that this Text3D object allows
reading the text alignment value.
|
| ALLOW_ALIGNMENT_WRITE | | final public static int ALLOW_ALIGNMENT_WRITE(Code) | | Specifies that this Text3D object allows
writing the text alignment value.
|
| ALLOW_BOUNDING_BOX_READ | | final public static int ALLOW_BOUNDING_BOX_READ(Code) | | Specifies that this Text3D object allows
reading the text string bounding box value
|
| ALLOW_CHARACTER_SPACING_READ | | final public static int ALLOW_CHARACTER_SPACING_READ(Code) | | Specifies that this Text3D object allows
reading the text character spacing value.
|
| ALLOW_CHARACTER_SPACING_WRITE | | final public static int ALLOW_CHARACTER_SPACING_WRITE(Code) | | Specifies that this Text3D object allows
writing the text character spacing value.
|
| ALLOW_FONT3D_READ | | final public static int ALLOW_FONT3D_READ(Code) | | Specifies that this Text3D object allows
reading the Font3D component information.
See Also: Font3D |
| ALLOW_FONT3D_WRITE | | final public static int ALLOW_FONT3D_WRITE(Code) | | Specifies that this Text3D object allows
writing the Font3D component information.
See Also: Font3D |
| ALLOW_PATH_READ | | final public static int ALLOW_PATH_READ(Code) | | Specifies that this Text3D object allows
reading the text path value.
|
| ALLOW_PATH_WRITE | | final public static int ALLOW_PATH_WRITE(Code) | | Specifies that this Text3D object allows
writing the text path value.
|
| ALLOW_POSITION_READ | | final public static int ALLOW_POSITION_READ(Code) | | Specifies that this Text3D object allows
reading the text position value.
|
| ALLOW_POSITION_WRITE | | final public static int ALLOW_POSITION_WRITE(Code) | | Specifies that this Text3D object allows
writing the text position value.
|
| ALLOW_STRING_READ | | final public static int ALLOW_STRING_READ(Code) | | Specifies that this Text3D object allows
reading the String object.
|
| ALLOW_STRING_WRITE | | final public static int ALLOW_STRING_WRITE(Code) | | Specifies that this Text3D object allows
writing the String object.
|
| PATH_DOWN | | final public static int PATH_DOWN(Code) | | path: succeeding glyphs are placed below the
current glyph.
See Also: Text3D.getPath |
| PATH_LEFT | | final public static int PATH_LEFT(Code) | | path: succeeding glyphs are placed to the left of
the current glyph.
See Also: Text3D.getPath |
| PATH_RIGHT | | final public static int PATH_RIGHT(Code) | | path: succeeding glyphs are placed to the left of
the current glyph.
See Also: Text3D.getPath |
| PATH_UP | | final public static int PATH_UP(Code) | | path: succeeding glyphs are placed above the
current glyph.
See Also: Text3D.getPath |
| Text3D | | public Text3D()(Code) | | Constructs a Text3D object with default parameters.
The default values are as follows:
font 3D : null
string : null
position : (0,0,0)
alignment : ALIGN_FIRST
path : PATH_RIGHT
character spacing : 0.0
|
| Text3D | | public Text3D(Font3D font3D)(Code) | | Creates a Text3D object with the given Font3D object.
See Also: Font3D |
| Text3D | | public Text3D(Font3D font3D, String string)(Code) | | Creates a Text3D object given a Font3D object and a string. The
string is converted into 3D glyphs. The first glyph from the
string is placed at (0.0, 0.0, 0.0) and succeeding glyphs are
placed to the right of the initial glyph.
See Also: Font3D |
| Text3D | | public Text3D(Font3D font3D, String string, Point3f position)(Code) | | Creates a Text3D object given a Font3D, a string and position. The
string is converted into 3D glyphs. The first glyph from the
string is placed at position position and succeeding
glyphs are placed to the right of the initial glyph.
See Also: Font3D |
| Text3D | | public Text3D(Font3D font3D, String string, Point3f position, int alignment, int path)(Code) | | Creates a Text3D object given a Font3D, string, position, alignment
and path along which string is to be placed. The
string is converted into 3D glyphs. The placement of the glyphs
with respect to the position position depends on
the alignment parameter and the path parameter.
See Also: Font3D |
| createRetained | | void createRetained()(Code) | | Creates the retained mode Text3DRetained object that this
Text3D component object will point to.
|
| duplicateAttributes | | void duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)(Code) | | Copies all node information from originalNodeComponent into
the current node. This method is called from the
duplicateNode method. This routine does
the actual duplication of all "local data" (any data defined in
this object).
Parameters:
originalNodeComponent - the original node to duplicate.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
See Also: Node.cloneTree
See Also: NodeComponent.setDuplicateOnCloneTree |
| getAlignment | | public int getAlignment()(Code) | | Retrieves the text alignment policy for this Text3D NodeComponent
object. The alignment is used to specify how
glyphs in the string are placed in relation to the
position field. Valid values for this field
are:
- ALIGN_CENTER - the center of the string is placed on the
position point.
- ALIGN_FIRST - the first character of the string is placed on
the
position point.
- ALIGN_LAST - the last character of the string is placed on the
position point.
The default value of this field is ALIGN_FIRST.
the current alingment policy for this node.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
See Also: Text3D.getPosition |
| getBoundingBox | | public void getBoundingBox(BoundingBox bounds)(Code) | | Retrieves the 3D bounding box that encloses this Text3D object.
Parameters:
bounds - the object to copy the bounding information to.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
See Also: BoundingBox |
| getCharacterSpacing | | public float getCharacterSpacing()(Code) | | Retrieves the character spacing used to construct the Text3D string.
This spacing is in addition to the regular spacing between glyphs as
defined in the Font object. 1.0 in this space is measured as the
width of the largest glyph in the 2D Font. The default value is
0.0.
the current character spacing value
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getFont3D | | public Font3D getFont3D()(Code) | | Returns the Font3D objects used by this Text3D NodeComponent object.
the Font3D object of this Text3D node - null if no Font3Dhas been associated with this node.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getPath | | public int getPath()(Code) | | Retrieves the node's path field. This field
is used to specify how succeeding
glyphs in the string are placed in relation to the previous glyph.
Valid values for this field are:
- PATH_LEFT: - succeeding glyphs are placed to the left of the
current glyph.
- PATH_RIGHT: - succeeding glyphs are placed to the right of the
current glyph.
- PATH_UP: - succeeding glyphs are placed above the current glyph.
- PATH_DOWN: - succeeding glyphs are placed below the current glyph.
The default value of this field is PATH_RIGHT.
the current alingment policy for this node.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getPosition | | public void getPosition(Point3f position)(Code) | | Copies the node's position field into the supplied
parameter. The position is used to determine the
initial placement of the Text3D string. The position, combined with
the path and alignment control how the text is displayed.
Parameters:
position - the point to position the text.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
See Also: Text3D.getAlignment
See Also: Text3D.getPath |
| getString | | public String getString()(Code) | | Copies the character string used in the construction of the
Text3D node into the supplied parameter.
a copy of the String object in this Text3D node.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setAlignment | | public void setAlignment(int alignment)(Code) | | Sets the text alignment policy for this Text3D NodeComponent
object. The alignment is used to specify how
glyphs in the string are placed in relation to the
position field. Valid values for this field
are:
- ALIGN_CENTER - the center of the string is placed on the
position point.
- ALIGN_FIRST - the first character of the string is placed on
the
position point.
- ALIGN_LAST - the last character of the string is placed on the
position point.
The default value of this field is ALIGN_FIRST.
Parameters:
alignment - specifies how glyphs in the string are placedin relation to the position field
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
See Also: Text3D.getPosition |
| setCharacterSpacing | | public void setCharacterSpacing(float characterSpacing)(Code) | | Sets the character spacing used when constructing the Text3D string.
This spacing is in addition to the regular spacing between glyphs as
defined in the Font object. 1.0 in this space is measured as the
width of the largest glyph in the 2D Font. The default value is
0.0.
Parameters:
characterSpacing - the new character spacing value
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setFont3D | | public void setFont3D(Font3D font3d)(Code) | | Sets the Font3D object used by this Text3D NodeComponent object.
Parameters:
font3d - the Font3D object to associate with this Text3D node.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setPath | | public void setPath(int path)(Code) | | Sets the node's path field. This field
is used to specify how succeeding
glyphs in the string are placed in relation to the previous glyph.
Valid values for this field are:
- PATH_LEFT - succeeding glyphs are placed to the left of the
current glyph.
- PATH_RIGHT - succeeding glyphs are placed to the right of the
current glyph.
- PATH_UP - succeeding glyphs are placed above the current glyph.
- PATH_DOWN - succeeding glyphs are placed below the current glyph.
The default value of this field is PATH_RIGHT.
Parameters:
path - the value to set the path to
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setPosition | | public void setPosition(Point3f position)(Code) | | Sets the node's position field to the supplied
parameter. The position is used to determine the
initial placement of the Text3D string. The position, combined with
the path and alignment control how the text is displayed.
Parameters:
position - the point to position the text.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
See Also: Text3D.getAlignment
See Also: Text3D.getPath |
| setString | | public void setString(String string)(Code) | | Copies the character string from the supplied parameter into the
Text3D node.
Parameters:
string - the String object to recieve the Text3D node's string.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| Fields inherited from javax.media.j3d.Geometry | final public static int ALLOW_INTERSECT(Code)(Java Doc)
|
| Fields inherited from javax.media.j3d.NodeComponent | boolean forceDuplicate(Code)(Java Doc)
|
|
|
|