stanford.androidlib.graphics

Class GImage

java.lang.Object

stanford.androidlib.graphics.GObject

stanford.androidlib.graphics.GImage

All Implemented Interfaces:

GResizable

public class GImage
extends GObject
implements GResizable

The GImage class is a graphical object whose appearance is defined by an image.

Constructor Summary

Constructors

Constructor and Description
GImage(Bitmap image) Creates a new GImage object at the origin.
GImage(Bitmap image, float x, float y) Creates a new GImage object at the specified coordinates.
GImage(Context context, int imageID) Creates a new GImage object at the origin inside the given context.
GImage(Context context, int imageID, float x, float y) Creates a new GImage object at the given x/y location inside the given context.
GImage(GCanvas canvas, Bitmap image) Creates a new GImage object at the origin.
GImage(GCanvas canvas, Bitmap image, float x, float y) Creates a new GImage object at the specified coordinates.
GImage(GCanvas canvas, Context context, int imageID) Creates a new GImage object at the origin inside the given context.
GImage(GCanvas canvas, Context context, int imageID, float x, float y) Creates a new GImage object at the given x/y location inside the given context.
GImage(GCanvas canvas, View view, Bitmap image) Creates a new GImage object at the origin inside the given view.
GImage(GCanvas canvas, View view, Bitmap image, float x, float y) Creates a new GImage object at the given x/y location inside the given view.
GImage(GCanvas canvas, View view, int imageID) Creates a new GImage object at the origin inside the given view.
GImage(GCanvas canvas, View view, int imageID, float x, float y) Creates a new GImage object at the given x/y location inside the given view.
GImage(View view, Bitmap image) Creates a new GImage object at the origin inside the given view.
GImage(View view, Bitmap image, float x, float y) Creates a new GImage object at the given x/y location inside the given view.
GImage(View view, int imageID) Creates a new GImage object at the origin inside the given view.
GImage(View view, int imageID, float x, float y) Creates a new GImage object at the given x/y location inside the given view.

Method Summary

Modifier and Type	Method and Description
static int	createRGBPixel(int red, int green, int blue) Creates an opaque pixel value with the color components given by red, green, and blue.
static int	createRGBPixel(int red, int green, int blue, int alpha) Creates a pixel value with the color components given by red, green, and blue and the transparency value alpha.
static int	getAlpha(int pixel) Returns the alpha component from an RGB value.
static int	getBlue(int pixel) Returns the blue component from an RGB value.
static int	getGreen(int pixel) Returns the green component from an RGB value.
Bitmap	getImage() Returns the image stored inside this GImage.
int[][]	getPixelArray() Returns a two-dimensional array of pixel values from the stored image.
static int	getRed(int pixel) Returns the red component from an RGB value.
void	paint(Canvas canvas) Implements the paint operation for this graphical object.
GImage	setContext(Context context) Sets the context used by this image.
GImage	setImage(Bitmap image) Resets the image used by this GImage object to the new image specified as an argument.
GImage	setImage(int imageID) Resets the image used by this GImage object to the one identified by the argument name, which is processed exactly as described in the constructors.

Methods inherited from class stanford.androidlib.graphics.GObject

addTo, addTo, addTo, contains, contains, getBottomY, getBounds, getCenterX, getCenterY, getColor, getFillColor, getGCanvas, getHeight, getLeftX, getLocation, getPaint, getRightX, getSize, getTopY, getWidth, getX, getY, intersects, isFilled, isVisible, moveBy, moveByPolar, moveTo, moveTo, moveTo, moveToPolar, remove, repaint, scale, scale, sendBackward, sendForward, sendToBack, sendToFront, setBottomY, setBounds, setBounds, setBounds, setCanvas, setColor, setFillColor, setFilled, setGCanvas, setLocation, setLocation, setLocation, setPaint, setRightX, setSize, setSize, setVisible, setX, setY, toString, translate

Methods inherited from class java.lang.Object

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

Methods inherited from interface stanford.androidlib.graphics.GResizable

setBounds, setBounds, setSize, setSize

Constructor Detail

GImage

public GImage(Bitmap image)

Creates a new GImage object at the origin.

Throws:

NullPointerException - if image is null

GImage

public GImage(Bitmap image,
              float x,
              float y)

Creates a new GImage object at the specified coordinates.

Throws:

NullPointerException - if image is null

GImage

public GImage(View view,
              Bitmap image)

Creates a new GImage object at the origin inside the given view.

Throws:

NullPointerException - if view or image is null

GImage

public GImage(View view,
              Bitmap image,
              float x,
              float y)

Creates a new GImage object at the given x/y location inside the given view.

Throws:

NullPointerException - if view or image is null

GImage

public GImage(Context context,
              @DrawableRes
              int imageID)

Creates a new GImage object at the origin inside the given context.

Throws:

NullPointerException - if context is null

GImage

public GImage(View view,
              @DrawableRes
              int imageID)

Creates a new GImage object at the origin inside the given view.

Throws:

NullPointerException - if view is null

GImage

public GImage(View view,
              @DrawableRes
              int imageID,
              float x,
              float y)

Creates a new GImage object at the given x/y location inside the given view.

Throws:

NullPointerException - if view is null

GImage

public GImage(Context context,
              @DrawableRes
              int imageID,
              float x,
              float y)

Creates a new GImage object at the given x/y location inside the given context.

Throws:

NullPointerException - if context is null

GImage

public GImage(GCanvas canvas,
              Bitmap image)

Creates a new GImage object at the origin.

Throws:

NullPointerException - if image is null

GImage

public GImage(GCanvas canvas,
              Bitmap image,
              float x,
              float y)

Creates a new GImage object at the specified coordinates.

Throws:

NullPointerException - if image is null

GImage

public GImage(GCanvas canvas,
              View view,
              Bitmap image)

Creates a new GImage object at the origin inside the given view.

Throws:

NullPointerException - if view or image is null

GImage

public GImage(GCanvas canvas,
              View view,
              Bitmap image,
              float x,
              float y)

Creates a new GImage object at the given x/y location inside the given view.

Throws:

NullPointerException - if view or image is null

GImage

public GImage(GCanvas canvas,
              Context context,
              @DrawableRes
              int imageID)

Creates a new GImage object at the origin inside the given context.

Throws:

NullPointerException - if context is null

GImage

public GImage(GCanvas canvas,
              View view,
              @DrawableRes
              int imageID)

Creates a new GImage object at the origin inside the given view.

Throws:

NullPointerException - if view is null

GImage

public GImage(GCanvas canvas,
              View view,
              @DrawableRes
              int imageID,
              float x,
              float y)

Creates a new GImage object at the given x/y location inside the given view.

Throws:

NullPointerException - if view is null

GImage

public GImage(GCanvas canvas,
              Context context,
              @DrawableRes
              int imageID,
              float x,
              float y)

Creates a new GImage object at the given x/y location inside the given context.

Throws:

NullPointerException - if context is null

Method Detail

setImage

public GImage setImage(Bitmap image)

Resets the image used by this GImage object to the new image specified as an argument. Calling setImage automatically changes the size of the image to be equal to that of the image data.

Parameters:

image - The image to use as the contents of this GImage

Throws:

NullPointerException - if image is null

Usage:

gimage.setImage(image);

setImage

public GImage setImage(@DrawableRes
                       int imageID)

Resets the image used by this GImage object to the one identified by the argument name, which is processed exactly as described in the constructors. Calling setImage automatically changes the size of the image to be equal to that of the image data.

Usage:

gimage.setImage(name);

getImage

public Bitmap getImage()

Returns the image stored inside this GImage.

Returns:

The Image object stored inside this GImage

Usage:

Image image = gimage.getImage();

paint

public void paint(Canvas canvas)

Implements the paint operation for this graphical object. This method is not called directly by clients.

Specified by:

paint in class GObject

Throws:

NullPointerException - if canvas is null

Noshow:

setContext

public GImage setContext(Context context)

Sets the context used by this image. Can be null.

Parameters:

context - the context to use

getPixelArray

public int[][] getPixelArray()

Returns a two-dimensional array of pixel values from the stored image. Not yet implemented.

Returns:

A two-dimensional array of pixel values from the stored image

Usage:

int[][] array = gimage.getPixelArray();

Noshow:

getAlpha

public static int getAlpha(int pixel)

Returns the alpha component from an RGB value.

Parameters:

pixel - An int containing a pixel value as alpha/red/green/blue.

Returns:

The alpha component of the pixel

Usage:

int alpha = GImage.getAlpha(pixel);

getRed

public static int getRed(int pixel)

Returns the red component from an RGB value.

Parameters:

pixel - An int containing a pixel value as alpha/red/green/blue.

Returns:

The red component of the pixel

Usage:

int red = GImage.getRed(pixel);

getGreen

public static int getGreen(int pixel)

Returns the green component from an RGB value.

Parameters:

pixel - An int containing a pixel value as alpha/red/green/blue.

Returns:

The green component of the pixel

Usage:

int green = GImage.getGreen(pixel);

getBlue

public static int getBlue(int pixel)

Returns the blue component from an RGB value.

Parameters:

pixel - An int containing a pixel value as alpha/red/green/blue.

Returns:

The blue component of the pixel

Usage:

int blue = GImage.getBlue(pixel);

createRGBPixel

public static int createRGBPixel(int red,
                                 int green,
                                 int blue)

Creates an opaque pixel value with the color components given by red, green, and blue.

Parameters:

red - The red component of the pixel (0 to 255)

green - The green component of the pixel (0 to 255)

blue - The blue component of the pixel (0 to 255)

Returns:

An opaque pixel value containing these components

Usage:

int pixel = GImage.createRGBPixel(red, green, blue);

createRGBPixel

public static int createRGBPixel(int red,
                                 int green,
                                 int blue,
                                 int alpha)

Creates a pixel value with the color components given by red, green, and blue and the transparency value alpha.

Parameters:

red - The red component of the pixel (0 to 255)

green - The green component of the pixel (0 to 255)

blue - The blue component of the pixel (0 to 255)

alpha - The transparency value of the pixel (0 to 255)

Returns:

A pixel value containing these components

Throws:

IllegalArgumentException - if any of r/g/b/a are not in range 0-255

Usage:

int pixel = GImage.createRGBPixel(red, green, blue);