com.github.ojil.core.RgbImage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojil-core Show documentation
Open Java Imaging Library.
There is a newer version: 0.0.11
/*
 * RgbImage.java
 *
 * Created on August 27, 2006, 12:47 PM
 *
 * To change this template, choose Tools | Template Manager
 * and open the template in the editor.
 *
 * Copyright 2006 by Jon A. Webb
 *     This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU Lesser General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Lesser General Public License for more details.
 *
 *    You should have received a copy of the Lesser GNU General Public License
 *    along with this program.  If not, see .
 *
 */

package com.github.ojil.core;

/**
 * RgbImage is the type used to hold an RGB image, which is stored as an ARGB
 * image type (32-bits) with the A byte ignored.
 * 
 * Implementation-specific libraries define methods that allow the creation of
 * an RgbImage from a native image type. RgbImage is therefore the first and
 * last jjil.core object used after capture and before display of an image.
 * 
 * @author webb
 */
public class RgbImage extends Image {
    /**
     * A pointer to the image data
     */
    protected Integer[] imageData;
    
    /**
     * Creates a new instance of RgbImage
     *
     * @param cWidth
     *            the image width
     * @param cHeight
     *            the image height
     */
    public RgbImage(final int cWidth, final int cHeight) {
        super(cWidth, cHeight, ImageType.INT_RGB);
        imageData = new Integer[getWidth() * getHeight()];
    }
    
    public RgbImage(final int cWidth, final int cHeight, final Integer[] rnData) {
        super(cWidth, cHeight, ImageType.INT_RGB);
        imageData = rnData;
    }
    
    /**
     * Creates a new instance of RgbImage, assigning a constant value
     * 
     * @param bR
     *            the red color value to be assigned.
     * @param bG
     *            the green color value to be assigned.
     * @param bB
     *            the blue color value to be assigned.
     * @param cWidth
     *            the image width
     * @param cHeight
     *            the image height
     */
    public RgbImage(final int cWidth, final int cHeight, final byte bR, final byte bG, final byte bB) {
        super(cWidth, cHeight, ImageType.INT_RGB);
        imageData = new Integer[getWidth() * getHeight()];
        final int nRgb = RgbVal.toRgb(bR, bG, bB);
        for (int i = 0; i < (getWidth() * getHeight()); i++) {
            imageData[i] = nRgb;
        }
    }
    
    /**
     * Creates a new instance of RgbImage, assigning a constant value
     * 
     * @param nRgb
     *            the packed RGB value to assign
     * @param cWidth
     *            the image width
     * @param cHeight
     *            the image height
     */
    public RgbImage(final int cWidth, final int cHeight, final int nRgb) {
        super(cWidth, cHeight, ImageType.INT_RGB);
        imageData = new Integer[getWidth() * getHeight()];
        for (int i = 0; i < (getWidth() * getHeight()); i++) {
            imageData[i] = nRgb;
        }
    }
    
    /**
     * Creates a shallow copy of this image
     *
     * @return the image copy.
     */
    @Override
    public Object clone() {
        final RgbImage image = new RgbImage<>(getWidth(), getHeight());
        System.arraycopy(getData(), 0, image.getData(), 0, getWidth() * getHeight());
        return image;
    }
    
    /**
     * Fill a rectangle in an RgbImage with a given value
     * 
     * @param r
     *            the Rect to fill
     * @param rgb
     *            the color to assign
     * @return the modified RgbImage (i.e., this)
     * @throws ImageError
     *             if the bounds are outside the image
     */
    public RgbImage fill(final Rect r, final int rgb) throws ImageError {
        if ((r.getTop() < 0) || (r.getBottom() > getHeight()) || (r.getLeft() < 0) || (r.getRight() > getWidth())) {
            throw new ImageError(ImageError.PACKAGE.CORE, ErrorCodes.BOUNDS_OUTSIDE_IMAGE, r.toString(), null, null);
        }
        for (int i = r.getTop(); i < r.getBottom(); i++) {
            for (int j = r.getLeft(); j < r.getRight(); j++) {
                imageData[(i * getWidth()) + j] = rgb;
            }
        }
        return this;
    }
    
    /**
     * Get a pointer to the image data.
     *
     * @return the data pointer.
     */
    @Override
    public Integer[] getData() {
        return imageData;
    }
    
    /**
     * Return a string describing the image.
     *
     * @return the string.
     */
    @Override
    public String toString() {
        return super.toString() + " (" + getWidth() + "x" + getHeight() + ")";
    }
}