CallbackAxisPointsAbstract.h

Go to the documentation of this file.

/******************************************************************************************************
 * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released      *
 * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *
 * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission.     *
 ******************************************************************************************************/
 
#ifndef CALLBACK_AXIS_POINTS_ABSTRACT
#define CALLBACK_AXIS_POINTS_ABSTRACT
 
#include "CallbackSearchReturn.h"
#include "DocumentAxesPointsRequired.h"
#include "DocumentModelCoords.h"
#include <QList>
#include <QString>
#include <QTransform>
 
typedef QList<QPointF> CoordPairVector;
typedef QList<double> CoordSingleVector;
 
class Point;

class CallbackAxisPointsAbstract
{
  friend class TestGraphCoords;
 
public:
  CallbackAxisPointsAbstract(const DocumentModelCoords &modelCoords,
                             DocumentAxesPointsRequired documentAxesPointsRequired);

  CallbackAxisPointsAbstract(const DocumentModelCoords &modelCoords,
                             const QString pointIdentifierOverride,
                             const QPointF &posGraphOverride,
                             const QPointF &posScreenOverride,
                             DocumentAxesPointsRequired documentAxesPointsRequired);

  CallbackSearchReturn callback (const QString &curveName,
                                 const Point &point);

  QTransform matrixGraph () const;

  QTransform matrixScreen () const;

  double xGraphRange () const { return m_xGraphHigh - m_xGraphLow; }

  double yGraphRange () const { return m_yGraphHigh - m_yGraphLow; }
 
protected:

  DocumentAxesPointsRequired documentAxesPointsRequired() const;

  QString errorMessage () const { return m_errorMessage; }

  bool isError () const { return m_isError; }

  unsigned int numberAxisPoints () const;
 
private:
 
  enum LinearOrLog {
    COORD_IS_LINEAR,
    COORD_IS_LOG
  };

  bool anyPointsRepeatPair (const CoordPairVector &vector,
                            double epsilon) const;
  
  bool anyPointsRepeatSingle (const CoordSingleVector &vector,
                              double epsilon) const;
  CallbackSearchReturn callbackRequire2AxisPoints (const QPointF &posScreen,
                                                   const QPointF &posGraph);
  CallbackSearchReturn callbackRequire3AxisPoints (const QPointF &posScreen,
                                                   const QPointF &posGraph);
  CallbackSearchReturn callbackRequire4AxisPoints (bool isXOnly,
                                                   const QPointF &posScreen,
                                                   const QPointF &posGraph);
  void computeTransforms3();
  void computeTransforms4();
  void loadTransforms2();
  void loadTransforms3();
  void loadTransforms4();
  LinearOrLog logXGraph () const;
  LinearOrLog logYGraph () const;
  bool threePointsAreCollinear (const QTransform &transform,
                                LinearOrLog logX,
                                LinearOrLog logY) const;
 
  // Coordinates information that will be applied to the coordinates before they are used to compute the transformation
  DocumentModelCoords m_modelCoords;
 
  // For overriding one existing Point. Identifier is empty for no overriding
  QString m_pointIdentifierOverride;
  QPointF m_posScreenOverride;
  QPointF m_posGraphOverride;
 
  // Storage of (x,y) axes points for DOCUMENT_AXES_POINTS_REQUIRED_3
  CoordPairVector m_screenInputs;
  CoordPairVector m_graphOutputs;
 
  // Storage of (x) and (y) axes points for DOCUMENT_AXES_POINTS_REQUIRED_4
  CoordPairVector m_screenInputsX; // Accumulated screen coordinates for x axis points
  CoordPairVector m_screenInputsY; // Accumulated screen coordinates for y axis points
  CoordSingleVector m_graphOutputsX; // Accumulated x values for x axis points
  CoordSingleVector m_graphOutputsY; // Accumulated y values for y axis points
 
  // Transforms computed from DOCUMENT_AXES_POINTS_REQUIRED_3 or DOCUMENT_AXES_POINTS_REQUIRED_4 variables
  QTransform m_screenInputsTransform;
  QTransform m_graphOutputsTransform;
 
  // Errors
  bool m_isError;
  QString m_errorMessage;
 
  // For computing the ranges of the graph coordinates
  double m_xGraphLow;
  double m_yGraphLow;
  double m_xGraphHigh;
  double m_yGraphHigh;
 
  // Either 3 points (each having x AND y coordinates) or 4 points (each having x OR y coordinate) define the transform
  DocumentAxesPointsRequired m_documentAxesPointsRequired;
};
 
#endif // CALLBACK_AXIS_POINTS_ABSTRACT