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@30: #ifndef _TIME_INSTANT_LAYER_H_
Chris@30: #define _TIME_INSTANT_LAYER_H_
Chris@0: 
Chris@287: #include "SingleColourLayer.h"
Chris@128: #include "data/model/SparseOneDimensionalModel.h"
Chris@0: 
Chris@0: #include <QObject>
Chris@0: #include <QColor>
Chris@0: 
Chris@0: class View;
Chris@0: class QPainter;
Chris@0: 
Chris@287: class TimeInstantLayer : public SingleColourLayer
Chris@0: {
Chris@0:     Q_OBJECT
Chris@0: 
Chris@0: public:
Chris@44:     TimeInstantLayer();
Chris@308:     virtual ~TimeInstantLayer();
Chris@0: 
Chris@916:     virtual void paint(LayerGeometryProvider *v, QPainter &paint, QRect rect) const;
Chris@0: 
Chris@909:     virtual QString getLabelPreceding(sv_frame_t) const;
Chris@918:     virtual QString getFeatureDescription(LayerGeometryProvider *v, QPoint &) const;
Chris@0: 
Chris@918:     virtual bool snapToFeatureFrame(LayerGeometryProvider *v, sv_frame_t &frame,
Chris@1266:                                     int &resolution,
Chris@1266:                                     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@17: 
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@18: 
Chris@918:     virtual bool editOpen(LayerGeometryProvider *, QMouseEvent *);
Chris@70: 
Chris@905:     virtual void moveSelection(Selection s, sv_frame_t newStartFrame);
Chris@43:     virtual void resizeSelection(Selection s, Selection newSize);
Chris@43:     virtual void deleteSelection(Selection s);
Chris@43: 
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@76: 
Chris@0:     virtual const Model *getModel() const { return m_model; }
Chris@0:     void setModel(SparseOneDimensionalModel *model);
Chris@0: 
Chris@0:     virtual PropertyList getProperties() const;
Chris@87:     virtual QString getPropertyLabel(const PropertyName &) const;
Chris@0:     virtual PropertyType getPropertyType(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@1266:                                           int value) const;
Chris@0:     virtual void setProperty(const PropertyName &, int value);
Chris@0: 
Chris@28:     enum PlotStyle {
Chris@1266:         PlotInstants,
Chris@1266:         PlotSegmentation
Chris@28:     };
Chris@28: 
Chris@28:     void setPlotStyle(PlotStyle style);
Chris@28:     PlotStyle getPlotStyle() const { return m_plotStyle; }
Chris@28: 
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@81:     virtual bool needsTextLabelHeight() const { return m_model->hasTextLabels(); }
Chris@79: 
Chris@905:     virtual bool getValueExtents(double &, double &, bool &, QString &) const {
Chris@79:         return false;
Chris@79:     }
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@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@918:     virtual int getVerticalScaleWidth(LayerGeometryProvider *, bool, QPainter &) const { return 0; }
Chris@607: 
Chris@0: protected:
Chris@918:     SparseOneDimensionalModel::PointList getLocalPoints(LayerGeometryProvider *v, int) const;
Chris@0: 
Chris@287:     virtual int getDefaultColourHint(bool dark, bool &impose);
Chris@287: 
Chris@918:     bool clipboardAlignmentDiffers(LayerGeometryProvider *v, const Clipboard &) const;
Chris@358: 
Chris@0:     SparseOneDimensionalModel *m_model;
Chris@18:     bool m_editing;
Chris@17:     SparseOneDimensionalModel::Point m_editingPoint;
Chris@22:     SparseOneDimensionalModel::EditCommand *m_editingCommand;
Chris@28:     PlotStyle m_plotStyle;
Chris@376: 
Chris@376:     void finish(SparseOneDimensionalModel::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: