svgui
1.9
|
#include <RegionLayer.h>
Public Types | |
enum | VerticalScale { AutoAlignScale, EqualSpaced, LinearScale, LogScale } |
enum | PlotStyle { PlotLines, PlotSegmentation } |
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 | |
RegionLayer () | |
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... | |
int | getVerticalScaleWidth (LayerGeometryProvider *v, bool, QPainter &) const override |
void | paintVerticalScale (LayerGeometryProvider *v, bool, QPainter &paint, QRect rect) const override |
QString | getFeatureDescription (LayerGeometryProvider *v, QPoint &) const override |
QString | getLabelPreceding (sv_frame_t) const override |
bool | snapToFeatureFrame (LayerGeometryProvider *v, sv_frame_t &frame, int &resolution, SnapType snap, int ycoord) const override |
Adjust the given frame to snap to the nearest feature, if possible. More... | |
bool | snapToSimilarFeature (LayerGeometryProvider *v, sv_frame_t &frame, int &resolution, SnapType snap) const override |
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... | |
void | drawStart (LayerGeometryProvider *v, QMouseEvent *) override |
void | drawDrag (LayerGeometryProvider *v, QMouseEvent *) override |
void | drawEnd (LayerGeometryProvider *v, QMouseEvent *) override |
void | eraseStart (LayerGeometryProvider *v, QMouseEvent *) override |
void | eraseDrag (LayerGeometryProvider *v, QMouseEvent *) override |
void | eraseEnd (LayerGeometryProvider *v, QMouseEvent *) override |
void | editStart (LayerGeometryProvider *v, QMouseEvent *) override |
void | editDrag (LayerGeometryProvider *v, QMouseEvent *) override |
void | editEnd (LayerGeometryProvider *v, QMouseEvent *) override |
bool | editOpen (LayerGeometryProvider *v, QMouseEvent *) override |
Open an editor on the item under the mouse (e.g. More... | |
void | moveSelection (Selection s, sv_frame_t newStartFrame) override |
void | resizeSelection (Selection s, Selection newSize) override |
void | deleteSelection (Selection s) override |
void | copy (LayerGeometryProvider *v, Selection s, Clipboard &to) override |
bool | paste (LayerGeometryProvider *v, const Clipboard &from, sv_frame_t frameOffset, bool interactive) override |
Paste from the given clipboard onto the layer at the given frame offset. More... | |
ModelId | getModel () const override |
Return the ID of the model represented in this layer. More... | |
void | setModel (ModelId model) |
PropertyList | getProperties () const override |
QString | getPropertyLabel (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 |
void | setProperty (const PropertyName &, int value) override |
void | setFillColourMap (int) |
int | getFillColourMap () const |
void | setVerticalScale (VerticalScale scale) |
VerticalScale | getVerticalScale () const |
void | setPlotStyle (PlotStyle style) |
PlotStyle | getPlotStyle () const |
bool | isLayerScrollable (const LayerGeometryProvider *v) const override |
This should return true if the layer can safely be scrolled automatically by a given view (simply copying the existing data and then refreshing the exposed area) without altering its meaning. More... | |
bool | isLayerEditable () const override |
This should return true if the layer can be edited by the user. 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... | |
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 | getYForValue (LayerGeometryProvider *v, double value) const override |
VerticalScaleLayer and ColourScaleLayer methods. More... | |
double | getValueForY (LayerGeometryProvider *v, int y) const override |
QString | getScaleUnits () const override |
QColor | getColourForValue (LayerGeometryProvider *v, double value) const override |
virtual void | setBaseColour (int) |
Set the colour used to draw primary items in the layer. More... | |
virtual int | getBaseColour () const |
Retrieve the current primary drawing colour, as a ColourDatabase index value. More... | |
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... | |
ColourSignificance | getLayerColourSignificance () const override |
Implements Layer::getLayerColourSignificance() More... | |
QPixmap | getLayerPresentationPixmap (QSize size) const override |
RangeMapper * | getNewPropertyRangeMapper (const PropertyName &) const override |
virtual void | setDefaultColourFor (LayerGeometryProvider *v) |
ModelId | getSourceModel () const |
Return the ID of the source model for the model represented in this layer. More... | |
virtual ModelId | getExportModel (LayerGeometryProvider *) const |
Return the ID of a model representing the contents of this layer in a form suitable for export to a tabular file format such as CSV. More... | |
virtual const ZoomConstraint * | getZoomConstraint () const |
Return a zoom constraint object defining the supported zoom levels for this layer. More... | |
virtual bool | supportsOtherZoomLevels () const |
Return true if this layer can handle zoom levels other than those supported by its zoom constraint (presumably less efficiently or accurately than the officially supported zoom levels). More... | |
virtual void | setSynchronousPainting (bool) |
Enable or disable synchronous painting. More... | |
virtual VerticalPosition | getPreferredTimeRulerPosition () const |
virtual VerticalPosition | getPreferredFrameCountPosition () const |
QString | getPropertyContainerIconName () const override |
QString | getPropertyContainerName () const override |
virtual void | setPresentationName (QString name) |
virtual bool | isPresentationNameSet () const |
virtual QString | getLayerPresentationName () const |
virtual int | getHorizontalScaleHeight (LayerGeometryProvider *, QPainter &) const |
virtual bool | getCrosshairExtents (LayerGeometryProvider *, QPainter &, QPoint, std::vector< QRect > &) const |
virtual void | paintCrosshairs (LayerGeometryProvider *, QPainter &, QPoint) const |
virtual void | paintMeasurementRects (LayerGeometryProvider *, QPainter &, bool showFocus, QPoint focusPoint) const |
virtual bool | nearestMeasurementRectChanged (LayerGeometryProvider *, QPoint prev, QPoint now) const |
virtual 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 | isLayerOpaque () const |
This should return true if the layer completely obscures any underlying layers. 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 bool | getYScaleValue (const LayerGeometryProvider *, int, double &, QString &) const |
Return the value and unit at the given y coordinate in the given view. More... | |
virtual bool | getYScaleDifference (const LayerGeometryProvider *v, int y0, int y1, double &diff, QString &unit) const |
Return the difference between the values at the given y coordinates in the given view, and the unit of the difference. More... | |
virtual 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... | |
virtual bool | canExistWithoutModel () const |
Return true if this layer type can function without a model being set. More... | |
Protected Types | |
typedef std::map< double, int > | SpacingMap |
typedef std::map< int, int > | ColourRefCount |
typedef std::set< MeasureRect > | MeasureRectSet |
Protected Slots | |
void | recalcSpacing () |
Protected Attributes | |
ModelId | m_model |
bool | m_editing |
int | m_dragPointX |
int | m_dragPointY |
int | m_dragStartX |
int | m_dragStartY |
Event | m_originalPoint |
Event | m_editingPoint |
ChangeEventsCommand * | m_editingCommand |
VerticalScale | m_verticalScale |
int | m_colourMap |
bool | m_colourInverted |
PlotStyle | m_plotStyle |
SpacingMap | m_spacingMap |
SpacingMap | m_distributionMap |
int | m_colour |
bool | m_colourExplicitlySet |
bool | m_defaultColourSet |
MeasureRectSet | m_measureRects |
MeasureRect | m_draggingRect |
bool | m_haveDraggingRect |
bool | m_haveCurrentMeasureRect |
QPoint | m_currentMeasureRectPoint |
QString | m_presentationName |
Static Protected Attributes | |
static ColourRefCount | m_colourRefCount |
Detailed Description
Definition at line 33 of file RegionLayer.h.
Member Typedef Documentation
|
protected |
Definition at line 162 of file RegionLayer.h.
|
protectedinherited |
Definition at line 89 of file SingleColourLayer.h.
|
protectedinherited |
Member Enumeration Documentation
Enumerator | |
---|---|
AutoAlignScale | |
EqualSpaced | |
LinearScale | |
LogScale |
Definition at line 95 of file RegionLayer.h.
Enumerator | |
---|---|
PlotLines | |
PlotSegmentation |
Definition at line 105 of file RegionLayer.h.
|
inherited |
|
inherited |
|
inherited |
Constructor & Destructor Documentation
RegionLayer::RegionLayer | ( | ) |
Definition at line 47 of file RegionLayer.cpp.
Member Function Documentation
|
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).
!! point y coords if model does not haveDistinctValues() should !! be assigned to avoid overlaps
!! if it does have distinct values, we should still ensure y !! coord is never completely flat on the top or bottom
Implements Layer.
Definition at line 842 of file RegionLayer.cpp.
References PaintAssistant::drawVisibleText(), SingleColourLayer::getBaseQColor(), getColourForValue(), LayerGeometryProvider::getForeground(), SingleColourLayer::getForegroundQColor(), LayerGeometryProvider::getFrameForX(), LayerGeometryProvider::getPaintHeight(), LayerGeometryProvider::getPaintWidth(), getPointToDrag(), getScaleUnits(), LayerGeometryProvider::getTextLabelYCoord(), LayerGeometryProvider::getView(), LayerGeometryProvider::getXForFrame(), getYForValue(), m_model, m_plotStyle, PaintAssistant::OutlinedText, PlotSegmentation, LayerGeometryProvider::scalePixelSize(), and LayerGeometryProvider::shouldIlluminateLocalFeatures().
|
overridevirtual |
Implements Layer.
Definition at line 1050 of file RegionLayer.cpp.
References AutoAlignScale, EqualSpaced, LinearNumericalScale::getWidth(), LogColourScale::getWidth(), LinearColourScale::getWidth(), LogNumericalScale::getWidth(), LogScale, m_model, m_plotStyle, m_verticalScale, and PlotSegmentation.
Referenced by paintVerticalScale().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1073 of file RegionLayer.cpp.
References TextAbbrev::abbreviate(), getScaleExtents(), getScaleUnits(), getValueExtents(), getVerticalScaleWidth(), m_model, m_plotStyle, LogColourScale::paintVertical(), LogNumericalScale::paintVertical(), LinearNumericalScale::paintVertical(), LinearColourScale::paintVertical(), and PlotSegmentation.
|
overridevirtual |
!! harmonise with whatever decision is made about point y !! coords in paint method
Reimplemented from Layer.
Definition at line 395 of file RegionLayer.cpp.
References getLocalPoints(), getScaleUnits(), LayerGeometryProvider::getXForFrame(), getYForValue(), and m_model.
|
overridevirtual |
|
overridevirtual |
Adjust the given frame to snap to the nearest feature, if possible.
If snap is SnapLeft or SnapRight, adjust the frame to match that of the nearest feature in the given direction regardless of how far away it is. If snap is SnapNeighbouring, adjust the frame to that of the nearest feature in either direction if it is close, and leave it alone (returning false) otherwise. SnapNeighbouring should always choose the same feature that would be used in an editing operation through calls to editStart etc.
If ycoord is non-negative, it contains the y coordinate at which the interaction that prompts this snap is taking place (e.g. of the mouse press used for a selection action). Layers that have objects at multiple different heights may choose to use this information. If the current action has no particular y coordinate associated with it, ycoord will be passed as -1.
Return true if a suitable feature was found and frame adjusted accordingly. Return false if no suitable feature was available (and leave frame unmodified). If returning true, also return the resolution of the model in this layer in sample frames.
Reimplemented from Layer.
Definition at line 467 of file RegionLayer.cpp.
References getLocalPoints(), LayerGeometryProvider::getXForFrame(), m_model, Layer::SnapLeft, Layer::SnapNeighbouring, and Layer::snapToFeatureFrame().
|
overridevirtual |
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 from Layer.
Definition at line 542 of file RegionLayer.cpp.
References m_model, Layer::SnapLeft, and Layer::snapToSimilarFeature().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1117 of file RegionLayer.cpp.
References finish(), LayerGeometryProvider::getFrameForX(), getValueForY(), m_editing, m_editingCommand, m_editingPoint, m_model, m_originalPoint, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1141 of file RegionLayer.cpp.
References EqualSpaced, LayerGeometryProvider::getFrameForX(), getValueForY(), m_editing, m_editingCommand, m_editingPoint, m_model, m_verticalScale, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1173 of file RegionLayer.cpp.
References finish(), m_editing, m_editingCommand, m_model, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1185 of file RegionLayer.cpp.
References finish(), getPointToDrag(), m_editing, m_editingCommand, m_editingPoint, m_model, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1202 of file RegionLayer.cpp.
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1207 of file RegionLayer.cpp.
References finish(), getPointToDrag(), m_editing, m_editingCommand, m_editingPoint, m_model, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1231 of file RegionLayer.cpp.
References finish(), getPointToDrag(), LayerGeometryProvider::getXForFrame(), getYForValue(), m_dragPointX, m_dragPointY, m_dragStartX, m_dragStartY, m_editing, m_editingCommand, m_editingPoint, m_model, m_originalPoint, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1257 of file RegionLayer.cpp.
References LayerGeometryProvider::getFrameForX(), getValueForY(), m_distributionMap, m_dragPointX, m_dragPointY, m_dragStartX, m_dragStartY, m_editing, m_editingCommand, m_editingPoint, m_model, m_spacingMap, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1294 of file RegionLayer.cpp.
References finish(), m_editing, m_editingCommand, m_editingPoint, m_model, m_originalPoint, and recalcSpacing().
|
overridevirtual |
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 from Layer.
Definition at line 1323 of file RegionLayer.cpp.
References finish(), ItemEditDialog::getFrameDuration(), ItemEditDialog::getFrameTime(), getPointToDrag(), getScaleUnits(), ItemEditDialog::getText(), ItemEditDialog::getValue(), m_model, recalcSpacing(), ItemEditDialog::setFrameDuration(), ItemEditDialog::setFrameTime(), ItemEditDialog::setText(), ItemEditDialog::setValue(), ItemEditDialog::ShowDuration, ItemEditDialog::ShowText, ItemEditDialog::ShowTime, and ItemEditDialog::ShowValue.
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1365 of file RegionLayer.cpp.
References finish(), m_model, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1390 of file RegionLayer.cpp.
References finish(), m_model, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1422 of file RegionLayer.cpp.
References finish(), m_model, and recalcSpacing().
|
overridevirtual |
Reimplemented from Layer.
Definition at line 1446 of file RegionLayer.cpp.
References Layer::alignToReference(), and m_model.
|
overridevirtual |
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 from Layer.
Definition at line 1460 of file RegionLayer.cpp.
References Layer::alignFromReference(), Layer::clipboardHasDifferentAlignment(), finish(), LayerGeometryProvider::getView(), m_model, and recalcSpacing().
|
inlineoverridevirtual |
Return the ID of the model represented in this layer.
Implements Layer.
Definition at line 79 of file RegionLayer.h.
References getProperties(), getPropertyGroupName(), getPropertyLabel(), getPropertyRangeAndValue(), getPropertyType(), getPropertyValueLabel(), m_model, setFillColourMap(), setModel(), and setProperty().
void RegionLayer::setModel | ( | ModelId | model | ) |
Definition at line 74 of file RegionLayer.cpp.
References Layer::connectSignals(), m_model, Layer::modelChanged(), Layer::modelReplaced(), PlotSegmentation, recalcSpacing(), and setPlotStyle().
Referenced by getModel().
|
override |
Definition at line 107 of file RegionLayer.cpp.
References SingleColourLayer::getProperties().
Referenced by getModel().
|
override |
Definition at line 117 of file RegionLayer.cpp.
References SingleColourLayer::getPropertyLabel().
Referenced by getModel().
|
override |
Definition at line 126 of file RegionLayer.cpp.
References SingleColourLayer::getPropertyType(), m_plotStyle, and PlotSegmentation.
Referenced by getModel().
|
override |
Definition at line 136 of file RegionLayer.cpp.
References SingleColourLayer::getPropertyGroupName().
Referenced by getModel().
|
override |
Definition at line 145 of file RegionLayer.cpp.
References EqualSpaced, ColourMapper::getColourMapCount(), SingleColourLayer::getPropertyRangeAndValue(), m_colourMap, m_model, m_plotStyle, m_verticalScale, and PlotSegmentation.
Referenced by getModel().
|
override |
Definition at line 192 of file RegionLayer.cpp.
References ColourMapper::getColourMapLabel(), SingleColourLayer::getPropertyValueLabel(), m_plotStyle, and PlotSegmentation.
Referenced by getModel().
|
override |
Definition at line 218 of file RegionLayer.cpp.
References m_model, m_plotStyle, Layer::modelChanged(), PlotSegmentation, setFillColourMap(), setPlotStyle(), SingleColourLayer::setProperty(), and setVerticalScale().
Referenced by getModel().
void RegionLayer::setFillColourMap | ( | int | map | ) |
Definition at line 239 of file RegionLayer.cpp.
References Layer::layerParametersChanged(), and m_colourMap.
Referenced by getModel(), setProperties(), and setProperty().
|
inline |
Definition at line 93 of file RegionLayer.h.
References m_colourMap.
void RegionLayer::setVerticalScale | ( | VerticalScale | scale | ) |
Definition at line 260 of file RegionLayer.cpp.
References Layer::layerParametersChanged(), and m_verticalScale.
Referenced by setProperties(), and setProperty().
|
inline |
Definition at line 103 of file RegionLayer.h.
References m_verticalScale.
void RegionLayer::setPlotStyle | ( | PlotStyle | style | ) |
Definition at line 247 of file RegionLayer.cpp.
References Layer::layerParameterRangesChanged(), Layer::layerParametersChanged(), m_plotStyle, and PlotSegmentation.
Referenced by setModel(), setProperties(), and setProperty().
|
inline |
Definition at line 111 of file RegionLayer.h.
References isLayerScrollable(), and m_plotStyle.
|
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 268 of file RegionLayer.cpp.
References LayerGeometryProvider::shouldIlluminateLocalFeatures().
Referenced by getPlotStyle().
|
inlineoverridevirtual |
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 from Layer.
Definition at line 115 of file RegionLayer.h.
References getColourForValue(), getCompletion(), getDefaultColourHint(), getDisplayExtents(), getLocalPoints(), getPointToDrag(), getScaleExtents(), getScaleUnits(), getValueExtents(), getValueForY(), getYForValue(), recalcSpacing(), setProperties(), and toXml().
|
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 66 of file RegionLayer.cpp.
References m_model.
Referenced by isLayerEditable().
|
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 301 of file RegionLayer.cpp.
References getScaleUnits(), LogScale, m_model, and m_verticalScale.
Referenced by isLayerEditable(), and paintVerticalScale().
|
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 316 of file RegionLayer.cpp.
References AutoAlignScale, EqualSpaced, m_model, and m_verticalScale.
Referenced by isLayerEditable().
|
override |
Definition at line 1541 of file RegionLayer.cpp.
References ColourMapper::getBackwardCompatibilityColourMap(), ColourMapper::getColourMapId(), m_colourMap, m_plotStyle, m_verticalScale, and SingleColourLayer::toXml().
Referenced by isLayerEditable().
|
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.
Implements Layer.
Definition at line 1566 of file RegionLayer.cpp.
References ColourMapper::getColourMapById(), ColourMapper::getColourMapCount(), setFillColourMap(), setPlotStyle(), SingleColourLayer::setProperties(), and setVerticalScale().
Referenced by isLayerEditable().
|
overridevirtual |
VerticalScaleLayer and ColourScaleLayer methods.
!! what now, if i->first != v?
Implements VerticalScaleLayer.
Definition at line 674 of file RegionLayer.cpp.
References EqualSpaced, LayerGeometryProvider::getPaintHeight(), getScaleExtents(), m_spacingMap, m_verticalScale, and spacingIndexToY().
Referenced by editStart(), getFeatureDescription(), getPointToDrag(), isLayerEditable(), and paint().
|
overridevirtual |
Implements VerticalScaleLayer.
Definition at line 709 of file RegionLayer.cpp.
Referenced by drawDrag(), drawStart(), editDrag(), and isLayerEditable().
|
overridevirtual |
Implements ColourScaleLayer.
Definition at line 589 of file RegionLayer.cpp.
References m_model.
Referenced by editOpen(), getFeatureDescription(), getScaleExtents(), getValueExtents(), isLayerEditable(), paint(), and paintVerticalScale().
|
overridevirtual |
Implements ColourScaleLayer.
Definition at line 812 of file RegionLayer.cpp.
References getScaleExtents(), m_colourInverted, m_colourMap, and ColourMapper::map().
Referenced by isLayerEditable(), and paint().
|
protectedslot |
Definition at line 275 of file RegionLayer.cpp.
References m_distributionMap, m_model, and m_spacingMap.
Referenced by deleteSelection(), drawDrag(), drawEnd(), drawStart(), editDrag(), editEnd(), editOpen(), editStart(), eraseEnd(), eraseStart(), isLayerEditable(), moveSelection(), paste(), resizeSelection(), and setModel().
|
protected |
Definition at line 715 of file RegionLayer.cpp.
References EqualSpaced, LayerGeometryProvider::getPaintHeight(), getScaleExtents(), m_spacingMap, m_verticalScale, spacingIndexToY(), and yToSpacingIndex().
|
protected |
Definition at line 597 of file RegionLayer.cpp.
References AutoAlignScale, EqualSpaced, getScaleUnits(), LayerGeometryProvider::getVisibleExtentsForUnit(), LogScale, m_model, m_spacingMap, and m_verticalScale.
Referenced by getColourForValue(), getValueForY(), getYForValue(), isLayerEditable(), and paintVerticalScale().
|
overrideprotectedvirtual |
Reimplemented from SingleColourLayer.
Definition at line 834 of file RegionLayer.cpp.
References ColourDatabase::getColourIndex(), and ColourDatabase::getInstance().
Referenced by isLayerEditable().
|
protected |
Definition at line 330 of file RegionLayer.cpp.
References LayerGeometryProvider::getFrameForX(), m_model, and ViewManager::scalePixelSize().
Referenced by getFeatureDescription(), isLayerEditable(), and snapToFeatureFrame().
|
protected |
Definition at line 354 of file RegionLayer.cpp.
References LayerGeometryProvider::getFrameForX(), getYForValue(), and m_model.
Referenced by editOpen(), editStart(), eraseEnd(), eraseStart(), isLayerEditable(), and paint().
|
protected |
Definition at line 652 of file RegionLayer.cpp.
References LayerGeometryProvider::getPaintHeight(), and m_spacingMap.
Referenced by getValueForY(), and getYForValue().
|
protected |
Definition at line 663 of file RegionLayer.cpp.
References LayerGeometryProvider::getPaintHeight(), and m_spacingMap.
Referenced by getValueForY().
|
inlineprotected |
Definition at line 173 of file RegionLayer.h.
References CommandHistory::addCommand(), and CommandHistory::getInstance().
Referenced by deleteSelection(), drawEnd(), drawStart(), editEnd(), editOpen(), editStart(), eraseEnd(), eraseStart(), moveSelection(), paste(), and resizeSelection().
|
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().
|
virtualinherited |
Retrieve the current primary drawing colour, as a ColourDatabase index value.
Definition at line 235 of file SingleColourLayer.cpp.
References SingleColourLayer::m_colour.
|
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().
|
inlineoverridevirtualinherited |
Implements Layer::getLayerColourSignificance()
Implements Layer.
Reimplemented in TimeValueLayer, TimeInstantLayer, TimeRulerLayer, SliceLayer, and WaveformLayer.
Definition at line 52 of file SingleColourLayer.h.
References Layer::ColourDistinguishes, SingleColourLayer::getBackgroundQColor(), SingleColourLayer::getBaseQColor(), SingleColourLayer::getForegroundQColor(), SingleColourLayer::getLayerPresentationPixmap(), SingleColourLayer::getNewPropertyRangeMapper(), SingleColourLayer::getPartialShades(), SingleColourLayer::getProperties(), SingleColourLayer::getPropertyGroupName(), SingleColourLayer::getPropertyLabel(), SingleColourLayer::getPropertyRangeAndValue(), SingleColourLayer::getPropertyType(), SingleColourLayer::getPropertyValueLabel(), SingleColourLayer::setDefaultColourFor(), SingleColourLayer::setProperties(), SingleColourLayer::setProperty(), SingleColourLayer::SingleColourLayer(), SingleColourLayer::toXml(), and SingleColourLayer::~SingleColourLayer().
|
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().
|
overrideinherited |
Definition at line 126 of file SingleColourLayer.cpp.
Referenced by SingleColourLayer::getLayerColourSignificance(), and SliceLayer::getNewPropertyRangeMapper().
|
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().
|
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(), paint(), NoteLayer::paint(), and WaveformLayer::paintChannel().
|
protectedvirtualinherited |
Definition at line 247 of file SingleColourLayer.cpp.
References LayerGeometryProvider::getBackground().
Referenced by SingleColourLayer::getLayerColourSignificance(), SingleColourLayer::getPartialShades(), and WaveformLayer::paint().
|
protectedvirtualinherited |
Definition at line 253 of file SingleColourLayer.cpp.
References LayerGeometryProvider::getForeground().
Referenced by SingleColourLayer::getLayerColourSignificance(), TimeInstantLayer::paint(), TimeValueLayer::paint(), WaveformLayer::paint(), and paint().
|
protectedinherited |
Definition at line 259 of file SingleColourLayer.cpp.
References SingleColourLayer::getBackgroundQColor(), and SingleColourLayer::getBaseQColor().
Referenced by SingleColourLayer::getLayerColourSignificance(), TimeRulerLayer::paint(), and TimeValueLayer::paint().
|
inlineprotectedvirtualinherited |
Reimplemented in WaveformLayer.
Definition at line 85 of file SingleColourLayer.h.
Referenced by SingleColourLayer::setBaseColour(), and SingleColourLayer::setProperties().
|
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().
|
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().
|
inlinevirtualinherited |
Return a zoom constraint object defining the supported zoom levels for this layer.
If this returns zero, the layer will support any integer zoom level.
Reimplemented in SpectrogramLayer, Colour3DPlotLayer, and WaveformLayer.
|
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().
|
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.
|
inlinevirtualinherited |
Definition at line 143 of file Layer.h.
References Layer::PositionMiddle.
|
inlinevirtualinherited |
Reimplemented in SpectrogramLayer, and SpectrumLayer.
Definition at line 146 of file Layer.h.
References Layer::PositionBottom.
|
overrideinherited |
Definition at line 80 of file Layer.cpp.
References LayerFactory::getInstance(), and LayerFactory::getLayerIconName().
Referenced by LayerTreeModel::data(), and Layer::hasLightBackground().
|
inlineoverrideinherited |
Definition at line 155 of file Layer.h.
References Layer::getLayerPresentationName(), Layer::isPresentationNameSet(), Layer::m_presentationName, and Layer::setPresentationName().
|
virtualinherited |
Definition at line 87 of file Layer.cpp.
References Layer::m_presentationName.
Referenced by Layer::getPropertyContainerName().
|
virtualinherited |
Definition at line 93 of file Layer.cpp.
References Layer::m_presentationName.
Referenced by Layer::getPropertyContainerName().
|
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().
|
inlinevirtualinherited |
Reimplemented in SpectrumLayer.
Definition at line 173 of file Layer.h.
Referenced by SliceLayer::paint(), and SliceLayer::paintVerticalScale().
|
inlinevirtualinherited |
Reimplemented in SpectrogramLayer, and SpectrumLayer.
|
inlinevirtualinherited |
Reimplemented in SpectrogramLayer, and SpectrumLayer.
Definition at line 179 of file Layer.h.
References Layer::nearestMeasurementRectChanged(), and Layer::paintMeasurementRects().
|
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().
|
virtualinherited |
Definition at line 496 of file Layer.cpp.
References Layer::findFocusedMeasureRect(), and Layer::updateMeasurePixrects().
Referenced by Pane::mouseMoveEvent(), and Layer::paintCrosshairs().
|
inlinevirtualinherited |
Reimplemented in FlexiNoteLayer.
Definition at line 276 of file Layer.h.
Referenced by Pane::mousePressEvent().
|
inlinevirtualinherited |
Reimplemented in FlexiNoteLayer.
Definition at line 277 of file Layer.h.
Referenced by Pane::mouseReleaseEvent().
|
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().
|
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().
|
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().
|
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().
|
virtualinherited |
Reimplemented in SpectrogramLayer.
Definition at line 444 of file Layer.cpp.
Referenced by Layer::addNote(), and Pane::mouseDoubleClickEvent().
|
inlinevirtualinherited |
Definition at line 289 of file Layer.h.
References Layer::deleteCurrentMeasureRect(), and Layer::m_haveCurrentMeasureRect.
|
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().
|
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().
|
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().
|
virtualinherited |
Definition at line 122 of file Layer.cpp.
References Layer::layerNameChanged().
Referenced by LayerFactory::createLayer(), and Layer::getError().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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.
|
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().
|
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().
|
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().
|
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().
|
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().
|
inlinevirtualinherited |
Return the value and unit at the given y coordinate in the given view.
Reimplemented in SpectrogramLayer, WaveformLayer, Colour3DPlotLayer, and SpectrumLayer.
Definition at line 550 of file Layer.h.
References Layer::getYScaleDifference().
Referenced by View::drawMeasurementRect(), and Layer::getYScaleDifference().
|
virtualinherited |
Return the difference between the values at the given y coordinates in the given view, and the unit of the difference.
The default implementation just calls getYScaleValue twice and returns the difference, with the same unit.
Reimplemented in WaveformLayer, and SpectrumLayer.
Definition at line 173 of file Layer.cpp.
References Layer::getYScaleValue().
Referenced by View::drawMeasurementRect(), SpectrumLayer::getYScaleDifference(), and Layer::getYScaleValue().
|
inlinevirtualinherited |
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, NoteLayer, and SliceLayer.
Definition at line 578 of file Layer.h.
Referenced by Pane::updateHeadsUpDisplay(), Pane::updateVerticalPanner(), and Pane::verticalThumbwheelMoved().
|
inlinevirtualinherited |
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, NoteLayer, and SliceLayer.
Definition at line 586 of file Layer.h.
Referenced by Pane::updateHeadsUpDisplay(), and Pane::verticalZoomChanged().
|
inlinevirtualinherited |
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, NoteLayer, and SliceLayer.
Definition at line 594 of file Layer.h.
Referenced by Pane::verticalThumbwheelMoved().
|
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().
|
inlinevirtualinherited |
Return true if this layer type can function without a model being set.
If false (the default), the layer will not be loaded from a session if its model cannot be found.
Reimplemented in WaveformLayer, and TimeRulerLayer.
Definition at line 609 of file Layer.h.
References Layer::alignFromReference(), Layer::alignToReference(), Layer::clipboardHasDifferentAlignment(), Layer::connectSignals(), Layer::layerMeasurementRectsChanged(), Layer::layerNameChanged(), Layer::layerParameterRangesChanged(), Layer::layerParametersChanged(), Layer::modelAlignmentCompletionChanged(), Layer::modelChanged(), Layer::modelChangedWithin(), Layer::modelCompletionChanged(), Layer::modelReplaced(), Layer::showLayer(), and Layer::verticalZoomChanged().
|
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().
|
signalinherited |
Referenced by Layer::canExistWithoutModel(), Layer::connectSignals(), ImageLayer::fileSourceReady(), Colour3DPlotLayer::handleModelChanged(), setModel(), Colour3DPlotLayer::setModel(), SpectrogramLayer::setModel(), BoxLayer::setProperty(), TimeValueLayer::setProperty(), setProperty(), NoteLayer::setProperty(), and FlexiNoteLayer::setProperty().
|
signalinherited |
Referenced by Layer::canExistWithoutModel(), and Layer::connectSignals().
|
signalinherited |
Referenced by Layer::canExistWithoutModel(), and Layer::connectSignals().
|
signalinherited |
|
signalinherited |
Referenced by Layer::canExistWithoutModel(), TimeRulerLayer::setModel(), WaveformLayer::setModel(), TextLayer::setModel(), ImageLayer::setModel(), TimeInstantLayer::setModel(), BoxLayer::setModel(), TimeValueLayer::setModel(), Colour3DPlotLayer::setModel(), setModel(), NoteLayer::setModel(), FlexiNoteLayer::setModel(), SpectrogramLayer::setModel(), and SliceLayer::setSliceableModel().
|
signalinherited |
Referenced by Layer::canExistWithoutModel(), SpectrogramLayer::preferenceChanged(), WaveformLayer::setAggressiveCacheing(), WaveformLayer::setAutoNormalize(), SingleColourLayer::setBaseColour(), SpectrogramLayer::setBinDisplay(), SliceLayer::setBinScale(), Colour3DPlotLayer::setBinScale(), SpectrogramLayer::setBinScale(), SpectrumLayer::setChannel(), SpectrogramLayer::setChannel(), WaveformLayer::setChannel(), WaveformLayer::setChannelMode(), Colour3DPlotLayer::setColourMap(), SpectrogramLayer::setColourMap(), SpectrogramLayer::setColourRotation(), Colour3DPlotLayer::setColourScale(), SpectrogramLayer::setColourScale(), SpectrogramLayer::setColourScaleMultiple(), SliceLayer::setDisplayExtents(), NoteLayer::setDisplayExtents(), FlexiNoteLayer::setDisplayExtents(), TimeValueLayer::setDisplayExtents(), Colour3DPlotLayer::setDisplayExtents(), SpectrogramLayer::setDisplayExtents(), TimeValueLayer::setDrawSegmentDivisions(), SliceLayer::setEnergyScale(), TimeValueLayer::setFillColourMap(), setFillColourMap(), SliceLayer::setFillColourMap(), WaveformLayer::setGain(), Colour3DPlotLayer::setGain(), SliceLayer::setGain(), SpectrogramLayer::setGain(), Colour3DPlotLayer::setInvertVertical(), SpectrogramLayer::setMaxFrequency(), WaveformLayer::setMiddleLineHeight(), SpectrogramLayer::setMinFrequency(), SpectrumLayer::setModel(), WaveformLayer::setModel(), Colour3DPlotLayer::setNormalization(), SpectrogramLayer::setNormalization(), SliceLayer::setNormalize(), Colour3DPlotLayer::setNormalizeVisibleArea(), SpectrogramLayer::setNormalizeVisibleArea(), Colour3DPlotLayer::setOpaque(), SpectrumLayer::setOversampling(), SpectrogramLayer::setOversampling(), TimeInstantLayer::setPlotStyle(), SliceLayer::setPlotStyle(), TimeValueLayer::setPlotStyle(), setPlotStyle(), SliceLayer::setSamplingMode(), WaveformLayer::setScale(), TimeValueLayer::setShowDerivative(), WaveformLayer::setShowMeans(), SpectrumLayer::setShowPeaks(), SliceLayer::setSliceableModel(), Colour3DPlotLayer::setSmooth(), SliceLayer::setThreshold(), SpectrogramLayer::setThreshold(), BoxLayer::setVerticalScale(), setVerticalScale(), NoteLayer::setVerticalScale(), TimeValueLayer::setVerticalScale(), FlexiNoteLayer::setVerticalScale(), Colour3DPlotLayer::setVerticalZoomStep(), SpectrumLayer::setWindowHopLevel(), SpectrogramLayer::setWindowHopLevel(), SpectrumLayer::setWindowSize(), SpectrogramLayer::setWindowSize(), SpectrumLayer::setWindowType(), SpectrogramLayer::setWindowType(), and Layer::showLayer().
|
signalinherited |
Referenced by Layer::canExistWithoutModel(), SliceLayer::setPlotStyle(), TimeValueLayer::setPlotStyle(), and setPlotStyle().
|
signalinherited |
Referenced by Layer::addMeasureRectToSet(), Layer::canExistWithoutModel(), and Layer::deleteMeasureRectFromSet().
|
signalinherited |
Referenced by Layer::canExistWithoutModel(), and Layer::setObjectName().
|
signalinherited |
|
protectedinherited |
Definition at line 49 of file Layer.cpp.
References Layer::modelAlignmentCompletionChanged(), Layer::modelChanged(), Layer::modelChangedWithin(), and Layer::modelCompletionChanged().
Referenced by Layer::canExistWithoutModel(), WaveformLayer::setModel(), TextLayer::setModel(), ImageLayer::setModel(), TimeInstantLayer::setModel(), BoxLayer::setModel(), TimeValueLayer::setModel(), Colour3DPlotLayer::setModel(), setModel(), NoteLayer::setModel(), FlexiNoteLayer::setModel(), SpectrogramLayer::setModel(), and SliceLayer::setSliceableModel().
|
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(), copy(), FlexiNoteLayer::copy(), and NoteLayer::copy().
|
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(), paste(), FlexiNoteLayer::paste(), and NoteLayer::paste().
|
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(), paste(), FlexiNoteLayer::paste(), and NoteLayer::paste().
|
inlineprotectedinherited |
Definition at line 682 of file Layer.h.
References Layer::layerMeasurementRectsChanged(), and Layer::m_measureRects.
Referenced by Layer::addMeasurementRect().
|
inlineprotectedinherited |
Definition at line 687 of file Layer.h.
References Layer::layerMeasurementRectsChanged(), and Layer::m_measureRects.
|
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().
|
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().
|
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().
|
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().
|
protectedinherited |
Definition at line 578 of file Layer.cpp.
References Layer::m_measureRects.
Referenced by Layer::deleteCurrentMeasureRect(), Layer::nearestMeasurementRectChanged(), and Layer::paintMeasurementRects().
|
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().
|
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
|
protected |
Definition at line 148 of file RegionLayer.h.
Referenced by copy(), deleteSelection(), drawDrag(), drawEnd(), drawStart(), editDrag(), editEnd(), editOpen(), editStart(), eraseEnd(), eraseStart(), getCompletion(), getDisplayExtents(), getFeatureDescription(), getLabelPreceding(), getLocalPoints(), getModel(), getPointToDrag(), getPropertyRangeAndValue(), getScaleExtents(), getScaleUnits(), getValueExtents(), getVerticalScaleWidth(), moveSelection(), paint(), paintVerticalScale(), paste(), recalcSpacing(), resizeSelection(), setModel(), setProperty(), snapToFeatureFrame(), and snapToSimilarFeature().
|
protected |
Definition at line 149 of file RegionLayer.h.
Referenced by drawDrag(), drawEnd(), drawStart(), editDrag(), editEnd(), editStart(), eraseEnd(), and eraseStart().
|
protected |
Definition at line 150 of file RegionLayer.h.
Referenced by editDrag(), and editStart().
|
protected |
Definition at line 151 of file RegionLayer.h.
Referenced by editDrag(), and editStart().
|
protected |
Definition at line 152 of file RegionLayer.h.
Referenced by editDrag(), and editStart().
|
protected |
Definition at line 153 of file RegionLayer.h.
Referenced by editDrag(), and editStart().
|
protected |
Definition at line 154 of file RegionLayer.h.
Referenced by drawStart(), editEnd(), and editStart().
|
protected |
Definition at line 155 of file RegionLayer.h.
Referenced by drawDrag(), drawStart(), editDrag(), editEnd(), editStart(), eraseEnd(), and eraseStart().
|
protected |
Definition at line 156 of file RegionLayer.h.
Referenced by drawDrag(), drawEnd(), drawStart(), editDrag(), editEnd(), editStart(), eraseEnd(), and eraseStart().
|
protected |
Definition at line 157 of file RegionLayer.h.
Referenced by drawDrag(), getDisplayExtents(), getPropertyRangeAndValue(), getScaleExtents(), getValueExtents(), getValueForY(), getVerticalScale(), getVerticalScaleWidth(), getYForValue(), setVerticalScale(), and toXml().
|
protected |
Definition at line 158 of file RegionLayer.h.
Referenced by getColourForValue(), getFillColourMap(), getPropertyRangeAndValue(), setFillColourMap(), and toXml().
|
protected |
Definition at line 159 of file RegionLayer.h.
Referenced by getColourForValue().
|
protected |
Definition at line 160 of file RegionLayer.h.
Referenced by getPlotStyle(), getPropertyRangeAndValue(), getPropertyType(), getPropertyValueLabel(), getVerticalScaleWidth(), paint(), paintVerticalScale(), setPlotStyle(), setProperty(), and toXml().
|
protected |
Definition at line 165 of file RegionLayer.h.
Referenced by editDrag(), getScaleExtents(), getValueForY(), getYForValue(), recalcSpacing(), spacingIndexToY(), and yToSpacingIndex().
|
protected |
Definition at line 168 of file RegionLayer.h.
Referenced by editDrag(), and recalcSpacing().
|
staticprotectedinherited |
Definition at line 90 of file SingleColourLayer.h.
Referenced by SingleColourLayer::refColor(), SingleColourLayer::setDefaultColourFor(), and SingleColourLayer::unrefColor().
|
protectedinherited |
Definition at line 92 of file SingleColourLayer.h.
Referenced by SingleColourLayer::getBaseColour(), SingleColourLayer::getBaseQColor(), SingleColourLayer::getLayerPresentationPixmap(), SingleColourLayer::getPropertyRangeAndValue(), SingleColourLayer::hasLightBackground(), WaveformLayer::paintChannel(), SingleColourLayer::refColor(), SingleColourLayer::setBaseColour(), SingleColourLayer::setDefaultColourFor(), SingleColourLayer::setProperties(), SingleColourLayer::toXml(), WaveformLayer::toXml(), and SingleColourLayer::unrefColor().
|
protectedinherited |
Definition at line 93 of file SingleColourLayer.h.
Referenced by SingleColourLayer::setBaseColour(), SingleColourLayer::setDefaultColourFor(), and SingleColourLayer::setProperties().
|
protectedinherited |
Definition at line 94 of file SingleColourLayer.h.
Referenced by SingleColourLayer::setDefaultColourFor().
|
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().
|
protectedinherited |
Definition at line 694 of file Layer.h.
Referenced by Layer::measureDrag(), Layer::measureEnd(), Layer::measureStart(), and Layer::paintMeasurementRects().
|
protectedinherited |
Definition at line 695 of file Layer.h.
Referenced by Layer::measureDrag(), Layer::measureEnd(), Layer::measureStart(), and Layer::paintMeasurementRects().
|
mutableprotectedinherited |
Definition at line 696 of file Layer.h.
Referenced by Layer::deleteCurrentMeasureRect(), Layer::haveCurrentMeasureRect(), and Layer::paintMeasurementRects().
|
mutableprotectedinherited |
Definition at line 697 of file Layer.h.
Referenced by Layer::deleteCurrentMeasureRect(), and Layer::paintMeasurementRects().
|
protectedinherited |
Definition at line 716 of file Layer.h.
Referenced by Layer::getLayerPresentationName(), Layer::getPropertyContainerName(), Layer::isPresentationNameSet(), Layer::setPresentationName(), Layer::toBriefXml(), and Layer::toXml().
The documentation for this class was generated from the following files:
Generated by 1.8.11