forester/java/src/org/forester/archaeopteryx/phylogeny/data/RenderablePhylogenyData.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // All rights reserved
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Lesser General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2.1 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 // Lesser General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Lesser General Public
  20 // License along with this library; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22 //
  23 // Contact: phylosoft @ gmail . com
  24 // WWW: www.phylosoft.org/forester
  25
  26 package org.forester.archaeopteryx.phylogeny.data;
  27
  28 import java.awt.Dimension;
  29 import java.awt.Graphics2D;
  30
  31 import org.forester.archaeopteryx.TreePanel;
  32 import org.forester.phylogeny.data.PhylogenyData;
  33
  34 public interface RenderablePhylogenyData extends PhylogenyData {
  35
  36     public Dimension getOriginalSize();
  37
  38     public Object getParameter();
  39
  40     public Dimension getRenderingSize();
  41
  42     /**
  43      * This can be used to render phylogeny data as graphics (for example,
  44      * display of the domain structure). In most Renderable implementations this
  45      * will do nothing (i.e. just return).
  46      *
  47      * @param g
  48      *            the Graphics to render to
  49      */
  50     public void render( final double x, final double y, final Graphics2D g, final TreePanel tree_panel, boolean to_pdf );
  51
  52     public void setParameter( final double parameter );
  53
  54     public void setRenderingHeight( final double rendering_height );
  55 }