com.threerings.opengl.gui.background
Class ImageBackground

java.lang.Object
  com.threerings.opengl.gui.background.Background
      com.threerings.opengl.gui.background.ImageBackground

public class ImageBackground
extends Background

Supports image backgrounds in a variety of ways. Specifically:

• Centering the image either horizontally, vertically or both.
• Scaling the image either horizontally, vertically or both.
• Tiling the image either horizontally, vertically or both.
• Framing the image in a fancy way: the background image is divided into nine sections (three across and three down), the corners are rendered unscaled, the central edges are scaled in one direction and the center section is scaled in both directions.

   +----------+----------------+----------+
   | unscaled |  <- scaled ->  | unscaled |
   +----------+----------------+----------+
   |    ^     |       ^        |    ^     |
   |  scaled  |  <- scaled ->  |  scaled  |
   |    v     |       v        |    v     |
   +----------+----------------+----------+
   | unscaled |  <- scaled ->  | unscaled |
   +----------+----------------+----------+
   

Field Summary

protected int	_anchor
protected Insets	_frame
protected Image	_image
protected int	_mode
static int	ANCHOR_LL
static int	ANCHOR_LR
static int	ANCHOR_UL
static int	ANCHOR_UR
protected static int	ASPECT
static int	ASPECT_INNER
static int	ASPECT_OUTER
protected static int	CENTER
static int	CENTER_X
static int	CENTER_XY
static int	CENTER_Y
protected static int	FRAME
static int	FRAME_X
static int	FRAME_XY
static int	FRAME_Y
protected static int	SCALE
static int	SCALE_X
static int	SCALE_XY
static int	SCALE_Y
protected static int	TILE
static int	TILE_X
static int	TILE_XY
static int	TILE_Y

Constructor Summary

ImageBackground(int mode, Image image)
Creates an image background in the specified mode using the supplied image.

ImageBackground(int mode, Image image, Insets frame)
Creates an image background in the specified mode using the supplied image and the special frame.

ImageBackground(int mode, Image image, Insets frame, int anchor)
Creates an image background in the specified mode using the supplied image and the special frame.

Method Summary

int	getMinimumHeight() Returns the minimum height allowed by this background.
int	getMinimumWidth() Returns the minimum width allowed by this background.
void	render(Renderer renderer, int x, int y, int width, int height, float alpha) Renders this background.
protected void	renderAspectScaled(Renderer renderer, int x, int y, int width, int height, float alpha)
protected void	renderCentered(Renderer renderer, int x, int y, int width, int height, float alpha)
protected void	renderFramed(Renderer renderer, int x, int y, int width, int height, float alpha)
protected void	renderRow(Renderer renderer, int x, int y, int width, int iheight, int sy, float alpha)
protected void	renderScaled(Renderer renderer, int x, int y, int width, int height, float alpha)
protected void	renderTiled(Renderer renderer, int x, int y, int width, int height, float alpha)

Methods inherited from class java.lang.Object

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

Field Detail

CENTER_XY

public static final int CENTER_XY

See Also:

Constant Field Values

CENTER_X

public static final int CENTER_X

See Also:

Constant Field Values

CENTER_Y

public static final int CENTER_Y

See Also:

Constant Field Values

SCALE_XY

public static final int SCALE_XY

See Also:

Constant Field Values

SCALE_X

public static final int SCALE_X

See Also:

Constant Field Values

SCALE_Y

public static final int SCALE_Y

See Also:

Constant Field Values

TILE_XY

public static final int TILE_XY

See Also:

Constant Field Values

TILE_X

public static final int TILE_X

See Also:

Constant Field Values

TILE_Y

public static final int TILE_Y

See Also:

Constant Field Values

FRAME_XY

public static final int FRAME_XY

See Also:

Constant Field Values

FRAME_X

public static final int FRAME_X

See Also:

Constant Field Values

FRAME_Y

public static final int FRAME_Y

See Also:

Constant Field Values

ASPECT_INNER

public static final int ASPECT_INNER

See Also:

Constant Field Values

ASPECT_OUTER

public static final int ASPECT_OUTER

See Also:

Constant Field Values

ANCHOR_LL

public static final int ANCHOR_LL

See Also:

Constant Field Values

ANCHOR_LR

public static final int ANCHOR_LR

See Also:

Constant Field Values

ANCHOR_UR

public static final int ANCHOR_UR

See Also:

Constant Field Values

ANCHOR_UL

public static final int ANCHOR_UL

See Also:

Constant Field Values

_mode

protected int _mode

_anchor

protected int _anchor

_image

protected Image _image

_frame

protected Insets _frame

CENTER

protected static final int CENTER

See Also:

Constant Field Values

SCALE

protected static final int SCALE

See Also:

Constant Field Values

TILE

protected static final int TILE

See Also:

Constant Field Values

FRAME

protected static final int FRAME

See Also:

Constant Field Values

ASPECT

protected static final int ASPECT

See Also:

Constant Field Values

Constructor Detail

ImageBackground

public ImageBackground(int mode,
                       Image image)

Creates an image background in the specified mode using the supplied image.

ImageBackground

public ImageBackground(int mode,
                       Image image,
                       Insets frame)

Creates an image background in the specified mode using the supplied image and the special frame. This should only be used if one of the framing modes is being used and the supplied frame will be used instead of the default frame which divides the image in thirds.

ImageBackground

public ImageBackground(int mode,
                       Image image,
                       Insets frame,
                       int anchor)

Creates an image background in the specified mode using the supplied image and the special frame. This should only be used if one of the framing modes is being used and the supplied frame will be used instead of the default frame which divides the image in thirds.

Method Detail

getMinimumWidth

public int getMinimumWidth()

Description copied from class: Background

Returns the minimum width allowed by this background.

Overrides:

getMinimumWidth in class Background

getMinimumHeight

public int getMinimumHeight()

Returns the minimum height allowed by this background.

Overrides:

getMinimumHeight in class Background

render

public void render(Renderer renderer,
                   int x,
                   int y,
                   int width,
                   int height,
                   float alpha)

Description copied from class: Background

Renders this background.

Overrides:

render in class Background

renderCentered

protected void renderCentered(Renderer renderer,
                              int x,
                              int y,
                              int width,
                              int height,
                              float alpha)

renderScaled

protected void renderScaled(Renderer renderer,
                            int x,
                            int y,
                            int width,
                            int height,
                            float alpha)

renderTiled

protected void renderTiled(Renderer renderer,
                           int x,
                           int y,
                           int width,
                           int height,
                           float alpha)

renderRow

protected void renderRow(Renderer renderer,
                         int x,
                         int y,
                         int width,
                         int iheight,
                         int sy,
                         float alpha)

renderFramed

protected void renderFramed(Renderer renderer,
                            int x,
                            int y,
                            int width,
                            int height,
                            float alpha)

renderAspectScaled

protected void renderAspectScaled(Renderer renderer,
                                  int x,
                                  int y,
                                  int width,
                                  int height,
                                  float alpha)