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@182:     This file copyright 2006 Chris Cannam and QMUL.
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@0: #ifndef _COLOUR_3D_PLOT_H_
Chris@0: #define _COLOUR_3D_PLOT_H_
Chris@0: 
Chris@193: #include "SliceableLayer.h"
Chris@0: 
Chris@128: #include "data/model/DenseThreeDimensionalModel.h"
Chris@0: 
Chris@0: class View;
Chris@0: class QPainter;
Chris@0: class QImage;
Chris@0: 
Chris@0: /**
Chris@0:  * This is a view that displays dense 3-D data (time, some sort of
Chris@0:  * binned y-axis range, value) as a colour plot with value mapped to
Chris@0:  * colour range.  Its source is a DenseThreeDimensionalModel.
Chris@0:  *
Chris@0:  * This was the original implementation for the spectrogram view, but
Chris@0:  * it was replaced with a more efficient implementation that derived
Chris@0:  * the spectrogram itself from a DenseTimeValueModel instead of using
Chris@0:  * a three-dimensional model.  This class is retained in case it
Chris@0:  * becomes useful, but it will probably need some cleaning up if it's
Chris@0:  * ever actually used.
Chris@0:  */
Chris@0: 
Chris@193: class Colour3DPlotLayer : public SliceableLayer
Chris@0: {
Chris@0:     Q_OBJECT
Chris@0: 
Chris@0: public:
Chris@44:     Colour3DPlotLayer();
Chris@0:     ~Colour3DPlotLayer();
Chris@0: 
Chris@156:     virtual const ZoomConstraint *getZoomConstraint() const {
Chris@156:         return m_model ? m_model->getZoomConstraint() : 0;
Chris@156:     }
Chris@0:     virtual const Model *getModel() const { return m_model; }
Chris@44:     virtual void paint(View *v, QPainter &paint, QRect rect) const;
Chris@0: 
Chris@44:     virtual int getVerticalScaleWidth(View *v, QPainter &) const;
Chris@44:     virtual void paintVerticalScale(View *v, QPainter &paint, QRect rect) const;
Chris@25: 
Chris@44:     virtual QString getFeatureDescription(View *v, QPoint &) const;
Chris@25: 
Chris@44:     virtual bool snapToFeatureFrame(View *v, int &frame, 
Chris@28: 				    size_t &resolution,
Chris@28: 				    SnapType snap) const;
Chris@24: 
Chris@44:     virtual bool isLayerScrollable(const View *v) const;
Chris@25: 
Chris@287:     virtual ColourSignificance getLayerColourSignificance() const {
Chris@287:         return ColourHasMeaningfulValue;
Chris@287:     }
Chris@183: 
Chris@0:     void setModel(const DenseThreeDimensionalModel *model);
Chris@0: 
Chris@115:     virtual int getCompletion(View *) const { return m_model->getCompletion(); }
Chris@24: 
Chris@101:     virtual bool getValueExtents(float &, float &, bool &, QString &) const { return false; }
Chris@0: 
Chris@0:     virtual PropertyList getProperties() const;
Chris@0:     virtual PropertyType getPropertyType(const PropertyName &) const;
Chris@159:     virtual QString getPropertyLabel(const PropertyName &) const;
Chris@373:     virtual QString getPropertyIconName(const PropertyName &) const;
Chris@159:     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@197:     virtual void setProperties(const QXmlAttributes &);
Chris@11:     
Chris@197:     enum ColourScale { LinearScale, LogScale, PlusMinusOneScale };
Chris@159: 
Chris@159:     void setColourScale(ColourScale);
Chris@159:     ColourScale getColourScale() const { return m_colourScale; }
Chris@159: 
Chris@197:     void setColourMap(int map);
Chris@197:     int getColourMap() const;
Chris@197: 
Chris@197:     void setNormalizeColumns(bool n);
Chris@197:     bool getNormalizeColumns() const;
Chris@197: 
Chris@197:     void setNormalizeVisibleArea(bool n);
Chris@197:     bool getNormalizeVisibleArea() const;
Chris@197: 
Chris@373:     void setInvertVertical(bool i);
Chris@373:     bool getInvertVertical() const;
Chris@373: 
Chris@193:     virtual const Model *getSliceableModel() const { return m_model; }
Chris@193: 
Chris@316:     virtual void toXml(QTextStream &stream, QString indent = "",
Chris@316:                        QString extraAttributes = "") const;
Chris@197: 
Chris@0: protected slots:
Chris@0:     void cacheInvalid();
Chris@0:     void cacheInvalid(size_t startFrame, size_t endFrame);
Chris@0: 
Chris@0: protected:
Chris@0:     const DenseThreeDimensionalModel *m_model; // I do not own this
Chris@0:     
Chris@0:     mutable QImage *m_cache;
Chris@197:     mutable size_t m_cacheStart;
Chris@98: 
Chris@159:     ColourScale m_colourScale;
Chris@197:     int         m_colourMap;
Chris@197:     bool        m_normalizeColumns;
Chris@197:     bool        m_normalizeVisibleArea;
Chris@373:     bool        m_invertVertical;
Chris@197: 
Chris@197:     void getColumn(size_t col, DenseThreeDimensionalModel::Column &) const;
Chris@159: 
Chris@159:     virtual int getColourScaleWidth(QPainter &) const;
Chris@197:     virtual void fillCache(size_t firstBin, size_t lastBin) const;
Chris@98:     virtual void paintDense(View *v, QPainter &paint, QRect rect) const;
Chris@0: };
Chris@0: 
Chris@0: #endif