Colour3DPlotLayer Class Reference

#include <Colour3DPlotLayer.h>

Inherits SliceableLayer.

Inheritance diagram for Colour3DPlotLayer:

Inheritance graph
[legend]
Collaboration diagram for Colour3DPlotLayer:

Collaboration graph
[legend]
List of all members.

Detailed Description

This is a view that displays dense 3-D data (time, some sort of binned y-axis range, value) as a colour plot with value mapped to colour range.

Its source is a DenseThreeDimensionalModel.

This was the original implementation for the spectrogram view, but it was replaced with a more efficient implementation that derived the spectrogram itself from a DenseTimeValueModel instead of using a three-dimensional model. This class is retained in case it becomes useful, but it will probably need some cleaning up if it's ever actually used.

Definition at line 40 of file Colour3DPlotLayer.h.

Public Types

enum  ColourScale { LinearScale, LogScale, PlusMinusOneScale }
enum  VerticalPosition { PositionTop, PositionMiddle, PositionBottom }
enum  SnapType { SnapLeft, SnapRight, SnapNearest, SnapNeighbouring }
enum  ColourSignificance {
  ColourAbsent, ColourIrrelevant, ColourDistinguishes, ColourAndBackgroundSignificant,
  ColourHasMeaningfulValue
}
enum  PropertyType {
  ToggleProperty, RangeProperty, ValueProperty, ColourProperty,
  UnitsProperty, InvalidProperty
}
typedef QString PropertyName
typedef std::vector< PropertyNamePropertyList

Public Slots

void showLayer (View *, bool show)
virtual void setProperty (const PropertyName &, int value)
 Set a property.
virtual void setProperty (QString nameString, QString valueString)
 Set a property using a fuzzy match.
virtual void setPropertyWithCommand (const PropertyName &, int value)
 Set a property using a command, supporting undo and redo.
virtual void setPropertyWithCommand (QString nameString, QString valueString)
 As above, but using a command.

Signals

void sliceableModelReplaced (const Model *modelToBeReplaced, const Model *replacement)
void modelChanged ()
void modelChanged (size_t startFrame, size_t endFrame)
void modelCompletionChanged ()
void modelAlignmentCompletionChanged ()
void modelReplaced ()
void layerParametersChanged ()
void layerParameterRangesChanged ()
void layerMeasurementRectsChanged ()
void layerNameChanged ()
void verticalZoomChanged ()
void propertyChanged (PropertyContainer::PropertyName)

Public Member Functions

 Colour3DPlotLayer ()
 ~Colour3DPlotLayer ()
virtual const ZoomConstraintgetZoomConstraint () const
 Return a zoom constraint object defining the supported zoom levels for this layer.
virtual const ModelgetModel () const
virtual void paint (View *v, QPainter &paint, QRect rect) const
virtual int getVerticalScaleWidth (View *v, QPainter &) const
virtual void paintVerticalScale (View *v, QPainter &paint, QRect rect) const
virtual QString getFeatureDescription (View *v, QPoint &) const
virtual bool snapToFeatureFrame (View *v, int &frame, size_t &resolution, SnapType snap) const
 Adjust the given frame to snap to the nearest feature, if possible.
virtual bool isLayerScrollable (const View *v) const
 This should return true if the layer can safely be scrolled automatically by a given view (simply copying the existing data and then refreshing the exposed area) without altering its meaning.
virtual ColourSignificance getLayerColourSignificance () const
 This should return the degree of meaning associated with colour in this layer.
void setModel (const DenseThreeDimensionalModel *model)
virtual int getCompletion (View *) const
 Return the proportion of background work complete in drawing this view, as a percentage -- in most cases this will be the value returned by pointer from a call to the underlying model's isReady(int *) call.
virtual bool getValueExtents (float &, float &, bool &, QString &) const
 Return the minimum and maximum values for the y axis of the model in this layer, as well as whether the layer is configured to use a logarithmic y axis display.
virtual PropertyList getProperties () const
 Get a list of the names of all the supported properties on this container.
virtual PropertyType getPropertyType (const PropertyName &) const
virtual QString getPropertyLabel (const PropertyName &) const
virtual QString getPropertyIconName (const PropertyName &) const
virtual QString getPropertyGroupName (const PropertyName &) const
virtual int getPropertyRangeAndValue (const PropertyName &, int *min, int *max, int *deflt) const
virtual QString getPropertyValueLabel (const PropertyName &, int value) const
virtual void setProperty (const PropertyName &, int value)
virtual void setProperties (const QXmlAttributes &)
 Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes.
void setColourScale (ColourScale)
ColourScale getColourScale () const
void setColourMap (int map)
int getColourMap () const
void setNormalizeColumns (bool n)
bool getNormalizeColumns () const
void setNormalizeVisibleArea (bool n)
bool getNormalizeVisibleArea () const
void setInvertVertical (bool i)
bool getInvertVertical () const
virtual const ModelgetSliceableModel () const
virtual void toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
 Convert the layer's data (though not those of the model it refers to) into XML for file output.
virtual ModelgetModel ()
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).
virtual VerticalPosition getPreferredTimeRulerPosition () const
virtual VerticalPosition getPreferredFrameCountPosition () const
virtual bool hasLightBackground () const
virtual QString getPropertyContainerIconName () const
virtual QString getPropertyContainerName () const
virtual void setPresentationName (QString name)
virtual QString getLayerPresentationName () const
virtual QPixmap getLayerPresentationPixmap (QSize) const
virtual bool getCrosshairExtents (View *, QPainter &, QPoint, std::vector< QRect > &) const
virtual void paintCrosshairs (View *, QPainter &, QPoint) const
virtual void paintMeasurementRects (View *, QPainter &, bool showFocus, QPoint focusPoint) const
virtual bool nearestMeasurementRectChanged (View *, QPoint prev, QPoint now) const
virtual 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 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.
virtual void moveSelection (Selection, size_t)
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.
virtual bool isLayerOpaque () const
 This should return true if the layer completely obscures any underlying layers.
virtual bool isLayerEditable () const
 This should return true if the layer can be edited by the user.
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.
virtual void addMeasurementRect (const QXmlAttributes &)
 Add a measurement rectangle from the given XML attributes (presumably taken from a measurement element).
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).
virtual bool isLayerDormant (const View *v) const
 Return whether the layer is dormant (i.e.
virtual PlayParametersgetPlayParameters ()
virtual bool needsTextLabelHeight () const
virtual bool hasTimeXAxis () const
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.
virtual bool setDisplayExtents (float, float)
 Set the displayed minimum and maximum values for the y axis to the given range, if supported.
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.
virtual bool getYScaleValue (const View *, int, float &, QString &) const
 Return the value and unit at the given y coordinate in the given view.
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.
virtual int getVerticalZoomSteps (int &) const
 Get the number of vertical zoom steps available for this layer.
virtual int getCurrentVerticalZoomStep () const
 Get the current vertical zoom step.
virtual void setVerticalZoomStep (int)
 Set the vertical zoom step.
virtual RangeMappergetNewVerticalZoomRangeMapper () const
 Create and return a range mapper for vertical zoom step values.
virtual QString getPropertyLabel (const PropertyName &) const =0
 Return the human-readable (and i18n'ised) name of a property.
virtual PropertyType getPropertyType (const PropertyName &) const
 Return the type of the given property, or InvalidProperty if the property is not supported on this container.
virtual QString getPropertyIconName (const PropertyName &) const
 Return an icon for the property, if any.
virtual QString getPropertyGroupName (const PropertyName &) const
 If this property has something in common with other properties on this container, return a name that can be used to group them (in order to save screen space, for example).
virtual int getPropertyRangeAndValue (const PropertyName &, int *min, int *max, int *deflt) const
 Return the minimum and maximum values for the given property and its current value in this container.
virtual QString getPropertyValueLabel (const PropertyName &, int value) const
 If the given property is a ValueProperty, return the display label to be used for the given value for that property.
virtual RangeMappergetNewPropertyRangeMapper (const PropertyName &) const
 If the given property is a RangeProperty, return a new RangeMapper object mapping its integer range onto an underlying floating point value range for human-intelligible display, if appropriate.
virtual QString toXmlString (QString indent="", QString extraAttributes="") const
 Convert this exportable object to XML in a string.

Static Public Member Functions

static QString encodeEntities (QString)
static QString encodeColour (QColor)
static int getObjectExportId (const void *)

Protected Types

typedef std::set< MeasureRect > MeasureRectSet

Protected Slots

void cacheInvalid ()
void cacheInvalid (size_t startFrame, size_t endFrame)

Protected Member Functions

void getColumn (size_t col, DenseThreeDimensionalModel::Column &) const
virtual int getColourScaleWidth (QPainter &) const
virtual void fillCache (size_t firstBin, size_t lastBin) const
virtual void paintDense (View *v, QPainter &paint, QRect rect) const
void connectSignals (const Model *)
virtual size_t alignToReference (View *v, size_t frame) const
virtual size_t alignFromReference (View *v, size_t 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
virtual bool convertPropertyStrings (QString nameString, QString valueString, PropertyName &name, int &value)

Protected Attributes

const DenseThreeDimensionalModelm_model
QImage * m_cache
size_t m_cacheStart
ColourScale m_colourScale
int m_colourMap
bool m_normalizeColumns
bool m_normalizeVisibleArea
bool m_invertVertical
MeasureRectSet m_measureRects
MeasureRect m_draggingRect
bool m_haveDraggingRect
bool m_haveCurrentMeasureRect
QPoint m_currentMeasureRectPoint
QString m_presentationName


Member Typedef Documentation

typedef std::set<MeasureRect> Layer::MeasureRectSet [protected, inherited]

Definition at line 529 of file Layer.h.

typedef QString PropertyContainer::PropertyName [inherited]

Definition at line 35 of file PropertyContainer.h.

typedef std::vector<PropertyName> PropertyContainer::PropertyList [inherited]

Definition at line 36 of file PropertyContainer.h.


Member Enumeration Documentation

enum Colour3DPlotLayer::ColourScale

Enumerator:
LinearScale 
LogScale 
PlusMinusOneScale 

Definition at line 87 of file Colour3DPlotLayer.h.

enum Layer::VerticalPosition [inherited]

Enumerator:
PositionTop 
PositionMiddle 
PositionBottom 

Definition at line 79 of file Layer.h.

enum Layer::SnapType [inherited]

Enumerator:
SnapLeft 
SnapRight 
SnapNearest 
SnapNeighbouring 

Definition at line 123 of file Layer.h.

enum Layer::ColourSignificance [inherited]

Enumerator:
ColourAbsent 
ColourIrrelevant 
ColourDistinguishes 
ColourAndBackgroundSignificant 
ColourHasMeaningfulValue 

Definition at line 242 of file Layer.h.

enum PropertyContainer::PropertyType [inherited]

Enumerator:
ToggleProperty 
RangeProperty 
ValueProperty 
ColourProperty 
UnitsProperty 
InvalidProperty 

Definition at line 38 of file PropertyContainer.h.


Constructor & Destructor Documentation

Colour3DPlotLayer::Colour3DPlotLayer (  ) 

Definition at line 35 of file Colour3DPlotLayer.cpp.

Colour3DPlotLayer::~Colour3DPlotLayer (  ) 

Definition at line 48 of file Colour3DPlotLayer.cpp.


Member Function Documentation

virtual const ZoomConstraint* Colour3DPlotLayer::getZoomConstraint (  )  const [inline, virtual]

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

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

Reimplemented from Layer.

Definition at line 48 of file Colour3DPlotLayer.h.

References Model::getZoomConstraint(), and m_model.

virtual const Model* Colour3DPlotLayer::getModel (  )  const [inline, virtual]

Implements Layer.

Definition at line 51 of file Colour3DPlotLayer.h.

References m_model.

void Colour3DPlotLayer::paint ( View v,
QPainter &  paint,
QRect  rect 
) const [virtual]

Implements Layer.

Definition at line 573 of file Colour3DPlotLayer.cpp.

References fillCache(), View::getBackground(), Model::getEndFrame(), View::getForeground(), View::getFrameForX(), DenseThreeDimensionalModel::getHeight(), ViewManager::getMainModelSampleRate(), DenseThreeDimensionalModel::getResolution(), Model::getSampleRate(), Model::getStartFrame(), DenseThreeDimensionalModel::getValueAt(), View::getViewManager(), View::getXForFrame(), View::getZoomLevel(), Model::isOK(), Model::isReady(), m_cache, m_cacheStart, m_model, m_normalizeColumns, m_normalizeVisibleArea, paintDense(), and View::shouldIlluminateLocalFeatures().

int Colour3DPlotLayer::getVerticalScaleWidth ( View v,
QPainter &   
) const [virtual]

Reimplemented from Layer.

Definition at line 346 of file Colour3DPlotLayer.cpp.

References DenseThreeDimensionalModel::getBinName(), getColourScaleWidth(), DenseThreeDimensionalModel::getHeight(), and m_model.

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

Reimplemented from Layer.

Definition at line 368 of file Colour3DPlotLayer.cpp.

References DenseThreeDimensionalModel::getBinName(), getColourScaleWidth(), View::getForeground(), DenseThreeDimensionalModel::getHeight(), m_cache, m_invertVertical, and m_model.

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

Reimplemented from Layer.

Definition at line 294 of file Colour3DPlotLayer.cpp.

References RealTime::frame2RealTime(), DenseThreeDimensionalModel::getBinName(), View::getFrameForX(), DenseThreeDimensionalModel::getHeight(), ViewManager::getMainModelSampleRate(), DenseThreeDimensionalModel::getResolution(), Model::getSampleRate(), Model::getStartFrame(), DenseThreeDimensionalModel::getValueAt(), View::getViewManager(), m_invertVertical, and m_model.

bool Colour3DPlotLayer::snapToFeatureFrame ( View v,
int &  frame,
size_t &  resolution,
SnapType  snap 
) const [virtual]

Adjust the given frame to snap to the nearest feature, if possible.

If snap is SnapLeft or SnapRight, adjust the frame to match that of the nearest feature in the given direction regardless of how far away it is. If snap is SnapNearest, adjust the frame to that of the nearest feature in either direction. If snap is SnapNeighbouring, adjust the frame to that of the nearest feature if it is close, and leave it alone (returning false) otherwise. SnapNeighbouring should always choose the same feature that would be used in an editing operation through calls to editStart etc.

Return true if a suitable feature was found and frame adjusted accordingly. Return false if no suitable feature was available (and leave frame unmodified). Also return the resolution of the model in this layer in sample frames.

Reimplemented from Layer.

Definition at line 808 of file Colour3DPlotLayer.cpp.

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

bool Colour3DPlotLayer::isLayerScrollable ( const View v  )  const [virtual]

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

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

Reimplemented from Layer.

Definition at line 286 of file Colour3DPlotLayer.cpp.

References m_normalizeVisibleArea, and View::shouldIlluminateLocalFeatures().

virtual ColourSignificance Colour3DPlotLayer::getLayerColourSignificance (  )  const [inline, 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.

Implements Layer.

Definition at line 65 of file Colour3DPlotLayer.h.

References Layer::ColourHasMeaningfulValue.

void Colour3DPlotLayer::setModel ( const DenseThreeDimensionalModel model  ) 

Definition at line 53 of file Colour3DPlotLayer.cpp.

References cacheInvalid(), Layer::connectSignals(), Model::isOK(), m_model, Layer::modelChanged(), Layer::modelReplaced(), and SliceableLayer::sliceableModelReplaced().

virtual int Colour3DPlotLayer::getCompletion ( View  )  const [inline, virtual]

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

References DenseThreeDimensionalModel::getCompletion(), and m_model.

virtual bool Colour3DPlotLayer::getValueExtents ( float &  ,
float &  ,
bool &  ,
QString &   
) const [inline, virtual]

Return the minimum and maximum values for the y axis of the model in this layer, as well as whether the layer is configured to use a logarithmic y axis display.

Also return the unit for these values if known.

This function returns the "normal" extents for the layer, not necessarily the extents actually in use in the display.

Implements Layer.

Definition at line 73 of file Colour3DPlotLayer.h.

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

Get a list of the names of all the supported properties on this container.

These should be fixed (i.e. not internationalized).

Reimplemented from PropertyContainer.

Definition at line 84 of file Colour3DPlotLayer.cpp.

Layer::PropertyType Colour3DPlotLayer::getPropertyType ( const PropertyName  )  const [virtual]

Definition at line 116 of file Colour3DPlotLayer.cpp.

References PropertyContainer::ToggleProperty, and PropertyContainer::ValueProperty.

QString Colour3DPlotLayer::getPropertyLabel ( const PropertyName  )  const [virtual]

Definition at line 96 of file Colour3DPlotLayer.cpp.

QString Colour3DPlotLayer::getPropertyIconName ( const PropertyName  )  const [virtual]

Definition at line 107 of file Colour3DPlotLayer.cpp.

QString Colour3DPlotLayer::getPropertyGroupName ( const PropertyName  )  const [virtual]

Definition at line 125 of file Colour3DPlotLayer.cpp.

int Colour3DPlotLayer::getPropertyRangeAndValue ( const PropertyName ,
int *  min,
int *  max,
int *  deflt 
) const [virtual]

Definition at line 135 of file Colour3DPlotLayer.cpp.

References ColourMapper::getColourMapCount(), PropertyContainer::getPropertyRangeAndValue(), LinearScale, m_colourMap, m_colourScale, m_invertVertical, m_normalizeColumns, and m_normalizeVisibleArea.

QString Colour3DPlotLayer::getPropertyValueLabel ( const PropertyName ,
int  value 
) const [virtual]

Definition at line 184 of file Colour3DPlotLayer.cpp.

References ColourMapper::getColourMapName().

void Colour3DPlotLayer::setProperty ( const PropertyName ,
int  value 
) [virtual]

Definition at line 202 of file Colour3DPlotLayer.cpp.

References LinearScale, LogScale, PlusMinusOneScale, setColourMap(), setColourScale(), setInvertVertical(), setNormalizeColumns(), and setNormalizeVisibleArea().

void Colour3DPlotLayer::setProperties ( const QXmlAttributes &   )  [virtual]

Set the particular properties of a layer (those specific to the subclass) from a set of XML attributes.

This is the effective inverse of the toXml method.

Implements Layer.

Definition at line 850 of file Colour3DPlotLayer.cpp.

References setColourMap(), setColourScale(), setNormalizeColumns(), and setNormalizeVisibleArea().

void Colour3DPlotLayer::setColourScale ( ColourScale   ) 

Definition at line 223 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperties(), and setProperty().

ColourScale Colour3DPlotLayer::getColourScale (  )  const [inline]

Definition at line 90 of file Colour3DPlotLayer.h.

References m_colourScale.

void Colour3DPlotLayer::setColourMap ( int  map  ) 

Definition at line 232 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperties(), and setProperty().

int Colour3DPlotLayer::getColourMap (  )  const

void Colour3DPlotLayer::setNormalizeColumns ( bool  n  ) 

Definition at line 241 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperties(), and setProperty().

bool Colour3DPlotLayer::getNormalizeColumns (  )  const

Definition at line 250 of file Colour3DPlotLayer.cpp.

References m_normalizeColumns.

void Colour3DPlotLayer::setNormalizeVisibleArea ( bool  n  ) 

Definition at line 256 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperties(), and setProperty().

bool Colour3DPlotLayer::getNormalizeVisibleArea (  )  const

Definition at line 265 of file Colour3DPlotLayer.cpp.

References m_normalizeVisibleArea.

void Colour3DPlotLayer::setInvertVertical ( bool  i  ) 

Definition at line 271 of file Colour3DPlotLayer.cpp.

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

Referenced by setProperty().

bool Colour3DPlotLayer::getInvertVertical (  )  const

Definition at line 280 of file Colour3DPlotLayer.cpp.

References m_invertVertical.

virtual const Model* Colour3DPlotLayer::getSliceableModel (  )  const [inline, virtual]

Implements SliceableLayer.

Definition at line 104 of file Colour3DPlotLayer.h.

References m_model.

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

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

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

Reimplemented from Layer.

Definition at line 834 of file Colour3DPlotLayer.cpp.

References m_colourMap, m_colourScale, m_normalizeColumns, m_normalizeVisibleArea, and Layer::toXml().

void Colour3DPlotLayer::cacheInvalid (  )  [protected, slot]

Definition at line 71 of file Colour3DPlotLayer.cpp.

References m_cache.

Referenced by cacheInvalid(), setColourMap(), setColourScale(), setInvertVertical(), setModel(), setNormalizeColumns(), and setNormalizeVisibleArea().

void Colour3DPlotLayer::cacheInvalid ( size_t  startFrame,
size_t  endFrame 
) [protected, slot]

Definition at line 78 of file Colour3DPlotLayer.cpp.

References cacheInvalid().

void Colour3DPlotLayer::getColumn ( size_t  col,
DenseThreeDimensionalModel::Column  
) const [protected]

Definition at line 419 of file Colour3DPlotLayer.cpp.

References DenseThreeDimensionalModel::getColumn(), DenseThreeDimensionalModel::getMaximumLevel(), DenseThreeDimensionalModel::getMinimumLevel(), m_model, and m_normalizeColumns.

Referenced by fillCache().

int Colour3DPlotLayer::getColourScaleWidth ( QPainter &   )  const [protected, virtual]

Definition at line 339 of file Colour3DPlotLayer.cpp.

Referenced by getVerticalScaleWidth(), and paintVerticalScale().

void Colour3DPlotLayer::fillCache ( size_t  firstBin,
size_t  lastBin 
) const [protected, virtual]

Definition at line 456 of file Colour3DPlotLayer.cpp.

References getColumn(), Model::getEndFrame(), DenseThreeDimensionalModel::getHeight(), DenseThreeDimensionalModel::getMaximumLevel(), DenseThreeDimensionalModel::getMinimumLevel(), DenseThreeDimensionalModel::getResolution(), Model::getStartFrame(), LogScale, m_cache, m_cacheStart, m_colourMap, m_colourScale, m_invertVertical, m_model, m_normalizeColumns, m_normalizeVisibleArea, LogRange::map(), ColourMapper::map(), LogRange::mapRange(), and PlusMinusOneScale.

Referenced by paint().

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

Definition at line 723 of file Colour3DPlotLayer.cpp.

References View::getFrameForX(), DenseThreeDimensionalModel::getHeight(), ViewManager::getMainModelSampleRate(), DenseThreeDimensionalModel::getResolution(), Model::getSampleRate(), Model::getStartFrame(), View::getViewManager(), m_cache, m_cacheStart, and m_model.

Referenced by paint().

void SliceableLayer::sliceableModelReplaced ( const Model modelToBeReplaced,
const Model replacement 
) [signal, inherited]

Referenced by SpectrogramLayer::invalidateFFTModels(), SpectrogramLayer::setLayerDormant(), and setModel().

virtual Model* Layer::getModel (  )  [inline, virtual, inherited]

Definition at line 56 of file Layer.h.

References Layer::getModel().

virtual bool Layer::supportsOtherZoomLevels (  )  const [inline, virtual, inherited]

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

virtual VerticalPosition Layer::getPreferredTimeRulerPosition (  )  const [inline, virtual, inherited]

Definition at line 82 of file Layer.h.

References Layer::PositionMiddle.

virtual VerticalPosition Layer::getPreferredFrameCountPosition (  )  const [inline, virtual, inherited]

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 85 of file Layer.h.

References Layer::PositionBottom.

virtual bool Layer::hasLightBackground (  )  const [inline, virtual, inherited]

Reimplemented in SingleColourLayer, and SpectrogramLayer.

Definition at line 88 of file Layer.h.

QString Layer::getPropertyContainerIconName (  )  const [virtual, inherited]

Implements PropertyContainer.

Definition at line 65 of file Layer.cpp.

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

virtual QString Layer::getPropertyContainerName (  )  const [inline, virtual, inherited]

Implements PropertyContainer.

Definition at line 94 of file Layer.h.

References Layer::m_presentationName.

void Layer::setPresentationName ( QString  name  )  [virtual, inherited]

Definition at line 72 of file Layer.cpp.

References Layer::m_presentationName.

Referenced by SVFileReader::readLayer(), and MainWindow::renameCurrentLayer().

QString Layer::getLayerPresentationName (  )  const [virtual, inherited]

Reimplemented in TimeRulerLayer.

Definition at line 78 of file Layer.cpp.

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

Referenced by MainWindow::setupExistingLayersMenus().

virtual QPixmap Layer::getLayerPresentationPixmap ( QSize   )  const [inline, virtual, inherited]

Reimplemented in SingleColourLayer.

Definition at line 102 of file Layer.h.

virtual bool Layer::getCrosshairExtents ( View ,
QPainter &  ,
QPoint  ,
std::vector< QRect > &   
) const [inline, virtual, inherited]

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 107 of file Layer.h.

virtual void Layer::paintCrosshairs ( View ,
QPainter &  ,
QPoint   
) const [inline, virtual, inherited]

Reimplemented in SpectrogramLayer, and SpectrumLayer.

Definition at line 111 of file Layer.h.

void Layer::paintMeasurementRects ( View ,
QPainter &  ,
bool  showFocus,
QPoint  focusPoint 
) const [virtual, inherited]

Definition at line 428 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 Pane::paintEvent().

bool Layer::nearestMeasurementRectChanged ( View ,
QPoint  prev,
QPoint  now 
) const [virtual, inherited]

Definition at line 460 of file Layer.cpp.

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

virtual void Layer::drawStart ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

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

Definition at line 162 of file Layer.h.

Referenced by Pane::mousePressEvent().

virtual void Layer::drawDrag ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

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

Definition at line 163 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

virtual void Layer::drawEnd ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

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

Definition at line 164 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

virtual void Layer::eraseStart ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

Reimplemented in NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.

Definition at line 166 of file Layer.h.

Referenced by Pane::mousePressEvent().

virtual void Layer::eraseDrag ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

Reimplemented in NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.

Definition at line 167 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

virtual void Layer::eraseEnd ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

Reimplemented in NoteLayer, TextLayer, TimeInstantLayer, and TimeValueLayer.

Definition at line 168 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

virtual void Layer::editStart ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

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

Definition at line 170 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

virtual void Layer::editDrag ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

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

Definition at line 171 of file Layer.h.

Referenced by Pane::mouseMoveEvent().

virtual void Layer::editEnd ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

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

Definition at line 172 of file Layer.h.

Referenced by Pane::mouseReleaseEvent().

void Layer::measureStart ( View ,
QMouseEvent *   
) [virtual, inherited]

Definition at line 374 of file Layer.cpp.

References Layer::m_draggingRect, Layer::m_haveDraggingRect, and Layer::setMeasureRectFromPixrect().

Referenced by Pane::mousePressEvent().

void Layer::measureDrag ( View ,
QMouseEvent *   
) [virtual, inherited]

Definition at line 382 of file Layer.cpp.

References Layer::m_draggingRect, Layer::m_haveDraggingRect, Layer::MeasureRect::pixrect, and Layer::setMeasureRectFromPixrect().

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

void Layer::measureEnd ( View ,
QMouseEvent *   
) [virtual, inherited]

Definition at line 394 of file Layer.cpp.

References CommandHistory::addCommand(), CommandHistory::getInstance(), Layer::m_draggingRect, Layer::m_haveDraggingRect, Layer::measureDrag(), and Layer::MeasureRect::pixrect.

Referenced by Pane::mouseReleaseEvent().

void Layer::measureDoubleClick ( View ,
QMouseEvent *   
) [virtual, inherited]

Reimplemented in SpectrogramLayer.

Definition at line 408 of file Layer.cpp.

Referenced by Pane::mouseDoubleClickEvent().

virtual bool Layer::haveCurrentMeasureRect (  )  const [inline, virtual, inherited]

Definition at line 183 of file Layer.h.

References Layer::m_haveCurrentMeasureRect.

void Layer::deleteCurrentMeasureRect (  )  [virtual, inherited]

Definition at line 414 of file Layer.cpp.

References CommandHistory::addCommand(), Layer::findFocusedMeasureRect(), CommandHistory::getInstance(), Layer::m_currentMeasureRectPoint, Layer::m_haveCurrentMeasureRect, and Layer::m_measureRects.

Referenced by MainWindowBase::deleteSelected().

virtual bool Layer::editOpen ( View ,
QMouseEvent *   
) [inline, virtual, inherited]

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

Definition at line 193 of file Layer.h.

Referenced by Pane::mouseDoubleClickEvent().

virtual void Layer::moveSelection ( Selection  ,
size_t   
) [inline, virtual, inherited]

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

Definition at line 195 of file Layer.h.

Referenced by Pane::editSelectionEnd().

virtual void Layer::resizeSelection ( Selection  ,
Selection   
) [inline, virtual, inherited]

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

Definition at line 196 of file Layer.h.

Referenced by Pane::editSelectionEnd().

virtual void Layer::deleteSelection ( Selection   )  [inline, virtual, inherited]

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

Definition at line 197 of file Layer.h.

Referenced by MainWindowBase::cut().

virtual void Layer::copy ( View ,
Selection  ,
Clipboard  
) [inline, virtual, inherited]

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

Definition at line 199 of file Layer.h.

Referenced by MainWindowBase::copy(), and MainWindowBase::cut().

virtual bool Layer::paste ( View ,
const Clipboard ,
int  ,
bool   
) [inline, virtual, inherited]

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

Definition at line 208 of file Layer.h.

Referenced by MainWindowBase::paste().

virtual bool Layer::isLayerOpaque (  )  const [inline, virtual, inherited]

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

virtual bool Layer::isLayerEditable (  )  const [inline, virtual, inherited]

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

Definition at line 276 of file Layer.h.

Referenced by Pane::mouseDoubleClickEvent(), Pane::mouseMoveEvent(), Pane::mousePressEvent(), Pane::mouseReleaseEvent(), MainWindowBase::paste(), Pane::updateContextHelp(), MainWindowBase::updateMenuStates(), and MainWindow::updateMenuStates().

void Layer::setObjectName ( const QString &  name  )  [virtual, inherited]

Definition at line 100 of file Layer.cpp.

References Layer::layerNameChanged().

Referenced by Document::createDerivedLayer(), Document::createImportedLayer(), LayerFactory::createLayer(), Document::createLayer(), and SVFileReader::readLayer().

void Layer::toBriefXml ( QTextStream &  stream,
QString  indent = "",
QString  extraAttributes = "" 
) const [virtual, inherited]

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 XmlExportable::encodeEntities(), LayerFactory::getInstance(), Layer::getModel(), XmlExportable::getObjectExportId(), and Layer::m_presentationName.

void Layer::addMeasurementRect ( const QXmlAttributes &   )  [virtual, inherited]

Add a measurement rectangle from the given XML attributes (presumably taken from a measurement element).

Does not use a command.

Definition at line 317 of file Layer.cpp.

References Layer::addMeasureRectToSet(), Layer::MeasureRect::endFrame, Layer::MeasureRect::endY, Layer::MeasureRect::haveFrames, Layer::MeasureRect::pixrect, Layer::MeasureRect::startFrame, and Layer::MeasureRect::startY.

Referenced by SVFileReader::readMeasurement().

void Layer::setLayerDormant ( const View v,
bool  dormant 
) [virtual, inherited]

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

Definition at line 118 of file Layer.cpp.

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

Referenced by Document::RemoveLayerCommand::execute(), Document::AddLayerCommand::execute(), SpectrogramLayer::paint(), SVFileReader::readLayer(), SpectrogramLayer::setLayerDormant(), Layer::showLayer(), Document::RemoveLayerCommand::unexecute(), and Document::AddLayerCommand::unexecute().

bool Layer::isLayerDormant ( const View v  )  const [virtual, inherited]

Return whether the layer is dormant (i.e.

hidden) in the given view.

Definition at line 126 of file Layer.cpp.

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

Referenced by SpectrogramLayer::paint(), PropertyStack::propertyContainerPropertyChanged(), PropertyStack::repopulate(), and SpectrogramLayer::setLayerDormant().

PlayParameters * Layer::getPlayParameters (  )  [virtual, inherited]

Reimplemented from PropertyContainer.

Definition at line 107 of file Layer.cpp.

References PlayParameterRepository::getInstance(), Layer::getModel(), and PlayParameterRepository::getPlayParameters().

Referenced by LayerTreeModel::setData().

virtual bool Layer::needsTextLabelHeight (  )  const [inline, virtual, inherited]

Reimplemented in TimeInstantLayer, and TimeValueLayer.

Definition at line 344 of file Layer.h.

virtual bool Layer::hasTimeXAxis (  )  const [inline, virtual, inherited]

Reimplemented in SliceLayer.

Definition at line 346 of file Layer.h.

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

virtual bool Layer::getDisplayExtents ( float &  ,
float &   
) const [inline, virtual, inherited]

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 NoteLayer, SpectrogramLayer, and TimeValueLayer.

Definition at line 368 of file Layer.h.

Referenced by Pane::drawVerticalScale(), and Pane::getTopLayerDisplayExtents().

virtual bool Layer::setDisplayExtents ( float  ,
float   
) [inline, virtual, inherited]

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.

Definition at line 380 of file Layer.h.

Referenced by MainWindow::handleOSCMessage(), Pane::setTopLayerDisplayExtents(), and Pane::zoomToRegion().

bool Layer::getXScaleValue ( const View v,
int  x,
float &  value,
QString &  unit 
) const [virtual, inherited]

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

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

Reimplemented in SpectrumLayer.

Definition at line 142 of file Layer.cpp.

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

Referenced by View::drawMeasurementRect().

virtual bool Layer::getYScaleValue ( const View ,
int  ,
float &  ,
QString &   
) const [inline, virtual, inherited]

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

Reimplemented in SpectrogramLayer, SpectrumLayer, and WaveformLayer.

Definition at line 398 of file Layer.h.

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

bool Layer::getYScaleDifference ( const View v,
int  y0,
int  y1,
float &  diff,
QString &  unit 
) const [virtual, inherited]

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 SpectrumLayer, and WaveformLayer.

Definition at line 155 of file Layer.cpp.

References Layer::getYScaleValue().

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

virtual int Layer::getVerticalZoomSteps ( int &   )  const [inline, virtual, inherited]

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

Definition at line 426 of file Layer.h.

Referenced by MainWindow::handleOSCMessage(), Pane::updateHeadsUpDisplay(), Pane::updateVerticalPanner(), and Pane::verticalThumbwheelMoved().

virtual int Layer::getCurrentVerticalZoomStep (  )  const [inline, virtual, inherited]

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

Definition at line 434 of file Layer.h.

Referenced by MainWindow::handleOSCMessage(), Pane::updateHeadsUpDisplay(), and Pane::verticalZoomChanged().

virtual void Layer::setVerticalZoomStep ( int   )  [inline, virtual, inherited]

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

Definition at line 442 of file Layer.h.

Referenced by MainWindow::handleOSCMessage(), and Pane::verticalThumbwheelMoved().

virtual RangeMapper* Layer::getNewVerticalZoomRangeMapper (  )  const [inline, virtual, inherited]

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.

Definition at line 450 of file Layer.h.

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

void Layer::showLayer ( View ,
bool  show 
) [slot, inherited]

Definition at line 135 of file Layer.cpp.

References Layer::layerParametersChanged(), and Layer::setLayerDormant().

Referenced by LayerTreeModel::setData(), and PropertyStack::showLayer().

void Layer::modelChanged (  )  [signal, inherited]

Referenced by Layer::connectSignals(), SpectrogramLayer::fillTimerTimedOut(), ImageLayer::remoteFileReady(), SpectrogramLayer::setModel(), setModel(), TimeValueLayer::setProperty(), and NoteLayer::setProperty().

void Layer::modelChanged ( size_t  startFrame,
size_t  endFrame 
) [signal, inherited]

void Layer::modelCompletionChanged (  )  [signal, inherited]

Referenced by Layer::connectSignals().

void Layer::modelAlignmentCompletionChanged (  )  [signal, inherited]

Referenced by Layer::connectSignals().

void Layer::modelReplaced (  )  [signal, inherited]

Referenced by WaveformLayer::setModel(), TimeValueLayer::setModel(), TimeRulerLayer::setModel(), TimeInstantLayer::setModel(), TextLayer::setModel(), SpectrogramLayer::setModel(), NoteLayer::setModel(), ImageLayer::setModel(), setModel(), and SliceLayer::setSliceableModel().

void Layer::layerParametersChanged (  )  [signal, inherited]

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

void Layer::layerParameterRangesChanged (  )  [signal, inherited]

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

void Layer::layerMeasurementRectsChanged (  )  [signal, inherited]

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

void Layer::layerNameChanged (  )  [signal, inherited]

Referenced by Layer::setObjectName().

void Layer::verticalZoomChanged (  )  [signal, inherited]

Referenced by SpectrogramLayer::setDisplayExtents(), WaveformLayer::setGain(), and SpectrogramLayer::setProperty().

void Layer::connectSignals ( const Model  )  [protected, inherited]

Definition at line 49 of file Layer.cpp.

References Layer::modelAlignmentCompletionChanged(), Layer::modelChanged(), and Layer::modelCompletionChanged().

Referenced by WaveformLayer::setModel(), TimeValueLayer::setModel(), TimeInstantLayer::setModel(), TextLayer::setModel(), SpectrogramLayer::setModel(), NoteLayer::setModel(), ImageLayer::setModel(), setModel(), and SliceLayer::setSliceableModel().

size_t Layer::alignToReference ( View v,
size_t  frame 
) const [protected, virtual, inherited]

Definition at line 169 of file Layer.cpp.

References View::alignToReference(), Model::alignToReference(), Model::getAlignmentReference(), and Layer::getModel().

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

size_t Layer::alignFromReference ( View v,
size_t  frame 
) const [protected, virtual, inherited]

Definition at line 181 of file Layer.cpp.

References View::alignFromReference(), Model::alignFromReference(), Model::getAlignmentReference(), and Layer::getModel().

Referenced by TimeValueLayer::paste(), TimeInstantLayer::paste(), TextLayer::paste(), NoteLayer::paste(), and ImageLayer::paste().

bool Layer::clipboardHasDifferentAlignment ( View v,
const Clipboard clip 
) const [protected, inherited]

Definition at line 193 of file Layer.cpp.

References Layer::alignToReference(), and Clipboard::getPoints().

Referenced by TimeValueLayer::paste(), TimeInstantLayer::paste(), TextLayer::paste(), NoteLayer::paste(), and ImageLayer::paste().

void Layer::addMeasureRectToSet ( const MeasureRect r  )  [inline, protected, inherited]

Definition at line 519 of file Layer.h.

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

Referenced by Layer::addMeasurementRect(), Layer::AddMeasurementRectCommand::execute(), and Layer::DeleteMeasurementRectCommand::unexecute().

void Layer::deleteMeasureRectFromSet ( const MeasureRect r  )  [inline, protected, inherited]

Definition at line 524 of file Layer.h.

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

Referenced by Layer::DeleteMeasurementRectCommand::execute(), and Layer::AddMeasurementRectCommand::unexecute().

void Layer::updateMeasurePixrects ( View v  )  const [protected, inherited]

Definition at line 471 of file Layer.cpp.

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

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

void Layer::updateMeasureRectYCoords ( View v,
const MeasureRect r 
) const [protected, virtual, inherited]

Definition at line 510 of file Layer.cpp.

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

Referenced by Layer::updateMeasurePixrects().

void Layer::setMeasureRectYCoord ( View v,
MeasureRect r,
bool  start,
int  y 
) const [protected, virtual, inherited]

Definition at line 518 of file Layer.cpp.

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

Referenced by Layer::setMeasureRectFromPixrect().

void Layer::setMeasureRectFromPixrect ( View v,
MeasureRect r,
QRect  pixrect 
) const [protected, virtual, inherited]

Definition at line 529 of file Layer.cpp.

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

Referenced by SpectrogramLayer::measureDoubleClick(), Layer::measureDrag(), and Layer::measureStart().

Layer::MeasureRectSet::const_iterator Layer::findFocusedMeasureRect ( QPoint   )  const [protected, inherited]

Definition at line 542 of file Layer.cpp.

References Layer::m_measureRects.

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

void Layer::paintMeasurementRect ( View v,
QPainter &  paint,
const MeasureRect r,
bool  focus 
) const [protected, inherited]

Definition at line 569 of file Layer.cpp.

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

Referenced by Layer::paintMeasurementRects().

virtual QString PropertyContainer::getPropertyLabel ( const PropertyName  )  const [pure virtual, inherited]

Return the human-readable (and i18n'ised) name of a property.

Referenced by PropertyContainer::convertPropertyStrings(), and PropertyBox::updatePropertyEditor().

PropertyContainer::PropertyType PropertyContainer::getPropertyType ( const PropertyName  )  const [virtual, inherited]

Return the type of the given property, or InvalidProperty if the property is not supported on this container.

Definition at line 33 of file PropertyContainer.cpp.

References PropertyContainer::InvalidProperty.

Referenced by PropertyBox::colourDatabaseChanged(), PropertyContainer::convertPropertyStrings(), ImageLayer::getPropertyType(), PropertyContainer::getPropertyValueLabel(), PropertyBox::propertyControllerChanged(), PropertyBox::unitDatabaseChanged(), and PropertyBox::updatePropertyEditor().

QString PropertyContainer::getPropertyIconName ( const PropertyName  )  const [virtual, inherited]

Return an icon for the property, if any.

Definition at line 39 of file PropertyContainer.cpp.

Referenced by PropertyBox::updatePropertyEditor().

QString PropertyContainer::getPropertyGroupName ( const PropertyName  )  const [virtual, inherited]

If this property has something in common with other properties on this container, return a name that can be used to group them (in order to save screen space, for example).

e.g. "Window Type" and "Window Size" might both have a group name of "Window". If this property is not groupable, return the empty string.

Definition at line 45 of file PropertyContainer.cpp.

Referenced by PropertyBox::updatePropertyEditor().

int PropertyContainer::getPropertyRangeAndValue ( const PropertyName ,
int *  min,
int *  max,
int *  deflt 
) const [virtual, inherited]

Return the minimum and maximum values for the given property and its current value in this container.

Min and/or max may be passed as NULL if their values are not required.

Definition at line 51 of file PropertyContainer.cpp.

Referenced by PropertyContainer::convertPropertyStrings(), PropertyContainer::SetPropertyCommand::execute(), SpectrogramLayer::getPropertyRangeAndValue(), SingleColourLayer::getPropertyRangeAndValue(), ImageLayer::getPropertyRangeAndValue(), getPropertyRangeAndValue(), PropertyContainer::setPropertyWithCommand(), and PropertyBox::updatePropertyEditor().

QString PropertyContainer::getPropertyValueLabel ( const PropertyName ,
int  value 
) const [virtual, inherited]

If the given property is a ValueProperty, return the display label to be used for the given value for that property.

Definition at line 61 of file PropertyContainer.cpp.

References PropertyContainer::ColourProperty, ColourDatabase::getColourCount(), ColourDatabase::getColourName(), ColourDatabase::getInstance(), and PropertyContainer::getPropertyType().

Referenced by PropertyContainer::convertPropertyStrings(), SingleColourLayer::getPropertyValueLabel(), ImageLayer::getPropertyValueLabel(), and PropertyBox::updatePropertyEditor().

RangeMapper * PropertyContainer::getNewPropertyRangeMapper ( const PropertyName  )  const [virtual, inherited]

If the given property is a RangeProperty, return a new RangeMapper object mapping its integer range onto an underlying floating point value range for human-intelligible display, if appropriate.

The RangeMapper should be allocated with new, and the caller takes responsibility for deleting it. Return NULL (as in the default implementation) if there is no such mapping.

Definition at line 74 of file PropertyContainer.cpp.

Referenced by PropertyContainer::convertPropertyStrings(), and PropertyBox::updatePropertyEditor().

void PropertyContainer::propertyChanged ( PropertyContainer::PropertyName   )  [signal, inherited]

Referenced by Preferences::setBackgroundMode(), Preferences::setOmitTempsFromRecentFiles(), Preferences::setPropertyBoxLayout(), Preferences::setResampleOnLoad(), Preferences::setResampleQuality(), Preferences::setShowSplash(), Preferences::setSpectrogramSmoothing(), Preferences::setTemporaryDirectoryRoot(), Preferences::setTuningFrequency(), Preferences::setViewFontSize(), Preferences::setWindowType(), SpectrogramLayer::SpectrogramLayer(), SpectrumLayer::SpectrumLayer(), and ViewPropertyContainer::ViewPropertyContainer().

void PropertyContainer::setProperty ( const PropertyName ,
int  value 
) [virtual, slot, inherited]

Set a property.

This is used for all property types. For boolean properties, zero is false and non-zero true; for colours, the integer value is an index into the colours in the global ColourDatabase.

Definition at line 80 of file PropertyContainer.cpp.

References PropertyContainer::getPropertyContainerName().

Referenced by PropertyContainer::SetPropertyCommand::execute(), PropertyContainer::setProperty(), ImageLayer::setProperty(), and PropertyContainer::SetPropertyCommand::unexecute().

void PropertyContainer::setProperty ( QString  nameString,
QString  valueString 
) [virtual, slot, inherited]

Set a property using a fuzzy match.

Compare nameString with the property labels and underlying names, and if it matches one (with preference given to labels), try to convert valueString appropriately and set it. The valueString should contain a value label for value properties, a mapped value for range properties, "on" or "off" for toggle properties, a colour or unit name, or the underlying integer value for the property.

Note that as property and value labels may be translatable, the results of this function may vary by locale. It is intended for handling user-originated strings, _not_ persistent storage.

The default implementation should work for most subclasses.

Definition at line 96 of file PropertyContainer.cpp.

References PropertyContainer::convertPropertyStrings(), and PropertyContainer::setProperty().

void PropertyContainer::setPropertyWithCommand ( const PropertyName ,
int  value 
) [virtual, slot, inherited]

Set a property using a command, supporting undo and redo.

The default implementation should work for most subclasses.

Definition at line 86 of file PropertyContainer.cpp.

References CommandHistory::addCommand(), CommandHistory::getInstance(), and PropertyContainer::getPropertyRangeAndValue().

Referenced by MainWindow::handleOSCMessage(), PropertyBox::propertyControllerChanged(), and PropertyContainer::setPropertyWithCommand().

void PropertyContainer::setPropertyWithCommand ( QString  nameString,
QString  valueString 
) [virtual, slot, inherited]

As above, but using a command.

Definition at line 111 of file PropertyContainer.cpp.

References PropertyContainer::convertPropertyStrings(), and PropertyContainer::setPropertyWithCommand().

bool PropertyContainer::convertPropertyStrings ( QString  nameString,
QString  valueString,
PropertyName name,
int &  value 
) [protected, virtual, inherited]

Definition at line 126 of file PropertyContainer.cpp.

References PropertyContainer::ColourProperty, ColourDatabase::getColourIndex(), UnitDatabase::getInstance(), ColourDatabase::getInstance(), PropertyContainer::getNewPropertyRangeMapper(), RangeMapper::getPositionForValue(), PropertyContainer::getProperties(), PropertyContainer::getPropertyLabel(), PropertyContainer::getPropertyRangeAndValue(), PropertyContainer::getPropertyType(), PropertyContainer::getPropertyValueLabel(), UnitDatabase::getUnitId(), PropertyContainer::InvalidProperty, PropertyContainer::RangeProperty, PropertyContainer::ToggleProperty, PropertyContainer::UnitsProperty, and PropertyContainer::ValueProperty.

Referenced by PropertyContainer::setProperty(), and PropertyContainer::setPropertyWithCommand().

QString XmlExportable::toXmlString ( QString  indent = "",
QString  extraAttributes = "" 
) const [virtual, inherited]

Convert this exportable object to XML in a string.

The default implementation calls toXml and returns the result as a string. Do not override this unless you really know what you're doing.

Definition at line 25 of file XmlExportable.cpp.

References XmlExportable::toXml().

Referenced by LayerFactory::setLayerDefaultProperties().

QString XmlExportable::encodeEntities ( QString   )  [static, inherited]

Definition at line 41 of file XmlExportable.cpp.

Referenced by AudioGenerator::getDefaultPlayPluginConfiguration(), SVFileReader::readPlugin(), Layer::toBriefXml(), WaveFileModel::toXml(), Transform::toXml(), TextPoint::toXml(), PluginXml::toXml(), Model::toXml(), Layer::toXml(), ImagePoint::toXml(), and Document::writeBackwardCompatibleDerivation().

QString XmlExportable::encodeColour ( QColor   )  [static, inherited]

Definition at line 54 of file XmlExportable.cpp.

Referenced by ColourDatabase::getStringValues().

int XmlExportable::getObjectExportId ( const void *   )  [static, inherited]

Definition at line 71 of file XmlExportable.cpp.

Referenced by FFTDataServer::generateFileBasename(), View::getTextLabelHeight(), Layer::toBriefXml(), SparseModel< PointType >::toXml(), Model::toXml(), Layer::toXml(), EditableDenseThreeDimensionalModel::toXml(), Document::toXml(), and Document::writeBackwardCompatibleDerivation().


Member Data Documentation

const DenseThreeDimensionalModel* Colour3DPlotLayer::m_model [protected]

Definition at line 114 of file Colour3DPlotLayer.h.

Referenced by fillCache(), getColumn(), getCompletion(), getFeatureDescription(), getModel(), getSliceableModel(), getVerticalScaleWidth(), getZoomConstraint(), paint(), paintDense(), paintVerticalScale(), setModel(), and snapToFeatureFrame().

QImage* Colour3DPlotLayer::m_cache [mutable, protected]

Definition at line 116 of file Colour3DPlotLayer.h.

Referenced by cacheInvalid(), fillCache(), paint(), paintDense(), and paintVerticalScale().

size_t Colour3DPlotLayer::m_cacheStart [mutable, protected]

Definition at line 117 of file Colour3DPlotLayer.h.

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

ColourScale Colour3DPlotLayer::m_colourScale [protected]

Definition at line 119 of file Colour3DPlotLayer.h.

Referenced by fillCache(), getColourScale(), getPropertyRangeAndValue(), setColourScale(), and toXml().

int Colour3DPlotLayer::m_colourMap [protected]

Definition at line 120 of file Colour3DPlotLayer.h.

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

bool Colour3DPlotLayer::m_normalizeColumns [protected]

Definition at line 121 of file Colour3DPlotLayer.h.

Referenced by fillCache(), getColumn(), getNormalizeColumns(), getPropertyRangeAndValue(), paint(), setNormalizeColumns(), and toXml().

bool Colour3DPlotLayer::m_normalizeVisibleArea [protected]

Definition at line 122 of file Colour3DPlotLayer.h.

Referenced by fillCache(), getNormalizeVisibleArea(), getPropertyRangeAndValue(), isLayerScrollable(), paint(), setNormalizeVisibleArea(), and toXml().

bool Colour3DPlotLayer::m_invertVertical [protected]

Definition at line 123 of file Colour3DPlotLayer.h.

Referenced by fillCache(), getFeatureDescription(), getInvertVertical(), getPropertyRangeAndValue(), paintVerticalScale(), and setInvertVertical().

MeasureRectSet Layer::m_measureRects [protected, inherited]

Definition at line 530 of file Layer.h.

Referenced by Layer::addMeasureRectToSet(), Layer::deleteCurrentMeasureRect(), Layer::deleteMeasureRectFromSet(), Layer::findFocusedMeasureRect(), Layer::paintMeasurementRects(), Layer::toXml(), and Layer::updateMeasurePixrects().

MeasureRect Layer::m_draggingRect [protected, inherited]

Definition at line 531 of file Layer.h.

Referenced by Layer::measureDrag(), Layer::measureEnd(), Layer::measureStart(), and Layer::paintMeasurementRects().

bool Layer::m_haveDraggingRect [protected, inherited]

Definition at line 532 of file Layer.h.

Referenced by Layer::measureDrag(), Layer::measureEnd(), Layer::measureStart(), and Layer::paintMeasurementRects().

bool Layer::m_haveCurrentMeasureRect [mutable, protected, inherited]

Definition at line 533 of file Layer.h.

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

QPoint Layer::m_currentMeasureRectPoint [mutable, protected, inherited]

Definition at line 534 of file Layer.h.

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

QString Layer::m_presentationName [protected, inherited]

Definition at line 551 of file Layer.h.

Referenced by Layer::getLayerPresentationName(), Layer::getPropertyContainerName(), Layer::setPresentationName(), Layer::toBriefXml(), and Layer::toXml().


The documentation for this class was generated from the following files:
Generated on Wed Feb 20 15:45:32 2008 for SonicVisualiser by  doxygen 1.5.1