frameitem.h

/***************************************************************************
                          frameitem.h  -  description
                             -------------------
 
    This file is a part of kpl - a program for graphical presentation of
    data sets and functions.
 
    begin                : Sun Aug 29 1999
    copyright            : (C) 2024 by Werner Stille
    email                : kpl@werner-stille.de
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program 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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef FRAMEITEM_H
#define FRAMEITEM_H
 
#include <math.h>
#include <QGraphicsRectItem>
#include "textitem.h"
 
class Q_DECL_EXPORT FrameItem : public KplItem, public QGraphicsRectItem
{
public:
  enum GridMode {
    FrameOnly,      
    Axes,           
    AxesWithLabels, 
    Grid,           
    GridWithLabels  
  };
  enum {
    Type = UserType + Frame
  };
  FrameItem(double x0 = 4, double y0 = 3, double width = 15,
            double height = 10,  unsigned colorFrame = 0,
            unsigned colorGrid = 0, bool logX = false, bool logY = false,
            GridMode gridMode = AxesWithLabels, double xMax = 15,
            double yMax = 10, const QString& textX = QString(),
            const QString& textY = QString(),
            const QString& header = QString(), double relSize = 1,
            int numDigX = -1, int numDigY = -1, int minTicX = 5,
            int minTicY = 2, int expX = 0, int expY = 0, double xMin = 0,
            double yMin = 0, double xTic = 5, double yTic = 2,
            bool collapsed = false, bool visible = true, double xOffset = 0,
            double yOffset = 0, bool xBottom = true, bool xTop = false,
            bool yLeft = true, bool yRight = false);
  FrameItem(const FrameItem& a);
  FrameItem(const KConfigGroup* plo, double x0 = 4, double y0 = 3,
            double width = 15, double height = 10, unsigned colorFrame = 0,
            unsigned colorGrid = 0, GridMode gridMode = AxesWithLabels);
  virtual ~FrameItem();
  static void autoScale(double& xMin, double& xMax, double& tick, int& minTic,
                        int& numDig, double xmi, double xma, double f,
                        double c, bool log);
  void autoScale(double xmi, double xma, double fx, double ymi, double yma,
                 double fy);
  void autoScale(bool autoNorm = true);
  virtual QRectF boundingRect() const override;
  bool calcAutoScale(bool autoNorm, const QList<QGraphicsItem*>& items,
                     double& fx, double& fy);
  inline QRectF clipRect() const { return cRect; };
  inline unsigned colorFrame() const { return m_colorFrame; };
  inline unsigned colorGrid() const { return m_colorGrid; };
  inline int expX() const { return m_expX; };
  inline int expY() const { return m_expY; };
  inline GridMode gridMode() const { return m_gridMode; };
  inline QString header() const { return m_header; };
  inline double height() const { return m_height; };
  inline bool collapsed() const { return m_collapsed; };
  inline bool logX() const { return m_logX; };
  inline bool logY() const { return m_logY; };
  QPointF mapFromUser(const QPointF& p) const;
  QPointF mapToUser(const QPointF& p) const;
  QRectF mapToUser(const QRectF& rect) const;
  inline int minTicX() const { return m_minTicX; };
  inline int minTicY() const { return m_minTicY; };
  inline double normX() const { return m_normX; };
  inline double normY() const { return m_normY; };
  inline int numDigX() const { return m_numDigX; };
  inline int numDigY() const { return m_numDigY; };
  virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option,
                     QWidget* widget = nullptr) override;
  QPointF rectPos() const;
  inline void setColorFrame(unsigned color) { m_colorFrame = color; };
  inline void setColorGrid(unsigned color) { m_colorGrid = color; };
  inline void setExpX(int expX) { m_expX = expX; m_normX = pow(10, expX); };
  inline void setExpY(int expY) { m_expY = expY; m_normY = pow(10, expY); };
  inline void setGridMode(GridMode gridMode) { m_gridMode = gridMode; };
  inline void setHeight(double height) { m_height = height; };
  inline void setLogX(bool logX) { m_logX = logX; };
  inline void setLogY(bool logY) { m_logY = logY; };
  inline void setMinTicX(int minTicX) { m_minTicX = minTicX; };
  inline void setMinTicY(int minTicY) { m_minTicY = minTicY; };
  inline void setNumDigX(int numDigX) { m_numDigX = numDigX; };
  inline void setNumDigY(int numDigY) { m_numDigY = numDigY; };
  void setProperties(const QTransform& m);
  inline void setHeader(const QString& text) { m_header = text; };
  inline void setTextX(const QString& text) { m_textX = text; };
  inline void setTextY(const QString& text) { m_textY = text; };
  inline void setWidth(double width) { m_width = width; };
  inline void setX0(double x0) { m_x0 = x0; };
  inline void setXBottom(bool xBottom) { m_xBottom = xBottom; };
  inline void setXMax(double xMax) { m_xMax = xMax; };
  inline void setXMin(double xMin) { m_xMin = xMin; };
  inline void setXOffset(double xOffset) { m_xOffset = xOffset; };
  inline void setXTic(double xTic) { m_xTic = xTic; };
  inline void setXTop(bool xTop) { m_xTop = xTop; };
  inline void setY0(double y0) { m_y0 = y0; };
  inline void setYLeft(bool yLeft) { m_yLeft = yLeft; };
  inline void setYMax(double yMax) { m_yMax = yMax; };
  inline void setYMin(double yMin) { m_yMin = yMin; };
  inline void setYOffset(double yOffset) { m_yOffset = yOffset; };
  inline void setYRight(bool yRight) { m_yRight = yRight; };
  inline void setYTic(double yTic) { m_yTic = yTic; };
  QPointF steps() const;
  inline QString textX() const { return m_textX; };
  inline QString textY() const { return m_textY; };
  virtual int type() const override { return Type; };
  inline void toggleCollapsed() { m_collapsed = !m_collapsed; };
  void update();
  void updatePos(QPointF p);
  static inline bool valid(double v, bool log = false)
    { return (v == v) && (fabs(v) <= 1e300) && ((!log) || (v > 0)); };
  bool valid(double x, double y) const;
  inline double width() const { return m_width; };
  void writePlo(KConfigGroup* plo) const;
  inline double x0() const { return m_x0; };
  inline bool xBottom() const { return m_xBottom; };
  inline double xMax() const { return m_xMax; };
  inline double xMin() const { return m_xMin; };
  inline double xOffset() const { return m_xOffset; };
  inline double xTic() const { return m_xTic; };
  inline bool xTop() const { return m_xTop; };
  inline double y0() const { return m_y0; };
  inline bool yLeft() const { return m_yLeft; };
  inline bool yRight() const { return m_yRight; };
  inline double yMax() const { return m_yMax; };
  inline double yMin() const { return m_yMin; };
  inline double yOffset() const { return m_yOffset; };
  inline double yTic() const { return m_yTic; };
 
protected:
  void drawText(QPainter* painter, const QString& text, double x, double y,
                TextItem::Alignment alignment, double dir = 0) const;
  double incLog(double& x, double f) const;
  virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent* event) override;
  int number(double v, int numDig, QString& label) const;
  void paintCond(QPainter* painter) const;
  void setProperties();
  double tick(double tic, bool log) const;
  bool m_logX, m_logY, m_xBottom, m_xTop, m_yLeft, m_yRight, m_collapsed;
  int m_numDigX, m_numDigY, m_minTicX, m_minTicY, m_expX, m_expY;
  GridMode m_gridMode;
  unsigned m_colorFrame, m_colorGrid;
  double m_x0, m_y0, m_width, m_height, m_xMin, m_xMax, m_yMin, m_yMax, m_xTic,
    m_yTic, m_xOffset, m_yOffset, m_normX, m_normY, xminl, xmaxl, yminl, ymaxl;
  QString m_textX, m_textY, m_header;
  mutable QRectF bRect;
  QRectF cRect;
  QTransform md, m_inv, m_matrix;
};
 
#endif