SliceLayer Class Reference

#include <SliceLayer.h>

Inheritance diagram for SliceLayer:

Collaboration diagram for SliceLayer:

Public Types
enum	EnergyScale { LinearScale, MeterScale, dBScale, AbsoluteScale }
enum	SamplingMode { NearestSample, SampleMean, SamplePeak }
enum	PlotStyle { PlotLines, PlotSteps, PlotBlocks, PlotFilledBlocks }
enum	BinScale { LinearBins, LogBins, InvertedLogBins }
enum	VerticalPosition { PositionTop, PositionMiddle, PositionBottom }
enum	SnapType { SnapLeft, SnapRight, SnapNeighbouring }
enum	ColourSignificance {   ColourAbsent, ColourIrrelevant, ColourDistinguishes, ColourAndBackgroundSignificant,   ColourHasMeaningfulValue }

Public Slots
void	sliceableModelReplaced (ModelId, ModelId)
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
	SliceLayer ()
	~SliceLayer ()
ModelId	getModel () const override
	Return the ID of the model represented in this layer. More...
void	setSliceableModel (ModelId model)
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...
QString	getFeatureDescription (LayerGeometryProvider *v, QPoint &) const override
int	getVerticalScaleWidth (LayerGeometryProvider *v, bool, QPainter &) const override
void	paintVerticalScale (LayerGeometryProvider *v, bool, QPainter &paint, QRect rect) const override
ColourSignificance	getLayerColourSignificance () const override
	Implements Layer::getLayerColourSignificance() More...
bool	hasLightBackground () const override
	Return true if the layer currently has a dark colour on a light background, false if it has a light colour on a dark background. More...
PropertyList	getProperties () const override
QString	getPropertyLabel (const PropertyName &) const override
QString	getPropertyIconName (const PropertyName &) const override
PropertyType	getPropertyType (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
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...
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...
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...
virtual bool	hasTimeXAxis () const override
	Return true if the X axis on the layer is time proportional to audio frames, false otherwise. More...
virtual void	zoomToRegion (const LayerGeometryProvider *, QRect) override
	Update the X and Y axis scales, where appropriate, to focus on the given rectangular region. More...
bool	isLayerScrollable (const LayerGeometryProvider *) 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...
bool	usesSolidColour () const
void	setFillColourMap (int)
int	getFillColourMap () const
void	setEnergyScale (EnergyScale)
EnergyScale	getEnergyScale () const
void	setSamplingMode (SamplingMode)
SamplingMode	getSamplingMode () const
void	setPlotStyle (PlotStyle style)
PlotStyle	getPlotStyle () const
void	setBinScale (BinScale scale)
BinScale	getBinScale () const
void	setThreshold (float)
float	getThreshold () const
void	setGain (float gain)
float	getGain () const
void	setNormalize (bool n)
bool	getNormalize () const
void	toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const override
virtual void	setBaseColour (int)
	Set the colour used to draw primary items in the layer. More...
virtual int	getBaseColour () const
	Retrieve the current primary drawing colour, as a ColourDatabase index value. More...
QPixmap	getLayerPresentationPixmap (QSize size) const override
virtual void	setDefaultColourFor (LayerGeometryProvider *v)
ModelId	getSourceModel () const
	Return the ID of the source model for the model represented in this layer. More...
virtual ModelId	getExportModel (LayerGeometryProvider *) const
	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...
virtual const ZoomConstraint *	getZoomConstraint () const
	Return a zoom constraint object defining the supported zoom levels for 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 void	setSynchronousPainting (bool)
	Enable or disable synchronous painting. 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 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	snapToFeatureFrame (LayerGeometryProvider *, sv_frame_t &, int &resolution, SnapType, int) const
	Adjust the given frame to snap to the nearest feature, if possible. More...
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 int	getCompletion (LayerGeometryProvider *) 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 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 void	setLayerDormant (const LayerGeometryProvider *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	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	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	getYScaleValue (const LayerGeometryProvider *, int, double &, QString &) const
	Return the value and unit at the given y 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
enum	BinAlignment { BinsCentredOnScalePoints, BinsSpanScalePoints }
typedef std::vector< float >	BiasCurve
typedef std::map< int, int >	ColourRefCount
typedef std::set< MeasureRect >	MeasureRectSet

Protected Member Functions
virtual double	getXForBin (const LayerGeometryProvider *, double bin) const
	Convert a (possibly non-integral) bin into x-coord. May be overridden. More...
virtual double	getBinForX (const LayerGeometryProvider *, double x) const
	Convert an x-coord into (possibly non-integral) bin. May be overridden. More...
double	getXForScalePoint (const LayerGeometryProvider *, double p, double pmin, double pmax) const
	Convert a point such as a bin number into x-coord, given max & min. More...
double	getScalePointForX (const LayerGeometryProvider *, double x, double pmin, double pmax) const
	Convert an x-coord into a point such as a bin number, given max & min. More...
virtual double	getYForValue (const LayerGeometryProvider *v, double value, double &norm) const
virtual double	getValueForY (const LayerGeometryProvider *v, double y) const
virtual QString	getFeatureDescriptionAux (LayerGeometryProvider *v, QPoint &, bool includeBinDescription, int &minbin, int &maxbin, int &range) const
virtual void	getBiasCurve (BiasCurve &) const
virtual float	getThresholdDb () const
int	getDefaultColourHint (bool dark, bool &impose) override
virtual QColor	getBaseQColor () const
virtual QColor	getBackgroundQColor (LayerGeometryProvider *v) const
virtual QColor	getForegroundQColor (LayerGeometryProvider *v) const
std::vector< QColor >	getPartialShades (LayerGeometryProvider *v) const
virtual void	flagBaseColourChanged ()
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

Protected Attributes
ModelId	m_sliceableModel
BinAlignment	m_binAlignment
int	m_colourMap
bool	m_colourInverted
EnergyScale	m_energyScale
SamplingMode	m_samplingMode
PlotStyle	m_plotStyle
BinScale	m_binScale
bool	m_normalize
float	m_threshold
float	m_initialThreshold
float	m_gain
int	m_minbin
int	m_maxbin
std::vector< int >	m_scalePoints
int	m_scalePaintHeight
std::map< int, int >	m_xorigins
std::map< int, int >	m_yorigins
std::map< int, int >	m_heights
sv_frame_t	m_currentf0
sv_frame_t	m_currentf1
std::vector< float >	m_values
int	m_colour
bool	m_colourExplicitlySet
bool	m_defaultColourSet
MeasureRectSet	m_measureRects
MeasureRect	m_draggingRect
bool	m_haveDraggingRect
bool	m_haveCurrentMeasureRect
QPoint	m_currentMeasureRectPoint
QString	m_presentationName

Static Protected Attributes
static ColourRefCount	m_colourRefCount

Detailed Description

Definition at line 27 of file SliceLayer.h.

Member Typedef Documentation

typedef std::vector<float> SliceLayer::BiasCurve

protected

Definition at line 150 of file SliceLayer.h.

typedef std::map<int, int> SingleColourLayer::ColourRefCount

protectedinherited

Definition at line 89 of file SingleColourLayer.h.

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

protectedinherited

Definition at line 692 of file Layer.h.

Member Enumeration Documentation

enum SliceLayer::EnergyScale

Enumerator
LinearScale
MeterScale
dBScale
AbsoluteScale

Definition at line 82 of file SliceLayer.h.

enum SliceLayer::SamplingMode

Enumerator
NearestSample
SampleMean
SamplePeak

Definition at line 84 of file SliceLayer.h.

enum SliceLayer::PlotStyle

Enumerator
PlotLines
PlotSteps
PlotBlocks
PlotFilledBlocks

Definition at line 86 of file SliceLayer.h.

enum SliceLayer::BinScale

Enumerator
LinearBins
LogBins
InvertedLogBins

Definition at line 88 of file SliceLayer.h.

enum SliceLayer::BinAlignment

protected

Enumerator
BinsCentredOnScalePoints
BinsSpanScalePoints

Definition at line 168 of file SliceLayer.h.

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

SliceLayer::SliceLayer

(

)

Definition at line 34 of file SliceLayer.cpp.

SliceLayer::~SliceLayer

(

)

Definition at line 53 of file SliceLayer.cpp.

Member Function Documentation

ModelId SliceLayer::getModel ( ) const

inlineoverridevirtual

Return the ID of the model represented in this layer.

Implements Layer.

Reimplemented in SpectrumLayer.

Definition at line 35 of file SliceLayer.h.

References getFeatureDescription(), getVerticalScaleWidth(), paint(), paintVerticalScale(), and setSliceableModel().

void SliceLayer::setSliceableModel

(

ModelId

model

)

Definition at line 59 of file SliceLayer.cpp.

References Layer::connectSignals(), Layer::layerParametersChanged(), m_maxbin, m_minbin, m_sliceableModel, and Layer::modelReplaced().

Referenced by getModel(), SpectrumLayer::setupFFT(), and sliceableModelReplaced().

void SliceLayer::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).

!! and dark background?

Implements Layer.

Reimplemented in SpectrumLayer.

Definition at line 409 of file SliceLayer.cpp.

References BinsSpanScalePoints, LayerGeometryProvider::getBackground(), SingleColourLayer::getBaseQColor(), getBiasCurve(), LayerGeometryProvider::getCentreFrame(), LayerGeometryProvider::getFrameForX(), Layer::getHorizontalScaleHeight(), LayerGeometryProvider::getId(), LayerGeometryProvider::getPaintHeight(), getVerticalScaleWidth(), LayerGeometryProvider::getViewManager(), getXForBin(), LayerGeometryProvider::getXForFrame(), getYForValue(), m_binAlignment, m_colourInverted, m_colourMap, m_currentf0, m_currentf1, m_heights, m_maxbin, m_minbin, m_normalize, m_plotStyle, m_samplingMode, m_scalePaintHeight, m_scalePoints, m_sliceableModel, m_values, m_xorigins, m_yorigins, ColourMapper::map(), NearestSample, PlotBlocks, PlotFilledBlocks, PlotLines, PlotSteps, SampleMean, SamplePeak, LayerGeometryProvider::scalePen(), and ViewManager::shouldShowScaleGuides().

Referenced by getModel(), and SpectrumLayer::paint().

QString SliceLayer::getFeatureDescription ( LayerGeometryProvider *  v, QPoint &  p  ) const

overridevirtual

Reimplemented from Layer.

Reimplemented in SpectrumLayer.

Definition at line 94 of file SliceLayer.cpp.

References getFeatureDescriptionAux().

Referenced by getModel().

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

overridevirtual

Implements Layer.

Definition at line 665 of file SliceLayer.cpp.

References AbsoluteScale, LinearScale, and m_energyScale.

Referenced by SpectrumLayer::getCrosshairExtents(), getModel(), paint(), and SpectrumLayer::paint().

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

overridevirtual

Reimplemented from Layer.

Definition at line 684 of file SliceLayer.cpp.

References AbsoluteScale, Layer::getHorizontalScaleHeight(), LayerGeometryProvider::getPaintHeight(), getThresholdDb(), LinearScale, m_energyScale, m_gain, m_scalePaintHeight, m_scalePoints, m_threshold, and PaintAssistant::paintVerticalLevelScale().

Referenced by getModel().

ColourSignificance SliceLayer::getLayerColourSignificance ( ) const

inlineoverridevirtual

Implements Layer::getLayerColourSignificance()

Reimplemented from SingleColourLayer.

Definition at line 46 of file SliceLayer.h.

References Layer::ColourAndBackgroundSignificant, getCurrentVerticalZoomStep(), getDisplayExtents(), getNewPropertyRangeMapper(), getNewVerticalZoomRangeMapper(), getProperties(), getPropertyGroupName(), getPropertyIconName(), getPropertyLabel(), getPropertyRangeAndValue(), getPropertyType(), getPropertyValueLabel(), getValueExtents(), getVerticalZoomSteps(), hasLightBackground(), setDisplayExtents(), setProperties(), setProperty(), and setVerticalZoomStep().

bool SliceLayer::hasLightBackground ( ) const

overridevirtual

Return true if the layer currently has a dark colour on a light background, false if it has a light colour on a dark background.

Reimplemented from SingleColourLayer.

Definition at line 729 of file SliceLayer.cpp.

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

Referenced by getLayerColourSignificance(), and SpectrumLayer::paint().

Layer::PropertyList SliceLayer::getProperties ( ) const

override

Definition at line 740 of file SliceLayer.cpp.

References SingleColourLayer::getProperties().

Referenced by getLayerColourSignificance(), and SpectrumLayer::getProperties().

QString SliceLayer::getPropertyLabel ( const PropertyName &  name ) const

override

Definition at line 754 of file SliceLayer.cpp.

References SingleColourLayer::getPropertyLabel().

Referenced by getLayerColourSignificance(), and SpectrumLayer::getPropertyLabel().

QString SliceLayer::getPropertyIconName ( const PropertyName &  name ) const

override

Definition at line 767 of file SliceLayer.cpp.

Referenced by getLayerColourSignificance(), and SpectrumLayer::getPropertyIconName().

Layer::PropertyType SliceLayer::getPropertyType ( const PropertyName &  name ) const

override

Definition at line 774 of file SliceLayer.cpp.

References SingleColourLayer::getPropertyType(), and usesSolidColour().

Referenced by getLayerColourSignificance(), and SpectrumLayer::getPropertyType().

QString SliceLayer::getPropertyGroupName ( const PropertyName &  name ) const

override

Definition at line 788 of file SliceLayer.cpp.

References SingleColourLayer::getPropertyGroupName().

Referenced by getLayerColourSignificance(), and SpectrumLayer::getPropertyGroupName().

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

override

Definition at line 801 of file SliceLayer.cpp.

References dBScale, ColourMapper::getColourMapCount(), SingleColourLayer::getPropertyRangeAndValue(), ColourMapper::Ice, LinearBins, m_binScale, m_colourMap, m_energyScale, m_gain, m_initialThreshold, m_normalize, m_plotStyle, m_samplingMode, m_threshold, PlotSteps, SampleMean, and usesSolidColour().

Referenced by getLayerColourSignificance(), and SpectrumLayer::getPropertyRangeAndValue().

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

override

Definition at line 890 of file SliceLayer.cpp.

References ColourMapper::getColourMapLabel(), SingleColourLayer::getPropertyValueLabel(), and usesSolidColour().

Referenced by getLayerColourSignificance(), and SpectrumLayer::getPropertyValueLabel().

RangeMapper * SliceLayer::getNewPropertyRangeMapper ( const PropertyName &  name ) const

override

Definition at line 934 of file SliceLayer.cpp.

References SingleColourLayer::getNewPropertyRangeMapper().

Referenced by getLayerColourSignificance(), and SpectrumLayer::getNewPropertyRangeMapper().

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

override

Definition at line 946 of file SliceLayer.cpp.

References AbsoluteScale, dBScale, InvertedLogBins, LinearBins, LinearScale, LogBins, MeterScale, NearestSample, SampleMean, SamplePeak, setBinScale(), setEnergyScale(), setFillColourMap(), setGain(), setNormalize(), setPlotStyle(), SingleColourLayer::setProperty(), setSamplingMode(), setThreshold(), and usesSolidColour().

Referenced by getLayerColourSignificance(), and SpectrumLayer::setProperty().

void SliceLayer::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.

Reimplemented from SingleColourLayer.

Reimplemented in SpectrumLayer.

Definition at line 1111 of file SliceLayer.cpp.

References ColourMapper::getColourMapById(), ColourMapper::getColourMapCount(), setBinScale(), setDisplayExtents(), setEnergyScale(), setFillColourMap(), setGain(), setNormalize(), setPlotStyle(), SingleColourLayer::setProperties(), setSamplingMode(), and setThreshold().

Referenced by getLayerColourSignificance(), and SpectrumLayer::setProperties().

bool SliceLayer::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 1161 of file SliceLayer.cpp.

References m_binScale, and m_sliceableModel.

Referenced by getLayerColourSignificance().

bool SliceLayer::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 1178 of file SliceLayer.cpp.

References m_maxbin, m_minbin, and m_sliceableModel.

Referenced by getCurrentVerticalZoomStep(), and getLayerColourSignificance().

bool SliceLayer::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.

Reimplemented in SpectrumLayer.

Definition at line 1199 of file SliceLayer.cpp.

References Layer::layerParametersChanged(), m_maxbin, m_minbin, and m_sliceableModel.

Referenced by getLayerColourSignificance(), SpectrumLayer::setDisplayExtents(), setProperties(), setVerticalZoomStep(), and zoomToRegion().

int SliceLayer::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 1229 of file SliceLayer.cpp.

References m_sliceableModel.

Referenced by getLayerColourSignificance().

int SliceLayer::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 1241 of file SliceLayer.cpp.

References getDisplayExtents(), and m_sliceableModel.

Referenced by getLayerColourSignificance().

void SliceLayer::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 1253 of file SliceLayer.cpp.

References m_maxbin, m_minbin, m_sliceableModel, and setDisplayExtents().

Referenced by getLayerColourSignificance().

RangeMapper * SliceLayer::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.

Reimplemented from Layer.

Definition at line 1270 of file SliceLayer.cpp.

References m_sliceableModel.

Referenced by getLayerColourSignificance().

virtual bool SliceLayer::hasTimeXAxis ( ) const

inlineoverridevirtual

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 from Layer.

Definition at line 76 of file SliceLayer.h.

References zoomToRegion().

void SliceLayer::zoomToRegion ( const LayerGeometryProvider *  , QRect    )

overridevirtual

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 from Layer.

Definition at line 1281 of file SliceLayer.cpp.

References getBinForX(), and setDisplayExtents().

Referenced by hasTimeXAxis().

bool SliceLayer::isLayerScrollable ( const LayerGeometryProvider *  ) const

inlineoverridevirtual

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.

Reimplemented in SpectrumLayer.

Definition at line 80 of file SliceLayer.h.

bool SliceLayer::usesSolidColour ( ) const

inline

Definition at line 90 of file SliceLayer.h.

References m_plotStyle, PlotFilledBlocks, and setFillColourMap().

Referenced by getPropertyRangeAndValue(), getPropertyType(), getPropertyValueLabel(), hasLightBackground(), and setProperty().

void SliceLayer::setFillColourMap

(

int

map

)

Definition at line 987 of file SliceLayer.cpp.

References Layer::layerParametersChanged(), and m_colourMap.

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

int SliceLayer::getFillColourMap ( ) const

inline

Definition at line 93 of file SliceLayer.h.

References m_colourMap, and setEnergyScale().

void SliceLayer::setEnergyScale

(

EnergyScale

scale

)

Definition at line 995 of file SliceLayer.cpp.

References Layer::layerParametersChanged(), and m_energyScale.

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

EnergyScale SliceLayer::getEnergyScale ( ) const

inline

Definition at line 96 of file SliceLayer.h.

References m_energyScale, and setSamplingMode().

void SliceLayer::setSamplingMode

(

SamplingMode

mode

)

Definition at line 1003 of file SliceLayer.cpp.

References Layer::layerParametersChanged(), and m_samplingMode.

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

SamplingMode SliceLayer::getSamplingMode ( ) const

inline

Definition at line 99 of file SliceLayer.h.

References m_samplingMode, and setPlotStyle().

void SliceLayer::setPlotStyle

(

PlotStyle

style

)

Definition at line 1011 of file SliceLayer.cpp.

References Layer::layerParameterRangesChanged(), Layer::layerParametersChanged(), m_plotStyle, and PlotFilledBlocks.

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

PlotStyle SliceLayer::getPlotStyle ( ) const

inline

Definition at line 102 of file SliceLayer.h.

References m_plotStyle, and setBinScale().

void SliceLayer::setBinScale

(

BinScale

scale

)

Definition at line 1024 of file SliceLayer.cpp.

References Layer::layerParametersChanged(), and m_binScale.

Referenced by getPlotStyle(), setProperties(), setProperty(), and SpectrumLayer::SpectrumLayer().

BinScale SliceLayer::getBinScale ( ) const

inline

Definition at line 105 of file SliceLayer.h.

References m_binScale, and setThreshold().

void SliceLayer::setThreshold

(

float

thresh

)

Definition at line 1040 of file SliceLayer.cpp.

References Layer::layerParametersChanged(), and m_threshold.

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

float SliceLayer::getThreshold ( ) const

inline

Definition at line 108 of file SliceLayer.h.

References getBinForX(), getFeatureDescriptionAux(), getGain(), getNormalize(), getScalePointForX(), getValueForY(), getXForBin(), getXForScalePoint(), getYForValue(), m_threshold, setGain(), setNormalize(), sliceableModelReplaced(), and toXml().

void SliceLayer::setGain

(

float

gain

)

Definition at line 1048 of file SliceLayer.cpp.

References Layer::layerParametersChanged(), and m_gain.

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

float SliceLayer::getGain

(

)

const

Referenced by getThreshold().

void SliceLayer::setNormalize

(

bool

n

)

Definition at line 1032 of file SliceLayer.cpp.

References Layer::layerParametersChanged(), and m_normalize.

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

bool SliceLayer::getNormalize

(

)

const

Referenced by getThreshold().

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

override

Definition at line 1072 of file SliceLayer.cpp.

References ColourMapper::getBackwardCompatibilityColourMap(), ColourMapper::getColourMapId(), m_binScale, m_colourMap, m_energyScale, m_gain, m_maxbin, m_minbin, m_normalize, m_plotStyle, m_samplingMode, m_threshold, and SingleColourLayer::toXml().

Referenced by getThreshold(), and SpectrumLayer::toXml().

void SliceLayer::sliceableModelReplaced ( ModelId  orig, ModelId  replacement  )

slot

Definition at line 84 of file SliceLayer.cpp.

References m_sliceableModel, and setSliceableModel().

Referenced by getThreshold().

double SliceLayer::getXForBin ( const LayerGeometryProvider *  v, double  bin  ) const

protectedvirtual

Convert a (possibly non-integral) bin into x-coord. May be overridden.

Reimplemented in SpectrumLayer.

Definition at line 190 of file SliceLayer.cpp.

References getXForScalePoint(), m_maxbin, and m_minbin.

Referenced by getThreshold(), and paint().

double SliceLayer::getBinForX ( const LayerGeometryProvider *  v, double  x  ) const

protectedvirtual

Convert an x-coord into (possibly non-integral) bin. May be overridden.

Reimplemented in SpectrumLayer.

Definition at line 265 of file SliceLayer.cpp.

References getScalePointForX(), m_maxbin, and m_minbin.

Referenced by getFeatureDescriptionAux(), getThreshold(), and zoomToRegion().

double SliceLayer::getXForScalePoint ( const LayerGeometryProvider *  v, double  p, double  pmin, double  pmax  ) const

protected

Convert a point such as a bin number into x-coord, given max & min.

For use by getXForBin etc

Definition at line 196 of file SliceLayer.cpp.

References LayerGeometryProvider::getId(), LayerGeometryProvider::getPaintWidth(), InvertedLogBins, LinearBins, m_binScale, and m_xorigins.

Referenced by getThreshold(), getXForBin(), and SpectrumLayer::getXForFrequency().

double SliceLayer::getScalePointForX ( const LayerGeometryProvider *  v, double  x, double  pmin, double  pmax  ) const

protected

Convert an x-coord into a point such as a bin number, given max & min.

For use by getBinForX etc

Definition at line 271 of file SliceLayer.cpp.

References LayerGeometryProvider::getId(), LayerGeometryProvider::getPaintWidth(), InvertedLogBins, LinearBins, m_binScale, and m_xorigins.

Referenced by getBinForX(), SpectrumLayer::getFrequencyForX(), and getThreshold().

double SliceLayer::getYForValue ( const LayerGeometryProvider *  v, double  value, double &  norm  ) const

protectedvirtual

Definition at line 320 of file SliceLayer.cpp.

References AbsoluteScale, dBScale, LayerGeometryProvider::getId(), getThresholdDb(), LinearScale, m_energyScale, m_gain, m_heights, m_threshold, m_yorigins, and MeterScale.

Referenced by getThreshold(), paint(), and SpectrumLayer::paint().

double SliceLayer::getValueForY ( const LayerGeometryProvider *  v, double  y  ) const

protectedvirtual

Definition at line 372 of file SliceLayer.cpp.

References AbsoluteScale, dBScale, LayerGeometryProvider::getId(), getThresholdDb(), LinearScale, m_energyScale, m_gain, m_heights, m_threshold, m_yorigins, and MeterScale.

Referenced by getThreshold(), SpectrumLayer::getYScaleValue(), and SpectrumLayer::paintCrosshairs().

QString SliceLayer::getFeatureDescriptionAux ( LayerGeometryProvider *  v, QPoint &  p, bool  includeBinDescription, int &  minbin, int &  maxbin, int &  range  ) const

protectedvirtual

Definition at line 101 of file SliceLayer.cpp.

References BinsSpanScalePoints, getBinForX(), m_binAlignment, m_currentf0, m_currentf1, m_minbin, m_samplingMode, m_sliceableModel, m_values, NearestSample, and SampleMean.

Referenced by getFeatureDescription(), SpectrumLayer::getFeatureDescription(), and getThreshold().

virtual void SliceLayer::getBiasCurve ( BiasCurve &  ) const

inlineprotectedvirtual

Reimplemented in SpectrumLayer.

Definition at line 151 of file SliceLayer.h.

References getDefaultColourHint(), and getThresholdDb().

Referenced by paint().

float SliceLayer::getThresholdDb ( ) const

protectedvirtual

Definition at line 1056 of file SliceLayer.cpp.

References m_threshold.

Referenced by getBiasCurve(), getValueForY(), getYForValue(), and paintVerticalScale().

int SliceLayer::getDefaultColourHint ( bool  dark, bool &  impose  )

overrideprotectedvirtual

Reimplemented from SingleColourLayer.

Definition at line 1064 of file SliceLayer.cpp.

References ColourDatabase::getColourIndex(), and ColourDatabase::getInstance().

Referenced by getBiasCurve().

void SingleColourLayer::setBaseColour ( int  colour )

virtualinherited

Set the colour used to draw primary items in the layer.

The colour value is a colour database index as returned by ColourDatabase::getColourIndex().

Definition at line 220 of file SingleColourLayer.cpp.

References SingleColourLayer::flagBaseColourChanged(), Layer::layerParametersChanged(), SingleColourLayer::m_colour, SingleColourLayer::m_colourExplicitlySet, SingleColourLayer::refColor(), and SingleColourLayer::unrefColor().

Referenced by SingleColourLayer::setDefaultColourFor(), and SingleColourLayer::setProperty().

int SingleColourLayer::getBaseColour ( ) const

virtualinherited

Retrieve the current primary drawing colour, as a ColourDatabase index value.

Definition at line 235 of file SingleColourLayer.cpp.

References SingleColourLayer::m_colour.

QPixmap SingleColourLayer::getLayerPresentationPixmap ( QSize  size ) const

overridevirtualinherited

Reimplemented from Layer.

Definition at line 47 of file SingleColourLayer.cpp.

References ColourDatabase::getExamplePixmap(), ColourDatabase::getInstance(), and SingleColourLayer::m_colour.

Referenced by SingleColourLayer::getLayerColourSignificance().

void SingleColourLayer::setDefaultColourFor ( LayerGeometryProvider *  v )

virtualinherited

Definition at line 140 of file SingleColourLayer.cpp.

References ColourDatabase::getColourCount(), SingleColourLayer::getDefaultColourHint(), ColourDatabase::getInstance(), LayerGeometryProvider::hasLightBackground(), SingleColourLayer::m_colour, SingleColourLayer::m_colourExplicitlySet, SingleColourLayer::m_colourRefCount, SingleColourLayer::m_defaultColourSet, SingleColourLayer::refColor(), SingleColourLayer::setBaseColour(), SingleColourLayer::unrefColor(), and ColourDatabase::useDarkBackground().

Referenced by View::addLayer(), SingleColourLayer::getLayerColourSignificance(), and SingleColourLayer::SingleColourLayer().

QColor SingleColourLayer::getBaseQColor ( ) const

protectedvirtualinherited

Definition at line 241 of file SingleColourLayer.cpp.

References ColourDatabase::getColour(), ColourDatabase::getInstance(), and SingleColourLayer::m_colour.

Referenced by SingleColourLayer::getLayerColourSignificance(), SingleColourLayer::getPartialShades(), TimeRulerLayer::paint(), TextLayer::paint(), TimeInstantLayer::paint(), paint(), FlexiNoteLayer::paint(), BoxLayer::paint(), TimeValueLayer::paint(), RegionLayer::paint(), NoteLayer::paint(), and WaveformLayer::paintChannel().

QColor SingleColourLayer::getBackgroundQColor ( LayerGeometryProvider *  v ) const

protectedvirtualinherited

Definition at line 247 of file SingleColourLayer.cpp.

References LayerGeometryProvider::getBackground().

Referenced by SingleColourLayer::getLayerColourSignificance(), SingleColourLayer::getPartialShades(), and WaveformLayer::paint().

QColor SingleColourLayer::getForegroundQColor ( LayerGeometryProvider *  v ) const

protectedvirtualinherited

Definition at line 253 of file SingleColourLayer.cpp.

References LayerGeometryProvider::getForeground().

Referenced by SingleColourLayer::getLayerColourSignificance(), TimeInstantLayer::paint(), TimeValueLayer::paint(), WaveformLayer::paint(), and RegionLayer::paint().

std::vector< QColor > SingleColourLayer::getPartialShades ( LayerGeometryProvider *  v ) const

protectedinherited

Definition at line 259 of file SingleColourLayer.cpp.

References SingleColourLayer::getBackgroundQColor(), and SingleColourLayer::getBaseQColor().

Referenced by SingleColourLayer::getLayerColourSignificance(), TimeRulerLayer::paint(), and TimeValueLayer::paint().

virtual void SingleColourLayer::flagBaseColourChanged ( )

inlineprotectedvirtualinherited

Reimplemented in WaveformLayer.

Definition at line 85 of file SingleColourLayer.h.

Referenced by SingleColourLayer::setBaseColour(), and SingleColourLayer::setProperties().

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 ModelId Layer::getExportModel ( LayerGeometryProvider *  ) const

inlinevirtualinherited

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 in SpectrogramLayer, and Colour3DPlotLayer.

Definition at line 95 of file Layer.h.

References Layer::getModel().

virtual const ZoomConstraint* Layer::getZoomConstraint ( ) const

inlinevirtualinherited

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 in SpectrogramLayer, Colour3DPlotLayer, and WaveformLayer.

Definition at line 104 of file Layer.h.

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 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, and Colour3DPlotLayer.

Definition at line 138 of file Layer.h.

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 int Layer::getHorizontalScaleHeight ( LayerGeometryProvider *  , QPainter &    ) const

inlinevirtualinherited

Reimplemented in SpectrumLayer.

Definition at line 173 of file Layer.h.

Referenced by paint(), and 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::snapToFeatureFrame ( LayerGeometryProvider *  , sv_frame_t &  , int &  resolution, SnapType  , int    ) const

inlinevirtualinherited

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 in SpectrogramLayer, Colour3DPlotLayer, NoteLayer, RegionLayer, TimeValueLayer, BoxLayer, FlexiNoteLayer, ImageLayer, TimeRulerLayer, TimeInstantLayer, and TextLayer.

Definition at line 226 of file Layer.h.

Referenced by Pane::dragExtendSelection(), Pane::mousePressEvent(), TextLayer::snapToFeatureFrame(), TimeInstantLayer::snapToFeatureFrame(), ImageLayer::snapToFeatureFrame(), FlexiNoteLayer::snapToFeatureFrame(), BoxLayer::snapToFeatureFrame(), TimeValueLayer::snapToFeatureFrame(), RegionLayer::snapToFeatureFrame(), NoteLayer::snapToFeatureFrame(), and Colour3DPlotLayer::snapToFeatureFrame().

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 int Layer::getCompletion ( LayerGeometryProvider *  ) const

inlinevirtualinherited

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 in SpectrogramLayer, WaveformLayer, TimeValueLayer, FlexiNoteLayer, RegionLayer, NoteLayer, BoxLayer, TimeInstantLayer, ImageLayer, Colour3DPlotLayer, and TextLayer.

Definition at line 391 of file Layer.h.

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

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

virtualinherited

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 in SpectrogramLayer, ImageLayer, and Colour3DPlotLayer.

Definition at line 136 of file Layer.cpp.

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

Referenced by Layer::getError(), Colour3DPlotLayer::setLayerDormant(), SpectrogramLayer::setLayerDormant(), and Layer::showLayer().

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(), Colour3DPlotLayer::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::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().

virtual bool Layer::getYScaleValue ( const LayerGeometryProvider *  , int  , double &  , QString &    ) const

inlinevirtualinherited

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

Reimplemented in SpectrogramLayer, WaveformLayer, Colour3DPlotLayer, and SpectrumLayer.

Definition at line 550 of file Layer.h.

References Layer::getYScaleDifference().

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

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(), Colour3DPlotLayer::handleModelChanged(), RegionLayer::setModel(), Colour3DPlotLayer::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(), Colour3DPlotLayer::handleModelChangedWithin(), Colour3DPlotLayer::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(), Colour3DPlotLayer::setModel(), RegionLayer::setModel(), NoteLayer::setModel(), FlexiNoteLayer::setModel(), SpectrogramLayer::setModel(), and setSliceableModel().

void Layer::layerParametersChanged ( )

signalinherited

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

void Layer::layerParameterRangesChanged ( )

signalinherited

Referenced by Layer::canExistWithoutModel(), 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(), Colour3DPlotLayer::setModel(), RegionLayer::setModel(), NoteLayer::setModel(), FlexiNoteLayer::setModel(), SpectrogramLayer::setModel(), and 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 SliceLayer::m_sliceableModel

protected

Definition at line 173 of file SliceLayer.h.

Referenced by SpectrumLayer::getBinForFrequency(), SpectrumLayer::getBinForX(), getCurrentVerticalZoomStep(), getDisplayExtents(), SpectrumLayer::getFeatureDescription(), getFeatureDescriptionAux(), SpectrumLayer::getFrequencyForBin(), SpectrumLayer::getFrequencyForX(), getNewVerticalZoomRangeMapper(), getValueExtents(), getVerticalZoomSteps(), SpectrumLayer::getXForBin(), SpectrumLayer::getXForFrequency(), paint(), SpectrumLayer::paint(), SpectrumLayer::paintCrosshairs(), setDisplayExtents(), setSliceableModel(), SpectrumLayer::setupFFT(), setVerticalZoomStep(), sliceableModelReplaced(), and SpectrumLayer::~SpectrumLayer().

BinAlignment SliceLayer::m_binAlignment

protected

Definition at line 174 of file SliceLayer.h.

Referenced by getFeatureDescriptionAux(), paint(), and SpectrumLayer::SpectrumLayer().

int SliceLayer::m_colourMap

protected

Definition at line 175 of file SliceLayer.h.

Referenced by getFillColourMap(), getPropertyRangeAndValue(), hasLightBackground(), paint(), SpectrumLayer::paintCrosshairs(), setFillColourMap(), and toXml().

bool SliceLayer::m_colourInverted

protected

Definition at line 176 of file SliceLayer.h.

Referenced by hasLightBackground(), paint(), SpectrumLayer::paint(), and SpectrumLayer::paintCrosshairs().

EnergyScale SliceLayer::m_energyScale

protected

Definition at line 177 of file SliceLayer.h.

Referenced by getEnergyScale(), getPropertyRangeAndValue(), getValueForY(), getVerticalScaleWidth(), getYForValue(), SpectrumLayer::getYScaleValue(), paintVerticalScale(), setEnergyScale(), and toXml().

SamplingMode SliceLayer::m_samplingMode

protected

Definition at line 178 of file SliceLayer.h.

Referenced by SpectrumLayer::getFeatureDescription(), getFeatureDescriptionAux(), getPropertyRangeAndValue(), getSamplingMode(), paint(), setSamplingMode(), and toXml().

PlotStyle SliceLayer::m_plotStyle

protected

Definition at line 179 of file SliceLayer.h.

Referenced by getPlotStyle(), getPropertyRangeAndValue(), paint(), setPlotStyle(), toXml(), and usesSolidColour().

BinScale SliceLayer::m_binScale

protected

Definition at line 180 of file SliceLayer.h.

Referenced by getBinScale(), SpectrumLayer::getCrosshairExtents(), getPropertyRangeAndValue(), getScalePointForX(), getValueExtents(), getXForScalePoint(), SpectrumLayer::paintHorizontalScale(), setBinScale(), and toXml().

bool SliceLayer::m_normalize

protected

Definition at line 181 of file SliceLayer.h.

Referenced by getPropertyRangeAndValue(), paint(), setNormalize(), and toXml().

float SliceLayer::m_threshold

protected

Definition at line 182 of file SliceLayer.h.

Referenced by getPropertyRangeAndValue(), getThreshold(), getThresholdDb(), getValueForY(), getYForValue(), SpectrumLayer::getYScaleValue(), SpectrumLayer::paintCrosshairs(), paintVerticalScale(), setThreshold(), and toXml().

float SliceLayer::m_initialThreshold

protected

Definition at line 183 of file SliceLayer.h.

Referenced by getPropertyRangeAndValue().

float SliceLayer::m_gain

protected

Definition at line 184 of file SliceLayer.h.

Referenced by getPropertyRangeAndValue(), getValueForY(), getYForValue(), SpectrumLayer::paint(), paintVerticalScale(), setGain(), and toXml().

int SliceLayer::m_minbin

protected

Definition at line 185 of file SliceLayer.h.

Referenced by getBinForX(), getDisplayExtents(), SpectrumLayer::getFeatureDescription(), getFeatureDescriptionAux(), SpectrumLayer::getFrequencyForX(), getXForBin(), SpectrumLayer::getXForFrequency(), paint(), setDisplayExtents(), SpectrumLayer::setDisplayExtents(), SpectrumLayer::setOversampling(), setSliceableModel(), SpectrumLayer::setupFFT(), setVerticalZoomStep(), SpectrumLayer::setWindowSize(), and toXml().

int SliceLayer::m_maxbin

protected

Definition at line 186 of file SliceLayer.h.

Referenced by getBinForX(), getDisplayExtents(), SpectrumLayer::getFrequencyForX(), getXForBin(), SpectrumLayer::getXForFrequency(), paint(), setDisplayExtents(), SpectrumLayer::setOversampling(), setSliceableModel(), SpectrumLayer::setupFFT(), setVerticalZoomStep(), SpectrumLayer::setWindowSize(), and toXml().

std::vector<int> SliceLayer::m_scalePoints

mutableprotected

Definition at line 187 of file SliceLayer.h.

Referenced by paint(), and paintVerticalScale().

int SliceLayer::m_scalePaintHeight

mutableprotected

Definition at line 188 of file SliceLayer.h.

Referenced by paint(), and paintVerticalScale().

std::map<int, int> SliceLayer::m_xorigins

mutableprotected

Definition at line 189 of file SliceLayer.h.

Referenced by getScalePointForX(), getXForScalePoint(), paint(), and SpectrumLayer::paintCrosshairs().

std::map<int, int> SliceLayer::m_yorigins

mutableprotected

Definition at line 190 of file SliceLayer.h.

Referenced by getValueForY(), getYForValue(), and paint().

std::map<int, int> SliceLayer::m_heights

mutableprotected

Definition at line 191 of file SliceLayer.h.

Referenced by getValueForY(), getYForValue(), and paint().

sv_frame_t SliceLayer::m_currentf0

mutableprotected

Definition at line 192 of file SliceLayer.h.

Referenced by getFeatureDescriptionAux(), and paint().

sv_frame_t SliceLayer::m_currentf1

mutableprotected

Definition at line 193 of file SliceLayer.h.

Referenced by getFeatureDescriptionAux(), and paint().

std::vector<float> SliceLayer::m_values

mutableprotected

Definition at line 194 of file SliceLayer.h.

Referenced by SpectrumLayer::getFeatureDescription(), getFeatureDescriptionAux(), and paint().

SingleColourLayer::ColourRefCount SingleColourLayer::m_colourRefCount

staticprotectedinherited

Definition at line 90 of file SingleColourLayer.h.

Referenced by SingleColourLayer::refColor(), SingleColourLayer::setDefaultColourFor(), and SingleColourLayer::unrefColor().

int SingleColourLayer::m_colour

protectedinherited

Definition at line 92 of file SingleColourLayer.h.

Referenced by SingleColourLayer::getBaseColour(), SingleColourLayer::getBaseQColor(), SingleColourLayer::getLayerPresentationPixmap(), SingleColourLayer::getPropertyRangeAndValue(), SingleColourLayer::hasLightBackground(), WaveformLayer::paintChannel(), SingleColourLayer::refColor(), SingleColourLayer::setBaseColour(), SingleColourLayer::setDefaultColourFor(), SingleColourLayer::setProperties(), SingleColourLayer::toXml(), WaveformLayer::toXml(), and SingleColourLayer::unrefColor().

bool SingleColourLayer::m_colourExplicitlySet

protectedinherited

Definition at line 93 of file SingleColourLayer.h.

Referenced by SingleColourLayer::setBaseColour(), SingleColourLayer::setDefaultColourFor(), and SingleColourLayer::setProperties().

bool SingleColourLayer::m_defaultColourSet

protectedinherited

Definition at line 94 of file SingleColourLayer.h.

Referenced by SingleColourLayer::setDefaultColourFor().

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:

• SliceLayer.h
• SliceLayer.cpp