AbstractPlotWidget.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLQt/src/ICLQt/AbstractPlotWidget.h                   **
** Module : ICLQt                                                  **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Range.h>
#include <ICLUtils/Rect32f.h>
#include <ICLUtils/Configurable.h>
#include <ICLMath/DynMatrix.h>
#include <ICLQt/MouseEvent.h>
#include <ICLQt/MouseHandler.h>

#include <ICLQt/ThreadedUpdatableWidget.h>

#include <QPen>
#include <QBrush>
#include <QPainter>

namespace icl{
  namespace qt{
    
    

    class ICLQt_API AbstractPlotWidget : public ThreadedUpdatableWidget, public utils::Configurable{
      struct Data; 
      Data *data;  
  
      void property_changed(const Property &);
  
      public:
      
      

      void install(MouseHandler *h);


      void uninstall(MouseHandler *h);
      
      enum PenType{
        X_AXIS_PEN,    
        Y_AXIS_PEN,    
        X_TIC_PEN,     
        Y_TIC_PEN,     
        X_LABEL_PEN,   
        Y_LABEL_PEN,   
        X_GRID_PEN,    
        Y_GRID_PEN,    
        AXIS_NAME_PEN, 
        NUM_PEN_TYPES
      };
  
      
      AbstractPlotWidget(QWidget *parent=0);
  
      ~AbstractPlotWidget();
      
      virtual void paintEvent(QPaintEvent *evt);
  
      virtual void keyPressEvent(QKeyEvent *event);
      
      void renderTo(QPainter &p);
  
      void setBackground(const QBrush &bgBrush);
  
      void setPen(PenType p, const QPen &pen);  
      

      struct Pen{


        Pen(const QPen &linePen=Qt::NoPen, 
            const QPen &symbolPen=Qt::NoPen,
            char symbol= ' ',
            int symbolSize=5,
            const QBrush &fillBrush=Qt::NoBrush):
        linePen(linePen),symbolPen(symbolPen),symbol(symbol),symbolSize(symbolSize),fillBrush(fillBrush){}
        QPen linePen;     
        QPen symbolPen;   
        char symbol;      
        int symbolSize;   
        QBrush fillBrush; 
      };
      typedef utils::SmartPtr<Pen> PenPtr;
  
  

      inline void render() { updateFromOtherThread(); }
  

      virtual utils::Rect32f getDataViewPort() const;
      

      void setDataViewPort(const utils::Rect32f &viewPort);
  

      void setDataViewPort(const utils::Range32f &xrange, const utils::Range32f &yrange);
  
      void lock() const;
  
      void unlock() const;
  

      void addAnnotations(const char type,const float *data, int num=1, 
                          const QPen &linePen = QColor(255,0,0),
                          const QBrush &brush = Qt::NoBrush,
                          const std::string &text="", const std::string &textDelim=",");
  
      void clearAnnotations();
      

      virtual void clear() { clearAnnotations(); }
      
      typedef utils::Function<float,float,float> bgFunction;


      void setBackgroundFunction(bgFunction f);
      

      void updateBackgroundFunction();
      
      void removeBackgroundFunction();
  
      protected:
      
      bool isZoomed() const;
      
      virtual void mouseDoubleClickEvent(QMouseEvent *event);
  
      virtual void mouseMoveEvent(QMouseEvent *event);
  
      virtual void mousePressEvent(QMouseEvent *event);
  
      virtual void mouseReleaseEvent(QMouseEvent *event);
  
      virtual void enterEvent(QEvent *event);
  
      virtual void leaveEvent(QEvent *event);
  

      virtual bool drawData(QPainter &p) = 0;
      
      virtual void drawLegend(QPainter &p,const utils::Rect &where, bool horizontal);
  
  
      void drawDefaultLedgend(QPainter &p,const utils::Rect &where, bool horizontal, 
                              const std::vector<std::string> &rowNames,
                              const std::vector<PenPtr> &pens);
  

      template<char s> static inline void draw_symbol(QPainter &p,int size, float x, float y){ 
        ERROR_LOG("undefined given symbol ID"); 
      }
      
      float winToDrawX(int winX) const;
  
      float winToDrawY(int winY) const;
  
      utils::Point32f winToDraw(const utils::Point &p) const;
      
      int drawToWinX(float drawX) const;
  
      int drawToWinY(float drawY) const;
  
      utils::Point drawToWin(const utils::Point32f &p) const;
  
      utils::Rect32f getDynamicDataViewPort() const;
      
      struct Locker{
        const AbstractPlotWidget *w; 

        inline Locker(const AbstractPlotWidget *w):w(w){ this->w->lock(); }
        inline Locker(const AbstractPlotWidget &w):w(&w){ this->w->lock();}
        ~Locker() { w->unlock(); }
      };
    }; 
    
    // (specialized) note, points have not size: use circle for larger round points ...
    template<> inline void AbstractPlotWidget::draw_symbol<'.'>(QPainter &p,int, float x, float y){ 
      //    p.drawPoint(QPoint(x,y));
      p.drawLine(QPoint(x,y),QPoint(x,y));
    }
    
    template<> inline void AbstractPlotWidget::draw_symbol<'x'>(QPainter &p,int size, float x, float y){ 
      p.drawLine(QPoint(x-size,y-size),QPoint(x+size,y+size));
      p.drawLine(QPoint(x-size,y+size),QPoint(x+size,y-size));
    }
  
    template<> inline void AbstractPlotWidget::draw_symbol<'+'>(QPainter &p,int size, float x, float y){ 
      p.drawLine(QPoint(x,y-size),QPoint(x,y+size));
      p.drawLine(QPoint(x-size,y),QPoint(x+size,y));
    }
  
    template<> inline void AbstractPlotWidget::draw_symbol<'*'>(QPainter &p,int size, float x, float y){ 
      draw_symbol<'+'>(p,(size*2)/3,x,y);    
      draw_symbol<'x'>(p,size,x,y);
    }
  
    template<> inline void AbstractPlotWidget::draw_symbol<'o'>(QPainter &p,int size, float x, float y){ 
      p.drawEllipse(QRect(x-size,y-size,2*size,2*size));
    }
  
    template<> inline void AbstractPlotWidget::draw_symbol<'s'>(QPainter &p,int size, float x, float y){ 
      p.drawRect(QRect(x-size,y-size,2*size,2*size));
    }
  
    template<> inline void AbstractPlotWidget::draw_symbol<'t'>(QPainter &p,int size, float x, float y){ 
      const QPoint e[3] = { QPoint(x,y-size),QPoint(x+size,y+size),QPoint(x-size,y+size) };
      p.drawConvexPolygon(e,3);
    }
  
    template<> inline void AbstractPlotWidget::draw_symbol<'d'>(QPainter &p,int size, float x, float y){ 
      const QPoint e[4] = { QPoint(x,y-size),QPoint(x+size,y),QPoint(x,y+size), QPoint(x-size,y) };
      p.drawConvexPolygon(e,4);
    }
  } // namespace qt
}