/home/kitware/dashboards/avogadro/libavogadro/src/plotwidget.h

/**********************************************************************
  PlotWidget -- 2D plotting interface

  Copyright (C) 2003 Jason Harris <[email protected]> (KDE)
  Copyright (C) 2008 David Lonie <[email protected]> (Avogadro)

  This file is part of the Avogadro molecular editor project.
  For more information, see <http://avogadro.openmolecules.net/>

  This file is based on KPlotWidget from the KDE library. For more
  information see <http://www.kde.org/>

  Avogadro is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  Avogadro 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
 **********************************************************************/

#ifndef PLOTWIDGET_H
#define PLOTWIDGET_H

#include <avogadro/plotaxis.h>
#include <avogadro/plotpoint.h>
#include <avogadro/plotobject.h>

#include <QtGui/QFrame>
#include <QtCore/QList>

namespace Avogadro {

    class A_EXPORT PlotWidget : public QFrame {
        Q_OBJECT
        Q_PROPERTY(int leftPadding READ leftPadding)
            Q_PROPERTY(int rightPadding READ rightPadding)
            Q_PROPERTY(int topPadding READ topPadding)
            Q_PROPERTY(int bottomPadding READ bottomPadding)
            Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor)
            Q_PROPERTY(QColor foregroundColor READ foregroundColor WRITE setForegroundColor)
            Q_PROPERTY(QColor gridColor READ gridColor WRITE setGridColor)
            Q_PROPERTY(bool grid READ isGridShown WRITE setShowGrid)
            Q_PROPERTY(bool objectToolTip READ isObjectToolTipShown WRITE setObjectToolTipShown)
            public:
            explicit PlotWidget( QWidget * parent = 0 );

        virtual ~PlotWidget();

        enum Axis
            {
                LeftAxis = 0,  
                BottomAxis,    
                RightAxis,     
                TopAxis        
            };
            
        enum Direction
            {
                None = 0,
                Left,  
                Down,    
                Right,     
                Up        
            };
            
        virtual QSize minimumSizeHint() const;

        virtual QSize sizeHint() const;

        void setLimits( double x1, double x2, double y1, double y2 );
        void setLimits( QRectF &rect);

        void scaleLimits(PlotObject *po = NULL);

        void setDefaultLimits( double x1, double x2, double y1, double y2 );

        void setDefaultLimits( QRectF &rect);

        void unsetDefaultLimits();

        void setSecondaryLimits( double x1, double x2, double y1, double y2 );

        void clearSecondaryLimits();

        QRectF dataRect() const;

        QRectF defaultDataRect() const;

        QRectF secondaryDataRect() const;

        QRect pixRect() const;

        void addPlotObject( PlotObject *object );

        void addPlotObjects( const QList< PlotObject* >& objects );

        QList< PlotObject* > plotObjects() const;

        void removeAllPlotObjects();

        void resetPlotMask();

        void resetPlot();

        void replacePlotObject( int i, PlotObject *o );

        QColor backgroundColor() const;

        QColor foregroundColor() const;

        QColor gridColor() const;

        void setBackgroundColor( const QColor &bg );

        void setForegroundColor( const QColor &fg );

        void setGridColor( const QColor &gc );

        void setFontSize( int pointSize );

        void setFont( QFont font );

        QFont getFont();

        bool isGridShown() const;

        bool isObjectToolTipShown() const;

        bool antialiasing() const;

        void setAntialiasing( bool b );

        int leftPadding() const;

        int rightPadding() const;

        int topPadding() const;

        int bottomPadding() const;

        void setLeftPadding( int padding );

        void setRightPadding( int padding );

        void setTopPadding( int padding );

        void setBottomPadding( int padding );

        void setDefaultPaddings();

        QPointF mapToWidget( const QPointF& p ) const;

        QPointF mapToData( const QPointF& p ) const;

        QPointF mapFrameToData( const QPointF& p ) const;

        void maskRect( const QRectF &r, float value=1.0 );

        void maskAlongLine( const QPointF &p1, const QPointF &p2, float value=1.0 );

        void placeLabel( QPainter *painter, PlotPoint *pp );

        PlotAxis* axis( Axis type );

        const PlotAxis* axis( Axis type ) const;

       signals:
        void pointClicked(double x, double y);

        void pointClicked(const QList<PlotPoint*> & pl);

        void pointClicked(PlotPoint*);

        void mouseOverPoint(double x, double y);

       public Q_SLOTS:
        void setShowGrid( bool show );

        void setObjectToolTipShown( bool show );

        bool saveImage(const QString &filename, double width, double height, double dpi, bool optimizeFontSize );

        void selectPoint(PlotPoint* point);

        void selectPoints(const QList<PlotPoint*> & points);

        void clearAndSelectPoint(PlotPoint* point);

        void clearAndSelectPoints(const QList<PlotPoint*> & points);

        void clearSelection();

        void setPointFollowMouse(bool b);
        
        void setJailedInDefaults(bool b);

        void setLabelShiftDirection(Direction dir, float priority=2.0);

    protected:
        virtual bool event( QEvent* );

        virtual void mouseMoveEvent(QMouseEvent *event);

        virtual void mousePressEvent(QMouseEvent *event);

        virtual void mouseDoubleClickEvent(QMouseEvent *event);

        virtual void mouseReleaseEvent(QMouseEvent *event);

        virtual void wheelEvent(QWheelEvent *event);

        virtual void paintEvent( QPaintEvent* );

        virtual void resizeEvent( QResizeEvent* );

        virtual void drawAxes( QPainter *p );

        void setPixRect();

        QList<PlotPoint*> pointsUnderPoint( const QPoint& p ) const;

        PlotPoint* pointNearestPoint( const QPoint& p ) const;

    private:
        class Private;
        Private * const d;

        QPointF mouseClickOrigin, zoomPosF;

        Q_DISABLE_COPY( PlotWidget )
    };

}

#endif