stanford.androidlib.graphics

Class GImage

java.lang.Object

stanford.androidlib.graphics.GObject

stanford.androidlib.graphics.GImage

All Implemented Interfaces:

GResizable, GScalable

public class GImage
extends GObject
implements GResizable, GScalable

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(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.
GRectangle	getBounds() Returns the bounding box of this object.
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.
GDimension	getSize() Returns the size of this object as a GDimension.
void	paint(Canvas canvas) Implements the paint operation for this graphical object.
void	scale(float sf) Scales the object on the screen by the scale factor sf, which applies in both dimensions.
void	scale(float sx, float sy) Scales the object on the screen by the scale factors sx and sy.
void	setBounds(float x, float y, float width, float height) Changes the bounds of this object to the specified values.
void	setBounds(GRectangle bounds) Changes the bounds of this object to the values from the specified GRectangle.
void	setContext(Context context)
void	setImage(Bitmap image) Resets the image used by this GImage object to the new image specified as an argument.
void	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.
void	setSize(float width, float height) Changes the size of this object to the specified width and height.
void	setSize(GDimension size) Changes the size of this object to the specified GDimension.

Methods inherited from class stanford.androidlib.graphics.GObject

contains, contains, getBottomY, getCenterX, getCenterY, getColor, getGCanvas, getHeight, getLocation, getPaint, getRightX, getWidth, getX, getY, intersects, isVisible, moveBy, moveByPolar, moveTo, moveTo, moveToPolar, repaint, sendBackward, sendForward, sendToBack, sendToFront, setBottomY, setCanvas, setColor, setGCanvas, setLocation, setLocation, setPaint, setRightX, setVisible, setX, setY, toString, translate

Methods inherited from class java.lang.Object

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

Constructor Detail

GImage

public GImage(Bitmap image)

Creates a new GImage object at the origin.

GImage

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

Creates a new GImage object at the specified coordinates.

GImage

public GImage(View view,
              Bitmap image)

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

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.

GImage

public GImage(Context context,
              @DrawableRes
              int imageID)

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

GImage

public GImage(View view,
              @DrawableRes
              int imageID)

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

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.

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.

Method Detail

setImage

public void 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

Usage:

gimage.setImage(image);

setImage

public void 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

Noshow:

setSize

public void setSize(float width,
                    float height)

Changes the size of this object to the specified width and height.

Specified by:

setSize in interface GResizable

Parameters:

width - The new width of the object

height - The new height of the object

Usage:

gimage.setSize(width, height);

setSize

public final void setSize(GDimension size)

Changes the size of this object to the specified GDimension.

Specified by:

setSize in interface GResizable

Parameters:

size - A GDimension object specifying the size

Usage:

gimage.setSize(size);

Noshow:

getSize

public GDimension getSize()

Returns the size of this object as a GDimension.

Overrides:

getSize in class GObject

Returns:

The size of this object

Usage:

GDimension size = gimage.getSize();

setBounds

public void setBounds(float x,
                      float y,
                      float width,
                      float height)

Changes the bounds of this object to the specified values.

Specified by:

setBounds in interface GResizable

Parameters:

x - The new x-coordinate for the object

y - The new y-coordinate for the object

width - The new width of the object

height - The new height of the object

Usage:

gimage.setBounds(x, y, width, height);

setBounds

public final void setBounds(GRectangle bounds)

Changes the bounds of this object to the values from the specified GRectangle.

Specified by:

setBounds in interface GResizable

Parameters:

bounds - A GRectangle specifying the new bounds

Usage:

gimage.setBounds(bounds);

getBounds

public GRectangle getBounds()

Returns the bounding box of this object.

Overrides:

getBounds in class GObject

Returns:

The bounding box for this object

Usage:

GRectangle bounds = gimage.getBounds();

scale

public void scale(float sx,
                  float sy)

Scales the object on the screen by the scale factors sx and sy.

Specified by:

scale in interface GScalable

Parameters:

sx - The factor used to scale all coordinates in the x direction

sy - The factor used to scale all coordinates in the y direction

Usage:

gobj.scale(sx, sy);

scale

public final void scale(float sf)

Scales the object on the screen by the scale factor sf, which applies in both dimensions.

Specified by:

scale in interface GScalable

Parameters:

sf - The factor used to scale all coordinates in both dimensions

Usage:

gobj.scale(sf);

setContext

public void setContext(Context context)

getPixelArray

public int[][] getPixelArray()

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

Returns:

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

Usage:

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

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

Usage:

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