org.graphstream.ui.j2dviewer.renderer.shape.Shape.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gs-ui Show documentation
The GraphStream library. With GraphStream you deal with graphs. Static and Dynamic. You create them from scratch, from a file or any source. You display and render them.
The newest version!
/*
 * Copyright 2006 - 2015
 *     Stefan Balev     
 *     Julien Baudry    
 *     Antoine Dutot    
 *     Yoann Pigné      
 *     Guilhelm Savin   
 * 
 * This file is part of GraphStream .
 * 
 * GraphStream is a library whose purpose is to handle static or dynamic
 * graph, create them from scratch, file or any source and display them.
 * 
 * This program is free software distributed under the terms of two licenses, the
 * CeCILL-C license that fits European law, and the GNU Lesser General Public
 * License. You can  use, modify and/ or redistribute the software under the terms
 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
 * URL  or under the terms of the GNU LGPL 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 GNU Lesser General Public License
 * along with this program.  If not, see .
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
 */
package org.graphstream.ui.j2dviewer.renderer.shape

import java.awt._
import java.awt.geom._

import org.graphstream.ui.j2dviewer._
import org.graphstream.ui.j2dviewer.renderer._
import org.graphstream.ui.util._
import org.graphstream.ui.geom.Point2
import org.graphstream.ui.geom._
import org.graphstream.ui.graphicGraph._
import org.graphstream.ui.graphicGraph.stylesheet._
import org.graphstream.ui.graphicGraph.stylesheet.StyleConstants._

/** Base for all shapes. */
abstract trait Shape {
 	/** Configure as much as possible the graphics before painting several version of this shape
      * at different positions.
      * @param backend The rendering back-end.
      * @param style The style for the group.
      * @param camera the view parameters. */
 	def configureForGroup(backend:Backend, style:Style, camera:Camera)
 
 	/** Configure all the dynamic and per element settings.
 	  * Some configurations can only be done before painting the element, since they change for
 	  * each element.
 	  * @param backend The rendering back-end.
 	  * @param element The specific element to render.
 	  * @param skeleton The element geometry and information.
 	  * @param camera the view parameters. */
 	def configureForElement(backend:Backend, element:GraphicElement, skeleton:Skeleton, camera:Camera)
 	
 	/** Must create the shape from informations given earlier, that is, resize it if needed and
      * position it, and do all the things that are specific to each element, and cannot be done
      * for the group of elements.
      * This method is made to be called inside the render() method, hence it is protected.
      * @param backend The rendering back-end.
      * @param camera the view parameters. */
 	protected def make(backend:Backend, camera:Camera)
 	
 	/** Same as {@link #make(Camera)} for the shadow shape. The shadow shape may be moved and
 	  * resized compared to the original shape. This method is made to be called inside the
 	  * renderShadow() method, hence it is protected. */
  	protected def makeShadow(backend:Backend, camera:Camera)
  
  	/** Render the shape for the given element.
      * @param backend The rendering back-end.
      * @param camera The view parameters.
      * @param element The element to render.
      * @param skeleton The element geometry and information. */
  	def render(bck:Backend, camera:Camera, element:GraphicElement, skeleton:Skeleton)
   
   	/** Render the shape shadow for the given element. The shadow is rendered in a different pass
      * than usual rendering, therefore it is a separate method. */
   	def renderShadow(bck:Backend, camera:Camera, element:GraphicElement, skeleton:Skeleton)
}