svgui  1.9
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:
Collaboration diagram for Colour3DPlotLayer:

Public Types

enum  ColourScale { LinearScale, LogScale, PlusMinusOneScale, AbsoluteScale }
 
enum  BinScale { LinearBinScale, LogBinScale }
 
enum  VerticalPosition { PositionTop, PositionMiddle, PositionBottom }
 
enum  SnapType { SnapLeft, SnapRight, SnapNearest, SnapNeighbouring }
 
enum  ColourSignificance {
  ColourAbsent, ColourIrrelevant, ColourDistinguishes, ColourAndBackgroundSignificant,
  ColourHasMeaningfulValue
}
 

Public Slots

void showLayer (View *, bool show)
 

Signals

void sliceableModelReplaced (const Model *modelToBeReplaced, const Model *replacement)
 
void modelCompletionChanged ()
 
void modelAlignmentCompletionChanged ()
 
void modelReplaced ()
 
void layerParametersChanged ()
 
void layerParameterRangesChanged ()
 
void layerMeasurementRectsChanged ()
 
void layerNameChanged ()
 
void verticalZoomChanged ()
 

Public Member Functions

 Colour3DPlotLayer ()
 
 ~Colour3DPlotLayer ()
 
virtual const ZoomConstraint * getZoomConstraint () const
 Return a zoom constraint object defining the supported zoom levels for this layer. More...
 
virtual const Model * getModel () const
 
virtual void paint (View *v, QPainter &paint, QRect rect) const
 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...
 
virtual int getVerticalScaleWidth (View *v, bool, QPainter &) const
 
virtual void paintVerticalScale (View *v, bool, QPainter &paint, QRect rect) const
 
virtual QString getFeatureDescription (View *v, QPoint &) const
 
virtual bool snapToFeatureFrame (View *v, int &frame, int &resolution, SnapType snap) const
 Adjust the given frame to snap to the nearest feature, if possible. More...
 
virtual void setLayerDormant (const View *v, bool dormant)
 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...
 
virtual bool isLayerScrollable (const View *v) const
 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...
 
virtual ColourSignificance getLayerColourSignificance () const
 This should return the degree of meaning associated with colour in this layer. More...
 
void setModel (const DenseThreeDimensionalModel *model)
 
virtual int getCompletion (View *) const
 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...
 
virtual PropertyList getProperties () const
 
virtual PropertyType getPropertyType (const PropertyName &) const
 
virtual QString getPropertyLabel (const PropertyName &) const
 
virtual QString getPropertyIconName (const PropertyName &) const
 
virtual QString getPropertyGroupName (const PropertyName &) const
 
virtual int getPropertyRangeAndValue (const PropertyName &, int *min, int *max, int *deflt) const
 
virtual QString getPropertyValueLabel (const PropertyName &, int value) const
 
virtual RangeMapper * getNewPropertyRangeMapper (const PropertyName &) const
 
virtual void setProperty (const PropertyName &, int value)
 
virtual void setProperties (const QXmlAttributes &)
 Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes. More...
 
void setColourScale (ColourScale)
 
ColourScale 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 setNormalizeColumns (bool n)
 Normalize each column to its maximum value, independent of its neighbours. More...
 
bool getNormalizeColumns () const
 
void setNormalizeVisibleArea (bool n)
 Normalize each value against the maximum in the visible region. More...
 
bool getNormalizeVisibleArea () const
 
void setNormalizeHybrid (bool n)
 Normalize each column to its maximum value, and then scale by the log of the (absolute) maximum value. More...
 
bool getNormalizeHybrid () const
 
void setInvertVertical (bool i)
 
bool getInvertVertical () const
 
void setOpaque (bool i)
 
bool getOpaque () const
 
void setSmooth (bool i)
 
bool getSmooth () const
 
virtual bool getValueExtents (float &min, float &max, bool &logarithmic, QString &unit) const
 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...
 
virtual bool getDisplayExtents (float &min, float &max) const
 Return the minimum and maximum values within the displayed range for the y axis, if only a subset of the whole range of the model (returned by getValueExtents) is being displayed. More...
 
virtual bool setDisplayExtents (float min, float max)
 Set the displayed minimum and maximum values for the y axis to the given range, if supported. More...
 
virtual bool getYScaleValue (const View *, int, float &, QString &) const
 Return the value and unit at the given y coordinate in the given view. More...
 
virtual int getVerticalZoomSteps (int &defaultStep) const
 Get the number of vertical zoom steps available for this layer. More...
 
virtual int getCurrentVerticalZoomStep () const
 Get the current vertical zoom step. More...
 
virtual void setVerticalZoomStep (int)
 Set the vertical zoom step. More...
 
virtual RangeMapper * getNewVerticalZoomRangeMapper () const
 Create and return a range mapper for vertical zoom step values. More...
 
virtual const Model * getSliceableModel () const
 
virtual void toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
 Convert the layer's data (though not those of the model it refers to) into XML for file output. More...
 
Model * getModel ()
 
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 void setSynchronousPainting (bool)
 Enable or disable synchronous painting. More...
 
virtual VerticalPosition getPreferredTimeRulerPosition () const
 
virtual VerticalPosition getPreferredFrameCountPosition () const
 
virtual bool hasLightBackground () const
 
virtual QString getPropertyContainerIconName () const
 
virtual QString getPropertyContainerName () const
 
virtual void setPresentationName (QString name)
 
virtual QString getLayerPresentationName () const
 
virtual QPixmap getLayerPresentationPixmap (QSize) const
 
virtual bool getCrosshairExtents (View *, QPainter &, QPoint, std::vector< QRect > &) const
 
virtual void paintCrosshairs (View *, QPainter &, QPoint) const
 
virtual void paintMeasurementRects (View *, QPainter &, bool showFocus, QPoint focusPoint) const
 
virtual bool nearestMeasurementRectChanged (View *, QPoint prev, QPoint now) const
 
virtual QString getLabelPreceding (int) const
 
virtual bool snapToSimilarFeature (View *, int &, 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 (View *, QMouseEvent *)
 
virtual void drawDrag (View *, QMouseEvent *)
 
virtual void drawEnd (View *, QMouseEvent *)
 
virtual void eraseStart (View *, QMouseEvent *)
 
virtual void eraseDrag (View *, QMouseEvent *)
 
virtual void eraseEnd (View *, QMouseEvent *)
 
virtual void editStart (View *, QMouseEvent *)
 
virtual void editDrag (View *, QMouseEvent *)
 
virtual void editEnd (View *, QMouseEvent *)
 
virtual void splitStart (View *, QMouseEvent *)
 
virtual void splitEnd (View *, QMouseEvent *)
 
virtual void addNote (View *, QMouseEvent *)
 
virtual void measureStart (View *, QMouseEvent *)
 
virtual void measureDrag (View *, QMouseEvent *)
 
virtual void measureEnd (View *, QMouseEvent *)
 
virtual void measureDoubleClick (View *, QMouseEvent *)
 
virtual bool haveCurrentMeasureRect () const
 
virtual void deleteCurrentMeasureRect ()
 
virtual bool editOpen (View *, QMouseEvent *)
 Open an editor on the item under the mouse (e.g. More...
 
virtual void moveSelection (Selection, int)
 
virtual void resizeSelection (Selection, Selection)
 
virtual void deleteSelection (Selection)
 
virtual void copy (View *, Selection, Clipboard &)
 
virtual bool paste (View *, const Clipboard &, int, 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 (View *) 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 View *v) const
 Return whether the layer is dormant (i.e. More...
 
virtual PlayParameters * getPlayParameters ()
 
virtual bool needsTextLabelHeight () const
 
virtual bool hasTimeXAxis () const
 
virtual bool getXScaleValue (const View *v, int x, float &value, QString &unit) const
 Return the value and unit at the given x coordinate in the given view. More...
 
virtual bool getYScaleDifference (const View *v, int y0, int y1, float &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...
 

Protected Types

typedef std::set< MeasureRectMeasureRectSet
 

Protected Slots

void cacheInvalid ()
 
void cacheInvalid (int startFrame, int endFrame)
 
void modelChanged ()
 
void modelChangedWithin (int, int)
 

Protected Member Functions

float getYForBin (View *, float bin) const
 Return the y coordinate at which the given bin "starts" (i.e. More...
 
float getBinForY (View *, float y) const
 Return the bin number, possibly fractional, at the given y coordinate. More...
 
DenseThreeDimensionalModel::Column getColumn (int col) const
 
bool shouldPaintDenseIn (const View *) const
 True if we have the opaque or smooth flag set, or if the cells are so small you can't see their borders. More...
 
int getColourScaleWidth (QPainter &) const
 
void fillCache (int firstBin, int lastBin) const
 
void paintDense (View *v, QPainter &paint, QRect rect) const
 
void connectSignals (const Model *)
 
virtual int alignToReference (View *v, int frame) const
 
virtual int alignFromReference (View *v, int frame) const
 
bool clipboardHasDifferentAlignment (View *v, const Clipboard &clip) const
 
void addMeasureRectToSet (const MeasureRect &r)
 
void deleteMeasureRectFromSet (const MeasureRect &r)
 
void updateMeasurePixrects (View *v) const
 
virtual void updateMeasureRectYCoords (View *v, const MeasureRect &r) const
 
virtual void setMeasureRectYCoord (View *v, MeasureRect &r, bool start, int y) const
 
virtual void setMeasureRectFromPixrect (View *v, MeasureRect &r, QRect pixrect) const
 
MeasureRectSet::const_iterator findFocusedMeasureRect (QPoint) const
 
void paintMeasurementRect (View *v, QPainter &paint, const MeasureRect &r, bool focus) const
 

Protected Attributes

const DenseThreeDimensionalModel * m_model
 
QImage * m_cache
 
QImage * m_peaksCache
 
int m_cacheValidStart
 
int m_cacheValidEnd
 
ColourScale m_colourScale
 
bool m_colourScaleSet
 
int m_colourMap
 
float m_gain
 
BinScale m_binScale
 
bool m_normalizeColumns
 
bool m_normalizeVisibleArea
 
bool m_normalizeHybrid
 
bool m_invertVertical
 
bool m_opaque
 
bool m_smooth
 
int m_peakResolution
 
int m_miny
 
int m_maxy
 
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 with a more efficient implementation that derived the spectrogram itself from a DenseTimeValueModel instead of using a three-dimensional model. This class is retained in case it becomes useful, but it will probably need some cleaning up if it's ever actually used.

Definition at line 40 of file Colour3DPlotLayer.h.

Member Typedef Documentation

◆ MeasureRectSet

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

Definition at line 598 of file Layer.h.

Member Enumeration Documentation

◆ ColourScale

Enumerator
LinearScale 
LogScale 
PlusMinusOneScale 
AbsoluteScale 

Definition at line 88 of file Colour3DPlotLayer.h.

◆ BinScale

Enumerator
LinearBinScale 
LogBinScale 

Definition at line 108 of file Colour3DPlotLayer.h.

◆ VerticalPosition

enum Layer::VerticalPosition
inherited
Enumerator
PositionTop 
PositionMiddle 
PositionBottom 

Definition at line 106 of file Layer.h.

◆ SnapType

enum Layer::SnapType
inherited
Enumerator
SnapLeft 
SnapRight 
SnapNearest 
SnapNeighbouring 

Definition at line 157 of file Layer.h.

◆ ColourSignificance

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

Definition at line 304 of file Layer.h.

Constructor & Destructor Documentation

◆ Colour3DPlotLayer()

Colour3DPlotLayer::Colour3DPlotLayer ( )

Definition at line 40 of file Colour3DPlotLayer.cpp.

◆ ~Colour3DPlotLayer()

Colour3DPlotLayer::~Colour3DPlotLayer ( )

Definition at line 64 of file Colour3DPlotLayer.cpp.

References m_cache, and m_peaksCache.

Member Function Documentation

◆ getZoomConstraint()

virtual const ZoomConstraint* Colour3DPlotLayer::getZoomConstraint ( ) const
inlinevirtual

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 48 of file Colour3DPlotLayer.h.

References m_model.

◆ getModel() [1/2]

virtual const Model* Colour3DPlotLayer::getModel ( ) const
inlinevirtual

Implements Layer.

Definition at line 51 of file Colour3DPlotLayer.h.

References m_model.

◆ paint()

void Colour3DPlotLayer::paint ( View ,
QPainter &  ,
QRect   
) const
virtual

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 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 1251 of file Colour3DPlotLayer.cpp.

References fillCache(), View::getBackground(), View::getForeground(), View::getFrameForX(), ViewManager::getMainModelSampleRate(), View::getViewManager(), View::getXForFrame(), getYForBin(), View::getZoomLevel(), m_cache, m_maxy, m_miny, m_model, m_normalizeColumns, m_normalizeVisibleArea, paintDense(), View::shouldIlluminateLocalFeatures(), and shouldPaintDenseIn().

Referenced by getVerticalScaleWidth(), paintDense(), and paintVerticalScale().

◆ getVerticalScaleWidth()

int Colour3DPlotLayer::getVerticalScaleWidth ( View v,
bool  ,
QPainter &  paint 
) const
virtual

Implements Layer.

Definition at line 749 of file Colour3DPlotLayer.cpp.

References getColourScaleWidth(), m_model, and paint().

◆ paintVerticalScale()

void Colour3DPlotLayer::paintVerticalScale ( View v,
bool  ,
QPainter &  paint,
QRect  rect 
) const
virtual

◆ getFeatureDescription()

QString Colour3DPlotLayer::getFeatureDescription ( View v,
QPoint &  pos 
) const
virtual

◆ snapToFeatureFrame()

bool Colour3DPlotLayer::snapToFeatureFrame ( View ,
int &  ,
int &  resolution,
SnapType   
) const
virtual

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 SnapNearest, adjust the frame to that of the nearest feature in either direction. If snap is SnapNeighbouring, adjust the frame to that of the nearest feature 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.

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 1645 of file Colour3DPlotLayer.cpp.

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

◆ setLayerDormant()

void Colour3DPlotLayer::setLayerDormant ( const View v,
bool  dormant 
)
virtual

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 507 of file Colour3DPlotLayer.cpp.

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

◆ isLayerScrollable()

bool Colour3DPlotLayer::isLayerScrollable ( const View ) const
virtual

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 531 of file Colour3DPlotLayer.cpp.

References m_normalizeVisibleArea, View::shouldIlluminateLocalFeatures(), and shouldPaintDenseIn().

◆ getLayerColourSignificance()

virtual ColourSignificance Colour3DPlotLayer::getLayerColourSignificance ( ) const
inlinevirtual

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 67 of file Colour3DPlotLayer.h.

References Layer::ColourHasMeaningfulValue.

◆ setModel()

void Colour3DPlotLayer::setModel ( const DenseThreeDimensionalModel *  model)

◆ getCompletion()

virtual int Colour3DPlotLayer::getCompletion ( View ) const
inlinevirtual

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 73 of file Colour3DPlotLayer.h.

References m_model.

◆ getProperties()

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

Definition at line 153 of file Colour3DPlotLayer.cpp.

◆ getPropertyType()

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

Definition at line 195 of file Colour3DPlotLayer.cpp.

◆ getPropertyLabel()

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

Definition at line 169 of file Colour3DPlotLayer.cpp.

◆ getPropertyIconName()

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

Definition at line 184 of file Colour3DPlotLayer.cpp.

◆ getPropertyGroupName()

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

Definition at line 207 of file Colour3DPlotLayer.cpp.

◆ getPropertyRangeAndValue()

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

◆ getPropertyValueLabel()

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

Definition at line 301 of file Colour3DPlotLayer.cpp.

References ColourMapper::getColourMapName().

◆ getNewPropertyRangeMapper()

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

Definition at line 327 of file Colour3DPlotLayer.cpp.

◆ setProperty()

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

◆ setProperties()

void Colour3DPlotLayer::setProperties ( const QXmlAttributes &  )
virtual

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.

Implements Layer.

Definition at line 1699 of file Colour3DPlotLayer.cpp.

References setBinScale(), setColourMap(), setColourScale(), setDisplayExtents(), setGain(), setInvertVertical(), setNormalizeColumns(), setNormalizeVisibleArea(), setOpaque(), and setSmooth().

◆ setColourScale()

void Colour3DPlotLayer::setColourScale ( ColourScale  scale)

◆ getColourScale()

ColourScale Colour3DPlotLayer::getColourScale ( ) const
inline

Definition at line 96 of file Colour3DPlotLayer.h.

References m_colourScale.

◆ setColourMap()

void Colour3DPlotLayer::setColourMap ( int  map)

Definition at line 380 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperties(), and setProperty().

◆ getColourMap()

int Colour3DPlotLayer::getColourMap ( ) const

◆ setGain()

void Colour3DPlotLayer::setGain ( float  gain)

Set the gain multiplier for sample values in this view.

The default is 1.0.

Definition at line 389 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperties(), and setProperty().

◆ getGain()

float Colour3DPlotLayer::getGain ( ) const

Definition at line 398 of file Colour3DPlotLayer.cpp.

References m_gain.

◆ setBinScale()

void Colour3DPlotLayer::setBinScale ( BinScale  binScale)

Specify the scale for the y axis.

Definition at line 404 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperties(), and setProperty().

◆ getBinScale()

Colour3DPlotLayer::BinScale Colour3DPlotLayer::getBinScale ( ) const

Definition at line 413 of file Colour3DPlotLayer.cpp.

References m_binScale.

◆ setNormalizeColumns()

void Colour3DPlotLayer::setNormalizeColumns ( bool  n)

Normalize each column to its maximum value, independent of its neighbours.

Definition at line 419 of file Colour3DPlotLayer.cpp.

References cacheInvalid(), Layer::layerParametersChanged(), and m_normalizeColumns.

Referenced by setProperties(), and setProperty().

◆ getNormalizeColumns()

bool Colour3DPlotLayer::getNormalizeColumns ( ) const

Definition at line 428 of file Colour3DPlotLayer.cpp.

References m_normalizeColumns.

◆ setNormalizeVisibleArea()

void Colour3DPlotLayer::setNormalizeVisibleArea ( bool  n)

Normalize each value against the maximum in the visible region.

Definition at line 449 of file Colour3DPlotLayer.cpp.

References cacheInvalid(), Layer::layerParametersChanged(), and m_normalizeVisibleArea.

Referenced by setProperties(), and setProperty().

◆ getNormalizeVisibleArea()

bool Colour3DPlotLayer::getNormalizeVisibleArea ( ) const

Definition at line 458 of file Colour3DPlotLayer.cpp.

References m_normalizeVisibleArea.

◆ setNormalizeHybrid()

void Colour3DPlotLayer::setNormalizeHybrid ( bool  n)

Normalize each column to its maximum value, and then scale by the log of the (absolute) maximum value.

Definition at line 434 of file Colour3DPlotLayer.cpp.

References cacheInvalid(), Layer::layerParametersChanged(), and m_normalizeHybrid.

◆ getNormalizeHybrid()

bool Colour3DPlotLayer::getNormalizeHybrid ( ) const

Definition at line 443 of file Colour3DPlotLayer.cpp.

References m_normalizeHybrid.

◆ setInvertVertical()

void Colour3DPlotLayer::setInvertVertical ( bool  i)

◆ getInvertVertical()

bool Colour3DPlotLayer::getInvertVertical ( ) const

Definition at line 489 of file Colour3DPlotLayer.cpp.

References m_invertVertical.

◆ setOpaque()

void Colour3DPlotLayer::setOpaque ( bool  i)

Definition at line 473 of file Colour3DPlotLayer.cpp.

References Layer::layerParametersChanged(), and m_opaque.

Referenced by setProperties(), and setProperty().

◆ getOpaque()

bool Colour3DPlotLayer::getOpaque ( ) const

Definition at line 495 of file Colour3DPlotLayer.cpp.

References m_opaque.

◆ setSmooth()

void Colour3DPlotLayer::setSmooth ( bool  i)

Definition at line 481 of file Colour3DPlotLayer.cpp.

References Layer::layerParametersChanged(), and m_smooth.

Referenced by setProperties(), and setProperty().

◆ getSmooth()

bool Colour3DPlotLayer::getSmooth ( ) const

Definition at line 501 of file Colour3DPlotLayer.cpp.

References m_smooth.

◆ getValueExtents()

bool Colour3DPlotLayer::getValueExtents ( float &  min,
float &  max,
bool &  logarithmic,
QString &  unit 
) const
virtual

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.

Implements Layer.

Definition at line 544 of file Colour3DPlotLayer.cpp.

References m_model.

◆ getDisplayExtents()

bool Colour3DPlotLayer::getDisplayExtents ( float &  ,
float &   
) const
virtual

Return the minimum and maximum values within the displayed range for the y axis, if only a subset of the whole range of the model (returned by getValueExtents) is being displayed.

Return false if the layer is not imposing a particular display extent (using the normal layer extents or deferring to whatever is in use for the same units elsewhere in the view).

Reimplemented from Layer.

Definition at line 559 of file Colour3DPlotLayer.cpp.

References m_maxy, m_miny, and m_model.

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

◆ setDisplayExtents()

bool Colour3DPlotLayer::setDisplayExtents ( float  ,
float   
)
virtual

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 576 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperties().

◆ getYScaleValue()

bool Colour3DPlotLayer::getYScaleValue ( const View ,
int  ,
float &  ,
QString &   
) const
virtual

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

!!

Reimplemented from Layer.

Definition at line 588 of file Colour3DPlotLayer.cpp.

◆ getVerticalZoomSteps()

int Colour3DPlotLayer::getVerticalZoomSteps ( int &  ) const
virtual

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 595 of file Colour3DPlotLayer.cpp.

References m_model.

◆ getCurrentVerticalZoomStep()

int Colour3DPlotLayer::getCurrentVerticalZoomStep ( ) const
virtual

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 605 of file Colour3DPlotLayer.cpp.

References getDisplayExtents(), and m_model.

◆ setVerticalZoomStep()

void Colour3DPlotLayer::setVerticalZoomStep ( int  )
virtual

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 615 of file Colour3DPlotLayer.cpp.

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

◆ getNewVerticalZoomRangeMapper()

RangeMapper * Colour3DPlotLayer::getNewVerticalZoomRangeMapper ( ) const
virtual

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.

Reimplemented from Layer.

Definition at line 635 of file Colour3DPlotLayer.cpp.

References m_model.

◆ getSliceableModel()

virtual const Model* Colour3DPlotLayer::getSliceableModel ( ) const
inlinevirtual

Implements SliceableLayer.

Definition at line 162 of file Colour3DPlotLayer.h.

References m_model.

◆ toXml()

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

Convert the layer's data (though not those of the model it refers to) into XML for file output.

This class implements the basic name/type/model-id output; subclasses will typically call this superclass implementation with extra attributes describing their particular properties.

Reimplemented from Layer.

Definition at line 1671 of file Colour3DPlotLayer.cpp.

References m_binScale, m_colourMap, m_colourScale, m_gain, m_invertVertical, m_maxy, m_miny, m_normalizeColumns, m_normalizeVisibleArea, m_opaque, m_smooth, and Layer::toXml().

◆ cacheInvalid [1/2]

◆ cacheInvalid [2/2]

void Colour3DPlotLayer::cacheInvalid ( int  startFrame,
int  endFrame 
)
protectedslot

Definition at line 110 of file Colour3DPlotLayer.cpp.

References m_cache, m_cacheValidEnd, m_cacheValidStart, and m_model.

◆ modelChanged

void Colour3DPlotLayer::modelChanged ( )
protectedslot

◆ modelChangedWithin

void Colour3DPlotLayer::modelChangedWithin ( int  startFrame,
int  endFrame 
)
protectedslot

◆ getYForBin()

float Colour3DPlotLayer::getYForBin ( View v,
float  bin 
) const
protected

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.

Definition at line 644 of file Colour3DPlotLayer.cpp.

References getDisplayExtents(), LinearBinScale, m_binScale, and m_model.

Referenced by paint(), and paintVerticalScale().

◆ getBinForY()

float Colour3DPlotLayer::getBinForY ( View v,
float  y 
) const
protected

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).

Definition at line 662 of file Colour3DPlotLayer.cpp.

References getDisplayExtents(), LinearBinScale, m_binScale, and m_model.

Referenced by getFeatureDescription(), and paintDense().

◆ getColumn()

DenseThreeDimensionalModel::Column Colour3DPlotLayer::getColumn ( int  col) const
protected

Definition at line 913 of file Colour3DPlotLayer.cpp.

References m_model, m_normalizeColumns, and m_normalizeHybrid.

Referenced by fillCache().

◆ shouldPaintDenseIn()

bool Colour3DPlotLayer::shouldPaintDenseIn ( const View v) const
protected

True if we have the opaque or smooth flag set, or if the cells are so small you can't see their borders.

False for big, translucent cells.

Definition at line 1233 of file Colour3DPlotLayer.cpp.

References ViewManager::getMainModelSampleRate(), View::getViewManager(), View::getZoomLevel(), m_model, m_opaque, and m_smooth.

Referenced by isLayerScrollable(), and paint().

◆ getColourScaleWidth()

int Colour3DPlotLayer::getColourScaleWidth ( QPainter &  ) const
protected

Definition at line 742 of file Colour3DPlotLayer.cpp.

Referenced by getVerticalScaleWidth(), and paintVerticalScale().

◆ fillCache()

void Colour3DPlotLayer::fillCache ( int  firstBin,
int  lastBin 
) const
protected

◆ paintDense()

void Colour3DPlotLayer::paintDense ( View v,
QPainter &  paint,
QRect  rect 
) const
protected

◆ sliceableModelReplaced

void SliceableLayer::sliceableModelReplaced ( const Model *  modelToBeReplaced,
const Model *  replacement 
)
signalinherited

◆ getModel() [2/2]

Model* Layer::getModel ( )
inlineinherited

Definition at line 62 of file Layer.h.

References Layer::getModel().

◆ supportsOtherZoomLevels()

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 81 of file Layer.h.

◆ setSynchronousPainting()

virtual void Layer::setSynchronousPainting ( bool  )
inlinevirtualinherited

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 in SpectrogramLayer.

Definition at line 104 of file Layer.h.

◆ getPreferredTimeRulerPosition()

virtual VerticalPosition Layer::getPreferredTimeRulerPosition ( ) const
inlinevirtualinherited

Definition at line 109 of file Layer.h.

References Layer::PositionMiddle.

◆ getPreferredFrameCountPosition()

virtual VerticalPosition Layer::getPreferredFrameCountPosition ( ) const
inlinevirtualinherited

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 112 of file Layer.h.

References Layer::PositionBottom.

◆ hasLightBackground()

virtual bool Layer::hasLightBackground ( ) const
inlinevirtualinherited

Reimplemented in SpectrogramLayer, and SingleColourLayer.

Definition at line 115 of file Layer.h.

◆ getPropertyContainerIconName()

QString Layer::getPropertyContainerIconName ( ) const
virtualinherited

Definition at line 65 of file Layer.cpp.

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

Referenced by LayerTreeModel::data().

◆ getPropertyContainerName()

virtual QString Layer::getPropertyContainerName ( ) const
inlinevirtualinherited

Definition at line 121 of file Layer.h.

References Layer::m_presentationName.

◆ setPresentationName()

void Layer::setPresentationName ( QString  name)
virtualinherited

Definition at line 72 of file Layer.cpp.

References Layer::m_presentationName.

◆ getLayerPresentationName()

QString Layer::getLayerPresentationName ( ) const
virtualinherited

◆ getLayerPresentationPixmap()

virtual QPixmap Layer::getLayerPresentationPixmap ( QSize  ) const
inlinevirtualinherited

Reimplemented in SingleColourLayer.

Definition at line 129 of file Layer.h.

◆ getCrosshairExtents()

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

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 137 of file Layer.h.

◆ paintCrosshairs()

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

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 141 of file Layer.h.

◆ paintMeasurementRects()

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

◆ nearestMeasurementRectChanged()

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

Definition at line 460 of file Layer.cpp.

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

Referenced by Pane::mouseMoveEvent().

◆ getLabelPreceding()

virtual QString Layer::getLabelPreceding ( int  ) const
inlinevirtualinherited

Reimplemented in RegionLayer, TimeValueLayer, and TimeInstantLayer.

Definition at line 153 of file Layer.h.

◆ snapToSimilarFeature()

virtual bool Layer::snapToSimilarFeature ( View ,
int &  ,
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 207 of file Layer.h.

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

◆ drawStart()

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

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

Definition at line 220 of file Layer.h.

Referenced by Pane::mousePressEvent().

◆ drawDrag()

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

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

Definition at line 221 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

◆ drawEnd()

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

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

Definition at line 222 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

◆ eraseStart()

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

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

Definition at line 224 of file Layer.h.

Referenced by Pane::mousePressEvent().

◆ eraseDrag()

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

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

Definition at line 225 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

◆ eraseEnd()

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

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

Definition at line 226 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

◆ editStart()

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

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

Definition at line 228 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

◆ editDrag()

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

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

Definition at line 229 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

◆ editEnd()

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

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

Definition at line 230 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

◆ splitStart()

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

Reimplemented in FlexiNoteLayer.

Definition at line 232 of file Layer.h.

Referenced by Pane::mousePressEvent().

◆ splitEnd()

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

Reimplemented in FlexiNoteLayer.

Definition at line 233 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

◆ addNote()

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

Reimplemented in FlexiNoteLayer.

Definition at line 234 of file Layer.h.

Referenced by Pane::mouseDoubleClickEvent().

◆ measureStart()

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

◆ measureDrag()

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

◆ measureEnd()

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

◆ measureDoubleClick()

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

Reimplemented in SpectrogramLayer.

Definition at line 408 of file Layer.cpp.

Referenced by Pane::mouseDoubleClickEvent().

◆ haveCurrentMeasureRect()

virtual bool Layer::haveCurrentMeasureRect ( ) const
inlinevirtualinherited

Definition at line 245 of file Layer.h.

References Layer::m_haveCurrentMeasureRect.

◆ deleteCurrentMeasureRect()

◆ editOpen()

virtual bool Layer::editOpen ( View ,
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 FlexiNoteLayer, RegionLayer, TimeValueLayer, ImageLayer, TextLayer, NoteLayer, and TimeInstantLayer.

Definition at line 255 of file Layer.h.

Referenced by Pane::mouseDoubleClickEvent().

◆ moveSelection()

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

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

Definition at line 257 of file Layer.h.

Referenced by Pane::editSelectionEnd().

◆ resizeSelection()

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

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

Definition at line 258 of file Layer.h.

Referenced by Pane::editSelectionEnd().

◆ deleteSelection()

virtual void Layer::deleteSelection ( Selection  )
inlinevirtualinherited

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

Definition at line 259 of file Layer.h.

◆ copy()

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

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

Definition at line 261 of file Layer.h.

Referenced by SpectrogramLayer::paint(), and paintDense().

◆ paste()

virtual bool Layer::paste ( View ,
const Clipboard &  ,
int  ,
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 FlexiNoteLayer, RegionLayer, TimeValueLayer, NoteLayer, TimeInstantLayer, ImageLayer, and TextLayer.

Definition at line 270 of file Layer.h.

◆ isLayerOpaque()

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 302 of file Layer.h.

Referenced by View::getAligningModel().

◆ isLayerEditable()

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, TimeInstantLayer, ImageLayer, and TextLayer.

Definition at line 338 of file Layer.h.

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

◆ getError()

virtual QString Layer::getError ( View ) 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 354 of file Layer.h.

◆ setObjectName()

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

Definition at line 100 of file Layer.cpp.

References Layer::layerNameChanged().

Referenced by LayerFactory::createLayer().

◆ toBriefXml()

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 626 of file Layer.cpp.

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

◆ addMeasurementRect()

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 317 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.

◆ isLayerDormant()

bool Layer::isLayerDormant ( const View v) const
virtualinherited

◆ getPlayParameters()

PlayParameters * Layer::getPlayParameters ( )
virtualinherited

◆ needsTextLabelHeight()

virtual bool Layer::needsTextLabelHeight ( ) const
inlinevirtualinherited

Reimplemented in TimeValueLayer, and TimeInstantLayer.

Definition at line 413 of file Layer.h.

◆ hasTimeXAxis()

virtual bool Layer::hasTimeXAxis ( ) const
inlinevirtualinherited

Reimplemented in SliceLayer.

Definition at line 415 of file Layer.h.

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

◆ getXScaleValue()

bool Layer::getXScaleValue ( const View v,
int  x,
float &  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 142 of file Layer.cpp.

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

Referenced by View::drawMeasurementRect().

◆ getYScaleDifference()

bool Layer::getYScaleDifference ( const View v,
int  y0,
int  y1,
float &  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 155 of file Layer.cpp.

References Layer::getYScaleValue().

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

◆ showLayer

void Layer::showLayer ( View view,
bool  show 
)
slotinherited

◆ modelCompletionChanged

void Layer::modelCompletionChanged ( )
signalinherited

Referenced by Layer::connectSignals().

◆ modelAlignmentCompletionChanged

void Layer::modelAlignmentCompletionChanged ( )
signalinherited

Referenced by Layer::connectSignals().

◆ modelReplaced

◆ layerParametersChanged

void Layer::layerParametersChanged ( )
signalinherited

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

◆ layerParameterRangesChanged

void Layer::layerParameterRangesChanged ( )
signalinherited

◆ layerMeasurementRectsChanged

void Layer::layerMeasurementRectsChanged ( )
signalinherited

◆ layerNameChanged

void Layer::layerNameChanged ( )
signalinherited

Referenced by Layer::setObjectName().

◆ verticalZoomChanged

void Layer::verticalZoomChanged ( )
signalinherited

◆ connectSignals()

◆ alignToReference()

int Layer::alignToReference ( View v,
int  frame 
) const
protectedvirtualinherited

◆ alignFromReference()

int Layer::alignFromReference ( View v,
int  frame 
) const
protectedvirtualinherited

◆ clipboardHasDifferentAlignment()

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

◆ addMeasureRectToSet()

void Layer::addMeasureRectToSet ( const MeasureRect r)
inlineprotectedinherited

Definition at line 588 of file Layer.h.

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

Referenced by Layer::addMeasurementRect().

◆ deleteMeasureRectFromSet()

void Layer::deleteMeasureRectFromSet ( const MeasureRect r)
inlineprotectedinherited

Definition at line 593 of file Layer.h.

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

◆ updateMeasurePixrects()

void Layer::updateMeasurePixrects ( View v) const
protectedinherited

◆ updateMeasureRectYCoords()

void Layer::updateMeasureRectYCoords ( View v,
const MeasureRect r 
) const
protectedvirtualinherited

◆ setMeasureRectYCoord()

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

Reimplemented in SpectrogramLayer.

Definition at line 518 of file Layer.cpp.

References Layer::MeasureRect::endY, and Layer::MeasureRect::startY.

Referenced by Layer::setMeasureRectFromPixrect().

◆ setMeasureRectFromPixrect()

◆ findFocusedMeasureRect()

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

◆ paintMeasurementRect()

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

Member Data Documentation

◆ m_model

◆ m_cache

QImage* Colour3DPlotLayer::m_cache
mutableprotected

◆ m_peaksCache

QImage* Colour3DPlotLayer::m_peaksCache
mutableprotected

Definition at line 177 of file Colour3DPlotLayer.h.

Referenced by cacheInvalid(), fillCache(), paintDense(), and ~Colour3DPlotLayer().

◆ m_cacheValidStart

int Colour3DPlotLayer::m_cacheValidStart
mutableprotected

Definition at line 178 of file Colour3DPlotLayer.h.

Referenced by cacheInvalid(), and fillCache().

◆ m_cacheValidEnd

int Colour3DPlotLayer::m_cacheValidEnd
mutableprotected

Definition at line 179 of file Colour3DPlotLayer.h.

Referenced by cacheInvalid(), and fillCache().

◆ m_colourScale

ColourScale Colour3DPlotLayer::m_colourScale
protected

◆ m_colourScaleSet

bool Colour3DPlotLayer::m_colourScaleSet
protected

Definition at line 182 of file Colour3DPlotLayer.h.

Referenced by modelChanged(), modelChangedWithin(), and setColourScale().

◆ m_colourMap

int Colour3DPlotLayer::m_colourMap
protected

Definition at line 183 of file Colour3DPlotLayer.h.

Referenced by fillCache(), getPropertyRangeAndValue(), setColourMap(), and toXml().

◆ m_gain

float Colour3DPlotLayer::m_gain
protected

Definition at line 184 of file Colour3DPlotLayer.h.

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

◆ m_binScale

BinScale Colour3DPlotLayer::m_binScale
protected

◆ m_normalizeColumns

bool Colour3DPlotLayer::m_normalizeColumns
protected

◆ m_normalizeVisibleArea

bool Colour3DPlotLayer::m_normalizeVisibleArea
protected

◆ m_normalizeHybrid

bool Colour3DPlotLayer::m_normalizeHybrid
protected

Definition at line 188 of file Colour3DPlotLayer.h.

Referenced by getColumn(), getNormalizeHybrid(), and setNormalizeHybrid().

◆ m_invertVertical

bool Colour3DPlotLayer::m_invertVertical
protected

◆ m_opaque

bool Colour3DPlotLayer::m_opaque
protected

◆ m_smooth

bool Colour3DPlotLayer::m_smooth
protected

◆ m_peakResolution

int Colour3DPlotLayer::m_peakResolution
protected

Definition at line 192 of file Colour3DPlotLayer.h.

Referenced by fillCache(), paintDense(), and setModel().

◆ m_miny

int Colour3DPlotLayer::m_miny
protected

◆ m_maxy

int Colour3DPlotLayer::m_maxy
protected

◆ m_measureRects

◆ m_draggingRect

MeasureRect Layer::m_draggingRect
protectedinherited

◆ m_haveDraggingRect

bool Layer::m_haveDraggingRect
protectedinherited

◆ m_haveCurrentMeasureRect

bool Layer::m_haveCurrentMeasureRect
mutableprotectedinherited

◆ m_currentMeasureRectPoint

QPoint Layer::m_currentMeasureRectPoint
mutableprotectedinherited

Definition at line 603 of file Layer.h.

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

◆ m_presentationName

QString Layer::m_presentationName
protectedinherited

The documentation for this class was generated from the following files: