com.ccg.awt
Class RGBPixels

java.lang.Object
  com.ccg.awt.RGBPixels

All Implemented Interfaces:

Serializable

public class RGBPixels
extends Object
implements Serializable

Manipulate integer array representations of images. This class was created to allow one to manipulate integer arrays which represented RGB values of a image. Methods to create, fill and manipulate these images. Some of the basic transformations are based from code snippets out of "Kick Ass Java Programming" by Tonny Espeset.

It should be noted that the integer array representation is treated in the following manner:

• Each entry in the array corresponds to a single screen pixel.
• Each value contains a red component value in the range of [0,255] (in hex: [0x00,0xFF]). The mask of the red component is 0x00FF0000 in the integer value.
• Each value contains a green component value in the range of [0,255] (in hex: [0x00,0xFF]). The mask of the green component is 0x0000FF00 in the integer value.
• Each value contains a blue component value in the range of [0,255] (in hex: [0x00,0xFF]). The mask of the blue component is 0x000000FF in the integer value.
• Each value contains a reserved component value in the range of [0,255] (in hex: [0x00,0xFF]). The mask of the reserved component is 0xFF000000 in the integer value. This may be used for something else in the future, but is currently left at zero or unused.
• The array is assume to be laid out by rows starting from the top. So, if you picuture the coordinates of (0,0) as the top left corner of your image, they would have an array value of [0]. The last pixel on the first row would have an array value of [width-1]. The last pixel on the image would have an array entry at [width*height-1].

  Since:

  1.0

  Version:

  $Revision: 1.9 $

  Author:

  $Author: pkb $

  See Also:

  ImageUtility, Serialized Form

  Constructor Summary

  RGBPixels()
  Construct a empty RGBPixel map.

  RGBPixels(int w, int h, Color c)
  Construct a new pixel area and fill with an optional color.

  Method Summary

  void	adjustBrightness(int percent) Adjust the brightness This filter allows one to adjust the brightness of the pixels making up the bitmap by a specific percentage.
  void	adjustContrast(int percent) Adjust the contrast This filter allows one to adjust the contrast of the pixels making up the bitmap by a specific percentage.
  void	adjustContrast(int ra, int rp, int ga, int gp, int ba, int bp) Adjust the contrast on each color channel This filter allows one to adjust the contrast of the pixels making up the bitmap by a specific percentage.
  void	button3D(int bsize, int strength) Turn the pixel map into a 3D button.
  RGBPixels	getArea(int x, int y, int w, int h) Extract a rectangular area from this object.
  int	getHeight() Get height of the image in pixels
  Image	getImage() Get a Image representation.
  ImageProducer	getImageProducer() Get a ImageProducer representation.
  int[]	getPixels() Get the RGB pixel data as a linear array.
  int	getWidth() Get width of the pixel images
  void	grayScale() Convert to gray scale.
  void	initialize(int[] pixels, int width) Associate a previously allocated pixel area with this object.
  void	initialize(int w, int h, Color c) Create a new pixel area and fill with an optional color.
  void	noise(int minPercentAdj, int maxPercentAdj) Randomly adjust the brightness of each pixel This method allows one to randomly adjust the brightness of each pixel.

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  RGBPixels

  public RGBPixels()

  Construct a empty RGBPixel map. This allows the object to be used as a bean and initializes the object to be a pixmap which is 0x0.

  Since:

  1.0

  See Also:

  RGBPixels(int,int,Color)

  RGBPixels

  public RGBPixels(int w,
                   int h,
                   Color c)

  Construct a new pixel area and fill with an optional color. This method sets the width/height and allocates a new array of pixel data for the image. In addition, it will fill the array with your specified color (unless you specify null).

  Parameters:

  width - Width of your desired pixmap.

  height - Height of your desired pixmap.

  color - Optional Color to initialize the RGB array with (if you pass null - the array won't be filled).

  Since:

  1.0

  See Also:

  initialize(int,int,Color)

  Method Detail

  initialize

  public void initialize(int[] pixels,
                         int width)

  Associate a previously allocated pixel area with this object. This method allows one to associate any integer array as the pixel map for the object. The array passed should contain RGB values. The height of the pixel map will be computed based upon the width.

  This method is primarily useful if you find yourself wanting to apply an affect to an existing array of pixel data you have available. For example the following applies a 3D button edge to an existing pixel array:

  
   public static void make3DEdges(int[] pixels, int w, boolean pressed) {
     RGBPixels rp = new RGBPixels();
     rp.initialize(pixels,w);
     rp.button3D(8,pressed ? -20 : +20);
   }
   

  Parameters:

  pixels - The data for the RGB pixels. Please note, a duplicate is not made, so, if you don't want to share your pixel data, you should make a copy prior to using this method.

  width - The width of one row of pixels. This value must be less than or equal to the length of the pixel array.

  Since:

  1.0

  See Also:

  initialize(int,int,java.awt.Color)

  initialize

  public void initialize(int w,
                         int h,
                         Color c)

  Create a new pixel area and fill with an optional color. This method sets the width/height and allocates a new array of pixel data for the image. In addition, it will fill the array with your specified color (unless you specify null).

  Parameters:

  width - Width of your desired pixmap.

  height - Height of your desired pixmap.

  color - Optional Color to initialize the RGB array with (if you pass null or the color you pass has a RGB value of 0, then the extra step of filling the array will be skipped - and all values in the array will be set to 0).

  Since:

  1.0

  See Also:

  initialize(int[],int)

  getArea

  public RGBPixels getArea(int x,
                           int y,
                           int w,
                           int h)

  Extract a rectangular area from this object. There may be times when you would like to extract a small rectangular region from a RGBPixels object. This method allows one to do that. You specify the top left corner and the width and height of the pixels you want, and they will be returned as a new RGBPixel object.

  Here is an example of how one might use this. Pretend you just want the upper left corner look of a 3D button. Step 1, create a large 3D Button. Step 2, extract the rectangular region in the upper left corner.

  Parameters:

  x - Left edge of the rectangular area to extract from the object.

  y - Top edge of the rectangular are to extract from the object.

  w - Width of the rectangular area to extract from the object.

  h - Height of the rectangular are to extract from the object.

  Returns:

  New RGBPixel object which is the sub-rectangle of the pixels requested. Will return null if you pass a invalid request.

  Since:

  1.0

  See Also:

  initialize(int[],int)

  getImageProducer

  public ImageProducer getImageProducer()

  Get a ImageProducer representation.

  Returns:

  A standard ImageProducer of the pixels.

  Since:

  1.0

  See Also:

  getImage()

  getImage

  public Image getImage()

  Get a Image representation.

  Returns:

  A standard Image of the pixels.

  Since:

  1.0

  See Also:

  getImageProducer()

  getWidth

  public int getWidth()

  Get width of the pixel images

  Returns:

  Current int value assigned.

  See Also:

  initialize(int,int,Color)

  getHeight

  public int getHeight()

  Get height of the image in pixels

  Returns:

  Current int value assigned.

  See Also:

  initialize(int,int,Color)

  getPixels

  public int[] getPixels()

  Get the RGB pixel data as a linear array.

  Returns:

  Current int[] value assigned.

  See Also:

  initialize(int,int,Color)

  adjustBrightness

  public void adjustBrightness(int percent)

  Adjust the brightness This filter allows one to adjust the brightness of the pixels making up the bitmap by a specific percentage. Values less than 100 will darken the image (a value of 0 results in black pixels), values larger than 100 will increase the brightness.

  Parameters:

  percent - How much (percentage wise) you want to adjust the brightness by values from [0,99] will darken the image, values larger than 100 will brighten the image

  Since:

  1.0

  adjustContrast

  public void adjustContrast(int percent)

  Adjust the contrast This filter allows one to adjust the contrast of the pixels making up the bitmap by a specific percentage. Values less than 100 will reduce the contrast. Values larger than 100 will increase the brightness.

  Parameters:

  percent - How much (percentage wise) you want to adjust the contrast by. Values from [0,99] will reduce the contrast, values larger than 100 will increase the constrast.

  Since:

  1.0

  adjustContrast

  public void adjustContrast(int ra,
                             int rp,
                             int ga,
                             int gp,
                             int ba,
                             int bp)

  Adjust the contrast on each color channel This filter allows one to adjust the contrast of the pixels making up the bitmap by a specific percentage. Values less than 100 will reduce the contrast. Values larger than 100 will increase the contrast.

  Parameters:

  ra - The "average" (or normalized) value for red which we will move the color towards or away from.

  rp - The percentage which dictates how much movement should occur. Specified as a integer percentage. Values from [0,99] will reduce the contrast (move towards 'ra'), values larger than 100 will increase the constrast (move away from 'ra').

  ga - The "average" (or normalized) value for green which we will move the color towards or away from.

  gp - The percentage which dictates how much movement should occur. Specified as a integer percentage. Values from [0,99] will reduce the contrast (move towards 'ga'), values larger than 100 will increase the constrast (move away from 'ga').

  ba - The "average" (or normalized) value for blue which we will move the color towards or away from.

  bp - The percentage which dictates how much movement should occur. Specified as a integer percentage. Values from [0,99] will reduce the contrast (move towards 'ba'), values larger than 100 will increase the constrast (move away from 'ba').

  Since:

  1.0

  grayScale

  public void grayScale()

  Convert to gray scale. This filter takes the color values from each pixel and produces a equivalent grey value. This results in making a black and white image out of a color one.

  Since:

  1.0

  noise

  public void noise(int minPercentAdj,
                    int maxPercentAdj)

  Randomly adjust the brightness of each pixel This method allows one to randomly adjust the brightness of each pixel. You can specify a percentage range to adjust the brightness by (the smaller the range the less change). This can create a nice texture affect.

  Parameters:

  minPercent - The minimum percentage change to adjust the brightness by. Values from [0,99] will darken the image, values larger than 100 will brighten the image

  maxPercent - The maximum percentage change to adjust the brightness by. Values from [0,99] will darken the image, values larger than 100 will brighten the image

  Since:

  1.0

  button3D

  public void button3D(int bsize,
                       int strength)

  Turn the pixel map into a 3D button. This code is a slightly optimized version of the 3D button code out of "Kick Ass Java Programming" by Tonny Espeset. It will round off the edges of the bit map to shade it to look like a 3D button. You have two parameter to play with. The "border" controls how many pixels to use for the rounded edge (higher numbers will produce taller looking buttons). The "strength" controls how much brightness transitions as the button is rounded. Setting a negative "strength" value will produce a button that appears pressed in, whereas positive values result in the button looking as if its released. You can pass any kind of data for this affect (you don't have to use solid maps - you can use pictures as well).

  Parameters:

  border - How many pixels to use for the rounded edge.

  strength - How much brightness should vary as we go from light to dark. Negative for pressed in state, positive for released (out) state. Values should always probably be in the range of (-64/+64) - if you go too big, you will "peak" on the brightness of the individual RGB values as they are adjusted.

  Since:

  1.0