fr.inria.zuist.od

Class ImageDescription

java.lang.Object

fr.inria.zuist.od.ObjectDescription

fr.inria.zuist.od.ResourceDescription

fr.inria.zuist.od.ImageDescription

public class ImageDescription
extends ResourceDescription

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

Author:

Emmanuel Pietriga

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_TYPE_IMG

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
ImageDescription(String id, double x, double y, int z, double w, double h, URL p, Color sc, float alpha, Object im, Region pr) Constructs the description of an image (VImageST).

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 Glyph described by this description.
float	getTranslucencyValue()
String	getType() Type of object.
void	moveTo(double x, double y)

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

getFeedbackWhenFetching, getURL, getX, getY, isInJAR, isLocal, 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_IMG

public static final String RESOURCE_TYPE_IMG

See Also:

Constant Field Values

Constructor Detail

ImageDescription

public ImageDescription(String id,
                        double x,
                        double y,
                        int z,
                        double w,
                        double h,
                        URL p,
                        Color sc,
                        float alpha,
                        Object im,
                        Region pr)

Constructs the description of an image (VImageST).

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.

w - width in scene

h - height in scene

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

sc - border color

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

im - one of java.awt.RenderingHints.{VALUE_INTERPOLATION_NEAREST_NEIGHBOR,VALUE_INTERPOLATION_BILINEAR,VALUE_INTERPOLATION_BICUBIC} ; default is VALUE_INTERPOLATION_NEAREST_NEIGHBOR

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

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.

moveTo

public void moveTo(double x,
                   double y)

Overrides:

moveTo in class ResourceDescription

getTranslucencyValue

public float getTranslucencyValue()

coordInside

public boolean coordInside(double pvx,
                           double pvy)

Description copied from class: ObjectDescription

Are the supplied coordinates inside the object described.

Specified by:

coordInside in class ObjectDescription

Returns:

true if the supplied coordinates are inside the object descrived.