GraphicDevice.h

Go to the documentation of this file.

//
// File: GraphicDevice.h
// Created by: Julien Dutheil
// Created on: Mon Mar 03 2008
//

/*
Copyright or © or Copr. Bio++ Development Team, (November 16, 2006)

This software is a computer program whose purpose is to provide utilitary
classes. This file belongs to the Bio++ Project.

This software is governed by the CeCILL  license under French law and
abiding by the rules of distribution of free software.  You can  use, 
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info". 

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability. 

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or 
data to be ensured and,  more generally, to use and operate it in the 
same conditions as regards security. 

The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/

#ifndef _GRAPHICDEVICE_H_
#define _GRAPHICDEVICE_H_

#include "RgbColor.h"
#include "Font/Font.h"

namespace bpp
{

  class UnvalidFlagException: public virtual Exception
  {
    public:
      UnvalidFlagException(const std::string& message): Exception(message) {}
  };



  class GraphicDevice
  {
    public:
      GraphicDevice() {}
      virtual ~GraphicDevice() {}

    public:
      virtual void begin() = 0;

      virtual void end() = 0;

      virtual void setXUnit(double xu) = 0;

      virtual void setYUnit(double yu) = 0;

      virtual double getXUnit() const = 0;

      virtual double getYUnit() const = 0;

      virtual void setCurrentForegroundColor(const RGBColor& color) = 0;
      virtual void setCurrentBackgroundColor(const RGBColor& color) = 0;
      virtual void setCurrentFont(const Font& font) = 0;
      virtual void setCurrentPointSize(unsigned int size) = 0;
      virtual void setCurrentLineType(short type) = 0;
      virtual void setCurrentLayer(int layerIndex) = 0;

      virtual const RGBColor& getCurrentForegroundColor() const = 0;
      virtual const RGBColor& getCurrentBackgroundColor() const = 0;
      virtual const Font& getCurrentFont() const = 0;
      virtual unsigned int getCurrentPointSize() const = 0;
      virtual short getCurrentLineType() const = 0;
      virtual int getCurrentLayer() const = 0;


      virtual void drawLine(double x1, double y1, double x2, double y2) = 0;

      virtual void drawRect(double x, double y, double width, double height, short fill = FILL_EMPTY) = 0;

      virtual void drawCircle(double x, double y, double radius, short fill = FILL_EMPTY) = 0;

      virtual void drawText(double x, double y, const std::string& text, short hpos = TEXT_HORIZONTAL_LEFT, short vpos = TEXT_VERTICAL_BOTTOM, double angle = 0) throw (UnvalidFlagException) = 0;

      virtual void comment(const std::string & comment) = 0;

    public:
      static short TEXT_HORIZONTAL_CENTER;
      static short TEXT_HORIZONTAL_LEFT;
      static short TEXT_HORIZONTAL_RIGHT;
      static short TEXT_VERTICAL_CENTER;
      static short TEXT_VERTICAL_BOTTOM;
      static short TEXT_VERTICAL_TOP;

      static short FILL_EMPTY;
      static short FILL_FILLED;
      static short FILL_PATTERN;

      static short LINE_SOLID;
      static short LINE_DASHED;
      static short LINE_DOTTED;
  };

} // end of namespace bpp.

#endif //_GRAPHICDEVICE_H_