fr.inria.zuist.od

Class ClosedShapeDescription

java.lang.Object

fr.inria.zuist.od.ObjectDescription

fr.inria.zuist.od.ClosedShapeDescription

public class ClosedShapeDescription
extends ObjectDescription

Description of any ZVTM glyph sibclass of ClosedShape to be loaded/unloaded in the scene.

Author:

Emmanuel Pietriga

Field Summary

Fields

Modifier and Type	Field and Description
static String	OBJECT_TYPE_CLOSED_SHAPE

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

id, parentRegion, sensitive, takesTo, takesToType, zindex

Constructor Summary

Constructors

Constructor and Description
ClosedShapeDescription(String id, ClosedShape g, int z, Region pr, boolean sensitive) Constructs the description of a ZVTM ClosedShape.

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.
Glyph	getGlyph() Get actual ClosedShape instance wrapped in this ZUIST object description.
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)

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_CLOSED_SHAPE

public static final String OBJECT_TYPE_CLOSED_SHAPE

See Also:

Constant Field Values

Constructor Detail

ClosedShapeDescription

public ClosedShapeDescription(String id,
                              ClosedShape g,
                              int z,
                              Region pr,
                              boolean sensitive)

Constructs the description of a ZVTM ClosedShape.

Parameters:

id - ID of object in scene.

g - any ZVTM ClosedShape instance. Must implement fr.inria.zvtm.glyphs.Translucent if fade in/out transitions are used in the parent region.

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

pr - parent Region in scene.

sensitive - should the glyph be made sensitive to cursor events or not.

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

getGlyph

public Glyph getGlyph()

Get actual ClosedShape instance wrapped in this ZUIST object 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.

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

coordInside

public boolean coordInside(double pvx,
                           double pvy)

Are the supplied coordinates inside the object described. This will not work for objects that need to know which camera is observing them (SIRectangle, SICircle, VText).

Specified by:

coordInside in class ObjectDescription

Returns:

true if the supplied coordinates are inside the object described.