Public Types | Public Slots | Signals | Public Member Functions | Protected Types | Protected Slots | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Colour3DPlotLayer Class Reference

This is a view that displays dense 3-D data (time, some sort of binned y-axis range, value) as a colour plot with value mapped to colour range. More...

#include <Colour3DPlotLayer.h>

Inheritance diagram for Colour3DPlotLayer:
Inheritance graph
Collaboration diagram for Colour3DPlotLayer:
Collaboration graph

Public Types

enum  VerticalPosition { PositionTop, PositionMiddle, PositionBottom }
 
enum  SnapType { SnapLeft, SnapRight, SnapNeighbouring }
 
enum  ColourSignificance {
  ColourAbsent, ColourIrrelevant, ColourDistinguishes, ColourAndBackgroundSignificant,
  ColourHasMeaningfulValue
}
 

Public Slots

void showLayer (LayerGeometryProvider *, bool show)
 Change the visibility status (dormancy) of the layer in the given view. More...
 

Signals

void modelChanged (ModelId)
 
void modelCompletionChanged (ModelId)
 
void modelAlignmentCompletionChanged (ModelId)
 
void modelChangedWithin (ModelId, sv_frame_t startFrame, sv_frame_t endFrame)
 
void modelReplaced ()
 
void layerParametersChanged ()
 
void layerParameterRangesChanged ()
 
void layerMeasurementRectsChanged ()
 
void layerNameChanged ()
 
void verticalZoomChanged ()
 

Public Member Functions

 Colour3DPlotLayer ()
 
 ~Colour3DPlotLayer ()
 
ModelId getModel () const override
 Return the ID of the model represented in this layer. More...
 
ModelId getExportModel (LayerGeometryProvider *) const override
 Return the ID of a model representing the contents of this layer in a form suitable for export to a tabular file format such as CSV. More...
 
const ZoomConstraint * getZoomConstraint () const override
 Return a zoom constraint object defining the supported zoom levels for this layer. More...
 
void paint (LayerGeometryProvider *v, QPainter &paint, QRect rect) const override
 Paint the given rectangle of this layer onto the given view using the given painter, superimposing it on top of any existing material in that view. More...
 
void setSynchronousPainting (bool synchronous) override
 Enable or disable synchronous painting. More...
 
int getVerticalScaleWidth (LayerGeometryProvider *v, bool, QPainter &) const override
 
void paintVerticalScale (LayerGeometryProvider *v, bool, QPainter &paint, QRect rect) const override
 
QString getFeatureDescription (LayerGeometryProvider *v, QPoint &) const override
 
bool snapToFeatureFrame (LayerGeometryProvider *v, sv_frame_t &frame, int &resolution, SnapType snap, int ycoord) const override
 Adjust the given frame to snap to the nearest feature, if possible. More...
 
void setLayerDormant (const LayerGeometryProvider *v, bool dormant) override
 Indicate that a layer is not currently visible in the given view and is not expected to become visible in the near future (for example because the user has explicitly removed or hidden it). More...
 
bool isLayerScrollable (const LayerGeometryProvider *v) const override
 This should return true if the layer can safely be scrolled automatically by a given view (simply copying the existing data and then refreshing the exposed area) without altering its meaning. More...
 
ColourSignificance getLayerColourSignificance () const override
 This should return the degree of meaning associated with colour in this layer. More...
 
void setModel (ModelId model)
 
int getCompletion (LayerGeometryProvider *) const override
 Return the proportion of background work complete in drawing this view, as a percentage – in most cases this will be the value returned by pointer from a call to the underlying model's isReady(int *) call. More...
 
PropertyList getProperties () const override
 
PropertyType getPropertyType (const PropertyName &) const override
 
QString getPropertyLabel (const PropertyName &) const override
 
QString getPropertyIconName (const PropertyName &) const override
 
QString getPropertyGroupName (const PropertyName &) const override
 
int getPropertyRangeAndValue (const PropertyName &, int *min, int *max, int *deflt) const override
 
QString getPropertyValueLabel (const PropertyName &, int value) const override
 
QString getPropertyValueIconName (const PropertyName &, int value) const override
 
RangeMapper * getNewPropertyRangeMapper (const PropertyName &) const override
 
void setProperty (const PropertyName &, int value) override
 
void setProperties (const QXmlAttributes &) override
 Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes. More...
 
void setColourScale (ColourScaleType)
 
ColourScaleType getColourScale () const
 
void setColourMap (int map)
 
int getColourMap () const
 
void setGain (float gain)
 Set the gain multiplier for sample values in this view. More...
 
float getGain () const
 
void setBinScale (BinScale)
 Specify the scale for the y axis. More...
 
BinScale getBinScale () const
 
void setNormalization (ColumnNormalization)
 Specify the normalization mode for individual columns. More...
 
ColumnNormalization getNormalization () const
 
void setNormalizeVisibleArea (bool)
 Specify whether to normalize the visible area. More...
 
bool getNormalizeVisibleArea () const
 
void setInvertVertical (bool i)
 
bool getInvertVertical () const
 
void setOpaque (bool i)
 
bool getOpaque () const
 
void setSmooth (bool i)
 
bool getSmooth () const
 
bool hasLightBackground () const override
 
bool getValueExtents (double &min, double &max, bool &logarithmic, QString &unit) const override
 Return the minimum and maximum values for the y axis of the model in this layer, as well as whether the layer is configured to use a logarithmic y axis display. More...
 
bool getDisplayExtents (double &min, double &max) const override
 Return the minimum and maximum values within the visible area for the y axis of this layer. More...
 
bool setDisplayExtents (double min, double max) override
 Set the displayed minimum and maximum values for the y axis to the given range, if supported. More...
 
bool getYScaleValue (const LayerGeometryProvider *, int, double &, QString &) const override
 Return the value and unit at the given y coordinate in the given view. More...
 
int getVerticalZoomSteps (int &defaultStep) const override
 Get the number of vertical zoom steps available for this layer. More...
 
int getCurrentVerticalZoomStep () const override
 Get the current vertical zoom step. More...
 
void setVerticalZoomStep (int) override
 Set the vertical zoom step. More...
 
RangeMapper * getNewVerticalZoomRangeMapper () const override
 Create and return a range mapper for vertical zoom step values. More...
 
ModelId getSliceableModel () const override
 
void toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const override
 
virtual int getIYForBin (const LayerGeometryProvider *v, int bin) const
 As getYForBin, but rounding to integer values. More...
 
virtual int getIBinForY (const LayerGeometryProvider *v, int y) const
 As getBinForY, but rounding to integer values. More...
 
ModelId getSourceModel () const
 Return the ID of the source model for the model represented in this layer. More...
 
virtual bool supportsOtherZoomLevels () const
 Return true if this layer can handle zoom levels other than those supported by its zoom constraint (presumably less efficiently or accurately than the officially supported zoom levels). More...
 
virtual VerticalPosition getPreferredTimeRulerPosition () const
 
virtual VerticalPosition getPreferredFrameCountPosition () const
 
QString getPropertyContainerIconName () const override
 
QString getPropertyContainerName () const override
 
virtual void setPresentationName (QString name)
 
virtual bool isPresentationNameSet () const
 
virtual QString getLayerPresentationName () const
 
virtual QPixmap getLayerPresentationPixmap (QSize) const
 
virtual int getHorizontalScaleHeight (LayerGeometryProvider *, QPainter &) const
 
virtual bool getCrosshairExtents (LayerGeometryProvider *, QPainter &, QPoint, std::vector< QRect > &) const
 
virtual void paintCrosshairs (LayerGeometryProvider *, QPainter &, QPoint) const
 
virtual void paintMeasurementRects (LayerGeometryProvider *, QPainter &, bool showFocus, QPoint focusPoint) const
 
virtual bool nearestMeasurementRectChanged (LayerGeometryProvider *, QPoint prev, QPoint now) const
 
virtual QString getLabelPreceding (sv_frame_t) const
 
virtual bool snapToSimilarFeature (LayerGeometryProvider *, sv_frame_t &, int &resolution, SnapType) const
 Adjust the given frame to snap to the next feature that has "effectively" the same value as the feature prior to the given frame, if possible. More...
 
virtual void drawStart (LayerGeometryProvider *, QMouseEvent *)
 
virtual void drawDrag (LayerGeometryProvider *, QMouseEvent *)
 
virtual void drawEnd (LayerGeometryProvider *, QMouseEvent *)
 
virtual void eraseStart (LayerGeometryProvider *, QMouseEvent *)
 
virtual void eraseDrag (LayerGeometryProvider *, QMouseEvent *)
 
virtual void eraseEnd (LayerGeometryProvider *, QMouseEvent *)
 
virtual void editStart (LayerGeometryProvider *, QMouseEvent *)
 
virtual void editDrag (LayerGeometryProvider *, QMouseEvent *)
 
virtual void editEnd (LayerGeometryProvider *, QMouseEvent *)
 
virtual void splitStart (LayerGeometryProvider *, QMouseEvent *)
 
virtual void splitEnd (LayerGeometryProvider *, QMouseEvent *)
 
virtual void addNote (LayerGeometryProvider *, QMouseEvent *)
 
virtual void measureStart (LayerGeometryProvider *, QMouseEvent *)
 
virtual void measureDrag (LayerGeometryProvider *, QMouseEvent *)
 
virtual void measureEnd (LayerGeometryProvider *, QMouseEvent *)
 
virtual void measureDoubleClick (LayerGeometryProvider *, QMouseEvent *)
 
virtual bool haveCurrentMeasureRect () const
 
virtual void deleteCurrentMeasureRect ()
 
virtual bool editOpen (LayerGeometryProvider *, QMouseEvent *)
 Open an editor on the item under the mouse (e.g. More...
 
virtual void moveSelection (Selection, sv_frame_t)
 
virtual void resizeSelection (Selection, Selection)
 
virtual void deleteSelection (Selection)
 
virtual void copy (LayerGeometryProvider *, Selection, Clipboard &)
 
virtual bool paste (LayerGeometryProvider *, const Clipboard &, sv_frame_t, bool)
 Paste from the given clipboard onto the layer at the given frame offset. More...
 
virtual bool isLayerOpaque () const
 This should return true if the layer completely obscures any underlying layers. More...
 
virtual bool isLayerEditable () const
 This should return true if the layer can be edited by the user. More...
 
virtual QString getError (LayerGeometryProvider *) const
 Return an error string if any errors have occurred while loading or processing data for the given view. More...
 
virtual void setObjectName (const QString &name)
 
virtual void toBriefXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
 Produce XML containing the layer's ID and type. More...
 
virtual void addMeasurementRect (const QXmlAttributes &)
 Add a measurement rectangle from the given XML attributes (presumably taken from a measurement element). More...
 
virtual bool isLayerDormant (const LayerGeometryProvider *v) const
 Return whether the layer is dormant (i.e. More...
 
std::shared_ptr< PlayParameters > getPlayParameters () override
 Return the play parameters for this layer, if any. More...
 
virtual bool needsTextLabelHeight () const
 True if this layer will need to place text labels when it is painted. More...
 
virtual bool hasTimeXAxis () const
 Return true if the X axis on the layer is time proportional to audio frames, false otherwise. More...
 
virtual void zoomToRegion (const LayerGeometryProvider *, QRect)
 Update the X and Y axis scales, where appropriate, to focus on the given rectangular region. More...
 
virtual bool adoptExtents (double, double, QString)
 Consider using the given value extents and units for this layer. More...
 
virtual bool getXScaleValue (const LayerGeometryProvider *v, int x, double &value, QString &unit) const
 Return the value and unit at the given x coordinate in the given view. More...
 
virtual bool getYScaleDifference (const LayerGeometryProvider *v, int y0, int y1, double &diff, QString &unit) const
 Return the difference between the values at the given y coordinates in the given view, and the unit of the difference. More...
 
virtual bool canExistWithoutModel () const
 Return true if this layer type can function without a model being set. More...
 

Protected Types

typedef std::map< int, MagnitudeRange > ViewMagMap
 
typedef std::map< int, Colour3DPlotRenderer * > ViewRendererMap
 
typedef std::set< MeasureRect > MeasureRectSet
 

Protected Slots

void handleModelChanged (ModelId)
 
void handleModelChangedWithin (ModelId, sv_frame_t, sv_frame_t)
 

Protected Member Functions

void invalidatePeakCache ()
 
ModelId getPeakCache () const
 
void invalidateMagnitudes ()
 
Colour3DPlotRenderer * getRenderer (const LayerGeometryProvider *) const
 
void invalidateRenderers ()
 
double getYForBin (const LayerGeometryProvider *, double bin) const override
 Return the y coordinate at which the given bin "starts" (i.e. More...
 
double getBinForY (const LayerGeometryProvider *, double y) const override
 Return the bin number, possibly fractional, at the given y coordinate. More...
 
int getColourScaleWidth (QPainter &) const
 
void paintWithRenderer (LayerGeometryProvider *v, QPainter &paint, QRect rect) const
 
void connectSignals (ModelId)
 
virtual sv_frame_t alignToReference (LayerGeometryProvider *v, sv_frame_t frame) const
 
virtual sv_frame_t alignFromReference (LayerGeometryProvider *v, sv_frame_t frame) const
 
bool clipboardHasDifferentAlignment (LayerGeometryProvider *v, const Clipboard &clip) const
 
void addMeasureRectToSet (const MeasureRect &r)
 
void deleteMeasureRectFromSet (const MeasureRect &r)
 
void updateMeasurePixrects (LayerGeometryProvider *v) const
 
virtual void updateMeasureRectYCoords (LayerGeometryProvider *v, const MeasureRect &r) const
 
virtual void setMeasureRectYCoord (LayerGeometryProvider *v, MeasureRect &r, bool start, int y) const
 
virtual void setMeasureRectFromPixrect (LayerGeometryProvider *v, MeasureRect &r, QRect pixrect) const
 
MeasureRectSet::const_iterator findFocusedMeasureRect (QPoint) const
 
void paintMeasurementRect (LayerGeometryProvider *v, QPainter &paint, const MeasureRect &r, bool focus) const
 
bool valueExtentsMatchMine (LayerGeometryProvider *v) const
 

Static Protected Member Functions

static ColourScaleType convertToColourScale (int value)
 
static int convertFromColourScale (ColourScaleType)
 
static std::pair< ColumnNormalization, bool > convertToColumnNorm (int value)
 
static int convertFromColumnNorm (ColumnNormalization norm, bool visible)
 

Protected Attributes

ModelId m_model
 
ColourScaleType m_colourScale
 
bool m_colourScaleSet
 
int m_colourMap
 
bool m_colourInverted
 
float m_gain
 
BinScale m_binScale
 
ColumnNormalization m_normalization
 
bool m_normalizeVisibleArea
 
bool m_invertVertical
 
bool m_opaque
 
bool m_smooth
 
int m_peakResolution
 
int m_miny
 
int m_maxy
 
bool m_synchronous
 
ModelId m_peakCache
 
const int m_peakCacheDivisor
 
std::vector< ModelId > m_exporters
 
ViewMagMap m_viewMags
 
ViewMagMap m_lastRenderedMags
 
ViewRendererMap m_renderers
 
MeasureRectSet m_measureRects
 
MeasureRect m_draggingRect
 
bool m_haveDraggingRect
 
bool m_haveCurrentMeasureRect
 
QPoint m_currentMeasureRectPoint
 
QString m_presentationName
 

Detailed Description

This is a view that displays dense 3-D data (time, some sort of binned y-axis range, value) as a colour plot with value mapped to colour range.

Its source is a DenseThreeDimensionalModel.

This was the original implementation for the spectrogram view, but it was replaced for that purpose with a more efficient implementation that derived the spectrogram itself from a DenseTimeValueModel instead of using a three-dimensional model.

Definition at line 41 of file Colour3DPlotLayer.h.

Member Typedef Documentation

typedef std::map<int, MagnitudeRange> Colour3DPlotLayer::ViewMagMap
protected

Definition at line 199 of file Colour3DPlotLayer.h.

typedef std::map<int, Colour3DPlotRenderer *> Colour3DPlotLayer::ViewRendererMap
protected

Definition at line 204 of file Colour3DPlotLayer.h.

typedef std::set<MeasureRect> Layer::MeasureRectSet
protectedinherited

Definition at line 692 of file Layer.h.

Member Enumeration Documentation

enum Layer::VerticalPosition
inherited
Enumerator
PositionTop 
PositionMiddle 
PositionBottom 

Definition at line 140 of file Layer.h.

enum Layer::SnapType
inherited
Enumerator
SnapLeft 
SnapRight 
SnapNeighbouring 

Definition at line 195 of file Layer.h.

enum Layer::ColourSignificance
inherited
Enumerator
ColourAbsent 
ColourIrrelevant 
ColourDistinguishes 
ColourAndBackgroundSignificant 
ColourHasMeaningfulValue 

Definition at line 348 of file Layer.h.

Constructor & Destructor Documentation

Colour3DPlotLayer::Colour3DPlotLayer ( )

Definition at line 46 of file Colour3DPlotLayer.cpp.

References ColourMapper::Green, Linear, and setColourMap().

Colour3DPlotLayer::~Colour3DPlotLayer ( )

Definition at line 71 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), and m_exporters.

Member Function Documentation

ModelId Colour3DPlotLayer::getModel ( ) const
inlineoverridevirtual

Return the ID of the model represented in this layer.

Implements Layer.

Definition at line 49 of file Colour3DPlotLayer.h.

References getExportModel(), getFeatureDescription(), getVerticalScaleWidth(), getZoomConstraint(), isLayerScrollable(), m_model, paint(), paintVerticalScale(), setLayerDormant(), setSynchronousPainting(), and snapToFeatureFrame().

ModelId Colour3DPlotLayer::getExportModel ( LayerGeometryProvider *  ) const
overridevirtual

Return the ID of a model representing the contents of this layer in a form suitable for export to a tabular file format such as CSV.

In most cases this will be the same as returned by getModel(). The exceptions are those layers such as SpectrogramLayer, that are "only" alternative views of time-domain sample data. For such layers, getModel() will return the backing time-domain data, for example as a ReadOnlyWaveFileModel; but getExportModel() will return a model, possibly "local to" the layer, which adapts this into the form shown in the layer for a given view so that the export matches the layer's visible contents.

Because this is supposed to match the contents of the view rather than the backing model, it's necessary to pass in a view (or LayerGeometryProvider) so that the layer can retrieve its vertical extents for export.

Reimplemented from Layer.

Definition at line 220 of file Colour3DPlotLayer.cpp.

References m_exporters, m_model, Colour3DPlotExporter::Sources::provider, Colour3DPlotExporter::Sources::source, and Colour3DPlotExporter::Sources::verticalBinLayer.

Referenced by getModel().

const ZoomConstraint * Colour3DPlotLayer::getZoomConstraint ( ) const
overridevirtual

Return a zoom constraint object defining the supported zoom levels for this layer.

If this returns zero, the layer will support any integer zoom level.

Reimplemented from Layer.

Definition at line 85 of file Colour3DPlotLayer.cpp.

References m_model.

Referenced by getModel().

void Colour3DPlotLayer::paint ( LayerGeometryProvider *  ,
QPainter &  ,
QRect   
) const
overridevirtual

Paint the given rectangle of this layer onto the given view using the given painter, superimposing it on top of any existing material in that view.

The LayerGeometryProvider (an interface implemented by View) is provided here because it is possible for one layer to exist in more than one view, so the dimensions of the view may vary from one paint call to another (without any view having been resized).

Implements Layer.

Definition at line 1218 of file Colour3DPlotLayer.cpp.

References LayerGeometryProvider::getPaintWidth(), LayerGeometryProvider::getZoomLevel(), m_model, and paintWithRenderer().

Referenced by getModel().

void Colour3DPlotLayer::setSynchronousPainting ( bool  )
overridevirtual

Enable or disable synchronous painting.

If synchronous painting is enabled, a call to paint() must complete painting the entire rectangle before it returns. If synchronous painting is disabled (which should be the default), the paint() call may defer painting some regions if data is not yet available, by calling back on its view to schedule another update. Synchronous painting is necessary when rendering to an image. Simple layer types will always paint synchronously, and so may ignore this.

Reimplemented from Layer.

Definition at line 147 of file Colour3DPlotLayer.cpp.

References m_synchronous.

Referenced by getModel().

int Colour3DPlotLayer::getVerticalScaleWidth ( LayerGeometryProvider *  v,
bool  ,
QPainter &  paint 
) const
overridevirtual

Implements Layer.

Definition at line 938 of file Colour3DPlotLayer.cpp.

References getColourScaleWidth(), and m_model.

Referenced by getModel().

void Colour3DPlotLayer::paintVerticalScale ( LayerGeometryProvider *  v,
bool  ,
QPainter &  paint,
QRect  rect 
) const
overridevirtual

Reimplemented from Layer.

Definition at line 966 of file Colour3DPlotLayer.cpp.

References PaintAssistant::drawVisibleText(), getColourScaleWidth(), LayerGeometryProvider::getForeground(), LayerGeometryProvider::getId(), VerticalBinLayer::getIYForBin(), getRenderer(), m_invertVertical, m_maxy, m_miny, m_model, m_viewMags, and PaintAssistant::OutlinedText.

Referenced by getModel().

QString Colour3DPlotLayer::getFeatureDescription ( LayerGeometryProvider *  v,
QPoint &  pos 
) const
overridevirtual

Reimplemented from Layer.

Definition at line 865 of file Colour3DPlotLayer.cpp.

References LayerGeometryProvider::getFrameForX(), VerticalBinLayer::getIBinForY(), ViewManager::getMainModelSampleRate(), LayerGeometryProvider::getViewManager(), m_invertVertical, m_maxy, m_miny, and m_model.

Referenced by getModel().

bool Colour3DPlotLayer::snapToFeatureFrame ( LayerGeometryProvider *  ,
sv_frame_t &  ,
int &  resolution,
SnapType  ,
int   
) const
overridevirtual

Adjust the given frame to snap to the nearest feature, if possible.

If snap is SnapLeft or SnapRight, adjust the frame to match that of the nearest feature in the given direction regardless of how far away it is. If snap is SnapNeighbouring, adjust the frame to that of the nearest feature in either direction if it is close, and leave it alone (returning false) otherwise. SnapNeighbouring should always choose the same feature that would be used in an editing operation through calls to editStart etc.

If ycoord is non-negative, it contains the y coordinate at which the interaction that prompts this snap is taking place (e.g. of the mouse press used for a selection action). Layers that have objects at multiple different heights may choose to use this information. If the current action has no particular y coordinate associated with it, ycoord will be passed as -1.

Return true if a suitable feature was found and frame adjusted accordingly. Return false if no suitable feature was available (and leave frame unmodified). If returning true, also return the resolution of the model in this layer in sample frames.

Reimplemented from Layer.

Definition at line 1252 of file Colour3DPlotLayer.cpp.

References m_model, Layer::SnapLeft, Layer::SnapNeighbouring, Layer::SnapRight, and Layer::snapToFeatureFrame().

Referenced by getModel().

void Colour3DPlotLayer::setLayerDormant ( const LayerGeometryProvider *  v,
bool  dormant 
)
overridevirtual

Indicate that a layer is not currently visible in the given view and is not expected to become visible in the near future (for example because the user has explicitly removed or hidden it).

The layer may respond by (for example) freeing any cache memory it is using, until next time its paint method is called, when it should set itself un-dormant again.

A layer class that overrides this function must also call this class's implementation.

Reimplemented from Layer.

Definition at line 669 of file Colour3DPlotLayer.cpp.

References invalidatePeakCache(), Layer::isLayerDormant(), and Layer::setLayerDormant().

Referenced by getModel().

bool Colour3DPlotLayer::isLayerScrollable ( const LayerGeometryProvider *  ) const
overridevirtual

This should return true if the layer can safely be scrolled automatically by a given view (simply copying the existing data and then refreshing the exposed area) without altering its meaning.

For the view widget as a whole this is usually not possible because of invariant (non-scrolling) material displayed over the top, but the widget may be able to optimise scrolling better if it is known that individual views can be scrolled safely in this way.

Reimplemented from Layer.

Definition at line 693 of file Colour3DPlotLayer.cpp.

Referenced by getModel().

ColourSignificance Colour3DPlotLayer::getLayerColourSignificance ( ) const
inlineoverridevirtual

This should return the degree of meaning associated with colour in this layer.

If ColourAbsent, the layer does not use colour. If ColourIrrelevant, the layer is coloured and the colour may be set by the user, but it doesn't really matter what the colour is (for example, in a time ruler layer). If ColourDistinguishes, then the colour is used to distinguish this layer from other similar layers (e.g. for data layers). If ColourAndBackgroundSignificant, then the layer should be given greater weight than ColourDistinguishes layers when choosing a background colour (e.g. for waveforms). If ColourHasMeaningfulValue, colours are actually meaningful – the view will then show selections using unfilled rectangles instead of translucent filled rectangles, so as not to disturb the colours underneath.

Implements Layer.

Definition at line 76 of file Colour3DPlotLayer.h.

References Layer::ColourHasMeaningfulValue, getCompletion(), getNewPropertyRangeMapper(), getProperties(), getPropertyGroupName(), getPropertyIconName(), getPropertyLabel(), getPropertyRangeAndValue(), getPropertyType(), getPropertyValueIconName(), getPropertyValueLabel(), setColourScale(), setModel(), setProperties(), and setProperty().

void Colour3DPlotLayer::setModel ( ModelId  model)

Definition at line 153 of file Colour3DPlotLayer.cpp.

References Layer::connectSignals(), handleModelChanged(), handleModelChangedWithin(), invalidatePeakCache(), m_model, m_peakResolution, Layer::modelChanged(), Layer::modelChangedWithin(), and Layer::modelReplaced().

Referenced by getLayerColourSignificance().

int Colour3DPlotLayer::getCompletion ( LayerGeometryProvider *  ) const
overridevirtual

Return the proportion of background work complete in drawing this view, as a percentage – in most cases this will be the value returned by pointer from a call to the underlying model's isReady(int *) call.

The view may choose to show a progress meter if it finds that this returns < 100 at any given moment.

Reimplemented from Layer.

Definition at line 702 of file Colour3DPlotLayer.cpp.

References m_model.

Referenced by getLayerColourSignificance().

Layer::PropertyList Colour3DPlotLayer::getProperties ( ) const
override

Definition at line 291 of file Colour3DPlotLayer.cpp.

Referenced by getLayerColourSignificance().

Layer::PropertyType Colour3DPlotLayer::getPropertyType ( const PropertyName &  name) const
override

Definition at line 329 of file Colour3DPlotLayer.cpp.

Referenced by getLayerColourSignificance().

QString Colour3DPlotLayer::getPropertyLabel ( const PropertyName &  name) const
override

Definition at line 306 of file Colour3DPlotLayer.cpp.

Referenced by getLayerColourSignificance().

QString Colour3DPlotLayer::getPropertyIconName ( const PropertyName &  name) const
override

Definition at line 320 of file Colour3DPlotLayer.cpp.

Referenced by getLayerColourSignificance().

QString Colour3DPlotLayer::getPropertyGroupName ( const PropertyName &  name) const
override

Definition at line 340 of file Colour3DPlotLayer.cpp.

Referenced by getLayerColourSignificance().

int Colour3DPlotLayer::getPropertyRangeAndValue ( const PropertyName &  name,
int *  min,
int *  max,
int *  deflt 
) const
override

Definition at line 360 of file Colour3DPlotLayer.cpp.

References convertFromColourScale(), convertFromColumnNorm(), ColourMapper::getColourMapCount(), Linear, m_binScale, m_colourMap, m_colourScale, m_gain, m_invertVertical, m_normalization, m_normalizeVisibleArea, m_opaque, and m_smooth.

Referenced by getLayerColourSignificance().

QString Colour3DPlotLayer::getPropertyValueLabel ( const PropertyName &  name,
int  value 
) const
override

Definition at line 444 of file Colour3DPlotLayer.cpp.

References ColourMapper::getColourMapLabel().

Referenced by getLayerColourSignificance().

QString Colour3DPlotLayer::getPropertyValueIconName ( const PropertyName &  name,
int  value 
) const
override

Definition at line 480 of file Colour3DPlotLayer.cpp.

Referenced by getLayerColourSignificance().

RangeMapper * Colour3DPlotLayer::getNewPropertyRangeMapper ( const PropertyName &  name) const
override

Definition at line 496 of file Colour3DPlotLayer.cpp.

Referenced by getLayerColourSignificance().

void Colour3DPlotLayer::setProperty ( const PropertyName &  name,
int  value 
)
override

Definition at line 505 of file Colour3DPlotLayer.cpp.

References convertToColourScale(), convertToColumnNorm(), Linear, Log, setBinScale(), setColourMap(), setColourScale(), setGain(), setInvertVertical(), setNormalization(), setNormalizeVisibleArea(), setOpaque(), and setSmooth().

Referenced by getLayerColourSignificance().

void Colour3DPlotLayer::setProperties ( const QXmlAttributes &  )
overridevirtual

Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes.

This is the effective inverse of the toXml method.

!! todo: check save/reload scaling, compare with !! SpectrogramLayer, compare with prior SV versions, compare !! with Tony v1 and v2 and their save files

Implements Layer.

Definition at line 1332 of file Colour3DPlotLayer.cpp.

References convertToColourScale(), ColourMapper::getColourMapById(), ColourMapper::getColourMapCount(), setBinScale(), setColourMap(), setColourScale(), setDisplayExtents(), setGain(), setInvertVertical(), setNormalization(), setNormalizeVisibleArea(), setOpaque(), and setSmooth().

Referenced by getLayerColourSignificance().

void Colour3DPlotLayer::setColourScale ( ColourScaleType  scale)

Definition at line 533 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), m_colourScale, and m_colourScaleSet.

Referenced by getLayerColourSignificance(), handleModelChanged(), handleModelChangedWithin(), setProperties(), and setProperty().

ColourScaleType Colour3DPlotLayer::getColourScale ( ) const
inline

Definition at line 100 of file Colour3DPlotLayer.h.

References getBinScale(), getColourMap(), getCurrentVerticalZoomStep(), getDisplayExtents(), getGain(), getInvertVertical(), getNewVerticalZoomRangeMapper(), getNormalization(), getNormalizeVisibleArea(), getOpaque(), getSmooth(), getValueExtents(), getVerticalZoomSteps(), getYScaleValue(), hasLightBackground(), m_colourScale, setBinScale(), setColourMap(), setDisplayExtents(), setGain(), setInvertVertical(), setNormalization(), setNormalizeVisibleArea(), setOpaque(), setSmooth(), and setVerticalZoomStep().

void Colour3DPlotLayer::setColourMap ( int  map)

Definition at line 543 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), and m_colourMap.

Referenced by Colour3DPlotLayer(), getColourScale(), setProperties(), and setProperty().

int Colour3DPlotLayer::getColourMap ( ) const

Referenced by getColourScale().

void Colour3DPlotLayer::setGain ( float  gain)

Set the gain multiplier for sample values in this view.

The default is 1.0.

Definition at line 552 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), and m_gain.

Referenced by getColourScale(), setProperties(), and setProperty().

float Colour3DPlotLayer::getGain ( ) const

Definition at line 561 of file Colour3DPlotLayer.cpp.

References m_gain.

Referenced by getColourScale().

void Colour3DPlotLayer::setBinScale ( BinScale  binScale)

Specify the scale for the y axis.

Definition at line 567 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), and m_binScale.

Referenced by getColourScale(), setProperties(), and setProperty().

BinScale Colour3DPlotLayer::getBinScale ( ) const

Definition at line 576 of file Colour3DPlotLayer.cpp.

References m_binScale.

Referenced by getColourScale().

void Colour3DPlotLayer::setNormalization ( ColumnNormalization  n)

Specify the normalization mode for individual columns.

Definition at line 582 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), and m_normalization.

Referenced by getColourScale(), setProperties(), and setProperty().

ColumnNormalization Colour3DPlotLayer::getNormalization ( ) const

Definition at line 593 of file Colour3DPlotLayer.cpp.

References m_normalization.

Referenced by getColourScale().

void Colour3DPlotLayer::setNormalizeVisibleArea ( bool  n)

Specify whether to normalize the visible area.

Definition at line 599 of file Colour3DPlotLayer.cpp.

References invalidateMagnitudes(), invalidateRenderers(), Layer::layerParametersChanged(), and m_normalizeVisibleArea.

Referenced by getColourScale(), setProperties(), and setProperty().

bool Colour3DPlotLayer::getNormalizeVisibleArea ( ) const

Definition at line 611 of file Colour3DPlotLayer.cpp.

References m_normalizeVisibleArea.

Referenced by getColourScale().

void Colour3DPlotLayer::setInvertVertical ( bool  i)

Definition at line 617 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), and m_invertVertical.

Referenced by getColourScale(), setProperties(), and setProperty().

bool Colour3DPlotLayer::getInvertVertical ( ) const

Definition at line 644 of file Colour3DPlotLayer.cpp.

References m_invertVertical.

Referenced by getColourScale().

void Colour3DPlotLayer::setOpaque ( bool  i)

Definition at line 626 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), and m_opaque.

Referenced by getColourScale(), setProperties(), and setProperty().

bool Colour3DPlotLayer::getOpaque ( ) const

Definition at line 650 of file Colour3DPlotLayer.cpp.

References m_opaque.

Referenced by getColourScale().

void Colour3DPlotLayer::setSmooth ( bool  i)

Definition at line 635 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), and m_smooth.

Referenced by getColourScale(), setProperties(), and setProperty().

bool Colour3DPlotLayer::getSmooth ( ) const

Definition at line 656 of file Colour3DPlotLayer.cpp.

References m_smooth.

Referenced by getColourScale().

bool Colour3DPlotLayer::hasLightBackground ( ) const
overridevirtual

Reimplemented from Layer.

Definition at line 662 of file Colour3DPlotLayer.cpp.

References ColourMapper::hasLightBackground(), m_colourInverted, and m_colourMap.

Referenced by getColourScale().

bool Colour3DPlotLayer::getValueExtents ( double &  min,
double &  max,
bool &  logarithmic,
QString &  unit 
) const
overridevirtual

Return the minimum and maximum values for the y axis of the model in this layer, as well as whether the layer is configured to use a logarithmic y axis display.

Also return the unit for these values if known.

This function returns the "normal" extents for the layer, not necessarily the extents actually in use in the display (see getDisplayExtents).

Implements Layer.

Definition at line 710 of file Colour3DPlotLayer.cpp.

References Log, m_binScale, and m_model.

Referenced by getColourScale().

bool Colour3DPlotLayer::getDisplayExtents ( double &  ,
double &   
) const
overridevirtual

Return the minimum and maximum values within the visible area for the y axis of this layer.

Return false if the layer has no display extents of its own. This could be because the layer is "auto-aligning" against another layer with the same units elsewhere in the view, or because the layer has no concept of a vertical scale at all.

Reimplemented from Layer.

Definition at line 726 of file Colour3DPlotLayer.cpp.

References m_maxy, m_miny, and m_model.

Referenced by getBinForY(), getColourScale(), getCurrentVerticalZoomStep(), and getYForBin().

bool Colour3DPlotLayer::setDisplayExtents ( double  ,
double   
)
overridevirtual

Set the displayed minimum and maximum values for the y axis to the given range, if supported.

Return false if not supported on this layer (and set nothing). In most cases, layers that return false for getDisplayExtents should also return false for this function.

Reimplemented from Layer.

Definition at line 746 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), m_maxy, and m_miny.

Referenced by getColourScale(), and setProperties().

bool Colour3DPlotLayer::getYScaleValue ( const LayerGeometryProvider *  ,
int  ,
double &  ,
QString &   
) const
overridevirtual

Return the value and unit at the given y coordinate in the given view.

!!

Reimplemented from Layer.

Definition at line 758 of file Colour3DPlotLayer.cpp.

Referenced by getColourScale().

int Colour3DPlotLayer::getVerticalZoomSteps ( int &  ) const
overridevirtual

Get the number of vertical zoom steps available for this layer.

If vertical zooming is not available, return 0. The meaning of "zooming" is entirely up to the layer – changing the zoom level may cause the layer to reset its display extents or change another property such as display gain. However, layers are advised for consistency to treat smaller zoom steps as "more distant" or "zoomed out" and larger ones as "closer" or "zoomed in".

Layers that provide this facility should also emit the verticalZoomChanged signal if their vertical zoom changes due to factors other than setVerticalZoomStep being called.

Reimplemented from Layer.

Definition at line 765 of file Colour3DPlotLayer.cpp.

References m_model.

Referenced by getColourScale().

int Colour3DPlotLayer::getCurrentVerticalZoomStep ( ) const
overridevirtual

Get the current vertical zoom step.

A layer may support finer control over ranges etc than is available through the integer zoom step mechanism; if this one does, it should just return the nearest of the available zoom steps to the current settings.

Reimplemented from Layer.

Definition at line 776 of file Colour3DPlotLayer.cpp.

References getDisplayExtents(), and m_model.

Referenced by getColourScale().

void Colour3DPlotLayer::setVerticalZoomStep ( int  )
overridevirtual

Set the vertical zoom step.

The meaning of "zooming" is entirely up to the layer – changing the zoom level may cause the layer to reset its display extents or change another property such as display gain.

Reimplemented from Layer.

Definition at line 787 of file Colour3DPlotLayer.cpp.

References invalidateRenderers(), Layer::layerParametersChanged(), m_maxy, m_miny, and m_model.

Referenced by getColourScale().

RangeMapper * Colour3DPlotLayer::getNewVerticalZoomRangeMapper ( ) const
overridevirtual

Create and return a range mapper for vertical zoom step values.

See the RangeMapper documentation for more details. The returned value is allocated on the heap and will be deleted by the caller.

!! most of our uses of model in these functions is just to !! retrieve the model's height - perhaps we should cache it

Reimplemented from Layer.

Definition at line 810 of file Colour3DPlotLayer.cpp.

References m_model.

Referenced by getColourScale().

ModelId Colour3DPlotLayer::getSliceableModel ( ) const
inlineoverridevirtual

Implements SliceableLayer.

Definition at line 155 of file Colour3DPlotLayer.h.

References handleModelChanged(), handleModelChangedWithin(), m_model, and toXml().

void Colour3DPlotLayer::toXml ( QTextStream &  stream,
QString  indent = "",
QString  extraAttributes = "" 
) const
override

Definition at line 1280 of file Colour3DPlotLayer.cpp.

References convertFromColourScale(), ColourMapper::getBackwardCompatibilityColourMap(), ColourMapper::getColourMapId(), m_binScale, m_colourMap, m_colourScale, m_gain, m_invertVertical, m_maxy, m_miny, m_normalization, m_normalizeVisibleArea, m_opaque, m_smooth, and Layer::toXml().

Referenced by getSliceableModel().

void Colour3DPlotLayer::handleModelChanged ( ModelId  modelId)
protectedslot

Definition at line 256 of file Colour3DPlotLayer.cpp.

References invalidatePeakCache(), Linear, Log, m_colourScale, m_colourScaleSet, m_model, Layer::modelChanged(), and setColourScale().

Referenced by getSliceableModel(), and setModel().

void Colour3DPlotLayer::handleModelChangedWithin ( ModelId  modelId,
sv_frame_t  startFrame,
sv_frame_t  endFrame 
)
protectedslot

Definition at line 273 of file Colour3DPlotLayer.cpp.

References Linear, Log, m_colourScale, m_colourScaleSet, m_model, Layer::modelChangedWithin(), and setColourScale().

Referenced by getSliceableModel(), and setModel().

ColourScaleType Colour3DPlotLayer::convertToColourScale ( int  value)
staticprotected

Definition at line 93 of file Colour3DPlotLayer.cpp.

References Absolute, Linear, Log, and PlusMinusOne.

Referenced by setProperties(), and setProperty().

int Colour3DPlotLayer::convertFromColourScale ( ColourScaleType  scale)
staticprotected

Definition at line 105 of file Colour3DPlotLayer.cpp.

References Absolute, Linear, Log, Meter, Phase, and PlusMinusOne.

Referenced by getPropertyRangeAndValue(), and toXml().

std::pair< ColumnNormalization, bool > Colour3DPlotLayer::convertToColumnNorm ( int  value)
staticprotected

Definition at line 120 of file Colour3DPlotLayer.cpp.

Referenced by setProperty().

int Colour3DPlotLayer::convertFromColumnNorm ( ColumnNormalization  norm,
bool  visible 
)
staticprotected

Definition at line 132 of file Colour3DPlotLayer.cpp.

Referenced by getPropertyRangeAndValue().

void Colour3DPlotLayer::invalidatePeakCache ( )
protected

Definition at line 188 of file Colour3DPlotLayer.cpp.

References invalidateMagnitudes(), invalidateRenderers(), and m_peakCache.

Referenced by handleModelChanged(), setLayerDormant(), and setModel().

ModelId Colour3DPlotLayer::getPeakCache ( ) const
protected

Definition at line 245 of file Colour3DPlotLayer.cpp.

References m_model, m_peakCache, and m_peakCacheDivisor.

Referenced by getRenderer().

void Colour3DPlotLayer::invalidateMagnitudes ( )
protected

Definition at line 211 of file Colour3DPlotLayer.cpp.

References m_viewMags.

Referenced by invalidatePeakCache(), and setNormalizeVisibleArea().

Colour3DPlotRenderer * Colour3DPlotLayer::getRenderer ( const LayerGeometryProvider *  v) const
protected

Definition at line 1090 of file Colour3DPlotLayer.cpp.

References Colour3DPlotRenderer::Parameters::alwaysOpaque, Colour3DPlotRenderer::Parameters::binScale, ColourScale::Parameters::colourMap, Colour3DPlotRenderer::Parameters::colourScale, ColourScale::Parameters::gain, LayerGeometryProvider::getId(), getPeakCache(), Colour3DPlotRenderer::Parameters::interpolate, ColourScale::Parameters::inverted, Colour3DPlotRenderer::Parameters::invertVertical, m_binScale, m_colourInverted, m_colourMap, m_colourScale, m_gain, m_invertVertical, m_lastRenderedMags, m_model, m_normalization, m_normalizeVisibleArea, m_opaque, m_renderers, m_smooth, m_viewMags, ColourScale::Parameters::maxValue, ColourScale::Parameters::minValue, Colour3DPlotRenderer::Parameters::normalization, Colour3DPlotRenderer::Sources::peakCaches, ColourScale::Parameters::scaleType, Colour3DPlotRenderer::Sources::source, ColourScale::Parameters::threshold, and Colour3DPlotRenderer::Sources::verticalBinLayer.

Referenced by paintVerticalScale(), and paintWithRenderer().

void Colour3DPlotLayer::invalidateRenderers ( )
protected

Definition at line 201 of file Colour3DPlotLayer.cpp.

References m_renderers.

Referenced by invalidatePeakCache(), setBinScale(), setColourMap(), setColourScale(), setDisplayExtents(), setGain(), setInvertVertical(), setNormalization(), setNormalizeVisibleArea(), setOpaque(), setSmooth(), setVerticalZoomStep(), and ~Colour3DPlotLayer().

double Colour3DPlotLayer::getYForBin ( const LayerGeometryProvider *  v,
double  bin 
) const
overrideprotectedvirtual

Return the y coordinate at which the given bin "starts" (i.e.

at the bottom of the bin, if the given bin is an integer and the vertical scale is the usual way up). Bin number may be fractional, to obtain a position part-way through a bin.

Implements VerticalBinLayer.

Definition at line 823 of file Colour3DPlotLayer.cpp.

References getDisplayExtents(), LayerGeometryProvider::getPaintHeight(), Linear, m_binScale, and m_model.

double Colour3DPlotLayer::getBinForY ( const LayerGeometryProvider *  v,
double  y 
) const
overrideprotectedvirtual

Return the bin number, possibly fractional, at the given y coordinate.

Note that the whole numbers occur at the positions at which the bins "start" (i.e. the bottom of the visible bin, if the vertical scale is the usual way up).

Implements VerticalBinLayer.

Definition at line 842 of file Colour3DPlotLayer.cpp.

References getDisplayExtents(), LayerGeometryProvider::getPaintHeight(), Linear, m_binScale, and m_model.

int Colour3DPlotLayer::getColourScaleWidth ( QPainter &  p) const
protected

Definition at line 930 of file Colour3DPlotLayer.cpp.

Referenced by getVerticalScaleWidth(), and paintVerticalScale().

void Colour3DPlotLayer::paintWithRenderer ( LayerGeometryProvider *  v,
QPainter &  paint,
QRect  rect 
) const
protected

Definition at line 1163 of file Colour3DPlotLayer.cpp.

References Colour3DPlotRenderer::geometryChanged(), LayerGeometryProvider::getId(), Colour3DPlotRenderer::getLargestUncachedRect(), LayerGeometryProvider::getPaintRect(), getRenderer(), m_lastRenderedMags, m_normalizeVisibleArea, m_renderers, m_synchronous, m_viewMags, Colour3DPlotRenderer::RenderResult::range, Colour3DPlotRenderer::render(), Colour3DPlotRenderer::renderTimeConstrained(), and LayerGeometryProvider::updatePaintRect().

Referenced by paint().

virtual int VerticalBinLayer::getIYForBin ( const LayerGeometryProvider *  v,
int  bin 
) const
inlinevirtualinherited

As getYForBin, but rounding to integer values.

Definition at line 42 of file VerticalBinLayer.h.

References VerticalBinLayer::getBinForY(), and VerticalBinLayer::getYForBin().

Referenced by paintVerticalScale().

virtual int VerticalBinLayer::getIBinForY ( const LayerGeometryProvider *  v,
int  y 
) const
inlinevirtualinherited

As getBinForY, but rounding to integer values.

Definition at line 57 of file VerticalBinLayer.h.

References VerticalBinLayer::getBinForY().

Referenced by getFeatureDescription().

ModelId Layer::getSourceModel ( ) const
inherited

Return the ID of the source model for the model represented in this layer.

If the model has no other source, or there is no model here, return None.

Definition at line 68 of file Layer.cpp.

References Layer::getModel().

Referenced by View::paintEvent().

virtual bool Layer::supportsOtherZoomLevels ( ) const
inlinevirtualinherited

Return true if this layer can handle zoom levels other than those supported by its zoom constraint (presumably less efficiently or accurately than the officially supported zoom levels).

If true, the layer will unenthusistically accept any integer zoom level from 1 to the maximum returned by its zoom constraint.

Definition at line 114 of file Layer.h.

References Layer::paint().

virtual VerticalPosition Layer::getPreferredTimeRulerPosition ( ) const
inlinevirtualinherited

Definition at line 143 of file Layer.h.

References Layer::PositionMiddle.

virtual VerticalPosition Layer::getPreferredFrameCountPosition ( ) const
inlinevirtualinherited

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 146 of file Layer.h.

References Layer::PositionBottom.

QString Layer::getPropertyContainerIconName ( ) const
overrideinherited

Definition at line 80 of file Layer.cpp.

References LayerFactory::getInstance(), and LayerFactory::getLayerIconName().

Referenced by LayerTreeModel::data(), and Layer::hasLightBackground().

QString Layer::getPropertyContainerName ( ) const
inlineoverrideinherited

Definition at line 155 of file Layer.h.

References Layer::getLayerPresentationName(), Layer::isPresentationNameSet(), Layer::m_presentationName, and Layer::setPresentationName().

void Layer::setPresentationName ( QString  name)
virtualinherited

Definition at line 87 of file Layer.cpp.

References Layer::m_presentationName.

Referenced by Layer::getPropertyContainerName().

bool Layer::isPresentationNameSet ( ) const
virtualinherited

Definition at line 93 of file Layer.cpp.

References Layer::m_presentationName.

Referenced by Layer::getPropertyContainerName().

QString Layer::getLayerPresentationName ( ) const
virtualinherited

Reimplemented in TimeRulerLayer.

Definition at line 99 of file Layer.cpp.

References LayerFactory::getInstance(), LayerFactory::getLayerPresentationName(), LayerFactory::getLayerType(), Layer::getModel(), and Layer::m_presentationName.

Referenced by Pane::drawVerticalScale(), FlexiNoteLayer::getAssociatedPitchModel(), Layer::getPropertyContainerName(), View::getScaleProvidingLayerForUnit(), and PropertyStack::repopulate().

virtual QPixmap Layer::getLayerPresentationPixmap ( QSize  ) const
inlinevirtualinherited

Reimplemented in SingleColourLayer.

Definition at line 165 of file Layer.h.

References Layer::getVerticalScaleWidth().

virtual int Layer::getHorizontalScaleHeight ( LayerGeometryProvider *  ,
QPainter &   
) const
inlinevirtualinherited

Reimplemented in SpectrumLayer.

Definition at line 173 of file Layer.h.

Referenced by SliceLayer::paint(), and SliceLayer::paintVerticalScale().

virtual bool Layer::getCrosshairExtents ( LayerGeometryProvider *  ,
QPainter &  ,
QPoint  ,
std::vector< QRect > &   
) const
inlinevirtualinherited

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 175 of file Layer.h.

virtual void Layer::paintCrosshairs ( LayerGeometryProvider *  ,
QPainter &  ,
QPoint   
) const
inlinevirtualinherited

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 179 of file Layer.h.

References Layer::nearestMeasurementRectChanged(), and Layer::paintMeasurementRects().

void Layer::paintMeasurementRects ( LayerGeometryProvider *  v,
QPainter &  paint,
bool  showFocus,
QPoint  focusPoint 
) const
virtualinherited

Definition at line 464 of file Layer.cpp.

References Layer::findFocusedMeasureRect(), Layer::m_currentMeasureRectPoint, Layer::m_draggingRect, Layer::m_haveCurrentMeasureRect, Layer::m_haveDraggingRect, Layer::m_measureRects, Layer::paintMeasurementRect(), and Layer::updateMeasurePixrects().

Referenced by Layer::paintCrosshairs(), and Pane::paintEvent().

bool Layer::nearestMeasurementRectChanged ( LayerGeometryProvider *  v,
QPoint  prev,
QPoint  now 
) const
virtualinherited

Definition at line 496 of file Layer.cpp.

References Layer::findFocusedMeasureRect(), and Layer::updateMeasurePixrects().

Referenced by Pane::mouseMoveEvent(), and Layer::paintCrosshairs().

virtual QString Layer::getLabelPreceding ( sv_frame_t  ) const
inlinevirtualinherited

Reimplemented in RegionLayer, TimeValueLayer, BoxLayer, and TimeInstantLayer.

Definition at line 191 of file Layer.h.

virtual bool Layer::snapToSimilarFeature ( LayerGeometryProvider *  ,
sv_frame_t &  ,
int &  resolution,
SnapType   
) const
inlinevirtualinherited

Adjust the given frame to snap to the next feature that has "effectively" the same value as the feature prior to the given frame, if possible.

The snap type must be SnapLeft (snap to the time of the next feature prior to the one preceding the given frame that has a similar value to it) or SnapRight (snap to the time of the next feature following the given frame that has a similar value to the feature preceding it). Other values are not permitted.

Return true if a suitable feature was found and frame adjusted accordingly. Return false if no suitable feature was available (and leave frame unmodified). If returning true, also return the resolution of the model in this layer in sample frames.

Reimplemented in RegionLayer, and TimeValueLayer.

Definition at line 251 of file Layer.h.

Referenced by TimeValueLayer::snapToSimilarFeature(), and RegionLayer::snapToSimilarFeature().

virtual void Layer::drawStart ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.

Definition at line 264 of file Layer.h.

Referenced by Pane::mousePressEvent().

virtual void Layer::drawDrag ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.

Definition at line 265 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

virtual void Layer::drawEnd ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.

Definition at line 266 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

virtual void Layer::eraseStart ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, TimeInstantLayer, and TextLayer.

Definition at line 268 of file Layer.h.

Referenced by Pane::mousePressEvent().

virtual void Layer::eraseDrag ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, TimeInstantLayer, and TextLayer.

Definition at line 269 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

virtual void Layer::eraseEnd ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, TimeInstantLayer, and TextLayer.

Definition at line 270 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

virtual void Layer::editStart ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.

Definition at line 272 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

virtual void Layer::editDrag ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.

Definition at line 273 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

virtual void Layer::editEnd ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.

Definition at line 274 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

virtual void Layer::splitStart ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in FlexiNoteLayer.

Definition at line 276 of file Layer.h.

Referenced by Pane::mousePressEvent().

virtual void Layer::splitEnd ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in FlexiNoteLayer.

Definition at line 277 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

virtual void Layer::addNote ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Reimplemented in FlexiNoteLayer.

Definition at line 278 of file Layer.h.

References Layer::measureDoubleClick(), Layer::measureDrag(), Layer::measureEnd(), and Layer::measureStart().

Referenced by Pane::mouseDoubleClickEvent().

void Layer::measureStart ( LayerGeometryProvider *  v,
QMouseEvent *  e 
)
virtualinherited

Definition at line 390 of file Layer.cpp.

References Layer::MeasureRect::endFrame, LayerGeometryProvider::getFrameForX(), Layer::hasTimeXAxis(), Layer::MeasureRect::haveFrames, Layer::m_draggingRect, Layer::m_haveDraggingRect, Layer::MeasureRect::pixrect, Layer::setMeasureRectYCoord(), and Layer::MeasureRect::startFrame.

Referenced by Layer::addNote(), and Pane::mousePressEvent().

void Layer::measureDrag ( LayerGeometryProvider *  v,
QMouseEvent *  e 
)
virtualinherited

Definition at line 414 of file Layer.cpp.

References Layer::MeasureRect::endFrame, LayerGeometryProvider::getFrameForX(), Layer::MeasureRect::haveFrames, Layer::m_draggingRect, Layer::m_haveDraggingRect, Layer::MeasureRect::pixrect, and Layer::setMeasureRectYCoord().

Referenced by Layer::addNote(), Layer::measureEnd(), and Pane::mouseMoveEvent().

void Layer::measureEnd ( LayerGeometryProvider *  v,
QMouseEvent *  e 
)
virtualinherited

Definition at line 430 of file Layer.cpp.

References CommandHistory::addCommand(), CommandHistory::getInstance(), Layer::m_draggingRect, Layer::m_haveDraggingRect, Layer::measureDrag(), and Layer::MeasureRect::pixrect.

Referenced by Layer::addNote(), and Pane::mouseReleaseEvent().

void Layer::measureDoubleClick ( LayerGeometryProvider *  ,
QMouseEvent *   
)
virtualinherited

Reimplemented in SpectrogramLayer.

Definition at line 444 of file Layer.cpp.

Referenced by Layer::addNote(), and Pane::mouseDoubleClickEvent().

virtual bool Layer::haveCurrentMeasureRect ( ) const
inlinevirtualinherited

Definition at line 289 of file Layer.h.

References Layer::deleteCurrentMeasureRect(), and Layer::m_haveCurrentMeasureRect.

void Layer::deleteCurrentMeasureRect ( )
virtualinherited

Definition at line 450 of file Layer.cpp.

References CommandHistory::addCommand(), Layer::findFocusedMeasureRect(), CommandHistory::getInstance(), Layer::m_currentMeasureRectPoint, Layer::m_haveCurrentMeasureRect, and Layer::m_measureRects.

Referenced by Layer::haveCurrentMeasureRect().

virtual bool Layer::editOpen ( LayerGeometryProvider *  ,
QMouseEvent *   
)
inlinevirtualinherited

Open an editor on the item under the mouse (e.g.

on double-click). If there is no item or editing is not supported, return false.

Reimplemented in NoteLayer, FlexiNoteLayer, RegionLayer, TimeValueLayer, ImageLayer, BoxLayer, TextLayer, and TimeInstantLayer.

Definition at line 299 of file Layer.h.

Referenced by Pane::mouseDoubleClickEvent().

virtual void Layer::moveSelection ( Selection  ,
sv_frame_t   
)
inlinevirtualinherited

Reimplemented in NoteLayer, FlexiNoteLayer, RegionLayer, TimeValueLayer, BoxLayer, TimeInstantLayer, ImageLayer, and TextLayer.

Definition at line 301 of file Layer.h.

Referenced by Pane::editSelectionEnd().

virtual void Layer::resizeSelection ( Selection  ,
Selection   
)
inlinevirtualinherited

Reimplemented in NoteLayer, FlexiNoteLayer, RegionLayer, TimeValueLayer, BoxLayer, TimeInstantLayer, ImageLayer, and TextLayer.

Definition at line 302 of file Layer.h.

Referenced by Pane::editSelectionEnd().

virtual void Layer::deleteSelection ( Selection  )
inlinevirtualinherited

Reimplemented in NoteLayer, FlexiNoteLayer, RegionLayer, TimeValueLayer, BoxLayer, TimeInstantLayer, ImageLayer, and TextLayer.

Definition at line 303 of file Layer.h.

virtual void Layer::copy ( LayerGeometryProvider *  ,
Selection  ,
Clipboard &   
)
inlinevirtualinherited

Reimplemented in NoteLayer, FlexiNoteLayer, RegionLayer, TimeValueLayer, BoxLayer, TimeInstantLayer, ImageLayer, and TextLayer.

Definition at line 305 of file Layer.h.

virtual bool Layer::paste ( LayerGeometryProvider *  ,
const Clipboard &  ,
sv_frame_t  ,
bool   
)
inlinevirtualinherited

Paste from the given clipboard onto the layer at the given frame offset.

If interactive is true, the layer may ask the user about paste options through a dialog if desired, and may return false if the user cancelled the paste operation. This function should return true if a paste actually occurred.

Reimplemented in NoteLayer, FlexiNoteLayer, RegionLayer, TimeValueLayer, BoxLayer, TimeInstantLayer, ImageLayer, and TextLayer.

Definition at line 314 of file Layer.h.

virtual bool Layer::isLayerOpaque ( ) const
inlinevirtualinherited

This should return true if the layer completely obscures any underlying layers.

It's used to determine whether the view can safely draw any selection rectangles under the layer instead of over it, in the case where the layer is not scrollable and therefore needs to be redrawn each time (so that the selection rectangle can be cached).

Reimplemented in SpectrogramLayer.

Definition at line 346 of file Layer.h.

Referenced by Pane::drawVerticalScale().

virtual bool Layer::isLayerEditable ( ) const
inlinevirtualinherited

This should return true if the layer can be edited by the user.

If this is the case, the appropriate edit tools may be made available by the application and the layer's drawStart/Drag/End and editStart/Drag/End methods should be implemented.

Reimplemented in TimeValueLayer, FlexiNoteLayer, RegionLayer, NoteLayer, BoxLayer, TimeInstantLayer, ImageLayer, and TextLayer.

Definition at line 382 of file Layer.h.

Referenced by Pane::mouseDoubleClickEvent(), Pane::mouseMoveEvent(), Pane::mousePressEvent(), Pane::mouseReleaseEvent(), Pane::shouldIlluminateLocalSelection(), and Pane::updateContextHelp().

virtual QString Layer::getError ( LayerGeometryProvider *  ) const
inlinevirtualinherited

Return an error string if any errors have occurred while loading or processing data for the given view.

Return the empty string if no error has occurred.

Reimplemented in SpectrogramLayer.

Definition at line 398 of file Layer.h.

References Layer::addMeasurementRect(), Layer::getPlayParameters(), Layer::isLayerDormant(), Layer::setLayerDormant(), Layer::setObjectName(), Layer::setProperties(), Layer::toBriefXml(), and Layer::toXml().

void Layer::setObjectName ( const QString &  name)
virtualinherited

Definition at line 122 of file Layer.cpp.

References Layer::layerNameChanged().

Referenced by LayerFactory::createLayer(), and Layer::getError().

void Layer::toBriefXml ( QTextStream &  stream,
QString  indent = "",
QString  extraAttributes = "" 
) const
virtualinherited

Produce XML containing the layer's ID and type.

This is used to refer to the layer in the display section of the SV session file, for a layer that has already been described in the data section.

Definition at line 691 of file Layer.cpp.

References LayerFactory::getInstance(), Layer::getModel(), and Layer::m_presentationName.

Referenced by Layer::getError().

void Layer::addMeasurementRect ( const QXmlAttributes &  attributes)
virtualinherited

Add a measurement rectangle from the given XML attributes (presumably taken from a measurement element).

Does not use a command.

Definition at line 333 of file Layer.cpp.

References Layer::addMeasureRectToSet(), Layer::MeasureRect::endFrame, Layer::MeasureRect::endY, Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, Layer::MeasureRect::startFrame, and Layer::MeasureRect::startY.

Referenced by Layer::getError().

bool Layer::isLayerDormant ( const LayerGeometryProvider *  v) const
virtualinherited

Return whether the layer is dormant (i.e.

hidden) in the given view.

Definition at line 144 of file Layer.cpp.

References Layer::m_dormancy, and Layer::m_dormancyMutex.

Referenced by LayerTreeModel::data(), Pane::drawVerticalScale(), Layer::getError(), View::getInteractionLayer(), View::getScaleProvidingLayerForUnit(), View::getVisibleExtentsForAnyUnit(), PropertyStack::propertyContainerPropertyChanged(), PropertyStack::repopulate(), setLayerDormant(), and SpectrogramLayer::setLayerDormant().

std::shared_ptr< PlayParameters > Layer::getPlayParameters ( )
overrideinherited

Return the play parameters for this layer, if any.

The return value is a shared_ptr that can be passed to (e.g.) PlayParameterRepository::EditCommand to change the parameters.

Definition at line 129 of file Layer.cpp.

References Layer::getModel().

Referenced by LayerTreeModel::data(), Layer::getError(), LayerTreeModel::LayerTreeModel(), LayerTreeModel::playParametersAudibilityChanged(), and LayerTreeModel::setData().

virtual bool Layer::needsTextLabelHeight ( ) const
inlinevirtualinherited

True if this layer will need to place text labels when it is painted.

The view will take into account how many layers are requesting this, and will provide a distinct y-coord to each layer on request via View::getTextLabelHeight().

Reimplemented in TimeValueLayer, SpectrumLayer, and TimeInstantLayer.

Definition at line 468 of file Layer.h.

virtual bool Layer::hasTimeXAxis ( ) const
inlinevirtualinherited

Return true if the X axis on the layer is time proportional to audio frames, false otherwise.

Almost all layer types return true here: the exceptions are spectrum and slice layers.

Reimplemented in SliceLayer.

Definition at line 475 of file Layer.h.

Referenced by Layer::getXScaleValue(), Layer::measureStart(), Pane::mouseMoveEvent(), Layer::setMeasureRectFromPixrect(), and Pane::zoomToRegion().

virtual void Layer::zoomToRegion ( const LayerGeometryProvider *  ,
QRect   
)
inlinevirtualinherited

Update the X and Y axis scales, where appropriate, to focus on the given rectangular region.

This should only be overridden by layers whose hasTimeXAxis() returns false - the pane handles zooming appropriately in every "normal" case.

Reimplemented in SliceLayer.

Definition at line 483 of file Layer.h.

References Layer::getValueExtents().

Referenced by Pane::zoomToRegion().

virtual bool Layer::adoptExtents ( double  ,
double  ,
QString   
)
inlinevirtualinherited

Consider using the given value extents and units for this layer.

This may be called on a new layer when added, to prepare it for editing, and the extents are those of the layer underneath it. May not be appropriate for most layer types.

Reimplemented in BoxLayer.

Definition at line 532 of file Layer.h.

References Layer::getXScaleValue().

bool Layer::getXScaleValue ( const LayerGeometryProvider *  v,
int  x,
double &  value,
QString &  unit 
) const
virtualinherited

Return the value and unit at the given x coordinate in the given view.

This is for descriptive purposes using the measurement tool. The default implementation works correctly if the layer hasTimeXAxis().

Reimplemented in SpectrumLayer.

Definition at line 160 of file Layer.cpp.

References LayerGeometryProvider::getFrameForX(), Layer::getModel(), and Layer::hasTimeXAxis().

Referenced by Layer::adoptExtents(), and View::drawMeasurementRect().

bool Layer::getYScaleDifference ( const LayerGeometryProvider *  v,
int  y0,
int  y1,
double &  diff,
QString &  unit 
) const
virtualinherited

Return the difference between the values at the given y coordinates in the given view, and the unit of the difference.

The default implementation just calls getYScaleValue twice and returns the difference, with the same unit.

Reimplemented in WaveformLayer, and SpectrumLayer.

Definition at line 173 of file Layer.cpp.

References Layer::getYScaleValue().

Referenced by View::drawMeasurementRect(), SpectrumLayer::getYScaleDifference(), and Layer::getYScaleValue().

virtual bool Layer::canExistWithoutModel ( ) const
inlinevirtualinherited

Return true if this layer type can function without a model being set.

If false (the default), the layer will not be loaded from a session if its model cannot be found.

Reimplemented in WaveformLayer, and TimeRulerLayer.

Definition at line 609 of file Layer.h.

References Layer::alignFromReference(), Layer::alignToReference(), Layer::clipboardHasDifferentAlignment(), Layer::connectSignals(), Layer::layerMeasurementRectsChanged(), Layer::layerNameChanged(), Layer::layerParameterRangesChanged(), Layer::layerParametersChanged(), Layer::modelAlignmentCompletionChanged(), Layer::modelChanged(), Layer::modelChangedWithin(), Layer::modelCompletionChanged(), Layer::modelReplaced(), Layer::showLayer(), and Layer::verticalZoomChanged().

void Layer::showLayer ( LayerGeometryProvider *  view,
bool  show 
)
slotinherited

Change the visibility status (dormancy) of the layer in the given view.

Definition at line 153 of file Layer.cpp.

References Layer::layerParametersChanged(), and Layer::setLayerDormant().

Referenced by Layer::canExistWithoutModel(), ShowLayerCommand::execute(), LayerTreeModel::setData(), and ShowLayerCommand::unexecute().

void Layer::modelChanged ( ModelId  )
signalinherited

Referenced by Layer::canExistWithoutModel(), Layer::connectSignals(), ImageLayer::fileSourceReady(), handleModelChanged(), RegionLayer::setModel(), setModel(), SpectrogramLayer::setModel(), BoxLayer::setProperty(), TimeValueLayer::setProperty(), RegionLayer::setProperty(), NoteLayer::setProperty(), and FlexiNoteLayer::setProperty().

void Layer::modelCompletionChanged ( ModelId  )
signalinherited

Referenced by Layer::canExistWithoutModel(), and Layer::connectSignals().

void Layer::modelAlignmentCompletionChanged ( ModelId  )
signalinherited

Referenced by Layer::canExistWithoutModel(), and Layer::connectSignals().

void Layer::modelChangedWithin ( ModelId  ,
sv_frame_t  startFrame,
sv_frame_t  endFrame 
)
signalinherited

Referenced by Layer::canExistWithoutModel(), Layer::connectSignals(), handleModelChangedWithin(), setModel(), and SpectrogramLayer::setModel().

void Layer::modelReplaced ( )
signalinherited

Referenced by Layer::canExistWithoutModel(), TimeRulerLayer::setModel(), WaveformLayer::setModel(), TextLayer::setModel(), ImageLayer::setModel(), TimeInstantLayer::setModel(), BoxLayer::setModel(), TimeValueLayer::setModel(), setModel(), RegionLayer::setModel(), NoteLayer::setModel(), FlexiNoteLayer::setModel(), SpectrogramLayer::setModel(), and SliceLayer::setSliceableModel().

void Layer::layerParametersChanged ( )
signalinherited

Referenced by Layer::canExistWithoutModel(), SpectrogramLayer::preferenceChanged(), WaveformLayer::setAggressiveCacheing(), WaveformLayer::setAutoNormalize(), SingleColourLayer::setBaseColour(), SpectrogramLayer::setBinDisplay(), SliceLayer::setBinScale(), setBinScale(), SpectrogramLayer::setBinScale(), SpectrumLayer::setChannel(), SpectrogramLayer::setChannel(), WaveformLayer::setChannel(), WaveformLayer::setChannelMode(), setColourMap(), SpectrogramLayer::setColourMap(), SpectrogramLayer::setColourRotation(), setColourScale(), SpectrogramLayer::setColourScale(), SpectrogramLayer::setColourScaleMultiple(), SliceLayer::setDisplayExtents(), NoteLayer::setDisplayExtents(), FlexiNoteLayer::setDisplayExtents(), TimeValueLayer::setDisplayExtents(), setDisplayExtents(), SpectrogramLayer::setDisplayExtents(), TimeValueLayer::setDrawSegmentDivisions(), SliceLayer::setEnergyScale(), TimeValueLayer::setFillColourMap(), RegionLayer::setFillColourMap(), SliceLayer::setFillColourMap(), WaveformLayer::setGain(), setGain(), SliceLayer::setGain(), SpectrogramLayer::setGain(), setInvertVertical(), SpectrogramLayer::setMaxFrequency(), WaveformLayer::setMiddleLineHeight(), SpectrogramLayer::setMinFrequency(), SpectrumLayer::setModel(), WaveformLayer::setModel(), setNormalization(), SpectrogramLayer::setNormalization(), SliceLayer::setNormalize(), setNormalizeVisibleArea(), SpectrogramLayer::setNormalizeVisibleArea(), setOpaque(), SpectrumLayer::setOversampling(), SpectrogramLayer::setOversampling(), TimeInstantLayer::setPlotStyle(), SliceLayer::setPlotStyle(), TimeValueLayer::setPlotStyle(), RegionLayer::setPlotStyle(), SliceLayer::setSamplingMode(), WaveformLayer::setScale(), TimeValueLayer::setShowDerivative(), WaveformLayer::setShowMeans(), SpectrumLayer::setShowPeaks(), SliceLayer::setSliceableModel(), setSmooth(), SliceLayer::setThreshold(), SpectrogramLayer::setThreshold(), BoxLayer::setVerticalScale(), NoteLayer::setVerticalScale(), RegionLayer::setVerticalScale(), FlexiNoteLayer::setVerticalScale(), TimeValueLayer::setVerticalScale(), setVerticalZoomStep(), SpectrumLayer::setWindowHopLevel(), SpectrogramLayer::setWindowHopLevel(), SpectrumLayer::setWindowSize(), SpectrogramLayer::setWindowSize(), SpectrumLayer::setWindowType(), SpectrogramLayer::setWindowType(), and Layer::showLayer().

void Layer::layerParameterRangesChanged ( )
signalinherited

Referenced by Layer::canExistWithoutModel(), SliceLayer::setPlotStyle(), TimeValueLayer::setPlotStyle(), and RegionLayer::setPlotStyle().

void Layer::layerMeasurementRectsChanged ( )
signalinherited

Referenced by Layer::addMeasureRectToSet(), Layer::canExistWithoutModel(), and Layer::deleteMeasureRectFromSet().

void Layer::layerNameChanged ( )
signalinherited

Referenced by Layer::canExistWithoutModel(), and Layer::setObjectName().

void Layer::verticalZoomChanged ( )
signalinherited

Referenced by Layer::canExistWithoutModel(), SpectrogramLayer::setDisplayExtents(), WaveformLayer::setGain(), and SpectrogramLayer::setProperty().

void Layer::connectSignals ( ModelId  modelId)
protectedinherited

Definition at line 49 of file Layer.cpp.

References Layer::modelAlignmentCompletionChanged(), Layer::modelChanged(), Layer::modelChangedWithin(), and Layer::modelCompletionChanged().

Referenced by Layer::canExistWithoutModel(), WaveformLayer::setModel(), TextLayer::setModel(), ImageLayer::setModel(), TimeInstantLayer::setModel(), BoxLayer::setModel(), TimeValueLayer::setModel(), setModel(), RegionLayer::setModel(), NoteLayer::setModel(), FlexiNoteLayer::setModel(), SpectrogramLayer::setModel(), and SliceLayer::setSliceableModel().

sv_frame_t Layer::alignToReference ( LayerGeometryProvider *  v,
sv_frame_t  frame 
) const
protectedvirtualinherited

Definition at line 187 of file Layer.cpp.

References View::alignToReference(), Layer::getModel(), and LayerGeometryProvider::getView().

Referenced by Layer::canExistWithoutModel(), Layer::clipboardHasDifferentAlignment(), TextLayer::copy(), ImageLayer::copy(), TimeInstantLayer::copy(), BoxLayer::copy(), TimeValueLayer::copy(), RegionLayer::copy(), FlexiNoteLayer::copy(), and NoteLayer::copy().

sv_frame_t Layer::alignFromReference ( LayerGeometryProvider *  v,
sv_frame_t  frame 
) const
protectedvirtualinherited

Definition at line 198 of file Layer.cpp.

References View::alignFromReference(), Layer::getModel(), and LayerGeometryProvider::getView().

Referenced by Layer::canExistWithoutModel(), TextLayer::paste(), ImageLayer::paste(), TimeInstantLayer::paste(), BoxLayer::paste(), TimeValueLayer::paste(), RegionLayer::paste(), FlexiNoteLayer::paste(), and NoteLayer::paste().

bool Layer::clipboardHasDifferentAlignment ( LayerGeometryProvider *  v,
const Clipboard &  clip 
) const
protectedinherited

Definition at line 209 of file Layer.cpp.

References Layer::alignToReference().

Referenced by Layer::canExistWithoutModel(), TextLayer::paste(), ImageLayer::paste(), TimeInstantLayer::paste(), BoxLayer::paste(), TimeValueLayer::paste(), RegionLayer::paste(), FlexiNoteLayer::paste(), and NoteLayer::paste().

void Layer::addMeasureRectToSet ( const MeasureRect &  r)
inlineprotectedinherited

Definition at line 682 of file Layer.h.

References Layer::layerMeasurementRectsChanged(), and Layer::m_measureRects.

Referenced by Layer::addMeasurementRect().

void Layer::deleteMeasureRectFromSet ( const MeasureRect &  r)
inlineprotectedinherited

Definition at line 687 of file Layer.h.

References Layer::layerMeasurementRectsChanged(), and Layer::m_measureRects.

void Layer::updateMeasurePixrects ( LayerGeometryProvider *  v) const
protectedinherited

Definition at line 507 of file Layer.cpp.

References LayerGeometryProvider::getEndFrame(), LayerGeometryProvider::getStartFrame(), LayerGeometryProvider::getXForFrame(), Layer::m_measureRects, and Layer::updateMeasureRectYCoords().

Referenced by Layer::nearestMeasurementRectChanged(), and Layer::paintMeasurementRects().

void Layer::updateMeasureRectYCoords ( LayerGeometryProvider *  v,
const MeasureRect &  r 
) const
protectedvirtualinherited

Reimplemented in SpectrogramLayer.

Definition at line 546 of file Layer.cpp.

References Layer::MeasureRect::endY, LayerGeometryProvider::getPaintHeight(), Layer::MeasureRect::pixrect, and Layer::MeasureRect::startY.

Referenced by Layer::updateMeasurePixrects().

void Layer::setMeasureRectYCoord ( LayerGeometryProvider *  v,
MeasureRect &  r,
bool  start,
int  y 
) const
protectedvirtualinherited

Reimplemented in SpectrogramLayer.

Definition at line 554 of file Layer.cpp.

References Layer::MeasureRect::endY, LayerGeometryProvider::getPaintHeight(), and Layer::MeasureRect::startY.

Referenced by Layer::measureDrag(), Layer::measureStart(), and Layer::setMeasureRectFromPixrect().

void Layer::setMeasureRectFromPixrect ( LayerGeometryProvider *  v,
MeasureRect &  r,
QRect  pixrect 
) const
protectedvirtualinherited

Definition at line 565 of file Layer.cpp.

References Layer::MeasureRect::endFrame, LayerGeometryProvider::getFrameForX(), Layer::hasTimeXAxis(), Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, Layer::setMeasureRectYCoord(), and Layer::MeasureRect::startFrame.

Referenced by SpectrogramLayer::measureDoubleClick().

Layer::MeasureRectSet::const_iterator Layer::findFocusedMeasureRect ( QPoint  focusPoint) const
protectedinherited

Definition at line 578 of file Layer.cpp.

References Layer::m_measureRects.

Referenced by Layer::deleteCurrentMeasureRect(), Layer::nearestMeasurementRectChanged(), and Layer::paintMeasurementRects().

void Layer::paintMeasurementRect ( LayerGeometryProvider *  v,
QPainter &  paint,
const MeasureRect &  r,
bool  focus 
) const
protectedinherited

Definition at line 605 of file Layer.cpp.

References LayerGeometryProvider::drawMeasurementRect(), Layer::MeasureRect::endFrame, LayerGeometryProvider::getEndFrame(), LayerGeometryProvider::getPaintWidth(), LayerGeometryProvider::getStartFrame(), LayerGeometryProvider::getXForFrame(), Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, and Layer::MeasureRect::startFrame.

Referenced by Layer::paintMeasurementRects().

bool Layer::valueExtentsMatchMine ( LayerGeometryProvider *  v) const
protectedinherited

Definition at line 628 of file Layer.cpp.

References Layer::getValueExtents(), and LayerGeometryProvider::getVisibleExtentsForUnit().

Referenced by TimeValueLayer::getVerticalScaleWidth(), and NoteLayer::getVerticalScaleWidth().

Member Data Documentation

ModelId Colour3DPlotLayer::m_model
protected

Definition at line 165 of file Colour3DPlotLayer.h.

Referenced by getBinForY(), getCompletion(), getCurrentVerticalZoomStep(), getDisplayExtents(), getExportModel(), getFeatureDescription(), getModel(), getNewVerticalZoomRangeMapper(), getPeakCache(), getRenderer(), getSliceableModel(), getValueExtents(), getVerticalScaleWidth(), getVerticalZoomSteps(), getYForBin(), getZoomConstraint(), handleModelChanged(), handleModelChangedWithin(), paint(), paintVerticalScale(), setModel(), setVerticalZoomStep(), and snapToFeatureFrame().

ColourScaleType Colour3DPlotLayer::m_colourScale
protected

Definition at line 167 of file Colour3DPlotLayer.h.

Referenced by getColourScale(), getPropertyRangeAndValue(), getRenderer(), handleModelChanged(), handleModelChangedWithin(), setColourScale(), and toXml().

bool Colour3DPlotLayer::m_colourScaleSet
protected

Definition at line 168 of file Colour3DPlotLayer.h.

Referenced by handleModelChanged(), handleModelChangedWithin(), and setColourScale().

int Colour3DPlotLayer::m_colourMap
protected

Definition at line 169 of file Colour3DPlotLayer.h.

Referenced by getPropertyRangeAndValue(), getRenderer(), hasLightBackground(), setColourMap(), and toXml().

bool Colour3DPlotLayer::m_colourInverted
protected

Definition at line 170 of file Colour3DPlotLayer.h.

Referenced by getRenderer(), and hasLightBackground().

float Colour3DPlotLayer::m_gain
protected

Definition at line 171 of file Colour3DPlotLayer.h.

Referenced by getGain(), getPropertyRangeAndValue(), getRenderer(), setGain(), and toXml().

BinScale Colour3DPlotLayer::m_binScale
protected

Definition at line 172 of file Colour3DPlotLayer.h.

Referenced by getBinForY(), getBinScale(), getPropertyRangeAndValue(), getRenderer(), getValueExtents(), getYForBin(), setBinScale(), and toXml().

ColumnNormalization Colour3DPlotLayer::m_normalization
protected

Definition at line 173 of file Colour3DPlotLayer.h.

Referenced by getNormalization(), getPropertyRangeAndValue(), getRenderer(), setNormalization(), and toXml().

bool Colour3DPlotLayer::m_normalizeVisibleArea
protected

Definition at line 174 of file Colour3DPlotLayer.h.

Referenced by getNormalizeVisibleArea(), getPropertyRangeAndValue(), getRenderer(), paintWithRenderer(), setNormalizeVisibleArea(), and toXml().

bool Colour3DPlotLayer::m_invertVertical
protected

Definition at line 175 of file Colour3DPlotLayer.h.

Referenced by getFeatureDescription(), getInvertVertical(), getPropertyRangeAndValue(), getRenderer(), paintVerticalScale(), setInvertVertical(), and toXml().

bool Colour3DPlotLayer::m_opaque
protected

Definition at line 176 of file Colour3DPlotLayer.h.

Referenced by getOpaque(), getPropertyRangeAndValue(), getRenderer(), setOpaque(), and toXml().

bool Colour3DPlotLayer::m_smooth
protected

Definition at line 177 of file Colour3DPlotLayer.h.

Referenced by getPropertyRangeAndValue(), getRenderer(), getSmooth(), setSmooth(), and toXml().

int Colour3DPlotLayer::m_peakResolution
protected

Definition at line 178 of file Colour3DPlotLayer.h.

Referenced by setModel().

int Colour3DPlotLayer::m_miny
protected

Definition at line 182 of file Colour3DPlotLayer.h.

Referenced by getDisplayExtents(), getFeatureDescription(), paintVerticalScale(), setDisplayExtents(), setVerticalZoomStep(), and toXml().

int Colour3DPlotLayer::m_maxy
protected

Definition at line 183 of file Colour3DPlotLayer.h.

Referenced by getDisplayExtents(), getFeatureDescription(), paintVerticalScale(), setDisplayExtents(), setVerticalZoomStep(), and toXml().

bool Colour3DPlotLayer::m_synchronous
protected

Definition at line 185 of file Colour3DPlotLayer.h.

Referenced by paintWithRenderer(), and setSynchronousPainting().

ModelId Colour3DPlotLayer::m_peakCache
mutableprotected

Definition at line 192 of file Colour3DPlotLayer.h.

Referenced by getPeakCache(), and invalidatePeakCache().

const int Colour3DPlotLayer::m_peakCacheDivisor
protected

Definition at line 193 of file Colour3DPlotLayer.h.

Referenced by getPeakCache().

std::vector<ModelId> Colour3DPlotLayer::m_exporters
mutableprotected

Definition at line 197 of file Colour3DPlotLayer.h.

Referenced by getExportModel(), and ~Colour3DPlotLayer().

ViewMagMap Colour3DPlotLayer::m_viewMags
mutableprotected

Definition at line 200 of file Colour3DPlotLayer.h.

Referenced by getRenderer(), invalidateMagnitudes(), paintVerticalScale(), and paintWithRenderer().

ViewMagMap Colour3DPlotLayer::m_lastRenderedMags
mutableprotected

Definition at line 201 of file Colour3DPlotLayer.h.

Referenced by getRenderer(), and paintWithRenderer().

ViewRendererMap Colour3DPlotLayer::m_renderers
mutableprotected

Definition at line 205 of file Colour3DPlotLayer.h.

Referenced by getRenderer(), invalidateRenderers(), and paintWithRenderer().

MeasureRectSet Layer::m_measureRects
protectedinherited

Definition at line 693 of file Layer.h.

Referenced by Layer::addMeasureRectToSet(), Layer::deleteCurrentMeasureRect(), Layer::deleteMeasureRectFromSet(), Layer::findFocusedMeasureRect(), Layer::paintMeasurementRects(), Layer::toXml(), and Layer::updateMeasurePixrects().

MeasureRect Layer::m_draggingRect
protectedinherited

Definition at line 694 of file Layer.h.

Referenced by Layer::measureDrag(), Layer::measureEnd(), Layer::measureStart(), and Layer::paintMeasurementRects().

bool Layer::m_haveDraggingRect
protectedinherited

Definition at line 695 of file Layer.h.

Referenced by Layer::measureDrag(), Layer::measureEnd(), Layer::measureStart(), and Layer::paintMeasurementRects().

bool Layer::m_haveCurrentMeasureRect
mutableprotectedinherited

Definition at line 696 of file Layer.h.

Referenced by Layer::deleteCurrentMeasureRect(), Layer::haveCurrentMeasureRect(), and Layer::paintMeasurementRects().

QPoint Layer::m_currentMeasureRectPoint
mutableprotectedinherited

Definition at line 697 of file Layer.h.

Referenced by Layer::deleteCurrentMeasureRect(), and Layer::paintMeasurementRects().

QString Layer::m_presentationName
protectedinherited

Definition at line 716 of file Layer.h.

Referenced by Layer::getLayerPresentationName(), Layer::getPropertyContainerName(), Layer::isPresentationNameSet(), Layer::setPresentationName(), Layer::toBriefXml(), and Layer::toXml().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11