org.cell2d

Interface Drawable

All Known Implementing Classes:

AnimationInstance, ArrayTileGrid, HashTileGrid, Sprite, TileGrid

public interface Drawable

A Drawable object is one that visually represents itself with an image that is contextless by itself but can be drawn to a Graphics context. Points on the image have x-coordinates that increase from left to right, as well as y-coordinates that increase from top to bottom. The image has an origin point somewhere on (or off) it around which it is flipped, rotated, and scaled.

The Drawable interface also contains the static method getRenderableRegion(), which is useful for checking whether a particular Drawable's image would be visible if drawn at a particular location.

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics g, int x, int y) Draws this Drawable's image to the specified Graphics context.
void	draw(Graphics g, int x, int y, boolean xFlip, boolean yFlip, double angle, double alpha, Filter filter) Draws this Drawable's image to the specified Graphics context.
void	draw(Graphics g, int x, int y, double scale, boolean xFlip, boolean yFlip, double alpha, Filter filter) Draws this Drawable's image to the specified Graphics context.
void	draw(Graphics g, int x, int y, int left, int right, int top, int bottom) Draws a rectangular region of this Drawable's image to the specified Graphics context.
void	draw(Graphics g, int x, int y, int left, int right, int top, int bottom, boolean xFlip, boolean yFlip, double angle, double alpha, Filter filter) Draws a rectangular region of this Drawable's image to the specified Graphics context.
void	draw(Graphics g, int x, int y, int left, int right, int top, int bottom, double scale, boolean xFlip, boolean yFlip, double alpha, Filter filter) Draws a rectangular region of this Drawable's image to the specified Graphics context.
static java.awt.Rectangle	getRenderableRegion(Graphics g) Returns the rectangular region of the specified Graphics context that can currently be rendered to.

Method Detail

draw

void draw(Graphics g,
          int x,
          int y)

Draws this Drawable's image to the specified Graphics context.

Parameters:

g - The Graphics context to draw the image to

x - The x-coordinate on the Graphics context of the drawn image's origin

y - The y-coordinate on the Graphics context of the drawn image's origin

draw

void draw(Graphics g,
          int x,
          int y,
          boolean xFlip,
          boolean yFlip,
          double angle,
          double alpha,
          Filter filter)

Draws this Drawable's image to the specified Graphics context.

Parameters:

g - The Graphics context to draw the image to

x - The x-coordinate on the Graphics context of the drawn image's origin

y - The y-coordinate on the Graphics context of the drawn image's origin

xFlip - If true, the drawn image is flipped along a vertical line through its origin

yFlip - If true, the drawn image is flipped along a horizontal line through its origin

angle - The angle in degrees by which to rotate the drawn image and its xFlip and yFlip lines counterclockwise around its origin

alpha - The drawn image's alpha (opacity) value from 0 to 1

filter - The Filter to apply to the drawn image, or null if none should be applied. Not every Filter has an effect on every Drawable.

draw

void draw(Graphics g,
          int x,
          int y,
          double scale,
          boolean xFlip,
          boolean yFlip,
          double alpha,
          Filter filter)

Draws this Drawable's image to the specified Graphics context.

Parameters:

g - The Graphics context to draw the image to

x - The x-coordinate on the Graphics context of the drawn image's origin

y - The y-coordinate on the Graphics context of the drawn image's origin

scale - The factor by which to scale the drawn image around its origin

xFlip - If true, the drawn image is flipped along a vertical line through its origin

yFlip - If true, the drawn image is flipped along a horizontal line through its origin

alpha - The drawn image's alpha (opacity) value from 0 to 1

filter - The Filter to apply to the drawn image, or null if none should be applied. Not every Filter has an effect on every Drawable.

draw

void draw(Graphics g,
          int x,
          int y,
          int left,
          int right,
          int top,
          int bottom)

Draws a rectangular region of this Drawable's image to the specified Graphics context.

Parameters:

g - The Graphics context to draw the region to

x - The x-coordinate on the Graphics context of the image's origin

y - The y-coordinate on the Graphics context of the image's origin

left - The x-coordinate on the image, relative to its origin, of the region's left edge

right - The x-coordinate on the image, relative to its origin, of the region's right edge

top - The y-coordinate on the image, relative to its origin, of the region's top edge

bottom - The y-coordinate on the image, relative to its origin, of the region's bottom edge

draw

void draw(Graphics g,
          int x,
          int y,
          int left,
          int right,
          int top,
          int bottom,
          boolean xFlip,
          boolean yFlip,
          double angle,
          double alpha,
          Filter filter)

Draws a rectangular region of this Drawable's image to the specified Graphics context.

Parameters:

g - The Graphics context to draw the region to

x - The x-coordinate on the Graphics context of the image's origin

y - The y-coordinate on the Graphics context of the image's origin

left - The x-coordinate on the image, relative to its origin, of the region's left edge

right - The x-coordinate on the image, relative to its origin, of the region's right edge

top - The y-coordinate on the image, relative to its origin, of the region's top edge

bottom - The y-coordinate on the image, relative to its origin, of the region's bottom edge

xFlip - If true, the drawn region is flipped along a vertical line through the image's origin

yFlip - If true, the drawn region is flipped along a horizontal line through the image's origin

angle - The angle in degrees by which to rotate the drawn region and its xFlip and yFlip lines counterclockwise around the image's origin

alpha - The drawn region's alpha (opacity) value from 0 to 1

filter - The Filter to apply to the drawn region, or null if none should be applied. Not every Filter has an effect on every Drawable.

draw

void draw(Graphics g,
          int x,
          int y,
          int left,
          int right,
          int top,
          int bottom,
          double scale,
          boolean xFlip,
          boolean yFlip,
          double alpha,
          Filter filter)

Draws a rectangular region of this Drawable's image to the specified Graphics context.

Parameters:

g - The Graphics context to draw the region to

x - The x-coordinate on the Graphics context of the image's origin

y - The y-coordinate on the Graphics context of the image's origin

left - The x-coordinate on the image, relative to its origin, of the region's left edge

right - The x-coordinate on the image, relative to its origin, of the region's right edge

top - The y-coordinate on the image, relative to its origin, of the region's top edge

bottom - The y-coordinate on the image, relative to its origin, of the region's bottom edge

scale - The factor by which to scale the drawn region around the image's origin

xFlip - If true, the drawn region is flipped along a vertical line through the image's origin

yFlip - If true, the drawn region is flipped along a horizontal line through the image's origin

alpha - The drawn region's alpha (opacity) value from 0 to 1

filter - The Filter to apply to the drawn region, or null if none should be applied. Not every Filter has an effect on every Drawable.

getRenderableRegion

static java.awt.Rectangle getRenderableRegion(Graphics g)

Returns the rectangular region of the specified Graphics context that can currently be rendered to. If a CellGame is currently rendering to the Graphics context, the returned region will be the one occupied by the CellGame's screen - or, if the view through a SpaceState's Viewport is currently being rendered, the region will be the one occupied by that Viewport. These facts are true as long as the Graphics context's setWorldClip() method has not been called outside of Cell2D's code, as the returned region is the same as the Graphics context's world clip region with its edges each rounded to the nearest integer.

Parameters:

g - The Graphics context to examine

Returns:

The region of the specified Graphics context that can currently be rendered to