fr.inria.zuist.od

Class SceneFragmentDescription

java.lang.Object

fr.inria.zuist.od.ObjectDescription

fr.inria.zuist.od.ResourceDescription

fr.inria.zuist.od.SceneFragmentDescription

public class SceneFragmentDescription
extends ResourceDescription

Description of a part of the scene that is loaded/unloaded dynamically.

Author:

Emmanuel Pietriga

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_TYPE_SCENE

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

src, vx, vy

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

id, parentRegion, sensitive, takesTo, takesToType, zindex

Constructor Summary

Constructors

Constructor and Description
SceneFragmentDescription(String id, double x, double y, URL p, Region pr, SceneManager sm) Constructs the description of a scene fragment.

Method Summary

Modifier and Type	Method and Description
boolean	coordInside(double vx, double vy) Will always return false in the case of a scene fragment.
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() Does not return anything since this is a scene fragment.
String	getType() Type of object.

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

getFeedbackWhenFetching, getURL, getX, getY, isInJAR, isLocal, moveTo, setDefaultFeedbackWhenFetching, setFeedbackWhenFetching, setProgressBarBackgroundColor, setProgressBarColor, setProgressBarDefaultColors, setURL

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

RESOURCE_TYPE_SCENE

public static final String RESOURCE_TYPE_SCENE

See Also:

Constant Field Values

Constructor Detail

SceneFragmentDescription

public SceneFragmentDescription(String id,
                                double x,
                                double y,
                                URL p,
                                Region pr,
                                SceneManager sm)

Constructs the description of a scene fragment.

Parameters:

id - ID of object in scene

x - x-coordinate in scene

y - y-coordinate in scene

p - path to bitmap resource (any valid absolute URL)

pr - parent Region in scene

Method Detail

getType

public String getType()

Description copied from class: ObjectDescription

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()

Does not return anything since this is a scene fragment.

Specified by:

getGlyph in class ObjectDescription

Returns:

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

coordInside

public boolean coordInside(double vx,
                           double vy)

Will always return false in the case of a scene fragment.

Specified by:

coordInside in class ObjectDescription

Returns:

true if the supplied coordinates are inside the object descrived.