ch.aplu.android

Class GGBitmap

java.lang.Object

ch.aplu.android.GGBitmap

public class GGBitmap
extends java.lang.Object

Class that holds a Bitmap to draw graphics elements and provide some static helper methods for image loading and transformation.

Constructor Summary

Constructors

Constructor and Description
GGBitmap(int width, int height) Creates a GGBitmap with given number of horizontal and vertical pixels that holds a Bitmap instance to draw graphics elements.
GGBitmap(int width, int height, int bgColor) Creates a GGBitmap with given number of horizontal and vertical pixels that holds a Bitmap instance to draw graphics elements.

Method Summary

Methods

Modifier and Type	Method and Description
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.
static android.graphics.Bitmap	crop(android.graphics.Bitmap bm, int x1, int y1, int x2, int y2) Extracts the partial image if the given rectangular area.
void	drawArc(android.graphics.Point pt, int radius, double startAngle, double extendAngle) Draws an arc with given center, radius, start and end angle.
void	drawCircle(android.graphics.Point center, int radius) Draws a circle with given center and given radius.
void	drawImage(android.graphics.Bitmap image, 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(android.graphics.Point pt1, android.graphics.Point pt2) Draws a rectangle with given opposite corners.
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 extendAngle) Fills an arc with given center, radius, start and end angle.
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(android.graphics.Point pt1, android.graphics.Point pt2) Draws a filled rectangle with given opposite corners.
static android.graphics.Bitmap	floodFill(android.graphics.Bitmap bitmap, android.graphics.Point pt, int oldColor, int newColor) Fills a bounded single-colored region with the given color.
android.graphics.Bitmap	getBitmap() Returns the bitmap attributed to this GGBitmap.
static android.graphics.Bitmap	getBitmap(java.lang.String filename) Loads the image from given image file and returns the Bitmap reference for this image.
android.graphics.Canvas	getCanvas() Returns a Canvas reference of the current background.
int	getColor(android.graphics.Point pt) Returns the color of the pixel of the bitmap at given point.
static android.graphics.Bitmap	getRotatedImage(android.graphics.Bitmap bitmap, double angle) Returns the bitmap rotated by the given angle.
static android.graphics.Bitmap	getRotatedImage(java.lang.String filename, double angle) Returns the bitmap from the given file rotated by the given angle.
static android.graphics.Bitmap	getScaledImage(android.graphics.Bitmap bitmap, double factor, double angle) Returns the bitmap scaled by the given factor and rotated by the given angle.
static android.graphics.Bitmap	getScaledImage(java.lang.String filename, double factor, double angle) Returns the bitmap from the given file scaled by the given factor and rotated by the given angle.
static android.graphics.Bitmap	getZoomedImage(android.graphics.Bitmap bitmap, double factor) Returns the bitmap scaled by the given factor.
static android.graphics.Bitmap	getZoomedImage(java.lang.String filename, double factor) Returns the bitmap from the given file scaled by the given factor.
static android.graphics.Bitmap	paste(android.graphics.Bitmap original, android.graphics.Bitmap replacement, int xStart, int yStart) Returns a clone of the original image where a part is replaced by another image.
void	setLineWidth(int lineWidth) Sets the current line width for all future painting.
void	setPaintColor(int color) Sets the current color for all future painting.

Methods inherited from class java.lang.Object

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

Constructor Detail

GGBitmap

public GGBitmap(int width,
        int height)

Creates a GGBitmap with given number of horizontal and vertical pixels that holds a Bitmap instance to draw graphics elements. The coordinates for the drawing methods are 0..width-1, 0..height-1 with zero at upper left corner. The background is Color.BLACK

Parameters:

width - the width of the Bitmap in pixels

height - the height of the Bitmap in pixels

GGBitmap

public GGBitmap(int width,
        int height,
        int bgColor)

Creates a GGBitmap with given number of horizontal and vertical pixels that holds a Bitmap instance to draw graphics elements. The coordinates for the drawing methods are 0..width-1, 0..height-1 with zero at upper left corner.

Parameters:

width - the width of the Bitmap in pixels

height - the height of the Bitmap in pixels

bgColor - the color of the background

Method Detail

getZoomedImage

public static android.graphics.Bitmap getZoomedImage(android.graphics.Bitmap bitmap,
                                     double factor)

Returns the bitmap scaled by the given factor.

Parameters:

bitmap - the original image bitmap

factor - the zoom factor (>1 zoom-in, <1 zoom-out)

Returns:

the transformed image bitmap

getZoomedImage

public static android.graphics.Bitmap getZoomedImage(java.lang.String filename,
                                     double factor)

Returns the bitmap from the given file scaled by the given factor. From the given filename the image file in searched in the following order:
- filename contains a colon : searched at URL in format http://...
- filename contains slash or backslash : searched on sdcard ("/sdcard/" appended)
- otherwise if contains no dot, searched in app package, else searched on sdcard
e.g. if neither a dot nor a slash, searched from res/drawable resource folder

Parameters:

filename - the path or URL to the image file

factor - the zoom factor (>1 zoom-in, <1 zoom-out)

Returns:

the transformed image bitmap

getRotatedImage

public static android.graphics.Bitmap getRotatedImage(android.graphics.Bitmap bitmap,
                                      double angle)

Returns the bitmap rotated by the given angle.

Parameters:

bitmap - the original image bitmap

angle - the rotation angle (in degrees clockwise)

Returns:

the transformed image bitmap

getRotatedImage

public static android.graphics.Bitmap getRotatedImage(java.lang.String filename,
                                      double angle)

Returns the bitmap from the given file rotated by the given angle. From the given filename the image file in searched in the following order:
- filename contains a colon : searched at URL in format http://...
- filename contains slash or backslash : searched on sdcard ("/sdcard/" appended)
- otherwise if contains no dot, searched in app package, else searched on sdcard
e.g. if neither a dot nor a slash, searched from res/drawable resource folder

Parameters:

filename - the path or URL to the image file

angle - the rotation angle (in degrees clockwise)

Returns:

the transformed image bitmap

getScaledImage

public static android.graphics.Bitmap getScaledImage(android.graphics.Bitmap bitmap,
                                     double factor,
                                     double angle)

Returns the bitmap scaled by the given factor and rotated by the given angle.

Parameters:

bitmap - the original image bitmap

factor - the zoom factor (>1 zoom-in, <1 zoom-out)

angle - the rotation angle (in degrees clockwise)

Returns:

the transformed image bitmap

getScaledImage

public static android.graphics.Bitmap getScaledImage(java.lang.String filename,
                                     double factor,
                                     double angle)

Returns the bitmap from the given file scaled by the given factor and rotated by the given angle. From the given filename the image file in searched in the following order:
- filename contains a colon : searched at URL in format http://...
- filename contains slash or backslash : searched on sdcard ("/sdcard/" appended)
- otherwise if contains no dot, searched in app package, else searched on sdcard
e.g. if neither a dot nor a slash, searched from res/drawable resource folder

Parameters:

filename - the path or URL to the image file

factor - the zoom factor (>1 zoom-in, <1 zoom-out)

angle - the rotation angle (in degrees clockwise)

Returns:

the transformed image bitmap

floodFill

public static android.graphics.Bitmap floodFill(android.graphics.Bitmap bitmap,
                                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:

bitmap - the bitmap containing the connected region

pt - a point inside the region

oldColor - the old color of the region

newColor - the new color of the region

Returns:

the bitmap with the transformed region

getBitmap

public static android.graphics.Bitmap getBitmap(java.lang.String filename)

Loads the image from given image file and returns the Bitmap reference for this image. From the given filename the image file in searched in the following order:
- filename contains a colon : searched at URL in format http://...
- filename contains slash or backslash : searched on sdcard ("/sdcard/" appended)
- otherwise if contains no dot, searched in app package, else searched on sdcard
e.g. if neither a dot nor a slash, searched from res/drawable resource folder

Parameters:

filename - the path or URL to the image file

getCanvas

public android.graphics.Canvas getCanvas()

Returns a Canvas reference of the current background.

Returns:

the Canvas reference of the background

getBitmap

public android.graphics.Bitmap getBitmap()

Returns the bitmap attributed to this GGBitmap.

Returns:

the bitmap used for this GGBitmap

setPaintColor

public void setPaintColor(int color)

Sets the current color for all future painting.

Parameters:

color - the new color for painting

setLineWidth

public void setLineWidth(int lineWidth)

Sets the current line width for all future painting.

Parameters:

lineWidth - the new line width (in pixels) for painting

drawImage

public void drawImage(android.graphics.Bitmap image,
             int x,
             int y)

Draws a given bitmap image into the background at the given position.

Parameters:

image - the bitmap of the image

x - the x-coordinate of the upper left corner

y - the y-coordinate of the upper left corner

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.

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

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 corners.

Parameters:

pt1 - upper left vertex of the rectangle

pt2 - lower right vertex of the rectangle

fillRectangle

public void fillRectangle(android.graphics.Point pt1,
                 android.graphics.Point pt2)

Draws a filled rectangle with given opposite corners. (The filling includes the complete outline of the rectangle.)

Parameters:

pt1 - upper left vertex of the rectangle

pt2 - lower right vertex of the rectangle

drawArc

public void drawArc(android.graphics.Point pt,
           int radius,
           double startAngle,
           double extendAngle)

Draws an arc with given center, radius, start and end angle.

Parameters:

pt - the center of the arc

radius - the radius of the arc

startAngle - the start angle in degrees (zero to east, positive counterclockwise)

extendAngle - the extend angle in degrees (zero to east, positive counterclockwise)

fillArc

public void fillArc(android.graphics.Point pt,
           int radius,
           double startAngle,
           double extendAngle)

Fills an arc with given center, radius, start and end angle.

Parameters:

pt - the center of the arc

radius - the radius of the arc

startAngle - the start angle in degrees (zero to east, positive counterclockwise)

extendAngle - the extendAngle in degrees (zero to east, positive counterclockwise)

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

getColor

public int getColor(android.graphics.Point pt)

Returns the color of the pixel of the bitmap at given point.

Parameters:

pt - point, where to pick the color

Returns:

the color at the selected point

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

crop

public static android.graphics.Bitmap crop(android.graphics.Bitmap bm,
                           int x1,
                           int y1,
                           int x2,
                           int y2)

Extracts the partial image if the given rectangular area. Extracted pixels outside the given image are set to white.

Parameters:

bm - the image bitmap where to extract the partial image

x1 - the x-coordinate of one of the rectangle vertex

y1 - the y-coordinate of this vertex

x2 - the x-coordinate of the opposite vertex

y2 - the y-coordinate of this vertex

Returns:

the extracted image bitmap (the given image is unchanged)

paste

public static android.graphics.Bitmap paste(android.graphics.Bitmap original,
                            android.graphics.Bitmap replacement,
                            int xStart,
                            int yStart)

Returns a clone of the original image where a part is replaced by another image.

Parameters:

original - the original image

replacement - the image to insert

xStart - the upper left x-coordinate where the replacement starts

yStart - the upper left y-coordinate where the replacement starts

Returns:

the modified image (the original image is unchanged)