GGBackground

java.lang.Object
- ch.aplu.android.GGBackground

Direct Known Subclasses:

GGPanel
```
public class GGBackground
extends java.lang.Object
```
Class for drawing into the GameGrid background using Canvas graphics methods. The size of the drawing area is determined by the number and size of the cells when constructing the GameGrid: In pixel units, e.g. distance between adjacent pixel, the width of the background is nbHorzCells * cellSize horizontally and the height is nbVertCells * cellSize vertically. Thus the background contains width + 1 pixels horizontally and height + 1 pixels vertically, and the pixel coordinates are 0 <= i <= width (inclusive), 0 <= k <= height (inclusive) respectively.
Example: Constructing new GameGrid(600, 400, 1) will give a background with 601x401 pixels. x-pixel coordinates are in the range 0 <= x <= 600, y-pixel coordinates in the range 0 <=y <= 400. The center is exactly at coordinate (300, 200).

Defaults:
- myPaint color: white
- line width 1 pixel
- background color: black
GGBackground uses an own bitmap buffer that may contain a background image, grid lines and any additional background graphics. The current content of the buffer may be saved and restored in an extra buffer using save() and restore().

All drawing methods draw into the buffer that is automatically rendered to the screen in every simulation cycle when the actor's act() methods are called. If act() is not active, an explicit call to GameGrid.refresh() may be necessary to render the buffer. Because actor sprite images are drawn in the foreground, use text as sprite image to display it in the foreground.

Method Summary

Methods
Modifier and Type	Method and Description
`android.graphics.Point`	`_drawRectangle(int x1, int y1, int x, int y, double r, boolean isHorz)`
`void`	`clear()` Clears the frame buffer by painting it with the current background color.
`void`	`clear(int color)` Sets the background color to the given color and clears the frame buffer by painting it with the given color.
`void`	`drawArc(android.graphics.Point pt, int radius, double startAngle, double extentAngle)` Draws an arc (without bounding lines to center) with given center, radius, start angle and angle extent.
`void`	`drawCircle(android.graphics.Point center, int radius)` Draws a circle with given center and given radius.
`void`	`drawFrame(int color)` Draws a rectangular frame around the playground.
`void`	`drawGridLines(int color)` Draws the grid lines using the given color.
`void`	`drawImage(android.graphics.Bitmap bm, int x, int y)` Draws a given bitmap image into the background at the given position.
`void`	`drawLine(int x1, int y1, int x2, int y2)` Draws a line from one coordinate pair to another coordinate pair.
`void`	`drawLine(android.graphics.Point pt1, android.graphics.Point pt2)` Draws a line from one coordinate pair to another coordinate pair.
`void`	`drawPoint(int x, int y)` Draws a single point into the background.
`void`	`drawPolygon(android.graphics.Point[] vertexes)` Draws a polygon with given vertexes.
`void`	`drawRectangle(int x1, int y1, int x2, int y2)` Draws a rectangle with given opposite corners.
`void`	`drawRectangle(android.graphics.Point pt1, android.graphics.Point pt2)` Draws a rectangle with given opposite vertexes.
`android.graphics.Point`	`drawRectangle(android.graphics.Point pt1, android.graphics.Point pt, double ratio, boolean isHorz)` Draws a rectangle with one vertex, a point on the line through the opposite horizotal side and the given side ratio.
`void`	`drawSector(android.graphics.Point pt, int radius, double startAngle, double extentAngle)` Draws a sector (arc with bounding lines to center, pie) with given center, radius, start angle and angle extent.
`void`	`drawSprite(android.graphics.Bitmap sprite, int x, int y)` Deprecated. Use GGBackground.drawImage instead.
`void`	`drawText(java.lang.String text, android.graphics.Point pt)` Displays the given text at the given position using the current font.
`void`	`fillArc(android.graphics.Point pt, int radius, double startAngle, double extentAngle)` Fills an arc (without bounding lines to center) with given center, radius, start angle and angle extent.
`void`	`fillCell(Location location, int fillColor)` Fills a cell with given color.
`void`	`fillCell(Location location, int fillColor, boolean boundary)` Fills a cell with given color.
`void`	`fillCircle(android.graphics.Point center, int radius)` Draws a filled circle with given center and given radius.
`void`	`fillPolygon(android.graphics.Point[] vertexes)` Draws a filled polygon with given vertexes.
`void`	`fillRectangle(int x1, int y1, int x2, int y2)` Draws a filled rectangle with given opposite vertexes.
`void`	`fillRectangle(android.graphics.Point pt1, android.graphics.Point pt2)` Draws a filled rectangle with given opposite vertexes.
`void`	`fillSector(android.graphics.Point pt, int radius, double startAngle, double extentAngle)` Fills a sector (arc with bounding lines to center, pie) with given center, radius, start angle and angle extent.
`void`	`floodFill(android.graphics.Point pt, int oldColor, int newColor)` Fills a bounded single-colored region with the given color.
`int[]`	`getBgAry()`
`android.graphics.Bitmap`	`getBgBitmap()` Returns the Bitmap reference of the current background buffer.
`android.graphics.Bitmap`	`getBgBuffer()` Returns the Bitmap reference of the current background (offscreen buffer).
`int`	`getBgColor()` Returns the current background color.
`android.graphics.Bitmap`	`getBgImage()` Returns the Bitmap reference of the current background image.
`android.graphics.Canvas`	`getCanvas()` Returns a Canvas reference of the current background pffscreen buffer.
`int`	`getColor(Location location)` Returns the color of the pixel of the background at given cell's center.
`int`	`getColor(android.graphics.Point pt)` Returns the color of the pixel of the background at given point.
`int`	`getLineWidth()` Returns the current line width in pixels.
`int`	`getPaintColor()` Returns the current myPaint color.
`android.graphics.Shader`	`getShader()` Returns the current shader.
`void`	`restore()` Restores a previously saved background.
`void`	`save()` Saves the current background to an extra buffer.
`int`	`setLineWidth(int width)` Sets the current line width for all future painting.
`int`	`setPaintColor(int color)` Sets the current color for all future painting.
`void`	`setPaintMode()` Removes the XOR paint mode and selects the normal overwrite mode.
`android.graphics.Shader`	`setShader(android.graphics.Shader shader)` Sets the shader for all future painting.
`void`	`setXORMode()` Selects the XOR paint mode.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getBgBuffer
```
public android.graphics.Bitmap getBgBuffer()
```
    Returns the Bitmap reference of the current background (offscreen buffer). The size is nbHorzPix x nbVertPix. The background consists of the background image and all shapes drawn with the background graphics methods.
    
    Returns:
    the bitmap of the background
  - getCanvas
```
public android.graphics.Canvas getCanvas()
```
    Returns a Canvas reference of the current background pffscreen buffer.
    
    Returns:
    the Canvas reference of the background
  - getBgImage
```
public android.graphics.Bitmap getBgImage()
```
    Returns the Bitmap reference of the current background image.
    
    Returns:
    the background's image bitmap
  - floodFill
```
public void floodFill(android.graphics.Point pt,
             int oldColor,
             int newColor)
```
    Fills a bounded single-colored region with the given color. The given point is part of the region and used to specify it.
    
    Parameters:
    pt - a point inside the region
    oldColor - the old color of the region
    newColor - the new color of the region
  - getBgAry
```
public int[] getBgAry()
```
  - drawFrame
```
public void drawFrame(int color)
```
    Draws a rectangular frame around the playground.
    
    Parameters:
    color - the color of the lines
  - getBgBitmap
```
public android.graphics.Bitmap getBgBitmap()
```
    Returns the Bitmap reference of the current background buffer.
    
    Returns:
    the background's bitmap
  - getPaintColor
```
public int getPaintColor()
```
    Returns the current myPaint color.
    
    Returns:
    the myPaint color
  - setPaintColor
```
public int setPaintColor(int color)
```
    Sets the current color for all future painting.
    
    Parameters:
    color - the new color for painting
    
    Returns:
    the old myPaint color
  - getLineWidth
```
public int getLineWidth()
```
    Returns the current line width in pixels.
    
    Returns:
    the line width
  - setLineWidth
```
public int setLineWidth(int width)
```
    Sets the current line width for all future painting. If width = 1, the hairline mode is enabled to ensure that the 1 pixel shapes do not vanish on high resolution devices.
    
    Parameters:
    width - the new line width (in pixels) for painting
    
    Returns:
    the old line width
  - getShader
```
public android.graphics.Shader getShader()
```
    Returns the current shader.
    
    Returns:
    the shader
  - setShader
```
public android.graphics.Shader setShader(android.graphics.Shader shader)
```
    Sets the shader for all future painting.
    
    Parameters:
    shader - the new shader for painting
    
    Returns:
    the old shader
  - drawSprite
```
@Deprecated
public void drawSprite(android.graphics.Bitmap sprite,
                         int x,
                         int y)
```
    Deprecated. Use GGBackground.drawImage instead.
    
    Draws a given bitmap image into the background at the given position.
    
    Parameters:
    sprite - the bitmap of the image
    x - the x-coordinate of the upper left vertex
    y - the y-coordinate of the upper left vertex
  - drawPoint
```
public void drawPoint(int x,
             int y)
```
    Draws a single point into the background.
    
    Parameters:
    x - the x-coordinate of the point
    y - the y-coordinate of the point
  - clear
```
public void clear(int color)
```
    Sets the background color to the given color and clears the frame buffer by painting it with the given color. Draws an available background image and the grid lines into the frame buffer.
  - clear
```
public void clear()
```
    Clears the frame buffer by painting it with the current background color. Draws an available background image and the grid lines into the frame buffer.
  - getBgColor
```
public int getBgColor()
```
    Returns the current background color.
    
    Returns:
    the background color
  - save
```
public void save()
```
    Saves the current background to an extra buffer.
  - restore
```
public void restore()
```
    Restores a previously saved background. Returns immediately if no save operation was done yet.
  - drawLine
```
public void drawLine(android.graphics.Point pt1,
            android.graphics.Point pt2)
```
    Draws a line from one coordinate pair to another coordinate pair. The line width and color is determined by setLineWidth() and setPaintColor().
    
    Parameters:
    pt1 - the start point
    pt2 - the endpoint
  - drawCircle
```
public void drawCircle(android.graphics.Point center,
              int radius)
```
    Draws a circle with given center and given radius.
    
    Parameters:
    radius - the radius of the circle
  - fillCircle
```
public void fillCircle(android.graphics.Point center,
              int radius)
```
    Draws a filled circle with given center and given radius.
    
    Parameters:
    center - the center of the circle
    radius - the radius of the circle
  - drawRectangle
```
public void drawRectangle(android.graphics.Point pt1,
                 android.graphics.Point pt2)
```
    Draws a rectangle with given opposite vertexes.
    
    Parameters:
    pt1 - one of the rectangle vertexes
    pt2 - the opposite rectangle vertex
  - drawRectangle
```
public void drawRectangle(int x1,
                 int y1,
                 int x2,
                 int y2)
```
    Draws a rectangle with given opposite corners.
    
    Parameters:
    x1 - x coordinate of one of the vertexes
    y1 - y coordinate of this vertex
    x2 - x coordinate the opposite vertex
    y2 - y coordinate of this vertex
  - fillRectangle
```
public void fillRectangle(android.graphics.Point pt1,
                 android.graphics.Point pt2)
```
    Draws a filled rectangle with given opposite vertexes. (The filling includes the complete outline of the rectangle.)
    
    Parameters:
    pt1 - one of the rectangle vertexes
    pt2 - the opposite rectangle vertex
  - fillRectangle
```
public void fillRectangle(int x1,
                 int y1,
                 int x2,
                 int y2)
```
    Draws a filled rectangle with given opposite vertexes. (The filling includes the complete outline of the rectangle.)
    
    Parameters:
    x1 - the x-coordinate of one of the rectangle vertexes
    y1 - the y-coordinate of this vertex
    x2 - the x-coordinate of the opposite vertex
    y2 - the y-coordinate of this vertex
  - drawSector
```
public void drawSector(android.graphics.Point pt,
              int radius,
              double startAngle,
              double extentAngle)
```
    Draws a sector (arc with bounding lines to center, pie) with given center, radius, start angle and angle extent.
    
    Parameters:
    pt - the center of the arc
    radius - the radius of the arc
    startAngle - the start angle in degrees (zero to east, positive counter-clockwise)
    extentAngle - the angle extent in degrees (zero to east, positive counter-clockwise)
  - fillSector
```
public void fillSector(android.graphics.Point pt,
              int radius,
              double startAngle,
              double extentAngle)
```
    Fills a sector (arc with bounding lines to center, pie) with given center, radius, start angle and angle extent.
    
    Parameters:
    pt - the center of the arc
    radius - the radius of the arc
    startAngle - the start angle in degrees (zero to east, positive counter-clockwise)
    extentAngle - the angle extent in degrees (zero to east, positive counter-clockwise)
  - drawArc
```
public void drawArc(android.graphics.Point pt,
           int radius,
           double startAngle,
           double extentAngle)
```
    Draws an arc (without bounding lines to center) with given center, radius, start angle and angle extent.
    
    Parameters:
    pt - the center of the arc
    radius - the radius of the arc
    startAngle - the start angle in degrees (zero to east, positive counter-clockwise)
    extentAngle - the angle extent in degrees (zero to east, positive counter-clockwise)
  - fillArc
```
public void fillArc(android.graphics.Point pt,
           int radius,
           double startAngle,
           double extentAngle)
```
    Fills an arc (without bounding lines to center) with given center, radius, start angle and angle extent.
    
    Parameters:
    pt - the center of the arc
    radius - the radius of the arc
    startAngle - the start angle in degrees (zero to east, positive clockwise)
    extentAngle - the angle extent in degrees (zero to east, positive clockwise)
  - drawPolygon
```
public void drawPolygon(android.graphics.Point[] vertexes)
```
    Draws a polygon with given vertexes.
    
    Parameters:
    vertexes - the vertexes of the polygon
  - fillPolygon
```
public void fillPolygon(android.graphics.Point[] vertexes)
```
    Draws a filled polygon with given vertexes.
    
    Parameters:
    vertexes - the vertexes of the polygon
  - fillCell
```
public void fillCell(Location location,
            int fillColor)
```
    Fills a cell with given color. The boundary lines are considered to be part of the cell. The myPaint color remains unchanged.
    
    Parameters:
    location - the cell's location (cell indices).
    fillColor - the filling color of the cell
  - fillCell
```
public void fillCell(Location location,
            int fillColor,
            boolean boundary)
```
    Fills a cell with given color. The myPaint color remains unchanged.
    
    Parameters:
    location - the cell's location (cell indices).
    fillColor - the filling color of the cell
    boundary - if true the boundary lines are considered to be part of the cell; otherwise the boundary lines are left intact
  - getColor
```
public int getColor(android.graphics.Point pt)
```
    Returns the color of the pixel of the background at given point. (Be aware that sprite images are not part of the background.)
    
    Parameters:
    pt - point, where to pick the color; if pt is outside the grid, returns Color.black.
    
    Returns:
    the color at the selected point
  - getColor
```
public int getColor(Location location)
```
    Returns the color of the pixel of the background at given cell's center. (Be aware that sprite images are not part of the background.)
    
    Parameters:
    location - cell's location where to pick the color; if location is outside the grid, returns Color.black.
    
    Returns:
    the color at the selected cell's center
  - drawGridLines
```
public void drawGridLines(int color)
```
    Draws the grid lines using the given color. The current myPaint color is unchanged.
    
    Parameters:
    color - the color of the grid lines
  - drawText
```
public void drawText(java.lang.String text,
            android.graphics.Point pt)
```
    Displays the given text at the given position using the current font.
    
    Parameters:
    text - the text to display
    pt - the start point of the text baseline
  - setXORMode
```
public void setXORMode()
```
    Selects the XOR paint mode. The current background and the current pen style (color, line width) is used for any further calls of drawLine(), drawRectangle(), drawCircle and drawImage() until setPaintMode() is called. Be aware that only these drawing methods support the XOR mode.
  - setPaintMode
```
public void setPaintMode()
```
    Removes the XOR paint mode and selects the normal overwrite mode.
  - drawImage
```
public void drawImage(android.graphics.Bitmap bm,
             int x,
             int y)
```
    Draws a given bitmap image into the background at the given position. The image part outside the background is clipped.
    
    Parameters:
    bm - the bitmap of the image
    x - the x-coordinate of the upper left vertex
    y - the y-coordinate of the upper left vertex
  - drawLine
```
public void drawLine(int x1,
            int y1,
            int x2,
            int y2)
```
    Draws a line from one coordinate pair to another coordinate pair. The line width and color is determined by setLineWidth() and setPaintColor().
    
    Parameters:
    x1 - the x-coordinate of the start point
    y1 - the y-coordinate of the start point
    x2 - the x-coordinate of the endpoint
    y2 - the y-coordinate of the endpoint
  - drawRectangle
```
public android.graphics.Point drawRectangle(android.graphics.Point pt1,
                                   android.graphics.Point pt,
                                   double ratio,
                                   boolean isHorz)
```
    Draws a rectangle with one vertex, a point on the line through the opposite horizotal side and the given side ratio.
    
    Parameters:
    pt1 - one of the vertexes
    pt - a point on a opposite horizontal or vertical line
    ratio - the side ratio r = horizontal_side_length / vertical_side_length
    isHorz - if true, pt is on the opposite horizontal line; otherwise it is on the opposite vertical line
    
    Returns:
    the calculated oppositve vertex of the rectangle or the given vertex, if the construction of the opposite vertex fails
  - _drawRectangle
```
public android.graphics.Point _drawRectangle(int x1,
                                    int y1,
                                    int x,
                                    int y,
                                    double r,
                                    boolean isHorz)
```

Class GGBackground

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getBgBuffer

getCanvas

getBgImage

floodFill

getBgAry

drawFrame

getBgBitmap

getPaintColor

setPaintColor

getLineWidth

setLineWidth

getShader

setShader

drawSprite

drawPoint

clear

clear

getBgColor

save

restore

drawLine

drawCircle

fillCircle

drawRectangle

drawRectangle

fillRectangle

fillRectangle

drawSector

fillSector

drawArc

fillArc

drawPolygon

fillPolygon

fillCell

fillCell

getColor

getColor

drawGridLines

drawText

setXORMode

setPaintMode

drawImage

drawLine

drawRectangle

_drawRectangle