|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.media.j3d.SceneGraphObject | +--javax.media.j3d.NodeComponent | +--javax.media.j3d.Geometry | +--javax.media.j3d.Text3D
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 a text position - a point in 3 space where the text should be placed. The 3D text can be placed around this position using different alignments and paths.
Font3D
Field Summary | |
static int |
ALIGN_CENTER
alignment : the center of the string is placed on the
position point. |
static int |
ALIGN_FIRST
alignment : the first character of the string is placed
on the position point. |
static int |
ALIGN_LAST
alignment : the last character of the string is placed
on the position point. |
static int |
ALLOW_ALIGNMENT_READ
Specifies that this Text3D object allows reading the text alignment value. |
static int |
ALLOW_ALIGNMENT_WRITE
Specifies that this Text3D object allows writing the text alignment value. |
static int |
ALLOW_BOUNDING_BOX_READ
Specifies that this Text3D object allows reading the text string bounding box value |
static int |
ALLOW_CHARACTER_SPACING_READ
Specifies that this Text3D object allows reading the text character spacing value. |
static int |
ALLOW_CHARACTER_SPACING_WRITE
Specifies that this Text3D object allows writing the text character spacing value. |
static int |
ALLOW_FONT3D_READ
Specifies that this Text3D object allows reading the Font3D component information. |
static int |
ALLOW_FONT3D_WRITE
Specifies that this Text3D object allows writing the Font3D component information. |
static int |
ALLOW_PATH_READ
Specifies that this Text3D object allows reading the text path value. |
static int |
ALLOW_PATH_WRITE
Specifies that this Text3D object allows writing the text path value. |
static int |
ALLOW_POSITION_READ
Specifies that this Text3D object allows reading the text position value. |
static int |
ALLOW_POSITION_WRITE
Specifies that this Text3D object allows writing the text position value. |
static int |
ALLOW_STRING_READ
Specifies that this Text3D object allows reading the String object. |
static int |
ALLOW_STRING_WRITE
Specifies that this Text3D object allows writing the String object. |
static int |
PATH_DOWN
path : succeeding glyphs are placed below the
current glyph. |
static int |
PATH_LEFT
path : succeeding glyphs are placed to the left of
the current glyph. |
static int |
PATH_RIGHT
path : succeeding glyphs are placed to the left of
the current glyph. |
static int |
PATH_UP
path : succeeding glyphs are placed above the
current glyph. |
Fields inherited from class javax.media.j3d.Geometry |
ALLOW_INTERSECT |
Constructor Summary | |
Text3D()
Constructs a Text3D object with default parameters. |
|
Text3D(Font3D font3D)
Creates a Text3D object with the given Font3D object. |
|
Text3D(Font3D font3D,
java.lang.String string)
Creates a Text3D object given a Font3D object and a string. |
|
Text3D(Font3D font3D,
java.lang.String string,
Point3f position)
Creates a Text3D object given a Font3D, a string and position. |
|
Text3D(Font3D font3D,
java.lang.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 | |
NodeComponent |
cloneNodeComponent()
Creates a new Text3D object. |
void |
duplicateNodeComponent(NodeComponent originalNodeComponent)
Copies the information found in originalNodeComponent to
the current node. |
int |
getAlignment()
Retrieves the text alignment policy for this Text3D NodeComponent object. |
void |
getBoundingBox(BoundingBox bounds)
Retrieves the 3D bounding box that encloses this Text3D object. |
float |
getCharacterSpacing()
Retrieves the character spacing used to construct the Text3D string. |
Font3D |
getFont3D()
Returns the Font3D objects used by this Text3D NodeComponent object. |
int |
getPath()
Retrieves the node's path field. |
void |
getPosition(Point3f position)
Copies the node's position field into the supplied
parameter. |
java.lang.String |
getString()
Copies the character string used in the construction of the Text3D node into the supplied parameter. |
void |
setAlignment(int alignment)
Sets the text alignment policy for this Text3D NodeComponent object. |
void |
setCharacterSpacing(float characterSpacing)
Sets the character spacing used hwne constructing the Text3D string. |
void |
setFont3D(Font3D font3d)
Sets the Font3D object used by this Text3D NodeComponent object. |
void |
setPath(int path)
Sets the node's path field. |
void |
setPosition(Point3f position)
Sets the node's position field to the supplied
parameter. |
void |
setString(java.lang.String string)
Copies the character string from the supplied parameter into Tex3D node. |
Methods inherited from class javax.media.j3d.NodeComponent |
getDuplicateOnCloneTree,
setDuplicateOnCloneTree |
Methods inherited from class javax.media.j3d.SceneGraphObject |
clearCapability,
duplicateSceneGraphObject,
getCapability,
getUserData,
isCompiled,
isLive,
setCapability,
setUserData |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int ALLOW_FONT3D_READ
Font3D
public static final int ALLOW_FONT3D_WRITE
Font3D
public static final int ALLOW_STRING_READ
public static final int ALLOW_STRING_WRITE
public static final int ALLOW_POSITION_READ
public static final int ALLOW_POSITION_WRITE
public static final int ALLOW_ALIGNMENT_READ
public static final int ALLOW_ALIGNMENT_WRITE
public static final int ALLOW_PATH_READ
public static final int ALLOW_PATH_WRITE
public static final int ALLOW_CHARACTER_SPACING_READ
public static final int ALLOW_CHARACTER_SPACING_WRITE
public static final int ALLOW_BOUNDING_BOX_READ
public static final int ALIGN_CENTER
alignment
: the center of the string is placed on the
position
point.getAlignment()
public static final int ALIGN_FIRST
alignment
: the first character of the string is placed
on the position
point.getAlignment()
public static final int ALIGN_LAST
alignment
: the last character of the string is placed
on the position
point.getAlignment()
public static final int PATH_LEFT
path
: succeeding glyphs are placed to the left of
the current glyph.getPath()
public static final int PATH_RIGHT
path
: succeeding glyphs are placed to the left of
the current glyph.getPath()
public static final int PATH_UP
path
: succeeding glyphs are placed above the
current glyph.getPath()
public static final int PATH_DOWN
path
: succeeding glyphs are placed below the
current glyph.getPath()
Constructor Detail |
public Text3D()
public Text3D(Font3D font3D)
Font3D
public Text3D(Font3D font3D, java.lang.String string)
Font3D
public Text3D(Font3D font3D, java.lang.String string, Point3f position)
position
and succeeding
glyphs are placed to the right of the initial glyph.Font3D
public Text3D(Font3D font3D, java.lang.String string, Point3f position, int alignment, int path)
position
position depends on
the alignment parameter and the path parameter.Font3D
Method Detail |
public NodeComponent cloneNodeComponent()
duplicateNode
method.Node.duplicateNode(javax.media.j3d.Node, boolean)
,
Node.cloneTree()
,
NodeComponent.setDuplicateOnCloneTree(boolean)
public void duplicateNodeComponent(NodeComponent originalNodeComponent)
originalNodeComponent
to
the current node. This routine is called as part of the
cloneNodeComponent
operation.originalNodeComponent
- the node to duplicate.Node.cloneTree()
,
Node.cloneNode(boolean)
,
NodeComponent.cloneNodeComponent()
,
NodeComponent.setDuplicateOnCloneTree(boolean)
public final Font3D getFont3D()
public final void setFont3D(Font3D font3d)
font3d
- the Font3D object to associate with this Text3D node.public final java.lang.String getString()
public final void setString(java.lang.String string)
string
- the String object to recieve the Text3D node's string.public final void getPosition(Point3f position)
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.position
- the point to position the text.getAlignment()
,
getPath()
public final void setPosition(Point3f position)
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.position
- the point to position the text.getAlignment()
,
getPath()
public final int getAlignment()
alignment
is used to specify how
glyphs in the string are placed in relation to the
position
field. Valid values for this field
are:
position
point.
position
point.
position
point.
ALIGN_FIRST
.getPosition(javax.vecmath.Point3f)
public final void setAlignment(int alignment)
alignment
is used to specify how
glyphs in the string are placed in relation to the
position
field. Valid values for this field
are:
position
point.
position
point.
position
point.
ALIGN_FIRST
.getPosition(javax.vecmath.Point3f)
public final int getPath()
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_RIGHT
.public final void setPath(int path)
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_RIGHT
.path
- the value to set the path to.public final void getBoundingBox(BoundingBox bounds)
bounds
- the object to copy the bounding information to.BoundingBox
public final float getCharacterSpacing()
public final void setCharacterSpacing(float characterSpacing)
characterSpacing
- the new character spacing value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |