RectanglePainter.java

/* ===========================================================
 * Orson Charts : a 3D chart library for the Java(tm) platform
 * ===========================================================
 * 
 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
 * 
 * http://www.object-refinery.com/orsoncharts/index.html
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
 * Other names may be trademarks of their respective owners.]
 * 
 * If you do not wish to be bound by the terms of the GPL, an alternative
 * commercial license can be purchased.  For details, please see visit the
 * Orson Charts home page:
 * 
 * http://www.object-refinery.com/orsoncharts/index.html
 * 
 */

package com.orsoncharts.table;

import java.awt.Graphics2D;
import java.awt.geom.Rectangle2D;
import com.orsoncharts.Chart3D;

/**
 * An object that can paint a rectangular region with a color, gradient, image
 * or anything.  
 * <br><br>
 * NOTE: It is recommended that classes that implement this interface are 
 * designed to be {@code Serializable} and immutable.  Immutability is 
 * desirable because painters are assigned to {@link Chart3D} instances, and 
 * there is no change notification if the painter can be modified directly.
 * In addition, a single painter can be shared amongst multiple charts.
 */
public interface RectanglePainter {
    
    /**
     * Fills the specified rectangle (where "fill" is some arbitrary drawing
     * operation defined by the class that implements this interface).
     * 
     * @param g2  the graphics target ({@code null} not permitted).
     * @param bounds  the rectangle ({@code null} not permitted).
     */
    public void fill(Graphics2D g2, Rectangle2D bounds);

}