fr.inria.zuist.od

Class TextDescription

java.lang.Object

fr.inria.zuist.od.ObjectDescription

fr.inria.zuist.od.TextDescription

public class TextDescription
extends ObjectDescription

Description of text objects to be loaded/unloaded in the scene.

Author:

Emmanuel Pietriga

Field Summary

Fields

Modifier and Type	Field and Description
static String	_end
static String	_middle
static String	_start
static String	OBJECT_TYPE_TEXT

Fields inherited from class fr.inria.zuist.od.ObjectDescription

id, parentRegion, sensitive, takesTo, takesToType, zindex

Constructor Summary

Constructors

Constructor and Description
TextDescription(String id, double x, double y, int z, float s, String tx, Color c, float alpha, short ta, Region pr) Constructs the description of an image (VTextST).

Method Summary

Modifier and Type	Method and Description
boolean	coordInside(double pvx, double pvy) Are the supplied coordinates inside the object described.
void	createObject(SceneManager sm, VirtualSpace vs, boolean fadeIn) Called automatically by scene manager.
void	destroyObject(SceneManager sm, VirtualSpace vs, boolean fadeOut) Called automatically by scene manager.
static short	getAnchor(String anchor) Get ZVTM constant value representing anchors "start", "midlle", "end".
Font	getFont() Get the AWT Font object used to draw this text.
Glyph	getGlyph() Get Glyph described by this description.
float	getScale() Get this text object's scale multiplication factor.
String	getText() Get this text object's text string.
float	getTranslucencyValue()
String	getType() Type of object.
double	getX() Get x-coordinate of object in virtual space.
double	getY() Get y-coordinate of object in virtual space.
void	moveTo(double x, double y)
void	setFont(Font f) Get the AWT Font used to draw this text.

Methods inherited from class fr.inria.zuist.od.ObjectDescription

getID, getParentRegion, getZindex, isSensitive, setParentRegion, setSensitive, setTakesTo, setZindex, takesTo, takesToType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OBJECT_TYPE_TEXT

public static final String OBJECT_TYPE_TEXT

See Also:

Constant Field Values

_start

public static final String _start

See Also:

Constant Field Values

_middle

public static final String _middle

See Also:

Constant Field Values

_end

public static final String _end

See Also:

Constant Field Values

Constructor Detail

TextDescription

public TextDescription(String id,
                       double x,
                       double y,
                       int z,
                       float s,
                       String tx,
                       Color c,
                       float alpha,
                       short ta,
                       Region pr)

Constructs the description of an image (VTextST).

Parameters:

id - ID of object in scene

x - x-coordinate in scene

y - y-coordinate in scene

z - z-index (layer). Feed 0 if you don't know.

s - scale factor

tx - text label

c - text color

alpha - in [0;1.0]. 0 is fully transparent, 1 is opaque

ta - text alignment, one of VText.TEXT_ANCHOR_*

pr - parent Region in scene

Method Detail

getType

public String getType()

Type of object.

Specified by:

getType in class ObjectDescription

Returns:

type of object.

createObject

public void createObject(SceneManager sm,
                         VirtualSpace vs,
                         boolean fadeIn)

Description copied from class: ObjectDescription

Called automatically by scene manager. Can be called by client application to force loading of objects not actually visible.

Specified by:

createObject in class ObjectDescription

destroyObject

public void destroyObject(SceneManager sm,
                          VirtualSpace vs,
                          boolean fadeOut)

Description copied from class: ObjectDescription

Called automatically by scene manager. Can be called by client application to force unloading of objects still visible.

Specified by:

destroyObject in class ObjectDescription

setFont

public void setFont(Font f)

Get the AWT Font used to draw this text.

getFont

public Font getFont()

Get the AWT Font object used to draw this text.

getGlyph

public Glyph getGlyph()

Description copied from class: ObjectDescription

Get Glyph described by this description.

Specified by:

getGlyph in class ObjectDescription

Returns:

might return null if the description has not been loaded. This depends on the type of ObjectDescription.

getText

public String getText()

Get this text object's text string.

getScale

public float getScale()

Get this text object's scale multiplication factor. Default is 1.0.

getAnchor

public static short getAnchor(String anchor)

Get ZVTM constant value representing anchors "start", "midlle", "end".

getX

public double getX()

Description copied from class: ObjectDescription

Get x-coordinate of object in virtual space.

Specified by:

getX in class ObjectDescription

getY

public double getY()

Description copied from class: ObjectDescription

Get y-coordinate of object in virtual space.

Specified by:

getY in class ObjectDescription

moveTo

public void moveTo(double x,
                   double y)

Specified by:

moveTo in class ObjectDescription

getTranslucencyValue

public float getTranslucencyValue()

coordInside

public boolean coordInside(double pvx,
                           double pvy)

Are the supplied coordinates inside the object described. Does not work for VText.

Specified by:

coordInside in class ObjectDescription

Returns:

true if the supplied coordinates are inside the object descrived.