Chris@411: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@411: 
Chris@411: /*
Chris@411:     Sonic Visualiser
Chris@411:     An audio file viewer and annotation editor.
Chris@411:     Centre for Digital Music, Queen Mary, University of London.
Chris@411:     This file copyright 2006-2008 Chris Cannam and QMUL.
Chris@411:     
Chris@411:     This program is free software; you can redistribute it and/or
Chris@411:     modify it under the terms of the GNU General Public License as
Chris@411:     published by the Free Software Foundation; either version 2 of the
Chris@411:     License, or (at your option) any later version.  See the file
Chris@411:     COPYING included with this distribution for more information.
Chris@411: */
Chris@411: 
Chris@411: #ifndef _REGION_LAYER_H_
Chris@411: #define _REGION_LAYER_H_
Chris@411: 
Chris@411: #include "SingleColourLayer.h"
Chris@701: #include "VerticalScaleLayer.h"
Chris@701: #include "ColourScaleLayer.h"
Chris@701: 
Chris@411: #include "data/model/RegionModel.h"
Chris@411: 
Chris@411: #include <QObject>
Chris@411: #include <QColor>
Chris@411: 
Chris@433: #include <map>
Chris@433: 
Chris@411: class View;
Chris@411: class QPainter;
Chris@411: 
Chris@701: class RegionLayer : public SingleColourLayer,
Chris@701:                     public VerticalScaleLayer,
Chris@701:                     public ColourScaleLayer
Chris@411: {
Chris@411:     Q_OBJECT
Chris@411: 
Chris@411: public:
Chris@411:     RegionLayer();
Chris@411: 
Chris@916:     virtual void paint(LayerGeometryProvider *v, QPainter &paint, QRect rect) const;
Chris@411: 
Chris@918:     virtual int getVerticalScaleWidth(LayerGeometryProvider *v, bool, QPainter &) const;
Chris@918:     virtual void paintVerticalScale(LayerGeometryProvider *v, bool, QPainter &paint, QRect rect) const;
Chris@701: 
Chris@918:     virtual QString getFeatureDescription(LayerGeometryProvider *v, QPoint &) const;
Chris@909:     virtual QString getLabelPreceding(sv_frame_t) const;
Chris@411: 
Chris@918:     virtual bool snapToFeatureFrame(LayerGeometryProvider *v, sv_frame_t &frame,
Chris@1266:                                     int &resolution,
Chris@1266:                                     SnapType snap) const;
Chris@918:     virtual bool snapToSimilarFeature(LayerGeometryProvider *v, sv_frame_t &frame,
Chris@805:                                       int &resolution,
Chris@559:                                       SnapType snap) const;
Chris@411: 
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@411: 
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@411: 
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@411: 
Chris@918:     virtual bool editOpen(LayerGeometryProvider *v, QMouseEvent *);
Chris@411: 
Chris@905:     virtual void moveSelection(Selection s, sv_frame_t newStartFrame);
Chris@411:     virtual void resizeSelection(Selection s, Selection newSize);
Chris@411:     virtual void deleteSelection(Selection s);
Chris@411: 
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@411:                        bool interactive);
Chris@411: 
Chris@411:     virtual const Model *getModel() const { return m_model; }
Chris@411:     void setModel(RegionModel *model);
Chris@411: 
Chris@411:     virtual PropertyList getProperties() const;
Chris@411:     virtual QString getPropertyLabel(const PropertyName &) const;
Chris@411:     virtual PropertyType getPropertyType(const PropertyName &) const;
Chris@411:     virtual QString getPropertyGroupName(const PropertyName &) const;
Chris@411:     virtual int getPropertyRangeAndValue(const PropertyName &,
Chris@411:                                          int *min, int *max, int *deflt) const;
Chris@411:     virtual QString getPropertyValueLabel(const PropertyName &,
Chris@1266:                                           int value) const;
Chris@411:     virtual void setProperty(const PropertyName &, int value);
Chris@411: 
Chris@427:     void setFillColourMap(int);
Chris@427:     int getFillColourMap() const { return m_colourMap; }
Chris@427: 
Chris@411:     enum VerticalScale {
Chris@411:         AutoAlignScale,
Chris@433:         EqualSpaced,
Chris@411:         LinearScale,
Chris@411:         LogScale,
Chris@411:     };
Chris@411: 
Chris@411:     void setVerticalScale(VerticalScale scale);
Chris@411:     VerticalScale getVerticalScale() const { return m_verticalScale; }
Chris@411: 
Chris@412:     enum PlotStyle {
Chris@1266:         PlotLines,
Chris@1266:         PlotSegmentation
Chris@412:     };
Chris@412: 
Chris@412:     void setPlotStyle(PlotStyle style);
Chris@412:     PlotStyle getPlotStyle() const { return m_plotStyle; }
Chris@412: 
Chris@918:     virtual bool isLayerScrollable(const LayerGeometryProvider *v) const;
Chris@411: 
Chris@411:     virtual bool isLayerEditable() const { return true; }
Chris@411: 
Chris@918:     virtual int getCompletion(LayerGeometryProvider *) const { return m_model->getCompletion(); }
Chris@411: 
Chris@905:     virtual bool getValueExtents(double &min, double &max,
Chris@411:                                  bool &log, QString &unit) const;
Chris@411: 
Chris@905:     virtual bool getDisplayExtents(double &min, double &max) const;
Chris@411: 
Chris@411:     virtual void toXml(QTextStream &stream, QString indent = "",
Chris@411:                        QString extraAttributes = "") const;
Chris@411: 
Chris@701:     void setProperties(const QXmlAttributes &attributes);
Chris@607: 
Chris@701:     /// VerticalScaleLayer and ColourScaleLayer methods
Chris@918:     int getYForValue(LayerGeometryProvider *v, double value) const;
Chris@918:     double getValueForY(LayerGeometryProvider *v, int y) const;
Chris@701:     virtual QString getScaleUnits() const;
Chris@918:     QColor getColourForValue(LayerGeometryProvider *v, double value) const;
Chris@411: 
Chris@433: protected slots:
Chris@433:     void recalcSpacing();
Chris@433: 
Chris@411: protected:
Chris@918:     double getValueForY(LayerGeometryProvider *v, int y, int avoid) const;
Chris@918:     void getScaleExtents(LayerGeometryProvider *, double &min, double &max, bool &log) const;
Chris@411: 
Chris@411:     virtual int getDefaultColourHint(bool dark, bool &impose);
Chris@411: 
Chris@918:     RegionModel::PointList getLocalPoints(LayerGeometryProvider *v, int x) const;
Chris@550: 
Chris@918:     bool getPointToDrag(LayerGeometryProvider *v, int x, int y, RegionModel::Point &) const;
Chris@411: 
Chris@411:     RegionModel *m_model;
Chris@411:     bool m_editing;
Chris@551:     int m_dragPointX;
Chris@551:     int m_dragPointY;
Chris@551:     int m_dragStartX;
Chris@551:     int m_dragStartY;
Chris@411:     RegionModel::Point m_originalPoint;
Chris@411:     RegionModel::Point m_editingPoint;
Chris@411:     RegionModel::EditCommand *m_editingCommand;
Chris@411:     VerticalScale m_verticalScale;
Chris@427:     int m_colourMap;
Chris@412:     PlotStyle m_plotStyle;
Chris@411: 
Chris@905:     typedef std::map<double, int> SpacingMap;
Chris@551: 
Chris@542:     // region value -> ordering
Chris@433:     SpacingMap m_spacingMap;
Chris@433: 
Chris@551:     // region value -> number of regions with this value
Chris@551:     SpacingMap m_distributionMap;
Chris@551: 
Chris@918:     int spacingIndexToY(LayerGeometryProvider *v, int i) const;
Chris@918:     double yToSpacingIndex(LayerGeometryProvider *v, int y) const;
Chris@542: 
Chris@411:     void finish(RegionModel::EditCommand *command) {
Chris@411:         Command *c = command->finish();
Chris@411:         if (c) CommandHistory::getInstance()->addCommand(c, false);
Chris@411:     }
Chris@411: };
Chris@411: 
Chris@411: #endif
Chris@411: