001/*
002 * Copyright 2006 - 2013
003 *     Stefan Balev     <stefan.balev@graphstream-project.org>
004 *     Julien Baudry    <julien.baudry@graphstream-project.org>
005 *     Antoine Dutot    <antoine.dutot@graphstream-project.org>
006 *     Yoann Pigné      <yoann.pigne@graphstream-project.org>
007 *     Guilhelm Savin   <guilhelm.savin@graphstream-project.org>
008 * 
009 * This file is part of GraphStream <http://graphstream-project.org>.
010 * 
011 * GraphStream is a library whose purpose is to handle static or dynamic
012 * graph, create them from scratch, file or any source and display them.
013 * 
014 * This program is free software distributed under the terms of two licenses, the
015 * CeCILL-C license that fits European law, and the GNU Lesser General Public
016 * License. You can  use, modify and/ or redistribute the software under the terms
017 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
018 * URL <http://www.cecill.info> or under the terms of the GNU LGPL as published by
019 * the Free Software Foundation, either version 3 of the License, or (at your
020 * option) any later version.
021 * 
022 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
023 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
024 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
025 * 
026 * You should have received a copy of the GNU Lesser General Public License
027 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
028 * 
029 * The fact that you are presently reading this means that you have had
030 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
031 */
032package org.graphstream.ui.swingViewer;
033
034import java.awt.Graphics2D;
035
036import org.graphstream.ui.graphicGraph.GraphicGraph;
037
038/**
039 * A specific rendering class that can be plugged in any view and is called to
040 * draw under or above the graph.
041 * 
042 * @see View#setForeLayoutRenderer(LayerRenderer)
043 * @see View#setBackLayerRenderer(LayerRenderer)
044 */
045public interface LayerRenderer {
046        /**
047         * Render something under or above the graph.
048         * 
049         * @param graphics
050         *            The Swing graphics.
051         * @param graph
052         *            The graphic representation of the graph.
053         * @param px2Gu
054         *            The ratio to pass from pixels to graph units.
055         * @param widthPx
056         *            The width in pixels of the view port.
057         * @param heightPx
058         *            The height in pixels of the view port.
059         * @param minXGu
060         *            The minimum visible point abscissa of the graph in graph
061         *            units.
062         * @param minYGu
063         *            The minimum visible point ordinate of the graph in graph
064         *            units.
065         * @param maxXGu
066         *            The maximum visible point abscissa of the graph in graph
067         *            units.
068         * @param maxYGu
069         *            The maximum visible point ordinate of the graph in graph
070         *            units.
071         */
072        void render(Graphics2D graphics, GraphicGraph graph, double px2Gu,
073                        int widthPx, int heightPx, double minXGu, double minYGu,
074                        double maxXGu, double maxYGu);
075}