    001/* ===========================================================
    002 * Orson Charts : a 3D chart library for the Java(tm) platform
    003 * ===========================================================
    004 *
    005 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
    006 *
    007 * http://www.object-refinery.com/orsoncharts/index.html
    008 *
    009 * This program is free software: you can redistribute it and/or modify
    010 * it under the terms of the GNU General Public License as published by
    011 * the Free Software Foundation, either version 3 of the License, or
    012 * (at your option) any later version.
    013 *
    014 * This program is distributed in the hope that it will be useful,
    015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
    016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    017 * GNU General Public License for more details.
    018 *
    019 * You should have received a copy of the GNU General Public License
    020 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    021 *
    022 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
    023 * Other names may be trademarks of their respective owners.]
    024 *
    025 * If you do not wish to be bound by the terms of the GPL, an alternative
    026 * commercial license can be purchased.  For details, please see visit the
    027 * Orson Charts home page:
    028 *
    029 * http://www.object-refinery.com/orsoncharts/index.html
    030 *
    031 */
    032
    033package com.orsoncharts.renderer;
    034
    035import java.awt.Color;
    036import com.orsoncharts.Chart3D;
    037import com.orsoncharts.ChartElement;
    038import com.orsoncharts.plot.CategoryPlot3D;
    039import com.orsoncharts.plot.XYZPlot;
    040
    041/**
    042 * A renderer is an object responsible for constructing objects in a 3D model
    043 * that correspond to data items in a dataset.  The renderer's methods will be
    044 * called by the plot ({@link CategoryPlot3D} or {@link XYZPlot}) that it is
    045 * assigned to.
    046 * <p>
    047 * All renderers support a change listener mechanism so that registered
    048 * listeners can be notified whenever any attribute of the renderer is modified.
    049 * Typically the plot that the renderer is assigned to will listen for
    050 * change events, and pass these events along to the {@link Chart3D} object.
    051 * <p>
    052 * Renderers should implement the {@code java.io.Serializable} interface,
    053 * so that charts can be serialized and deserialized, but this is not a forced
    054 * requirement (if you never use serialization, it won't matter if you
    055 * implement a renderer that does not support it).
    056 */
    057public interface Renderer3D extends ChartElement {
    058
    059    /**
    060     * A color instance that is completely transparent.
    061     *
    062     * @since 1.3
    063     */
    064    static final Color TRANSPARENT_COLOR = new Color(0, 0, 0, 0);
    065
    066    /**
    067     * Registers a listener to receive notification of changes to the
    068     * renderer.
    069     *
    070     * @param listener  the listener ({@code null} not permitted).
    071     */
    072    void addChangeListener(Renderer3DChangeListener listener);
    073
    074    /**
    075     * Deregisters a listener so that it no longer receives notification of
    076     * changes to the renderer.
    077     *
    078     * @param listener  the listener ({@code null} not permitted).
    079     */
    080    void removeChangeListener(Renderer3DChangeListener listener);
    081
    082}