File indexing completed on 2024-12-22 04:17:39

 /***************************************************************************
  *                                                                         *
  *   copyright : (C) 2007 The University of Toronto                        *
  *                   netterfield@astro.utoronto.ca                         *
  *                                                                         *
  *   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 PLOTAXIS_H
 #define PLOTAXIS_H
 
 #include <QObject>
 
 #include "plotitem.h"
 #include "plotmarkers.h"
 #include "ksttimezone.h"
 #include "plottickcalculator.h"
 
 namespace Kst {
 
 class PlotAxis : public QObject
 {
   Q_OBJECT
   public:
 
     enum ZoomMode { Auto, AutoBorder, FixedExpression, SpikeInsensitive, MeanCentered };
 
     PlotAxis(PlotItem *plotItem, Qt::Orientation orientation);
     ~PlotAxis();
 
     PlotItem* plotItem() { return _plotItem; }
 
     bool isAxisVisible() const;
     void setAxisVisible(bool visible);
 
     MajorTickMode axisMajorTickMode() const;
     void setAxisMajorTickMode(MajorTickMode mode);
 
     int axisMinorTickCount() const;
     void setAxisMinorTickCount(const int count);
 
     bool axisAutoMinorTicks() const;
     void setAxisAutoMinorTicks(const bool enabled);
 
     bool drawAxisMajorTicks() const;
     void setDrawAxisMajorTicks(const bool draw);
 
     bool drawAxisMinorTicks() const;
     void setDrawAxisMinorTicks(const bool draw);
 
     bool drawAxisMajorGridLines() const;
     void setDrawAxisMajorGridLines(const bool draw);
 
     bool drawAxisMinorGridLines() const;
     void setDrawAxisMinorGridLines(const bool draw);
 
     QColor axisMajorGridLineColor() const;
     void setAxisMajorGridLineColor(const QColor &color);
 
     QColor axisMinorGridLineColor() const;
     void setAxisMinorGridLineColor(const QColor &color);
 
     Qt::PenStyle axisMajorGridLineStyle() const;
     void setAxisMajorGridLineStyle(const Qt::PenStyle style);
 
     Qt::PenStyle axisMinorGridLineStyle() const;
     void setAxisMinorGridLineStyle(const Qt::PenStyle style);
 
     qreal axisMajorGridLineWidth() const;
     void setAxisMajorGridLineWidth(qreal width);
 
     qreal axisMinorGridLineWidth() const;
     void setAxisMinorGridLineWidth(qreal width);
 
     int axisSignificantDigits() const;
     void setAxisSignificantDigits(const int digits);
 
     ZoomMode axisZoomMode() const;
     void setAxisZoomMode(ZoomMode mode);
 
     bool axisLog() const;
     void setAxisLog(bool log);
 
     bool axisReversed() const;
     void setAxisReversed(const bool enabled);
 
     bool axisAutoBaseOffset() const;
     void setAxisAutoBaseOffset(const bool enabled);
 
     bool axisBaseOffset() const;
     void setAxisBaseOffset(const bool enabled);
 
     bool axisForceOffsetMin() const {return _axisForceOffsetMin;}
     void setAxisForceOffsetMin(bool enabled);
 
     bool axisInterpret() const;
     void setAxisInterpret(const bool enabled);
 
     QString timezoneName() const;
     void setTimezoneName(QString timezone);
 
     AxisDisplayType axisDisplay() const;
     void setAxisDisplay(const AxisDisplayType display);
 
     QString axisDisplayFormatString() const;
     void setAxisDisplayFormatString(const QString& formatString);
 
     AxisInterpretationType axisInterpretation() const;
     void setAxisInterpretation(const AxisInterpretationType interpret);
 
     int axisLabelRotation() const;
     void setAxisLabelRotation(const int rotation);
 
     PlotMarkers axisPlotMarkers() { return _axisPlotMarkers; }
     void setAxisPlotMarkers(const PlotMarkers &plotMarkers) { _axisPlotMarkers = plotMarkers; _ticksUpdated = true; }
 
     QMap<double, QString> axisLabels() { return _axisLabels; }
     QList<double> axisMajorTicks() { return _axisMajorTicks; }
     QList<double> axisMinorTicks() { return _axisMinorTicks; }
     QString baseLabel() { return _baseLabel; }
 
     void saveInPlot(QXmlStreamWriter &xml, QString axisId);
     bool configureFromXml(QXmlStreamReader &xml, ObjectStore *store);
 
     void validateDrawingRegion(QPainter *painter);
 
     // return the value and reset.
     bool ticksUpdated() { bool bReturn = _ticksUpdated; _ticksUpdated = false; return bReturn; }
     bool isDirty() { return _dirty; }
 
     void copyProperties(PlotAxis *source);
 
     void saveAsDialogDefaults(const QString &group) const;
 
     QString statusBarString(double X);
 
     int nsZoomLevel() { return _ns_zoom_level;}
 
   public Q_SLOTS:
     void updateTicks(bool useOverrideTicks = false);
     void setTicksUpdated() { _ticksUpdated = true; }
 
   private:
     double convertTimeValueToJD(double valueIn);
     double convertJDtoCTime(double jdIn);
     double convertJDtoDisplayTime(double T);
     QString convertJDToDateString(double jday, double range_jd);
 
     void updateLogTicks(MajorTickMode tickMode);
     void updateInterpretTicks(MajorTickMode tickMode);
     void updateLinearTicks(MajorTickMode tickMode);
     bool isLinearTickMode();
     MajorTickMode convertToMajorTickMode(int tickCount, MajorTickMode old_mode = TicksVeryFine);
 
   private:
 
     PlotItem *_plotItem;
     Qt::Orientation _orientation;
 
     bool _dirty;
 
     ZoomMode _axisZoomMode;
     bool _isAxisVisible;
     int _ns_zoom_level;
 
     bool _ticksUpdated;
 
     QRectF _labelRect;
     QMap<double, QString> _axisLabels;
     QList<double> _axisMajorTicks;
     QList<double> _axisMinorTicks;
 
     QString _baseLabel;
 
     bool _axisLog;
     bool _axisReversed;
     bool _axisAutoBaseOffset;
     bool _axisBaseOffset;
     bool _axisBaseOffsetOverride;
     bool _axisForceOffsetMin;
 
     bool _axisInterpret;
     AxisDisplayType _axisDisplay;
     QString _axisDisplayFormatString;
     AxisInterpretationType _axisInterpretation;
     KstTimeZone _timeZone;
 
     MajorTickMode _axisMajorTickMode;
     MajorTickMode _axisOverrideMajorTicks;
 
     int _axisMinorTickCount;
     bool _automaticMinorTicks;
     int _automaticMinorTickCount;
 
     int _axisSignificantDigits;
 
     bool _drawAxisMajorTicks;
     bool _drawAxisMinorTicks;
     bool _drawAxisMajorGridLines;
     bool _drawAxisMinorGridLines;
 
     QColor _axisMajorGridLineColor;
     QColor _axisMinorGridLineColor;
 
     Qt::PenStyle _axisMajorGridLineStyle;
     Qt::PenStyle _axisMinorGridLineStyle;
 
     qreal _axisMajorGridLineWidth;
     qreal _axisMinorGridLineWidth;
 
     PlotMarkers _axisPlotMarkers;
 
     int _labelRotation;
 };
 
 
 }
 
 #endif
 
 // vim: ts=2 sw=2 et