GraphicDevice.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_GRAPHICS_GRAPHICDEVICE_H
#define BPP_GRAPHICS_GRAPHICDEVICE_H


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

namespace bpp
{
class UnvalidFlagException : public virtual Exception
{
public:
  UnvalidFlagException(const std::string& text) : Exception(text) {}
};


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) = 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 // BPP_GRAPHICS_GRAPHICDEVICE_H