WaveformLayer Class Reference

#include <WaveformLayer.h>

Inheritance diagram for WaveformLayer:

Collaboration diagram for WaveformLayer:

Public Types
enum	ChannelMode { SeparateChannels, MixChannels, MergeChannels }
enum	Scale { LinearScale, MeterScale, dBScale }
enum	VerticalPosition { PositionTop, PositionMiddle, PositionBottom }
enum	SnapType { SnapLeft, SnapRight, SnapNeighbouring }
enum	ColourSignificance {   ColourAbsent, ColourIrrelevant, ColourDistinguishes, ColourAndBackgroundSignificant,   ColourHasMeaningfulValue }

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

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

Public Member Functions
	WaveformLayer ()
	~WaveformLayer ()
const ZoomConstraint *	getZoomConstraint () const override
	Return a zoom constraint object defining the supported zoom levels for this layer. More...
ModelId	getModel () const override
	Return the ID of the model represented in this layer. More...
void	paint (LayerGeometryProvider *v, QPainter &paint, QRect rect) const override
	Paint the given rectangle of this layer onto the given view using the given painter, superimposing it on top of any existing material in that view. More...
QString	getFeatureDescription (LayerGeometryProvider *v, QPoint &) const override
ColourSignificance	getLayerColourSignificance () const override
	Implements Layer::getLayerColourSignificance() More...
int	getVerticalScaleWidth (LayerGeometryProvider *v, bool detailed, QPainter &) const override
void	paintVerticalScale (LayerGeometryProvider *v, bool detailed, QPainter &paint, QRect rect) const override
void	setModel (ModelId model)
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	setGain (float gain)
	Set the gain multiplier for sample values in this view. More...
float	getGain () const
void	setAutoNormalize (bool)
	Toggle automatic normalization of the currently visible waveform. More...
bool	getAutoNormalize () const
void	setShowMeans (bool)
	Set whether to display mean values as a lighter-coloured area beneath the peaks. More...
bool	getShowMeans () const
void	setChannelMode (ChannelMode)
	Specify whether multi-channel audio data should be displayed with a separate axis per channel (SeparateChannels), with a single synthetic axis showing channel 0 above the axis and channel 1 below (MergeChannels), or with a single axis showing the average of the channels (MixChannels). More...
ChannelMode	getChannelMode () const
void	setChannel (int)
	Specify the channel to use from the source model. More...
int	getChannel () const
void	setScale (Scale)
	Specify the vertical scale for sample levels. More...
Scale	getScale () const
void	setMiddleLineHeight (double)
	Specify the height of the middle of the waveform track or tracks within the layer, from 0.0 to 1.0. More...
double	getMiddleLineHeight () const
void	setAggressiveCacheing (bool)
	Enable or disable aggressive pixmap cacheing. More...
bool	getAggressiveCacheing () const
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...
int	getCompletion (LayerGeometryProvider *) const override
	Return the proportion of background work complete in drawing this view, as a percentage – in most cases this will be the value returned by pointer from a call to the underlying model's isReady(int *) call. More...
bool	getValueExtents (double &min, double &max, bool &log, 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	getYScaleValue (const LayerGeometryProvider *v, int y, double &value, QString &unit) const override
	Return the value and unit at the given y coordinate in the given view. More...
bool	getYScaleDifference (const LayerGeometryProvider *v, int y0, int y1, double &diff, QString &unit) const override
	Return the difference between the values at the given y coordinates in the given view, and the unit of the difference. More...
void	toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const override
void	setProperties (const QXmlAttributes &attributes) override
	Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes. 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...
bool	canExistWithoutModel () const override
	Return true if this layer type can function without a model being set. More...
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...
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...
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 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 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	hasTimeXAxis () const
	Return true if the X axis on the layer is time proportional to audio frames, false otherwise. More...
virtual void	zoomToRegion (const LayerGeometryProvider *, QRect)
	Update the X and Y axis scales, where appropriate, to focus on the given rectangular region. More...
virtual bool	setDisplayExtents (double, double)
	Set the displayed minimum and maximum values for the y axis to the given range, if supported. 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 RangeMapper *	getNewVerticalZoomRangeMapper () const
	Create and return a range mapper for vertical zoom step values. More...

Protected Types
typedef std::vector< RangeSummarisableTimeValueModel::RangeBlock >	RangeVec
typedef std::map< int, int >	ColourRefCount
typedef std::set< MeasureRect >	MeasureRectSet

Protected Member Functions
double	dBscale (double sample, int m) const
int	getChannelArrangement (int &min, int &max, bool &merging, bool &mixing) const
	Return value is number of channels displayed. More...
void	paintChannel (LayerGeometryProvider *, QPainter *paint, QRect rect, int channel, const RangeVec &ranges, int blockSize, sv_frame_t frame0, sv_frame_t frame1) const
void	paintChannelScaleGuides (LayerGeometryProvider *, QPainter *paint, QRect rect, int channel) const
void	getSummaryRanges (int minChannel, int maxChannel, bool mixingOrMerging, sv_frame_t f0, sv_frame_t f1, int blockSize, RangeVec &ranges) const
void	getOversampledRanges (int minChannel, int maxChannel, bool mixingOrMerging, sv_frame_t f0, sv_frame_t f1, int oversampleBy, RangeVec &ranges) const
int	getYForValue (const LayerGeometryProvider *v, double value, int channel) const
double	getValueForY (const LayerGeometryProvider *v, int y, int &channel) const
bool	getSourceFramesForX (LayerGeometryProvider *v, int x, int modelZoomLevel, sv_frame_t &f0, sv_frame_t &f1) const
float	getNormalizeGain (LayerGeometryProvider *v, int channel) const
void	flagBaseColourChanged () 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 int	getDefaultColourHint (bool, bool &)
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_model
float	m_gain
bool	m_autoNormalize
bool	m_showMeans
ChannelMode	m_channelMode
int	m_channel
int	m_channelCount
Scale	m_scale
double	m_middleLineHeight
bool	m_aggressive
std::vector< float >	m_effectiveGains
QPixmap *	m_cache
bool	m_cacheValid
ZoomLevel	m_cacheZoomLevel
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 double	m_dBMin = -50.0
static ColourRefCount	m_colourRefCount

Detailed Description

Definition at line 31 of file WaveformLayer.h.

Member Typedef Documentation

typedef std::vector<RangeSummarisableTimeValueModel::RangeBlock> WaveformLayer::RangeVec

protected

Definition at line 201 of file WaveformLayer.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 WaveformLayer::ChannelMode

Enumerator
SeparateChannels
MixChannels
MergeChannels

Definition at line 90 of file WaveformLayer.h.

enum WaveformLayer::Scale

Enumerator
LinearScale
MeterScale
dBScale

Definition at line 117 of file WaveformLayer.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

WaveformLayer::WaveformLayer

(

)

Definition at line 45 of file WaveformLayer.cpp.

WaveformLayer::~WaveformLayer

(

)

Definition at line 61 of file WaveformLayer.cpp.

References m_cache.

Member Function Documentation

const ZoomConstraint * WaveformLayer::getZoomConstraint ( ) const

overridevirtual

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

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

Reimplemented from Layer.

Definition at line 67 of file WaveformLayer.cpp.

References m_model.

ModelId WaveformLayer::getModel ( ) const

inlineoverridevirtual

Return the ID of the model represented in this layer.

Implements Layer.

Definition at line 40 of file WaveformLayer.h.

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

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

overridevirtual

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

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

Implements Layer.

Definition at line 575 of file WaveformLayer.cpp.

References SingleColourLayer::getBackgroundQColor(), getChannelArrangement(), SingleColourLayer::getForegroundQColor(), getNormalizeGain(), getOversampledRanges(), LayerGeometryProvider::getPaintHeight(), LayerGeometryProvider::getPaintRect(), LayerGeometryProvider::getPaintWidth(), getSourceFramesForX(), getSummaryRanges(), LayerGeometryProvider::getZoomLevel(), m_aggressive, m_autoNormalize, m_cache, m_cacheValid, m_cacheZoomLevel, m_effectiveGains, m_gain, m_middleLineHeight, m_model, and paintChannel().

Referenced by getModel().

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

overridevirtual

Reimplemented from Layer.

Definition at line 1255 of file WaveformLayer.cpp.

References getChannelArrangement(), getSourceFramesForX(), LayerGeometryProvider::getZoomLevel(), and m_model.

Referenced by getModel().

ColourSignificance WaveformLayer::getLayerColourSignificance ( ) const

inlineoverridevirtual

Implements Layer::getLayerColourSignificance()

Reimplemented from SingleColourLayer.

Definition at line 45 of file WaveformLayer.h.

References Layer::ColourAndBackgroundSignificant, getNewPropertyRangeMapper(), getProperties(), getPropertyGroupName(), getPropertyIconName(), getPropertyLabel(), getPropertyRangeAndValue(), getPropertyType(), getPropertyValueLabel(), getVerticalScaleWidth(), paintVerticalScale(), setGain(), setModel(), and setProperty().

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

overridevirtual

Implements Layer.

Definition at line 1496 of file WaveformLayer.cpp.

References LinearScale, and m_scale.

Referenced by getLayerColourSignificance().

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

overridevirtual

Reimplemented from Layer.

Definition at line 1512 of file WaveformLayer.cpp.

References dBScale, getChannelArrangement(), getYForValue(), LinearScale, m_effectiveGains, m_gain, m_model, m_scale, meterdbs, and MeterScale.

Referenced by getLayerColourSignificance().

void WaveformLayer::setModel

(

ModelId

model

)

Definition at line 75 of file WaveformLayer.cpp.

References Layer::connectSignals(), Layer::layerParametersChanged(), m_cacheValid, m_channel, m_channelCount, m_model, and Layer::modelReplaced().

Referenced by getLayerColourSignificance().

Layer::PropertyList WaveformLayer::getProperties ( ) const

override

Definition at line 116 of file WaveformLayer.cpp.

References SingleColourLayer::getProperties(), m_channel, and m_channelCount.

Referenced by getLayerColourSignificance().

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

override

Definition at line 130 of file WaveformLayer.cpp.

References SingleColourLayer::getPropertyLabel().

Referenced by getLayerColourSignificance().

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

override

Definition at line 140 of file WaveformLayer.cpp.

Referenced by getLayerColourSignificance().

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

override

Definition at line 147 of file WaveformLayer.cpp.

References SingleColourLayer::getPropertyType().

Referenced by getLayerColourSignificance().

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

override

Definition at line 157 of file WaveformLayer.cpp.

Referenced by getLayerColourSignificance().

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

override

Definition at line 166 of file WaveformLayer.cpp.

References SingleColourLayer::getPropertyRangeAndValue(), m_autoNormalize, m_channelMode, m_gain, m_scale, MergeChannels, and MixChannels.

Referenced by getLayerColourSignificance().

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

override

Definition at line 216 of file WaveformLayer.cpp.

References SingleColourLayer::getPropertyValueLabel().

Referenced by getLayerColourSignificance().

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

override

Definition at line 239 of file WaveformLayer.cpp.

Referenced by getLayerColourSignificance().

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

override

Definition at line 248 of file WaveformLayer.cpp.

References dBScale, LinearScale, MergeChannels, MeterScale, MixChannels, SeparateChannels, setAutoNormalize(), setChannelMode(), setGain(), SingleColourLayer::setProperty(), and setScale().

Referenced by getLayerColourSignificance().

void WaveformLayer::setGain

(

float

gain

)

Set the gain multiplier for sample values in this view.

The default is 1.0.

Definition at line 271 of file WaveformLayer.cpp.

References Layer::layerParametersChanged(), m_cacheValid, m_gain, and Layer::verticalZoomChanged().

Referenced by getLayerColourSignificance(), setProperties(), setProperty(), and setVerticalZoomStep().

float WaveformLayer::getGain ( ) const

inline

Definition at line 72 of file WaveformLayer.h.

References m_gain, and setAutoNormalize().

void WaveformLayer::setAutoNormalize

(

bool

autoNormalize

)

Toggle automatic normalization of the currently visible waveform.

Definition at line 281 of file WaveformLayer.cpp.

References Layer::layerParametersChanged(), m_autoNormalize, and m_cacheValid.

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

bool WaveformLayer::getAutoNormalize ( ) const

inline

Definition at line 78 of file WaveformLayer.h.

References m_autoNormalize, and setShowMeans().

void WaveformLayer::setShowMeans

(

bool

showMeans

)

Set whether to display mean values as a lighter-coloured area beneath the peaks.

Rendering will be slightly faster without but arguably prettier with.

The default is to display means.

Definition at line 290 of file WaveformLayer.cpp.

References Layer::layerParametersChanged(), m_cacheValid, and m_showMeans.

Referenced by getAutoNormalize(), and setProperties().

bool WaveformLayer::getShowMeans ( ) const

inline

Definition at line 88 of file WaveformLayer.h.

References m_showMeans.

void WaveformLayer::setChannelMode

(

ChannelMode

channelMode

)

Specify whether multi-channel audio data should be displayed with a separate axis per channel (SeparateChannels), with a single synthetic axis showing channel 0 above the axis and channel 1 below (MergeChannels), or with a single axis showing the average of the channels (MixChannels).

MergeChannels does not work for files with more than 2 channels.

The default is SeparateChannels.

Definition at line 299 of file WaveformLayer.cpp.

References Layer::layerParametersChanged(), m_cacheValid, and m_channelMode.

Referenced by setProperties(), and setProperty().

ChannelMode WaveformLayer::getChannelMode ( ) const

inline

Definition at line 105 of file WaveformLayer.h.

References m_channelMode, and setChannel().

void WaveformLayer::setChannel

(

int

channel

)

Specify the channel to use from the source model.

A value of -1 means to show all available channels (laid out to the channel mode). The default is -1.

Definition at line 308 of file WaveformLayer.cpp.

References Layer::layerParametersChanged(), m_cacheValid, and m_channel.

Referenced by getChannelMode(), and setProperties().

int WaveformLayer::getChannel ( ) const

inline

Definition at line 114 of file WaveformLayer.h.

References m_channel.

void WaveformLayer::setScale

(

Scale

scale

)

Specify the vertical scale for sample levels.

With LinearScale, the scale is directly proportional to the raw [-1, +1) floating-point audio sample values. With dBScale the vertical scale is proportional to dB level (truncated at -50dB). MeterScale provides a hybrid variable scale based on IEC meter scale, intended to provide a clear overview at relatively small heights.

Note that the effective gain (see setGain()) is applied before vertical scaling.

The default is LinearScale.

Definition at line 319 of file WaveformLayer.cpp.

References Layer::layerParametersChanged(), m_cacheValid, and m_scale.

Referenced by setProperties(), and setProperty().

Scale WaveformLayer::getScale ( ) const

inline

Definition at line 134 of file WaveformLayer.h.

References m_scale, and setMiddleLineHeight().

void WaveformLayer::setMiddleLineHeight

(

double

height

)

Specify the height of the middle of the waveform track or tracks within the layer, from 0.0 to 1.0.

A value of 0.0 would indicate that the waveform occupies effectively no space at the very top of the layer; 1.0 would indicate that the waveform occupies no space at the very bottom; the default value of 0.5 indicates that it occupies the whole layer, centred at the middle.

Definition at line 328 of file WaveformLayer.cpp.

References Layer::layerParametersChanged(), m_cacheValid, and m_middleLineHeight.

Referenced by getScale(), and setProperties().

double WaveformLayer::getMiddleLineHeight ( ) const

inline

Definition at line 147 of file WaveformLayer.h.

References m_middleLineHeight, and setAggressiveCacheing().

void WaveformLayer::setAggressiveCacheing

(

bool

aggressive

)

Enable or disable aggressive pixmap cacheing.

If enabled, waveforms will be rendered to an off-screen pixmap and refreshed from there instead of being redrawn from the peak data each time. This may be faster if the data and zoom level do not change often, but it may be slower for frequently zoomed data and it will only work if the waveform is the "bottom" layer on the displayed widget, as each refresh will erase anything beneath the waveform.

This is intended specifically for a panner widget display in which the waveform never moves, zooms, or changes, but some graphic such as a panner outline is frequently redrawn over the waveform. This situation would necessitate a lot of waveform refresh if the default cacheing strategy was used.

The default is not to use aggressive cacheing.

Definition at line 337 of file WaveformLayer.cpp.

References Layer::layerParametersChanged(), m_aggressive, and m_cacheValid.

Referenced by getMiddleLineHeight(), and setProperties().

bool WaveformLayer::getAggressiveCacheing ( ) const

inline

Definition at line 168 of file WaveformLayer.h.

References getCompletion(), getCurrentVerticalZoomStep(), getDisplayExtents(), getValueExtents(), getVerticalZoomSteps(), getYScaleDifference(), getYScaleValue(), isLayerScrollable(), m_aggressive, setProperties(), setVerticalZoomStep(), and toXml().

bool WaveformLayer::isLayerScrollable ( const LayerGeometryProvider *  ) const

overridevirtual

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

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

Reimplemented from Layer.

Definition at line 490 of file WaveformLayer.cpp.

References m_autoNormalize.

Referenced by getAggressiveCacheing().

int WaveformLayer::getCompletion ( LayerGeometryProvider *  ) const

overridevirtual

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

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

Reimplemented from Layer.

Definition at line 346 of file WaveformLayer.cpp.

References m_model.

Referenced by getAggressiveCacheing().

bool WaveformLayer::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 356 of file WaveformLayer.cpp.

References dBScale, getDisplayExtents(), and m_scale.

Referenced by getAggressiveCacheing().

bool WaveformLayer::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 399 of file WaveformLayer.cpp.

References dBScale, LinearScale, m_channelCount, m_channelMode, m_dBMin, m_scale, MergeChannels, MeterScale, and SeparateChannels.

Referenced by getAggressiveCacheing(), and getValueExtents().

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

overridevirtual

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

Reimplemented from Layer.

Definition at line 1432 of file WaveformLayer.cpp.

References dBScale, getValueForY(), m_dBMin, m_scale, and MeterScale.

Referenced by getAggressiveCacheing().

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

overridevirtual

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

Definition at line 1458 of file WaveformLayer.cpp.

References dBScale, getValueForY(), m_dBMin, m_scale, and MeterScale.

Referenced by getAggressiveCacheing().

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

override

Definition at line 1634 of file WaveformLayer.cpp.

References ColourDatabase::getInstance(), ColourDatabase::getStringValues(), m_aggressive, m_autoNormalize, m_channel, m_channelMode, SingleColourLayer::m_colour, m_gain, m_middleLineHeight, m_scale, m_showMeans, and SingleColourLayer::toXml().

Referenced by getAggressiveCacheing().

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

Definition at line 1667 of file WaveformLayer.cpp.

References setAggressiveCacheing(), setAutoNormalize(), setChannel(), setChannelMode(), setGain(), setMiddleLineHeight(), SingleColourLayer::setProperties(), setScale(), and setShowMeans().

Referenced by getAggressiveCacheing().

int WaveformLayer::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 1703 of file WaveformLayer.cpp.

Referenced by getAggressiveCacheing().

int WaveformLayer::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 1710 of file WaveformLayer.cpp.

References m_gain.

Referenced by getAggressiveCacheing().

void WaveformLayer::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 1719 of file WaveformLayer.cpp.

References setGain().

Referenced by getAggressiveCacheing().

bool WaveformLayer::canExistWithoutModel ( ) const

inlineoverridevirtual

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

Definition at line 194 of file WaveformLayer.h.

References dBscale().

double WaveformLayer::dBscale ( double  sample, int  m  ) const

protected

Definition at line 436 of file WaveformLayer.cpp.

References m_dBMin.

Referenced by canExistWithoutModel(), getYForValue(), and paintChannel().

int WaveformLayer::getChannelArrangement ( int &  min, int &  max, bool &  merging, bool &  mixing  ) const

protected

Return value is number of channels displayed.

Definition at line 446 of file WaveformLayer.cpp.

References m_channel, m_channelCount, m_channelMode, MergeChannels, and MixChannels.

Referenced by getFeatureDescription(), getNormalizeGain(), getValueForY(), getYForValue(), paint(), paintChannel(), and paintVerticalScale().

void WaveformLayer::paintChannel ( LayerGeometryProvider *  v, QPainter *  paint, QRect  rect, int  channel, const RangeVec &  ranges, int  blockSize, sv_frame_t  frame0, sv_frame_t  frame1  ) const

protected

Definition at line 849 of file WaveformLayer.cpp.

References dBScale, dBscale(), SingleColourLayer::getBaseQColor(), getChannelArrangement(), LayerGeometryProvider::getFrameForX(), ColourDatabase::getInstance(), LayerGeometryProvider::getPaintHeight(), getSourceFramesForX(), LayerGeometryProvider::getXForFrame(), LayerGeometryProvider::getZoomLevel(), LayerGeometryProvider::hasLightBackground(), LinearScale, m_channelMode, SingleColourLayer::m_colour, m_effectiveGains, m_model, m_scale, m_showMeans, MergeChannels, MeterScale, paintChannelScaleGuides(), and LayerGeometryProvider::scaleSize().

Referenced by paint().

void WaveformLayer::paintChannelScaleGuides ( LayerGeometryProvider *  v, QPainter *  paint, QRect  rect, int  channel  ) const

protected

Definition at line 1195 of file WaveformLayer.cpp.

References dBScale, LayerGeometryProvider::getViewManager(), getYForValue(), LayerGeometryProvider::hasLightBackground(), LinearScale, m_effectiveGains, m_scale, meterdbs, MeterScale, and ViewManager::shouldShowScaleGuides().

Referenced by paintChannel().

void WaveformLayer::getSummaryRanges ( int  minChannel, int  maxChannel, bool  mixingOrMerging, sv_frame_t  f0, sv_frame_t  f1, int  blockSize, RangeVec &  ranges  ) const

protected

Definition at line 742 of file WaveformLayer.cpp.

References m_channelCount, and m_model.

Referenced by paint().

void WaveformLayer::getOversampledRanges ( int  minChannel, int  maxChannel, bool  mixingOrMerging, sv_frame_t  f0, sv_frame_t  f1, int  oversampleBy, RangeVec &  ranges  ) const

protected

Definition at line 774 of file WaveformLayer.cpp.

References m_channelCount, and m_model.

Referenced by paint().

int WaveformLayer::getYForValue ( const LayerGeometryProvider *  v, double  value, int  channel  ) const

protected

Definition at line 1343 of file WaveformLayer.cpp.

References dBScale, dBscale(), getChannelArrangement(), LayerGeometryProvider::getPaintHeight(), LinearScale, m_channelMode, m_scale, MergeChannels, and MeterScale.

Referenced by paintChannelScaleGuides(), and paintVerticalScale().

double WaveformLayer::getValueForY ( const LayerGeometryProvider *  v, int  y, int &  channel  ) const

protected

Definition at line 1386 of file WaveformLayer.cpp.

References dBScale, getChannelArrangement(), LayerGeometryProvider::getPaintHeight(), LinearScale, m_channelMode, m_dBMin, m_gain, m_scale, MergeChannels, and MeterScale.

Referenced by getYScaleDifference(), and getYScaleValue().

bool WaveformLayer::getSourceFramesForX ( LayerGeometryProvider *  v, int  x, int  modelZoomLevel, sv_frame_t &  f0, sv_frame_t &  f1  ) const

protected

Definition at line 499 of file WaveformLayer.cpp.

References LayerGeometryProvider::getFrameForX(), LayerGeometryProvider::getZoomLevel(), and m_model.

Referenced by getFeatureDescription(), paint(), and paintChannel().

float WaveformLayer::getNormalizeGain ( LayerGeometryProvider *  v, int  channel  ) const

protected

Definition at line 530 of file WaveformLayer.cpp.

References getChannelArrangement(), LayerGeometryProvider::getEndFrame(), LayerGeometryProvider::getStartFrame(), m_channelCount, and m_model.

Referenced by paint().

void WaveformLayer::flagBaseColourChanged ( )

inlineoverrideprotectedvirtual

Reimplemented from SingleColourLayer.

Definition at line 234 of file WaveformLayer.h.

References m_cacheValid.

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.

bool SingleColourLayer::hasLightBackground ( ) const

overridevirtualinherited

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

Reimplemented in TimeValueLayer, and SliceLayer.

Definition at line 53 of file SingleColourLayer.cpp.

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

Referenced by SliceLayer::hasLightBackground(), and TimeValueLayer::hasLightBackground().

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(), SliceLayer::paint(), FlexiNoteLayer::paint(), BoxLayer::paint(), TimeValueLayer::paint(), RegionLayer::paint(), NoteLayer::paint(), and 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 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(), 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 int SingleColourLayer::getDefaultColourHint ( bool  , bool &    )

inlineprotectedvirtualinherited

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

Definition at line 86 of file SingleColourLayer.h.

Referenced by SingleColourLayer::setDefaultColourFor().

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 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 SliceLayer::paint(), and SliceLayer::paintVerticalScale().

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

inlinevirtualinherited

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 175 of file Layer.h.

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

inlinevirtualinherited

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 179 of file Layer.h.

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

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

virtualinherited

Definition at line 464 of file Layer.cpp.

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

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

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

virtualinherited

Definition at line 496 of file Layer.cpp.

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

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

virtual QString Layer::getLabelPreceding ( sv_frame_t  ) const

inlinevirtualinherited

Reimplemented in RegionLayer, TimeValueLayer, BoxLayer, and TimeInstantLayer.

Definition at line 191 of file Layer.h.

virtual bool Layer::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 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::hasTimeXAxis ( ) const

inlinevirtualinherited

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

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

Reimplemented in SliceLayer.

Definition at line 475 of file Layer.h.

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

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

inlinevirtualinherited

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

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

Reimplemented in SliceLayer.

Definition at line 483 of file Layer.h.

References Layer::getValueExtents().

Referenced by Pane::zoomToRegion().

virtual bool Layer::setDisplayExtents ( double  , double    )

inlinevirtualinherited

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 in SpectrogramLayer, Colour3DPlotLayer, TimeValueLayer, FlexiNoteLayer, NoteLayer, SpectrumLayer, and SliceLayer.

Definition at line 521 of file Layer.h.

Referenced by Pane::setTopLayerDisplayExtents(), FlexiNoteLayer::setVerticalRangeToNoteRange(), and Pane::zoomToRegion().

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

inlinevirtualinherited

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

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

Reimplemented in BoxLayer.

Definition at line 532 of file Layer.h.

References Layer::getXScaleValue().

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

virtualinherited

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

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

Reimplemented in SpectrumLayer.

Definition at line 160 of file Layer.cpp.

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

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

virtual RangeMapper* Layer::getNewVerticalZoomRangeMapper ( ) const

inlinevirtualinherited

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 in SpectrogramLayer, Colour3DPlotLayer, TimeValueLayer, FlexiNoteLayer, NoteLayer, and SliceLayer.

Definition at line 602 of file Layer.h.

Referenced by Pane::propertyContainerSelected(), and Pane::updateHeadsUpDisplay().

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(), setModel(), TextLayer::setModel(), ImageLayer::setModel(), TimeInstantLayer::setModel(), BoxLayer::setModel(), TimeValueLayer::setModel(), Colour3DPlotLayer::setModel(), RegionLayer::setModel(), NoteLayer::setModel(), FlexiNoteLayer::setModel(), SpectrogramLayer::setModel(), and SliceLayer::setSliceableModel().

void Layer::layerParametersChanged ( )

signalinherited

Referenced by Layer::canExistWithoutModel(), SpectrogramLayer::preferenceChanged(), setAggressiveCacheing(), setAutoNormalize(), SingleColourLayer::setBaseColour(), SpectrogramLayer::setBinDisplay(), SliceLayer::setBinScale(), Colour3DPlotLayer::setBinScale(), SpectrogramLayer::setBinScale(), SpectrumLayer::setChannel(), SpectrogramLayer::setChannel(), setChannel(), setChannelMode(), Colour3DPlotLayer::setColourMap(), SpectrogramLayer::setColourMap(), SpectrogramLayer::setColourRotation(), Colour3DPlotLayer::setColourScale(), SpectrogramLayer::setColourScale(), SpectrogramLayer::setColourScaleMultiple(), SliceLayer::setDisplayExtents(), NoteLayer::setDisplayExtents(), FlexiNoteLayer::setDisplayExtents(), TimeValueLayer::setDisplayExtents(), Colour3DPlotLayer::setDisplayExtents(), SpectrogramLayer::setDisplayExtents(), TimeValueLayer::setDrawSegmentDivisions(), SliceLayer::setEnergyScale(), TimeValueLayer::setFillColourMap(), RegionLayer::setFillColourMap(), SliceLayer::setFillColourMap(), setGain(), Colour3DPlotLayer::setGain(), SliceLayer::setGain(), SpectrogramLayer::setGain(), Colour3DPlotLayer::setInvertVertical(), SpectrogramLayer::setMaxFrequency(), setMiddleLineHeight(), SpectrogramLayer::setMinFrequency(), SpectrumLayer::setModel(), setModel(), Colour3DPlotLayer::setNormalization(), SpectrogramLayer::setNormalization(), SliceLayer::setNormalize(), Colour3DPlotLayer::setNormalizeVisibleArea(), SpectrogramLayer::setNormalizeVisibleArea(), Colour3DPlotLayer::setOpaque(), SpectrumLayer::setOversampling(), SpectrogramLayer::setOversampling(), TimeInstantLayer::setPlotStyle(), SliceLayer::setPlotStyle(), TimeValueLayer::setPlotStyle(), RegionLayer::setPlotStyle(), SliceLayer::setSamplingMode(), setScale(), TimeValueLayer::setShowDerivative(), setShowMeans(), SpectrumLayer::setShowPeaks(), SliceLayer::setSliceableModel(), Colour3DPlotLayer::setSmooth(), SliceLayer::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(), SliceLayer::setPlotStyle(), TimeValueLayer::setPlotStyle(), and RegionLayer::setPlotStyle().

void Layer::layerMeasurementRectsChanged ( )

signalinherited

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

void Layer::layerNameChanged ( )

signalinherited

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

void Layer::verticalZoomChanged ( )

signalinherited

Referenced by Layer::canExistWithoutModel(), SpectrogramLayer::setDisplayExtents(), 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(), setModel(), TextLayer::setModel(), ImageLayer::setModel(), TimeInstantLayer::setModel(), BoxLayer::setModel(), TimeValueLayer::setModel(), Colour3DPlotLayer::setModel(), RegionLayer::setModel(), NoteLayer::setModel(), FlexiNoteLayer::setModel(), SpectrogramLayer::setModel(), and SliceLayer::setSliceableModel().

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

protectedvirtualinherited

Definition at line 187 of file Layer.cpp.

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

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

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

protectedvirtualinherited

Definition at line 198 of file Layer.cpp.

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

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

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

protectedinherited

Definition at line 209 of file Layer.cpp.

References Layer::alignToReference().

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

void Layer::addMeasureRectToSet ( const MeasureRect &  r )

inlineprotectedinherited

Definition at line 682 of file Layer.h.

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

Referenced by Layer::addMeasurementRect().

void Layer::deleteMeasureRectFromSet ( const MeasureRect &  r )

inlineprotectedinherited

Definition at line 687 of file Layer.h.

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

void Layer::updateMeasurePixrects ( LayerGeometryProvider *  v ) const

protectedinherited

Definition at line 507 of file Layer.cpp.

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

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

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

protectedvirtualinherited

Reimplemented in SpectrogramLayer.

Definition at line 546 of file Layer.cpp.

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

Referenced by Layer::updateMeasurePixrects().

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

protectedvirtualinherited

Reimplemented in SpectrogramLayer.

Definition at line 554 of file Layer.cpp.

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

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

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

protectedvirtualinherited

Definition at line 565 of file Layer.cpp.

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

Referenced by SpectrogramLayer::measureDoubleClick().

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

protectedinherited

Definition at line 578 of file Layer.cpp.

References Layer::m_measureRects.

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

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

protectedinherited

Definition at line 605 of file Layer.cpp.

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

Referenced by Layer::paintMeasurementRects().

bool Layer::valueExtentsMatchMine ( LayerGeometryProvider *  v ) const

protectedinherited

Definition at line 628 of file Layer.cpp.

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

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

Member Data Documentation

ModelId WaveformLayer::m_model

protected

Definition at line 199 of file WaveformLayer.h.

Referenced by getCompletion(), getFeatureDescription(), getModel(), getNormalizeGain(), getOversampledRanges(), getSourceFramesForX(), getSummaryRanges(), getZoomConstraint(), paint(), paintChannel(), paintVerticalScale(), and setModel().

float WaveformLayer::m_gain

protected

Definition at line 236 of file WaveformLayer.h.

Referenced by getCurrentVerticalZoomStep(), getGain(), getPropertyRangeAndValue(), getValueForY(), paint(), paintVerticalScale(), setGain(), and toXml().

bool WaveformLayer::m_autoNormalize

protected

Definition at line 237 of file WaveformLayer.h.

Referenced by getAutoNormalize(), getPropertyRangeAndValue(), isLayerScrollable(), paint(), setAutoNormalize(), and toXml().

bool WaveformLayer::m_showMeans

protected

Definition at line 238 of file WaveformLayer.h.

Referenced by getShowMeans(), paintChannel(), setShowMeans(), and toXml().

ChannelMode WaveformLayer::m_channelMode

protected

Definition at line 239 of file WaveformLayer.h.

Referenced by getChannelArrangement(), getChannelMode(), getDisplayExtents(), getPropertyRangeAndValue(), getValueForY(), getYForValue(), paintChannel(), setChannelMode(), and toXml().

int WaveformLayer::m_channel

protected

Definition at line 240 of file WaveformLayer.h.

Referenced by getChannel(), getChannelArrangement(), getProperties(), setChannel(), setModel(), and toXml().

int WaveformLayer::m_channelCount

protected

Definition at line 241 of file WaveformLayer.h.

Referenced by getChannelArrangement(), getDisplayExtents(), getNormalizeGain(), getOversampledRanges(), getProperties(), getSummaryRanges(), and setModel().

Scale WaveformLayer::m_scale

protected

Definition at line 242 of file WaveformLayer.h.

Referenced by getDisplayExtents(), getPropertyRangeAndValue(), getScale(), getValueExtents(), getValueForY(), getVerticalScaleWidth(), getYForValue(), getYScaleDifference(), getYScaleValue(), paintChannel(), paintChannelScaleGuides(), paintVerticalScale(), setScale(), and toXml().

double WaveformLayer::m_middleLineHeight

protected

Definition at line 243 of file WaveformLayer.h.

Referenced by getMiddleLineHeight(), paint(), setMiddleLineHeight(), and toXml().

bool WaveformLayer::m_aggressive

protected

Definition at line 244 of file WaveformLayer.h.

Referenced by getAggressiveCacheing(), paint(), setAggressiveCacheing(), and toXml().

double WaveformLayer::m_dBMin = -50.0

staticprotected

Definition at line 246 of file WaveformLayer.h.

Referenced by dBscale(), getDisplayExtents(), getValueForY(), getYScaleDifference(), and getYScaleValue().

std::vector<float> WaveformLayer::m_effectiveGains

mutableprotected

Definition at line 248 of file WaveformLayer.h.

Referenced by paint(), paintChannel(), paintChannelScaleGuides(), and paintVerticalScale().

QPixmap* WaveformLayer::m_cache

mutableprotected

Definition at line 250 of file WaveformLayer.h.

Referenced by paint(), and ~WaveformLayer().

bool WaveformLayer::m_cacheValid

mutableprotected

Definition at line 251 of file WaveformLayer.h.

Referenced by flagBaseColourChanged(), paint(), setAggressiveCacheing(), setAutoNormalize(), setChannel(), setChannelMode(), setGain(), setMiddleLineHeight(), setModel(), setScale(), and setShowMeans().

ZoomLevel WaveformLayer::m_cacheZoomLevel

mutableprotected

Definition at line 252 of file WaveformLayer.h.

Referenced by 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(), paintChannel(), SingleColourLayer::refColor(), SingleColourLayer::setBaseColour(), SingleColourLayer::setDefaultColourFor(), SingleColourLayer::setProperties(), SingleColourLayer::toXml(), 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:

• WaveformLayer.h
• WaveformLayer.cpp