qwt_symbol.h

/******************************************************************************
 * 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
 *
 * Modified by ChenZongYan in 2024 <czy.t@163.com>
 *   Summary of major modifications (see ChangeLog.md for full history):
 *   1. CMake build system & C++11 throughout.
 *   2. Core panner/ zoomer refactored:
 *        - QwtPanner → QwtCachePanner (pixmap-cache version)
 *        - New real-time QwtPlotPanner derived from QwtPicker.
 *   3. Zoomer supports multi-axis.
 *   4. Parasite-plot framework:
 *        - QwtFigure, QwtPlotParasiteLayout, QwtPlotTransparentCanvas,
 *        - QwtPlotScaleEventDispatcher, built-in pan/zoom on axis.
 *   5. New picker: QwtPlotSeriesDataPicker (works with date axis).
 *   6. Raster & color-map extensions:
 *        - QwtGridRasterData (2-D table + interpolation)
 *        - QwtLinearColorMap::stopColors(), stopPos() API rename.
 *   7. Bar-chart: expose pen/brush control.
 *   8. Amalgamated build: single QwtPlot.h / QwtPlot.cpp pair in src-amalgamate.
 *****************************************************************************/
 
#ifndef QWT_SYMBOL_H
#define QWT_SYMBOL_H
 
#include "qwt_global.h"
 
#include <qpolygon.h>
#include <qpen.h>
#include <qbrush.h>
 
class QPainter;
class QSize;
class QBrush;
class QPen;
class QColor;
class QPointF;
class QPainterPath;
class QPixmap;
class QByteArray;
class QwtGraphic;
 
class QWT_EXPORT QwtSymbol
{
public:
    enum Style
    {
        NoSymbol = -1,
 
        Ellipse,
 
        Rect,
 
        Diamond,
 
        Triangle,
 
        DTriangle,
 
        UTriangle,
 
        LTriangle,
 
        RTriangle,
 
        Cross,
 
        XCross,
 
        HLine,
 
        VLine,
 
        Star1,
 
        Star2,
 
        Hexagon,
 
        Path,
 
        Pixmap,
 
        Graphic,
 
        SvgDocument,
 
        UserStyle = 1000
    };
 
    enum CachePolicy
    {
        NoCache,
 
        Cache,
 
        AutoCache
    };
 
public:
    // Constructor with style
    explicit QwtSymbol(Style = NoSymbol);
    // Constructor with style, brush, pen and size
    QwtSymbol(Style, const QBrush&, const QPen&, const QSize&);
    // Constructor with painter path, brush and pen
    QwtSymbol(const QPainterPath&, const QBrush&, const QPen&);
 
    // Destructor
    virtual ~QwtSymbol();
 
    // Set cache policy
    void setCachePolicy(CachePolicy);
    // Get cache policy
    CachePolicy cachePolicy() const;
 
    // Set size
    void setSize(const QSize&);
    // Set size with width and height
    void setSize(int width, int height = -1);
    // Get size
    const QSize& size() const;
 
    // Set pin point
    void setPinPoint(const QPointF& pos, bool enable = true);
    // Get pin point
    QPointF pinPoint() const;
 
    // Enable/disable pin point
    void setPinPointEnabled(bool);
    // Check if pin point is enabled
    bool isPinPointEnabled() const;
 
    // Set color
    virtual void setColor(const QColor&);
 
    // Set brush
    void setBrush(const QBrush&);
    // Get brush
    const QBrush& brush() const;
 
    // Set pen with color, width and style
    void setPen(const QColor&, qreal width = 0.0, Qt::PenStyle = Qt::SolidLine);
    // Set pen
    void setPen(const QPen&);
    // Get pen
    const QPen& pen() const;
 
    // Set style
    void setStyle(Style);
    // Get style
    Style style() const;
 
    // Set painter path
    void setPath(const QPainterPath&);
    // Get painter path
    const QPainterPath& path() const;
 
    // Set pixmap
    void setPixmap(const QPixmap&);
    // Get pixmap
    const QPixmap& pixmap() const;
 
    // Set graphic
    void setGraphic(const QwtGraphic&);
    // Get graphic
    const QwtGraphic& graphic() const;
 
#ifndef QWT_NO_SVG
    // Set SVG document
    void setSvgDocument(const QByteArray&);
#endif
 
    // Draw symbol in rectangle
    void drawSymbol(QPainter*, const QRectF&) const;
    // Draw symbol at point
    void drawSymbol(QPainter*, const QPointF&) const;
    // Draw symbols at polygon points
    void drawSymbols(QPainter*, const QPolygonF&) const;
    // Draw symbols at points
    void drawSymbols(QPainter*, const QPointF*, int numPoints) const;
 
    // Get bounding rectangle
    virtual QRect boundingRect() const;
    // Invalidate cache
    void invalidateCache();
 
protected:
    virtual void renderSymbols(QPainter*, const QPointF*, int numPoints) const;
 
private:
    QwtSymbol(const QwtSymbol&)            = delete;
    QwtSymbol& operator=(const QwtSymbol&) = delete;
    QWT_DECLARE_PRIVATE(QwtSymbol)
};
 
inline void QwtSymbol::drawSymbol(QPainter* painter, const QPointF& pos) const
{
    drawSymbols(painter, &pos, 1);
}
 
inline void QwtSymbol::drawSymbols(QPainter* painter, const QPolygonF& points) const
{
    drawSymbols(painter, points.data(), points.size());
}
 
#endif