svgui
1.9
|
The base class for visual representations of the data found in a Model. More...
#include <Layer.h>
Classes | |
class | AddMeasurementRectCommand |
class | DeleteMeasurementRectCommand |
struct | MeasureRect |
Public Types | |
enum | VerticalPosition { PositionTop, PositionMiddle, PositionBottom } |
enum | SnapType { SnapLeft, SnapRight, SnapNearest, SnapNeighbouring } |
enum | ColourSignificance { ColourAbsent, ColourIrrelevant, ColourDistinguishes, ColourAndBackgroundSignificant, ColourHasMeaningfulValue } |
Public Slots | |
void | showLayer (View *, bool show) |
Signals | |
void | modelChanged () |
void | modelCompletionChanged () |
void | modelAlignmentCompletionChanged () |
void | modelChangedWithin (int startFrame, int endFrame) |
void | modelReplaced () |
void | layerParametersChanged () |
void | layerParameterRangesChanged () |
void | layerMeasurementRectsChanged () |
void | layerNameChanged () |
void | verticalZoomChanged () |
Public Member Functions | |
Layer () | |
virtual | ~Layer () |
virtual const Model * | getModel () const =0 |
Model * | getModel () |
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 | paint (View *, QPainter &, QRect) const =0 |
Paint the given rectangle of this layer onto the given view using the given painter, superimposing it on top of any existing material in that view. More... | |
virtual void | setSynchronousPainting (bool) |
Enable or disable synchronous painting. More... | |
virtual VerticalPosition | getPreferredTimeRulerPosition () const |
virtual VerticalPosition | getPreferredFrameCountPosition () const |
virtual bool | hasLightBackground () const |
virtual QString | getPropertyContainerIconName () const |
virtual QString | getPropertyContainerName () const |
virtual void | setPresentationName (QString name) |
virtual QString | getLayerPresentationName () const |
virtual QPixmap | getLayerPresentationPixmap (QSize) const |
virtual int | getVerticalScaleWidth (View *, bool detailed, QPainter &) const =0 |
virtual void | paintVerticalScale (View *, bool, QPainter &, QRect) const |
virtual bool | getCrosshairExtents (View *, QPainter &, QPoint, std::vector< QRect > &) const |
virtual void | paintCrosshairs (View *, QPainter &, QPoint) const |
virtual void | paintMeasurementRects (View *, QPainter &, bool showFocus, QPoint focusPoint) const |
virtual bool | nearestMeasurementRectChanged (View *, QPoint prev, QPoint now) const |
virtual QString | getFeatureDescription (View *, QPoint &) const |
virtual QString | getLabelPreceding (int) const |
virtual bool | snapToFeatureFrame (View *, int &, int &resolution, SnapType) const |
Adjust the given frame to snap to the nearest feature, if possible. More... | |
virtual bool | snapToSimilarFeature (View *, int &, int &resolution, SnapType) const |
Adjust the given frame to snap to the next feature that has "effectively" the same value as the feature prior to the given frame, if possible. More... | |
virtual void | drawStart (View *, QMouseEvent *) |
virtual void | drawDrag (View *, QMouseEvent *) |
virtual void | drawEnd (View *, QMouseEvent *) |
virtual void | eraseStart (View *, QMouseEvent *) |
virtual void | eraseDrag (View *, QMouseEvent *) |
virtual void | eraseEnd (View *, QMouseEvent *) |
virtual void | editStart (View *, QMouseEvent *) |
virtual void | editDrag (View *, QMouseEvent *) |
virtual void | editEnd (View *, QMouseEvent *) |
virtual void | splitStart (View *, QMouseEvent *) |
virtual void | splitEnd (View *, QMouseEvent *) |
virtual void | addNote (View *, QMouseEvent *) |
virtual void | measureStart (View *, QMouseEvent *) |
virtual void | measureDrag (View *, QMouseEvent *) |
virtual void | measureEnd (View *, QMouseEvent *) |
virtual void | measureDoubleClick (View *, QMouseEvent *) |
virtual bool | haveCurrentMeasureRect () const |
virtual void | deleteCurrentMeasureRect () |
virtual bool | editOpen (View *, QMouseEvent *) |
Open an editor on the item under the mouse (e.g. More... | |
virtual void | moveSelection (Selection, int) |
virtual void | resizeSelection (Selection, Selection) |
virtual void | deleteSelection (Selection) |
virtual void | copy (View *, Selection, Clipboard &) |
virtual bool | paste (View *, const Clipboard &, int, bool) |
Paste from the given clipboard onto the layer at the given frame offset. More... | |
virtual bool | isLayerScrollable (const View *) const |
This should return true if the layer can safely be scrolled automatically by a given view (simply copying the existing data and then refreshing the exposed area) without altering its meaning. More... | |
virtual bool | isLayerOpaque () const |
This should return true if the layer completely obscures any underlying layers. More... | |
virtual ColourSignificance | getLayerColourSignificance () const =0 |
This should return the degree of meaning associated with colour in this layer. More... | |
virtual bool | isLayerEditable () const |
This should return true if the layer can be edited by the user. More... | |
virtual int | getCompletion (View *) const |
Return the proportion of background work complete in drawing this view, as a percentage – in most cases this will be the value returned by pointer from a call to the underlying model's isReady(int *) call. More... | |
virtual QString | getError (View *) const |
Return an error string if any errors have occurred while loading or processing data for the given view. More... | |
virtual void | setObjectName (const QString &name) |
virtual void | toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const |
Convert the layer's data (though not those of the model it refers to) into XML for file output. More... | |
virtual void | setProperties (const QXmlAttributes &)=0 |
Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes. More... | |
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 View *v, bool dormant) |
Indicate that a layer is not currently visible in the given view and is not expected to become visible in the near future (for example because the user has explicitly removed or hidden it). More... | |
virtual bool | isLayerDormant (const View *v) const |
Return whether the layer is dormant (i.e. More... | |
virtual PlayParameters * | getPlayParameters () |
virtual bool | needsTextLabelHeight () const |
virtual bool | hasTimeXAxis () const |
virtual bool | getValueExtents (float &min, float &max, bool &logarithmic, QString &unit) const =0 |
Return the minimum and maximum values for the y axis of the model in this layer, as well as whether the layer is configured to use a logarithmic y axis display. More... | |
virtual bool | getDisplayExtents (float &, float &) const |
Return the minimum and maximum values within the displayed range for the y axis, if only a subset of the whole range of the model (returned by getValueExtents) is being displayed. More... | |
virtual bool | setDisplayExtents (float, float) |
Set the displayed minimum and maximum values for the y axis to the given range, if supported. More... | |
virtual bool | getXScaleValue (const View *v, int x, float &value, QString &unit) const |
Return the value and unit at the given x coordinate in the given view. More... | |
virtual bool | getYScaleValue (const View *, int, float &, QString &) const |
Return the value and unit at the given y coordinate in the given view. More... | |
virtual bool | getYScaleDifference (const View *v, int y0, int y1, float &diff, QString &unit) const |
Return the difference between the values at the given y coordinates in the given view, and the unit of the difference. More... | |
virtual int | getVerticalZoomSteps (int &) const |
Get the number of vertical zoom steps available for this layer. More... | |
virtual int | getCurrentVerticalZoomStep () const |
Get the current vertical zoom step. More... | |
virtual void | setVerticalZoomStep (int) |
Set the vertical zoom step. More... | |
virtual RangeMapper * | getNewVerticalZoomRangeMapper () const |
Create and return a range mapper for vertical zoom step values. More... | |
Protected Types | |
typedef std::set< MeasureRect > | MeasureRectSet |
Protected Member Functions | |
void | connectSignals (const Model *) |
virtual int | alignToReference (View *v, int frame) const |
virtual int | alignFromReference (View *v, int frame) const |
bool | clipboardHasDifferentAlignment (View *v, const Clipboard &clip) const |
void | addMeasureRectToSet (const MeasureRect &r) |
void | deleteMeasureRectFromSet (const MeasureRect &r) |
void | updateMeasurePixrects (View *v) const |
virtual void | updateMeasureRectYCoords (View *v, const MeasureRect &r) const |
virtual void | setMeasureRectYCoord (View *v, MeasureRect &r, bool start, int y) const |
virtual void | setMeasureRectFromPixrect (View *v, MeasureRect &r, QRect pixrect) const |
MeasureRectSet::const_iterator | findFocusedMeasureRect (QPoint) const |
void | paintMeasurementRect (View *v, QPainter &paint, const MeasureRect &r, bool focus) const |
Protected Attributes | |
MeasureRectSet | m_measureRects |
MeasureRect | m_draggingRect |
bool | m_haveDraggingRect |
bool | m_haveCurrentMeasureRect |
QPoint | m_currentMeasureRectPoint |
QString | m_presentationName |
Private Attributes | |
QMutex | m_dormancyMutex |
std::map< const void *, bool > | m_dormancy |
The base class for visual representations of the data found in a Model.
Layers are expected to be able to draw themselves onto a View, and may also be editable.
|
protected |
enum Layer::SnapType |
|
pure virtual |
Implemented in FlexiNoteLayer, RegionLayer, TimeValueLayer, NoteLayer, ImageLayer, TimeInstantLayer, TextLayer, SpectrogramLayer, Colour3DPlotLayer, SpectrumLayer, WaveformLayer, TimeRulerLayer, and SliceLayer.
Referenced by alignFromReference(), alignToReference(), View::cancelClicked(), LayerTreeModel::data(), View::getAligningModel(), FlexiNoteLayer::getAssociatedPitchModel(), getLayerPresentationName(), getModel(), View::getModels(), getPlayParameters(), getXScaleValue(), ModelMetadataModel::rebuildModelSet(), toBriefXml(), and toXml().
|
inline |
Definition at line 62 of file Layer.h.
References getModel().
|
inlinevirtual |
Return a zoom constraint object defining the supported zoom levels for this layer.
If this returns zero, the layer will support any integer zoom level.
Reimplemented in SpectrogramLayer, Colour3DPlotLayer, and WaveformLayer.
|
inlinevirtual |
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.
|
pure virtual |
Paint the given rectangle of this layer onto the given view using the given painter, superimposing it on top of any existing material in that view.
The view is provided here because it is possible for one layer to exist in more than one view, so the dimensions of the view may vary from one paint call to another (without any view having been resized).
Implemented in SpectrogramLayer, Colour3DPlotLayer, SpectrumLayer, RegionLayer, FlexiNoteLayer, ImageLayer, SliceLayer, WaveformLayer, TimeValueLayer, NoteLayer, TimeInstantLayer, TextLayer, and TimeRulerLayer.
Referenced by paintMeasurementRect(), and paintMeasurementRects().
|
inlinevirtual |
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.
|
inlinevirtual |
Definition at line 109 of file Layer.h.
References PositionMiddle.
|
inlinevirtual |
Reimplemented in SpectrogramLayer, and SpectrumLayer.
Definition at line 112 of file Layer.h.
References PositionBottom.
|
inlinevirtual |
Reimplemented in SpectrogramLayer, and SingleColourLayer.
|
virtual |
Definition at line 65 of file Layer.cpp.
References LayerFactory::getInstance(), and LayerFactory::getLayerIconName().
Referenced by LayerTreeModel::data().
|
inlinevirtual |
Definition at line 121 of file Layer.h.
References m_presentationName.
|
virtual |
Definition at line 72 of file Layer.cpp.
References m_presentationName.
|
virtual |
Reimplemented in TimeRulerLayer.
Definition at line 78 of file Layer.cpp.
References LayerFactory::getInstance(), LayerFactory::getLayerPresentationName(), LayerFactory::getLayerType(), getModel(), and m_presentationName.
Referenced by FlexiNoteLayer::getAssociatedPitchModel(), and PropertyStack::repopulate().
|
inlinevirtual |
Reimplemented in SingleColourLayer.
|
pure virtual |
Implemented in TimeInstantLayer, SpectrumLayer, ImageLayer, TextLayer, SpectrogramLayer, TimeRulerLayer, Colour3DPlotLayer, WaveformLayer, SliceLayer, RegionLayer, FlexiNoteLayer, TimeValueLayer, and NoteLayer.
Referenced by Pane::drawVerticalScale(), Pane::getImageSize(), and Pane::toNewImage().
|
inlinevirtual |
Reimplemented in SpectrogramLayer, Colour3DPlotLayer, WaveformLayer, SliceLayer, RegionLayer, FlexiNoteLayer, TimeValueLayer, and NoteLayer.
Definition at line 134 of file Layer.h.
Referenced by Pane::drawVerticalScale(), and Pane::render().
|
inlinevirtual |
Reimplemented in SpectrogramLayer, and SpectrumLayer.
|
inlinevirtual |
Reimplemented in SpectrogramLayer, and SpectrumLayer.
|
virtual |
Definition at line 428 of file Layer.cpp.
References findFocusedMeasureRect(), m_currentMeasureRectPoint, m_draggingRect, m_haveCurrentMeasureRect, m_haveDraggingRect, m_measureRects, paint(), paintMeasurementRect(), and updateMeasurePixrects().
Referenced by Pane::paintEvent().
|
virtual |
Definition at line 460 of file Layer.cpp.
References findFocusedMeasureRect(), and updateMeasurePixrects().
Referenced by Pane::mouseMoveEvent().
|
inlinevirtual |
Reimplemented in SpectrogramLayer, Colour3DPlotLayer, RegionLayer, FlexiNoteLayer, SpectrumLayer, TimeValueLayer, ImageLayer, NoteLayer, SliceLayer, WaveformLayer, TimeInstantLayer, and TextLayer.
Definition at line 149 of file Layer.h.
Referenced by Pane::drawFeatureDescription().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, and TimeInstantLayer.
|
inlinevirtual |
Adjust the given frame to snap to the nearest feature, if possible.
If snap is SnapLeft or SnapRight, adjust the frame to match that of the nearest feature in the given direction regardless of how far away it is. If snap is SnapNearest, adjust the frame to that of the nearest feature in either direction. If snap is SnapNeighbouring, adjust the frame to that of the nearest feature if it is close, and leave it alone (returning false) otherwise. SnapNeighbouring should always choose the same feature that would be used in an editing operation through calls to editStart etc.
Return true if a suitable feature was found and frame adjusted accordingly. Return false if no suitable feature was available (and leave frame unmodified). If returning true, also return the resolution of the model in this layer in sample frames.
Reimplemented in SpectrogramLayer, Colour3DPlotLayer, RegionLayer, FlexiNoteLayer, TimeValueLayer, ImageLayer, NoteLayer, TimeRulerLayer, TimeInstantLayer, and TextLayer.
Definition at line 183 of file Layer.h.
Referenced by Pane::dragExtendSelection(), Pane::mousePressEvent(), TextLayer::snapToFeatureFrame(), TimeInstantLayer::snapToFeatureFrame(), ImageLayer::snapToFeatureFrame(), NoteLayer::snapToFeatureFrame(), FlexiNoteLayer::snapToFeatureFrame(), TimeValueLayer::snapToFeatureFrame(), RegionLayer::snapToFeatureFrame(), and Colour3DPlotLayer::snapToFeatureFrame().
|
inlinevirtual |
Adjust the given frame to snap to the next feature that has "effectively" the same value as the feature prior to the given frame, if possible.
The snap type must be SnapLeft (snap to the time of the next feature prior to the one preceding the given frame that has a similar value to it) or SnapRight (snap to the time of the next feature following the given frame that has a similar value to the feature preceding it). Other values are not permitted.
Return true if a suitable feature was found and frame adjusted accordingly. Return false if no suitable feature was available (and leave frame unmodified). If returning true, also return the resolution of the model in this layer in sample frames.
Reimplemented in RegionLayer, and TimeValueLayer.
Definition at line 207 of file Layer.h.
Referenced by TimeValueLayer::snapToSimilarFeature(), and RegionLayer::snapToSimilarFeature().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, ImageLayer, NoteLayer, TimeInstantLayer, and TextLayer.
Definition at line 220 of file Layer.h.
Referenced by Pane::mousePressEvent().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, ImageLayer, NoteLayer, TimeInstantLayer, and TextLayer.
Definition at line 221 of file Layer.h.
Referenced by Pane::mouseMoveEvent().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, ImageLayer, NoteLayer, TimeInstantLayer, and TextLayer.
Definition at line 222 of file Layer.h.
Referenced by Pane::mouseReleaseEvent().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, NoteLayer, TimeInstantLayer, and TextLayer.
Definition at line 224 of file Layer.h.
Referenced by Pane::mousePressEvent().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, NoteLayer, TimeInstantLayer, and TextLayer.
Definition at line 225 of file Layer.h.
Referenced by Pane::mouseMoveEvent().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, NoteLayer, TimeInstantLayer, and TextLayer.
Definition at line 226 of file Layer.h.
Referenced by Pane::mouseReleaseEvent().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, NoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.
Definition at line 228 of file Layer.h.
Referenced by Pane::mouseMoveEvent().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, NoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.
Definition at line 229 of file Layer.h.
Referenced by Pane::mouseMoveEvent().
|
inlinevirtual |
Reimplemented in RegionLayer, TimeValueLayer, FlexiNoteLayer, NoteLayer, ImageLayer, TimeInstantLayer, and TextLayer.
Definition at line 230 of file Layer.h.
Referenced by Pane::mouseReleaseEvent().
|
inlinevirtual |
Reimplemented in FlexiNoteLayer.
Definition at line 232 of file Layer.h.
Referenced by Pane::mousePressEvent().
|
inlinevirtual |
Reimplemented in FlexiNoteLayer.
Definition at line 233 of file Layer.h.
Referenced by Pane::mouseReleaseEvent().
|
inlinevirtual |
Reimplemented in FlexiNoteLayer.
Definition at line 234 of file Layer.h.
Referenced by Pane::mouseDoubleClickEvent().
|
virtual |
Definition at line 374 of file Layer.cpp.
References m_draggingRect, m_haveDraggingRect, and setMeasureRectFromPixrect().
Referenced by Pane::mousePressEvent().
|
virtual |
Definition at line 382 of file Layer.cpp.
References m_draggingRect, m_haveDraggingRect, Layer::MeasureRect::pixrect, and setMeasureRectFromPixrect().
Referenced by measureEnd(), and Pane::mouseMoveEvent().
|
virtual |
Definition at line 394 of file Layer.cpp.
References CommandHistory::addCommand(), CommandHistory::getInstance(), m_draggingRect, m_haveDraggingRect, measureDrag(), and Layer::MeasureRect::pixrect.
Referenced by Pane::mouseReleaseEvent().
|
virtual |
Reimplemented in SpectrogramLayer.
Definition at line 408 of file Layer.cpp.
Referenced by Pane::mouseDoubleClickEvent().
|
inlinevirtual |
Definition at line 245 of file Layer.h.
References m_haveCurrentMeasureRect.
|
virtual |
Definition at line 414 of file Layer.cpp.
References CommandHistory::addCommand(), findFocusedMeasureRect(), CommandHistory::getInstance(), m_currentMeasureRectPoint, m_haveCurrentMeasureRect, and m_measureRects.
|
inlinevirtual |
Open an editor on the item under the mouse (e.g.
on double-click). If there is no item or editing is not supported, return false.
Reimplemented in FlexiNoteLayer, RegionLayer, TimeValueLayer, ImageLayer, TextLayer, NoteLayer, and TimeInstantLayer.
Definition at line 255 of file Layer.h.
Referenced by Pane::mouseDoubleClickEvent().
|
inlinevirtual |
Reimplemented in FlexiNoteLayer, RegionLayer, TimeValueLayer, NoteLayer, TimeInstantLayer, ImageLayer, and TextLayer.
Definition at line 257 of file Layer.h.
Referenced by Pane::editSelectionEnd().
|
inlinevirtual |
Reimplemented in FlexiNoteLayer, RegionLayer, TimeValueLayer, NoteLayer, TimeInstantLayer, ImageLayer, and TextLayer.
Definition at line 258 of file Layer.h.
Referenced by Pane::editSelectionEnd().
|
inlinevirtual |
Reimplemented in FlexiNoteLayer, RegionLayer, TimeValueLayer, NoteLayer, TimeInstantLayer, ImageLayer, and TextLayer.
|
inlinevirtual |
Reimplemented in FlexiNoteLayer, RegionLayer, TimeValueLayer, NoteLayer, TimeInstantLayer, ImageLayer, and TextLayer.
Definition at line 261 of file Layer.h.
Referenced by SpectrogramLayer::paint(), and Colour3DPlotLayer::paintDense().
|
inlinevirtual |
Paste from the given clipboard onto the layer at the given frame offset.
If interactive is true, the layer may ask the user about paste options through a dialog if desired, and may return false if the user cancelled the paste operation. This function should return true if a paste actually occurred.
Reimplemented in FlexiNoteLayer, RegionLayer, TimeValueLayer, NoteLayer, TimeInstantLayer, ImageLayer, and TextLayer.
|
inlinevirtual |
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 in SpectrogramLayer, WaveformLayer, TimeValueLayer, FlexiNoteLayer, RegionLayer, NoteLayer, TimeInstantLayer, ImageLayer, SpectrumLayer, TextLayer, SliceLayer, and Colour3DPlotLayer.
|
inlinevirtual |
This should return true if the layer completely obscures any underlying layers.
It's used to determine whether the view can safely draw any selection rectangles under the layer instead of over it, in the case where the layer is not scrollable and therefore needs to be redrawn each time (so that the selection rectangle can be cached).
Reimplemented in SpectrogramLayer.
Definition at line 302 of file Layer.h.
Referenced by View::getAligningModel().
|
pure virtual |
This should return the degree of meaning associated with colour in this layer.
If ColourAbsent, the layer does not use colour. If ColourIrrelevant, the layer is coloured and the colour may be set by the user, but it doesn't really matter what the colour is (for example, in a time ruler layer). If ColourDistinguishes, then the colour is used to distinguish this layer from other similar layers (e.g. for data layers). If ColourAndBackgroundSignificant, then the layer should be given greater weight than ColourDistinguishes layers when choosing a background colour (e.g. for waveforms). If ColourHasMeaningfulValue, colours are actually meaningful – the view will then show selections using unfilled rectangles instead of translucent filled rectangles, so as not to disturb the colours underneath.
Implemented in SpectrogramLayer, TimeValueLayer, TimeInstantLayer, ImageLayer, Colour3DPlotLayer, SingleColourLayer, SliceLayer, TimeRulerLayer, and WaveformLayer.
|
inlinevirtual |
This should return true if the layer can be edited by the user.
If this is the case, the appropriate edit tools may be made available by the application and the layer's drawStart/Drag/End and editStart/Drag/End methods should be implemented.
Reimplemented in TimeValueLayer, FlexiNoteLayer, RegionLayer, NoteLayer, TimeInstantLayer, ImageLayer, and TextLayer.
Definition at line 338 of file Layer.h.
Referenced by Pane::mouseDoubleClickEvent(), Pane::mouseMoveEvent(), Pane::mousePressEvent(), Pane::mouseReleaseEvent(), Pane::shouldIlluminateLocalSelection(), and Pane::updateContextHelp().
|
inlinevirtual |
Return the proportion of background work complete in drawing this view, as a percentage – in most cases this will be the value returned by pointer from a call to the underlying model's isReady(int *) call.
The view may choose to show a progress meter if it finds that this returns < 100 at any given moment.
Reimplemented in SpectrogramLayer, WaveformLayer, TimeValueLayer, FlexiNoteLayer, RegionLayer, NoteLayer, TimeInstantLayer, ImageLayer, TextLayer, and Colour3DPlotLayer.
|
inlinevirtual |
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.
|
virtual |
Definition at line 100 of file Layer.cpp.
References layerNameChanged().
Referenced by LayerFactory::createLayer().
|
virtual |
Convert the layer's data (though not those of the model it refers to) into XML for file output.
This class implements the basic name/type/model-id output; subclasses will typically call this superclass implementation with extra attributes describing their particular properties.
Reimplemented in SpectrogramLayer, WaveformLayer, Colour3DPlotLayer, FlexiNoteLayer, TimeValueLayer, NoteLayer, RegionLayer, SliceLayer, TimeInstantLayer, SpectrumLayer, ImageLayer, TextLayer, SingleColourLayer, and TimeRulerLayer.
Definition at line 592 of file Layer.cpp.
References LayerFactory::getInstance(), getModel(), m_measureRects, and m_presentationName.
Referenced by SingleColourLayer::toXml(), ImageLayer::toXml(), Colour3DPlotLayer::toXml(), and SpectrogramLayer::toXml().
|
pure virtual |
Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes.
This is the effective inverse of the toXml method.
Implemented in SpectrogramLayer, WaveformLayer, FlexiNoteLayer, TimeValueLayer, NoteLayer, RegionLayer, TimeInstantLayer, ImageLayer, TextLayer, Colour3DPlotLayer, SingleColourLayer, SpectrumLayer, SliceLayer, and TimeRulerLayer.
Referenced by LayerFactory::setLayerDefaultProperties().
|
virtual |
Produce XML containing the layer's ID and type.
This is used to refer to the layer in the display section of the SV session file, for a layer that has already been described in the data section.
Definition at line 626 of file Layer.cpp.
References LayerFactory::getInstance(), getModel(), and m_presentationName.
|
virtual |
Add a measurement rectangle from the given XML attributes (presumably taken from a measurement element).
Does not use a command.
Definition at line 317 of file Layer.cpp.
References addMeasureRectToSet(), Layer::MeasureRect::endFrame, Layer::MeasureRect::endY, Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, Layer::MeasureRect::startFrame, and Layer::MeasureRect::startY.
|
virtual |
Indicate that a layer is not currently visible in the given view and is not expected to become visible in the near future (for example because the user has explicitly removed or hidden it).
The layer may respond by (for example) freeing any cache memory it is using, until next time its paint method is called, when it should set itself un-dormant again.
A layer class that overrides this function must also call this class's implementation.
Reimplemented in SpectrogramLayer, ImageLayer, and Colour3DPlotLayer.
Definition at line 118 of file Layer.cpp.
References m_dormancy, and m_dormancyMutex.
Referenced by Colour3DPlotLayer::setLayerDormant(), SpectrogramLayer::setLayerDormant(), and showLayer().
|
virtual |
Return whether the layer is dormant (i.e.
hidden) in the given view.
Definition at line 126 of file Layer.cpp.
References m_dormancy, and m_dormancyMutex.
Referenced by LayerTreeModel::data(), View::getInteractionLayer(), SpectrogramLayer::paint(), PropertyStack::propertyContainerPropertyChanged(), PropertyStack::repopulate(), Colour3DPlotLayer::setLayerDormant(), and SpectrogramLayer::setLayerDormant().
|
virtual |
Definition at line 107 of file Layer.cpp.
References getModel().
Referenced by LayerTreeModel::data(), LayerTreeModel::LayerTreeModel(), LayerTreeModel::playParametersAudibilityChanged(), and LayerTreeModel::setData().
|
inlinevirtual |
Reimplemented in TimeValueLayer, and TimeInstantLayer.
|
inlinevirtual |
Reimplemented in SliceLayer.
Definition at line 415 of file Layer.h.
Referenced by getXScaleValue(), Pane::mouseMoveEvent(), and setMeasureRectFromPixrect().
|
pure virtual |
Return the minimum and maximum values for the y axis of the model in this layer, as well as whether the layer is configured to use a logarithmic y axis display.
Also return the unit for these values if known.
This function returns the "normal" extents for the layer, not necessarily the extents actually in use in the display.
Implemented in SpectrogramLayer, WaveformLayer, Colour3DPlotLayer, TimeValueLayer, FlexiNoteLayer, RegionLayer, NoteLayer, TimeInstantLayer, ImageLayer, TextLayer, SpectrumLayer, SliceLayer, and TimeRulerLayer.
Referenced by Pane::drawVerticalScale(), and Pane::getTopLayerDisplayExtents().
|
inlinevirtual |
Return the minimum and maximum values within the displayed range for the y axis, if only a subset of the whole range of the model (returned by getValueExtents) is being displayed.
Return false if the layer is not imposing a particular display extent (using the normal layer extents or deferring to whatever is in use for the same units elsewhere in the view).
Reimplemented in SpectrogramLayer, Colour3DPlotLayer, TimeValueLayer, FlexiNoteLayer, RegionLayer, and NoteLayer.
Definition at line 437 of file Layer.h.
Referenced by Pane::drawVerticalScale(), and Pane::getTopLayerDisplayExtents().
|
inlinevirtual |
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, and NoteLayer.
Definition at line 449 of file Layer.h.
Referenced by Pane::setTopLayerDisplayExtents(), FlexiNoteLayer::setVerticalRangeToNoteRange(), and Pane::zoomToRegion().
|
virtual |
Return the value and unit at the given x coordinate in the given view.
This is for descriptive purposes using the measurement tool. The default implementation works correctly if the layer hasTimeXAxis().
Reimplemented in SpectrumLayer.
Definition at line 142 of file Layer.cpp.
References View::getFrameForX(), getModel(), and hasTimeXAxis().
Referenced by View::drawMeasurementRect().
|
inlinevirtual |
Return the value and unit at the given y coordinate in the given view.
Reimplemented in SpectrogramLayer, WaveformLayer, Colour3DPlotLayer, and SpectrumLayer.
Definition at line 467 of file Layer.h.
Referenced by View::drawMeasurementRect(), and getYScaleDifference().
|
virtual |
Return the difference between the values at the given y coordinates in the given view, and the unit of the difference.
The default implementation just calls getYScaleValue twice and returns the difference, with the same unit.
Reimplemented in WaveformLayer, and SpectrumLayer.
Definition at line 155 of file Layer.cpp.
References getYScaleValue().
Referenced by View::drawMeasurementRect(), and SpectrumLayer::getYScaleDifference().
|
inlinevirtual |
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 in SpectrogramLayer, WaveformLayer, Colour3DPlotLayer, TimeValueLayer, FlexiNoteLayer, and NoteLayer.
Definition at line 495 of file Layer.h.
Referenced by Pane::updateHeadsUpDisplay(), Pane::updateVerticalPanner(), and Pane::verticalThumbwheelMoved().
|
inlinevirtual |
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 in SpectrogramLayer, WaveformLayer, Colour3DPlotLayer, TimeValueLayer, FlexiNoteLayer, and NoteLayer.
Definition at line 503 of file Layer.h.
Referenced by Pane::updateHeadsUpDisplay(), and Pane::verticalZoomChanged().
|
inlinevirtual |
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 in SpectrogramLayer, WaveformLayer, Colour3DPlotLayer, TimeValueLayer, FlexiNoteLayer, and NoteLayer.
Definition at line 511 of file Layer.h.
Referenced by Pane::verticalThumbwheelMoved().
|
inlinevirtual |
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, and NoteLayer.
Definition at line 519 of file Layer.h.
Referenced by Pane::propertyContainerSelected(), and Pane::updateHeadsUpDisplay().
|
slot |
Definition at line 135 of file Layer.cpp.
References layerParametersChanged(), and setLayerDormant().
Referenced by ShowLayerCommand::execute(), LayerTreeModel::setData(), and ShowLayerCommand::unexecute().
|
signal |
|
signal |
Referenced by connectSignals().
|
signal |
Referenced by connectSignals().
|
signal |
Referenced by connectSignals(), SpectrogramLayer::fillTimerTimedOut(), and SpectrogramLayer::setModel().
|
signal |
Referenced by TimeRulerLayer::setModel(), WaveformLayer::setModel(), TextLayer::setModel(), TimeInstantLayer::setModel(), ImageLayer::setModel(), Colour3DPlotLayer::setModel(), NoteLayer::setModel(), TimeValueLayer::setModel(), SpectrogramLayer::setModel(), RegionLayer::setModel(), FlexiNoteLayer::setModel(), and SliceLayer::setSliceableModel().
|
signal |
Referenced by SpectrogramLayer::preferenceChanged(), WaveformLayer::setAggressiveCacheing(), WaveformLayer::setAutoNormalize(), SingleColourLayer::setBaseColour(), SpectrogramLayer::setBinDisplay(), SliceLayer::setBinScale(), Colour3DPlotLayer::setBinScale(), SpectrumLayer::setChannel(), SpectrogramLayer::setChannel(), WaveformLayer::setChannel(), WaveformLayer::setChannelMode(), Colour3DPlotLayer::setColourMap(), SpectrogramLayer::setColourMap(), SpectrogramLayer::setColourRotation(), Colour3DPlotLayer::setColourScale(), SpectrogramLayer::setColourScale(), NoteLayer::setDisplayExtents(), FlexiNoteLayer::setDisplayExtents(), TimeValueLayer::setDisplayExtents(), Colour3DPlotLayer::setDisplayExtents(), SpectrogramLayer::setDisplayExtents(), TimeValueLayer::setDrawSegmentDivisions(), SliceLayer::setEnergyScale(), SliceLayer::setFillColourMap(), TimeValueLayer::setFillColourMap(), RegionLayer::setFillColourMap(), SpectrogramLayer::setFrequencyScale(), WaveformLayer::setGain(), SliceLayer::setGain(), Colour3DPlotLayer::setGain(), SpectrogramLayer::setGain(), Colour3DPlotLayer::setInvertVertical(), SpectrogramLayer::setMaxFrequency(), WaveformLayer::setMiddleLineHeight(), SpectrogramLayer::setMinFrequency(), SpectrumLayer::setModel(), WaveformLayer::setModel(), SliceLayer::setNormalize(), Colour3DPlotLayer::setNormalizeColumns(), SpectrogramLayer::setNormalizeColumns(), Colour3DPlotLayer::setNormalizeHybrid(), SpectrogramLayer::setNormalizeHybrid(), Colour3DPlotLayer::setNormalizeVisibleArea(), SpectrogramLayer::setNormalizeVisibleArea(), Colour3DPlotLayer::setOpaque(), TimeInstantLayer::setPlotStyle(), SliceLayer::setPlotStyle(), TimeValueLayer::setPlotStyle(), RegionLayer::setPlotStyle(), SliceLayer::setSamplingMode(), WaveformLayer::setScale(), TimeValueLayer::setShowDerivative(), WaveformLayer::setShowMeans(), SpectrumLayer::setShowPeaks(), Colour3DPlotLayer::setSmooth(), SliceLayer::setThreshold(), SpectrogramLayer::setThreshold(), WaveformLayer::setUseGreyscale(), NoteLayer::setVerticalScale(), RegionLayer::setVerticalScale(), TimeValueLayer::setVerticalScale(), FlexiNoteLayer::setVerticalScale(), Colour3DPlotLayer::setVerticalZoomStep(), SpectrumLayer::setWindowHopLevel(), SpectrogramLayer::setWindowHopLevel(), SpectrumLayer::setWindowSize(), SpectrogramLayer::setWindowSize(), SpectrumLayer::setWindowType(), SpectrogramLayer::setWindowType(), SpectrogramLayer::setZeroPadLevel(), and showLayer().
|
signal |
Referenced by SliceLayer::setPlotStyle(), TimeValueLayer::setPlotStyle(), and RegionLayer::setPlotStyle().
|
signal |
Referenced by addMeasureRectToSet(), and deleteMeasureRectFromSet().
|
signal |
Referenced by setObjectName().
|
signal |
Referenced by SpectrogramLayer::setDisplayExtents(), WaveformLayer::setGain(), and SpectrogramLayer::setProperty().
|
protected |
Definition at line 49 of file Layer.cpp.
References modelAlignmentCompletionChanged(), modelChanged(), modelChangedWithin(), and modelCompletionChanged().
Referenced by WaveformLayer::setModel(), TextLayer::setModel(), ImageLayer::setModel(), TimeInstantLayer::setModel(), Colour3DPlotLayer::setModel(), NoteLayer::setModel(), TimeValueLayer::setModel(), RegionLayer::setModel(), SpectrogramLayer::setModel(), FlexiNoteLayer::setModel(), and SliceLayer::setSliceableModel().
|
protectedvirtual |
Definition at line 169 of file Layer.cpp.
References View::alignToReference(), and getModel().
Referenced by clipboardHasDifferentAlignment(), TextLayer::copy(), ImageLayer::copy(), TimeInstantLayer::copy(), NoteLayer::copy(), TimeValueLayer::copy(), RegionLayer::copy(), and FlexiNoteLayer::copy().
|
protectedvirtual |
Definition at line 181 of file Layer.cpp.
References View::alignFromReference(), and getModel().
Referenced by TextLayer::paste(), ImageLayer::paste(), TimeInstantLayer::paste(), NoteLayer::paste(), TimeValueLayer::paste(), RegionLayer::paste(), and FlexiNoteLayer::paste().
|
protected |
Definition at line 193 of file Layer.cpp.
References alignToReference().
Referenced by TextLayer::paste(), ImageLayer::paste(), TimeInstantLayer::paste(), NoteLayer::paste(), TimeValueLayer::paste(), RegionLayer::paste(), and FlexiNoteLayer::paste().
|
inlineprotected |
Definition at line 588 of file Layer.h.
References layerMeasurementRectsChanged(), and m_measureRects.
Referenced by addMeasurementRect().
|
inlineprotected |
Definition at line 593 of file Layer.h.
References layerMeasurementRectsChanged(), and m_measureRects.
|
protected |
Definition at line 471 of file Layer.cpp.
References View::getEndFrame(), View::getStartFrame(), View::getXForFrame(), m_measureRects, and updateMeasureRectYCoords().
Referenced by nearestMeasurementRectChanged(), and paintMeasurementRects().
|
protectedvirtual |
Reimplemented in SpectrogramLayer.
Definition at line 510 of file Layer.cpp.
References Layer::MeasureRect::endY, Layer::MeasureRect::pixrect, and Layer::MeasureRect::startY.
Referenced by updateMeasurePixrects().
|
protectedvirtual |
Reimplemented in SpectrogramLayer.
Definition at line 518 of file Layer.cpp.
References Layer::MeasureRect::endY, and Layer::MeasureRect::startY.
Referenced by setMeasureRectFromPixrect().
|
protectedvirtual |
Definition at line 529 of file Layer.cpp.
References Layer::MeasureRect::endFrame, View::getFrameForX(), hasTimeXAxis(), Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, setMeasureRectYCoord(), and Layer::MeasureRect::startFrame.
Referenced by SpectrogramLayer::measureDoubleClick(), measureDrag(), and measureStart().
|
protected |
Definition at line 542 of file Layer.cpp.
References m_measureRects.
Referenced by deleteCurrentMeasureRect(), nearestMeasurementRectChanged(), and paintMeasurementRects().
|
protected |
Definition at line 569 of file Layer.cpp.
References View::drawMeasurementRect(), Layer::MeasureRect::endFrame, View::getEndFrame(), View::getStartFrame(), View::getXForFrame(), Layer::MeasureRect::haveFrames, paint(), Layer::MeasureRect::pixrect, and Layer::MeasureRect::startFrame.
Referenced by paintMeasurementRects().
|
protected |
Definition at line 599 of file Layer.h.
Referenced by addMeasureRectToSet(), deleteCurrentMeasureRect(), deleteMeasureRectFromSet(), findFocusedMeasureRect(), paintMeasurementRects(), toXml(), and updateMeasurePixrects().
|
protected |
Definition at line 600 of file Layer.h.
Referenced by measureDrag(), measureEnd(), measureStart(), and paintMeasurementRects().
|
protected |
Definition at line 601 of file Layer.h.
Referenced by measureDrag(), measureEnd(), measureStart(), and paintMeasurementRects().
|
mutableprotected |
Definition at line 602 of file Layer.h.
Referenced by deleteCurrentMeasureRect(), haveCurrentMeasureRect(), and paintMeasurementRects().
|
mutableprotected |
Definition at line 603 of file Layer.h.
Referenced by deleteCurrentMeasureRect(), and paintMeasurementRects().
|
protected |
Definition at line 620 of file Layer.h.
Referenced by getLayerPresentationName(), getPropertyContainerName(), setPresentationName(), toBriefXml(), and toXml().
|
mutableprivate |
Definition at line 623 of file Layer.h.
Referenced by isLayerDormant(), and setLayerDormant().
|
mutableprivate |
Definition at line 624 of file Layer.h.
Referenced by isLayerDormant(), and setLayerDormant().