eve.fx

Class BackgroundImage

java.lang.Object

eve.fx.BackgroundImage

public class BackgroundImage
extends Object

This specifies parameters for a "background" image.

Field Summary

Fields

Modifier and Type	Field and Description
int	anchor This is only used if the type is DISPLAY_TYPE_SINGLE.
static int	DISPLAY_TYPE_CACHED_SCALED An exclusive value for displayType - this one keeps a copy of the scaled image.
static int	DISPLAY_TYPE_SCALED An exclusive value for displayType.
static int	DISPLAY_TYPE_SINGLE An exclusive value for displayType.
static int	DISPLAY_TYPE_TILED An exclusive value for displayType.
int	displayType This should be one of the DISPLAY_TYPE_XXX values.
ImageData	imageToDraw
ImageData	originalImage
int	scaleOptions This is only used if the type is DISPLAY_TYPE_SCALED.

Constructor Summary

Constructors

Constructor and Description
BackgroundImage(ImageData im, int displayType, int anchorOrScaleOptions) Create a BackgroundImage.

Method Summary

Modifier and Type	Method and Description
void	display(Graphics g, int x, int y, int width, int height) Display the BackgroundImage in the Graphics within the specified location.
void	scaleImageTo(int width, int height, Color scaleOnTopOf) When using DISPLAY_TYPE_CACHED_SCALE this pre-scales the image.
void	scaleImageTo(int width, int height, Image scaleOnTopOf) When using DISPLAY_TYPE_CACHED_SCALE this pre-scales the image.

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_TYPE_SCALED

public static final int DISPLAY_TYPE_SCALED

An exclusive value for displayType.

See Also:

Constant Field Values

DISPLAY_TYPE_CACHED_SCALED

public static final int DISPLAY_TYPE_CACHED_SCALED

An exclusive value for displayType - this one keeps a copy of the scaled image.

See Also:

Constant Field Values

DISPLAY_TYPE_TILED

public static final int DISPLAY_TYPE_TILED

An exclusive value for displayType.

See Also:

Constant Field Values

DISPLAY_TYPE_SINGLE

public static final int DISPLAY_TYPE_SINGLE

An exclusive value for displayType.

See Also:

Constant Field Values

originalImage

public ImageData originalImage

imageToDraw

public ImageData imageToDraw

displayType

public int displayType

This should be one of the DISPLAY_TYPE_XXX values.

anchor

public int anchor

This is only used if the type is DISPLAY_TYPE_SINGLE. It determines where the image should be placed.

scaleOptions

public int scaleOptions

This is only used if the type is DISPLAY_TYPE_SCALED. It determines what scale options should be used.

Constructor Detail

BackgroundImage

public BackgroundImage(ImageData im,
                       int displayType,
                       int anchorOrScaleOptions)

Create a BackgroundImage.

Parameters:

im - the Image to display.

displayType - one of the DISPLAY_TYPE_XXX values.

anchorOrScaleOptions - the anchor for DISPLAY_TYPE_SINGLE or the scale options for DISPLAY_TYPE_SCALED.

Method Detail

scaleImageTo

public void scaleImageTo(int width,
                         int height,
                         Color scaleOnTopOf)

When using DISPLAY_TYPE_CACHED_SCALE this pre-scales the image. This is optional as a call to display() will automatically scale the image and keep a cache of the scaled version.

Parameters:

width - the new width.

height - the new height.

scaleOnTopOf - an optional Color to scale on top of.

scaleImageTo

public void scaleImageTo(int width,
                         int height,
                         Image scaleOnTopOf)

When using DISPLAY_TYPE_CACHED_SCALE this pre-scales the image. This is optional as a call to display() will automatically scale the image and keep a cache of the scaled version.

Parameters:

width - the new width.

height - the new height.

scaleOnTopOf - an optional Image to scale on top of (which should have the dimensions the same as width and height). You can free() that image as a picture of the final image is used.

display

public void display(Graphics g,
                    int x,
                    int y,
                    int width,
                    int height)

Display the BackgroundImage in the Graphics within the specified location.

Parameters:

g -

x -

y -

width -

height -