Chris@58: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@0: 
Chris@0: /*
Chris@59:     Sonic Visualiser
Chris@59:     An audio file viewer and annotation editor.
Chris@59:     Centre for Digital Music, Queen Mary, University of London.
Chris@59:     This file copyright 2006 Chris Cannam.
Chris@0:     
Chris@59:     This program is free software; you can redistribute it and/or
Chris@59:     modify it under the terms of the GNU General Public License as
Chris@59:     published by the Free Software Foundation; either version 2 of the
Chris@59:     License, or (at your option) any later version.  See the file
Chris@59:     COPYING included with this distribution for more information.
Chris@0: */
Chris@0: 
Chris@1227: #ifndef SV_TIME_VALUE_LAYER_H
Chris@1227: #define SV_TIME_VALUE_LAYER_H
Chris@0: 
Chris@287: #include "SingleColourLayer.h"
Chris@696: #include "VerticalScaleLayer.h"
Chris@699: #include "ColourScaleLayer.h"
Chris@699: 
Chris@128: #include "data/model/SparseTimeValueModel.h"
Chris@0: 
Chris@0: #include <QObject>
Chris@0: #include <QColor>
Chris@0: 
Chris@0: class View;
Chris@0: class QPainter;
Chris@0: 
Chris@699: class TimeValueLayer : public SingleColourLayer, 
Chris@699:                        public VerticalScaleLayer, 
Chris@699:                        public ColourScaleLayer
Chris@0: {
Chris@0:     Q_OBJECT
Chris@0: 
Chris@0: public:
Chris@44:     TimeValueLayer();
Chris@0: 
Chris@916:     virtual void paint(LayerGeometryProvider *v, QPainter &paint, QRect rect) const;
Chris@0: 
Chris@918:     virtual int getVerticalScaleWidth(LayerGeometryProvider *v, bool, QPainter &) const;
Chris@918:     virtual void paintVerticalScale(LayerGeometryProvider *v, bool, QPainter &paint, QRect rect) const;
Chris@42: 
Chris@918:     virtual QString getFeatureDescription(LayerGeometryProvider *v, QPoint &) const;
Chris@909:     virtual QString getLabelPreceding(sv_frame_t) const;
Chris@0: 
Chris@918:     virtual bool snapToFeatureFrame(LayerGeometryProvider *v, sv_frame_t &frame,
Chris@805: 				    int &resolution,
Chris@28: 				    SnapType snap) const;
Chris@918:     virtual bool snapToSimilarFeature(LayerGeometryProvider *v, sv_frame_t &frame,
Chris@805:                                       int &resolution,
Chris@517:                                       SnapType snap) const;
Chris@13: 
Chris@918:     virtual void drawStart(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void drawDrag(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void drawEnd(LayerGeometryProvider *v, QMouseEvent *);
Chris@21: 
Chris@918:     virtual void eraseStart(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void eraseDrag(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void eraseEnd(LayerGeometryProvider *v, QMouseEvent *);
Chris@335: 
Chris@918:     virtual void editStart(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void editDrag(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void editEnd(LayerGeometryProvider *v, QMouseEvent *);
Chris@21: 
Chris@918:     virtual bool editOpen(LayerGeometryProvider *v, QMouseEvent *);
Chris@70: 
Chris@905:     virtual void moveSelection(Selection s, sv_frame_t newStartFrame);
Chris@43:     virtual void resizeSelection(Selection s, Selection newSize);
Chris@76:     virtual void deleteSelection(Selection s);
Chris@76: 
Chris@918:     virtual void copy(LayerGeometryProvider *v, Selection s, Clipboard &to);
Chris@918:     virtual bool paste(LayerGeometryProvider *v, const Clipboard &from, sv_frame_t frameOffset,
Chris@125:                        bool interactive);
Chris@43: 
Chris@0:     virtual const Model *getModel() const { return m_model; }
Chris@0:     void setModel(SparseTimeValueModel *model);
Chris@0: 
Chris@0:     virtual PropertyList getProperties() const;
Chris@87:     virtual QString getPropertyLabel(const PropertyName &) const;
Chris@515:     virtual QString getPropertyIconName(const PropertyName &) const;
Chris@0:     virtual PropertyType getPropertyType(const PropertyName &) const;
Chris@198:     virtual QString getPropertyGroupName(const PropertyName &) const;
Chris@0:     virtual int getPropertyRangeAndValue(const PropertyName &,
Chris@216:                                          int *min, int *max, int *deflt) const;
Chris@0:     virtual QString getPropertyValueLabel(const PropertyName &,
Chris@0: 					  int value) const;
Chris@0:     virtual void setProperty(const PropertyName &, int value);
Chris@0: 
Chris@197:     void setFillColourMap(int);
Chris@197:     int getFillColourMap() const { return m_colourMap; }
Chris@197: 
Chris@26:     enum PlotStyle {
Chris@26: 	PlotPoints,
Chris@26: 	PlotStems,
Chris@26: 	PlotConnectedPoints,
Chris@26: 	PlotLines,
Chris@26: 	PlotCurve,
Chris@615: 	PlotSegmentation,
Chris@615:         PlotDiscreteCurves
Chris@26:     };
Chris@0: 
Chris@0:     void setPlotStyle(PlotStyle style);
Chris@0:     PlotStyle getPlotStyle() const { return m_plotStyle; }
Chris@0: 
Chris@66:     enum VerticalScale {
Chris@101:         AutoAlignScale,
Chris@66:         LinearScale,
Chris@66:         LogScale,
Chris@101:         PlusMinusOneScale
Chris@66:     };
Chris@66:     
Chris@66:     void setVerticalScale(VerticalScale scale);
Chris@66:     VerticalScale getVerticalScale() const { return m_verticalScale; }
Chris@66: 
Chris@513:     void setDrawSegmentDivisions(bool);
Chris@513:     bool getDrawSegmentDivisions() const { return m_drawSegmentDivisions; }
Chris@513: 
Chris@553:     void setShowDerivative(bool);
Chris@553:     bool getShowDerivative() const { return m_derivative; }
Chris@553: 
Chris@918:     virtual bool isLayerScrollable(const LayerGeometryProvider *v) const;
Chris@0: 
Chris@23:     virtual bool isLayerEditable() const { return true; }
Chris@23: 
Chris@918:     virtual int getCompletion(LayerGeometryProvider *) const { return m_model->getCompletion(); }
Chris@0: 
Chris@79:     virtual bool needsTextLabelHeight() const {
Chris@81:         return m_plotStyle == PlotSegmentation && m_model->hasTextLabels();
Chris@79:     }
Chris@79: 
Chris@905:     virtual bool getValueExtents(double &min, double &max,
Chris@101:                                  bool &logarithmic, QString &unit) const;
Chris@101: 
Chris@905:     virtual bool getDisplayExtents(double &min, double &max) const;
Chris@905:     virtual bool setDisplayExtents(double min, double max);
Chris@437: 
Chris@437:     virtual int getVerticalZoomSteps(int &defaultStep) const;
Chris@437:     virtual int getCurrentVerticalZoomStep() const;
Chris@437:     virtual void setVerticalZoomStep(int);
Chris@437:     virtual RangeMapper *getNewVerticalZoomRangeMapper() const;
Chris@79: 
Chris@316:     virtual void toXml(QTextStream &stream, QString indent = "",
Chris@316:                        QString extraAttributes = "") const;
Chris@6: 
Chris@11:     void setProperties(const QXmlAttributes &attributes);
Chris@11: 
Chris@1205:     /// Override from SingleColourLayer
Chris@494:     virtual ColourSignificance getLayerColourSignificance() const {
Chris@494:         if (m_plotStyle == PlotSegmentation) {
Chris@494:             return ColourHasMeaningfulValue;
Chris@494:         } else {
Chris@494:             return ColourDistinguishes;
Chris@494:         }
Chris@494:     }
Chris@494: 
Chris@1205:     /// Override from SingleColourLayer
Chris@1205:     virtual bool hasLightBackground() const {
Chris@1205:         if (m_plotStyle == PlotSegmentation) {
Chris@1205:             return true;
Chris@1205:         } else {
Chris@1205:             return SingleColourLayer::hasLightBackground();
Chris@1205:         }
Chris@1205:     }
Chris@1205: 
Chris@699:     /// VerticalScaleLayer and ColourScaleLayer methods
Chris@918:     virtual int getYForValue(LayerGeometryProvider *, double value) const;
Chris@918:     virtual double getValueForY(LayerGeometryProvider *, int y) const;
Chris@696:     virtual QString getScaleUnits() const;
Chris@918:     virtual QColor getColourForValue(LayerGeometryProvider *v, double value) const;
Chris@696: 
Chris@0: protected:
Chris@918:     void getScaleExtents(LayerGeometryProvider *, double &min, double &max, bool &log) const;
Chris@296:     bool shouldAutoAlign() const;
Chris@68: 
Chris@918:     SparseTimeValueModel::PointList getLocalPoints(LayerGeometryProvider *v, int) const;
Chris@0: 
Chris@287:     virtual int getDefaultColourHint(bool dark, bool &impose);
Chris@287: 
Chris@0:     SparseTimeValueModel *m_model;
Chris@21:     bool m_editing;
Chris@23:     SparseTimeValueModel::Point m_originalPoint;
Chris@21:     SparseTimeValueModel::Point m_editingPoint;
Chris@22:     SparseTimeValueModel::EditCommand *m_editingCommand;
Chris@197:     int m_colourMap;
Chris@0:     PlotStyle m_plotStyle;
Chris@66:     VerticalScale m_verticalScale;
Chris@513:     bool m_drawSegmentDivisions;
Chris@553:     bool m_derivative;
Chris@376: 
Chris@905:     mutable double m_scaleMinimum;
Chris@905:     mutable double m_scaleMaximum;
Chris@437: 
Chris@376:     void finish(SparseTimeValueModel::EditCommand *command) {
Chris@376:         Command *c = command->finish();
Chris@376:         if (c) CommandHistory::getInstance()->addCommand(c, false);
Chris@376:     }
Chris@0: };
Chris@0: 
Chris@0: #endif
Chris@0: