qwt_plot_vectorfield.h

Go to the documentation of this file.

/* -*- mode: C++ ; c-file-style: "stroustrup" -*- *****************************
 * Qwt Widget Library
 * Copyright (C) 1997   Josef Wilgen
 * Copyright (C) 2002   Uwe Rathmann
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the Qwt License, Version 1.0
 *****************************************************************************/

#ifndef QWT_PLOT_VECTOR_FIELD_H
#define QWT_PLOT_VECTOR_FIELD_H

#include "qwt_global.h"
#include "qwt_plot_seriesitem.h"

class QwtVectorFieldSymbol;
class QwtColorMap;
class QPen;
class QBrush;

class QWT_EXPORT QwtPlotVectorField:
    public QwtPlotSeriesItem, public QwtSeriesStore<QwtVectorFieldSample>
{
public:
    enum IndicatorOrigin
    {
        OriginHead,
        OriginTail,
        OriginCenter
    };

    enum PaintAttribute
    {
        FilterVectors        = 0x01,
        LimitLength          = 0x02
    };

    typedef QFlags<PaintAttribute> PaintAttributes;

    enum MagnitudeMode
    {
        MagnitudeAsColor = 0x01,
        MagnitudeAsLength = 0x02
    };

    typedef QFlags<MagnitudeMode> MagnitudeModes;

    explicit QwtPlotVectorField( const QString &title = QString() );
    explicit QwtPlotVectorField( const QwtText &title );

    virtual ~QwtPlotVectorField();

    void setPaintAttribute( PaintAttribute, bool on = true );
    bool testPaintAttribute( PaintAttribute ) const;

    void setMagnitudeMode( MagnitudeMode, bool on = true );
    bool testMagnitudeMode( MagnitudeMode ) const;

    MagnitudeModes magnitudeModes() const;
    void setMagnitudeModes( MagnitudeModes );

    void setSymbol( QwtVectorFieldSymbol * );
    const QwtVectorFieldSymbol* symbol() const;

    void setPen( const QPen & );
    QPen pen() const;

    void setBrush( const QBrush & );
    QBrush brush() const;

    void setRasterSize( const QSizeF& );
    QSizeF rasterSize() const;

    void setIndicatorOrigin( IndicatorOrigin );
    IndicatorOrigin indicatorOrigin() const;

    void setSamples( const QVector<QwtVectorFieldSample> & );
    void setSamples( QwtVectorFieldData * );

    void setColorMap( QwtColorMap * );
    const QwtColorMap *colorMap() const;
    void setMagnitudeRange( const QwtInterval & magnitudeRange);

    virtual double arrowLength( double magnitude ) const;

    virtual QRectF boundingRect() const QWT_OVERRIDE;

    virtual void drawSeries( QPainter *,
        const QwtScaleMap &xMap, const QwtScaleMap &yMap,
        const QRectF &canvasRect, int from, int to ) const QWT_OVERRIDE;

    virtual int rtti() const QWT_OVERRIDE;

    virtual QwtGraphic legendIcon(
        int index, const QSizeF & ) const QWT_OVERRIDE;

    void setMagnitudeScaleFactor( double factor );
    double magnitudeScaleFactor() const;

protected:
    virtual void drawSymbols( QPainter *,
        const QwtScaleMap &xMap, const QwtScaleMap &yMap,
        const QRectF &canvasRect, int from, int to ) const;

    virtual void drawSymbol( QPainter *,
        double x, double y, double vx, double vy ) const;

    virtual void dataChanged() QWT_OVERRIDE;

private:
    void init();

    class PrivateData;
    PrivateData *d_data;
};

Q_DECLARE_OPERATORS_FOR_FLAGS( QwtPlotVectorField::PaintAttributes )
Q_DECLARE_OPERATORS_FOR_FLAGS( QwtPlotVectorField::MagnitudeModes )

#endif