annotate layer/Layer.h @ 518:fe134ec37a2a

* fix unsigned overflow causing spectrogram to "disappear" in some resolution and scroll combinations
author Chris Cannam
date Fri, 06 Mar 2009 10:23:30 +0000
parents 1c6439ef99d6
children a72ab757b73b
rev   line source
Chris@127 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@127 2
Chris@127 3 /*
Chris@127 4 Sonic Visualiser
Chris@127 5 An audio file viewer and annotation editor.
Chris@127 6 Centre for Digital Music, Queen Mary, University of London.
Chris@182 7 This file copyright 2006 Chris Cannam and QMUL.
Chris@127 8
Chris@127 9 This program is free software; you can redistribute it and/or
Chris@127 10 modify it under the terms of the GNU General Public License as
Chris@127 11 published by the Free Software Foundation; either version 2 of the
Chris@127 12 License, or (at your option) any later version. See the file
Chris@127 13 COPYING included with this distribution for more information.
Chris@127 14 */
Chris@127 15
Chris@127 16 #ifndef _LAYER_H_
Chris@127 17 #define _LAYER_H_
Chris@127 18
Chris@128 19 #include "base/PropertyContainer.h"
Chris@128 20 #include "base/XmlExportable.h"
Chris@128 21 #include "base/Selection.h"
Chris@127 22
Chris@376 23 #include "widgets/CommandHistory.h"
Chris@376 24
Chris@127 25 #include <QObject>
Chris@127 26 #include <QRect>
Chris@127 27 #include <QXmlAttributes>
Chris@131 28 #include <QMutex>
Chris@299 29 #include <QPixmap>
Chris@127 30
Chris@127 31 #include <map>
Chris@268 32 #include <set>
Chris@127 33
Chris@127 34 class ZoomConstraint;
Chris@127 35 class Model;
Chris@127 36 class QPainter;
Chris@127 37 class View;
Chris@127 38 class QMouseEvent;
Chris@127 39 class Clipboard;
Chris@187 40 class RangeMapper;
Chris@127 41
Chris@127 42 /**
Chris@127 43 * The base class for visual representations of the data found in a
Chris@127 44 * Model. Layers are expected to be able to draw themselves onto a
Chris@127 45 * View, and may also be editable.
Chris@127 46 */
Chris@127 47
Chris@127 48 class Layer : public PropertyContainer,
Chris@127 49 public XmlExportable
Chris@127 50 {
Chris@127 51 Q_OBJECT
Chris@127 52
Chris@127 53 public:
Chris@127 54 Layer();
Chris@127 55 virtual ~Layer();
Chris@127 56
Chris@127 57 virtual const Model *getModel() const = 0;
Chris@502 58 Model *getModel() {
Chris@127 59 return const_cast<Model *>(const_cast<const Layer *>(this)->getModel());
Chris@127 60 }
Chris@127 61
Chris@137 62 /**
Chris@137 63 * Return a zoom constraint object defining the supported zoom
Chris@137 64 * levels for this layer. If this returns zero, the layer will
Chris@137 65 * support any integer zoom level.
Chris@137 66 */
Chris@127 67 virtual const ZoomConstraint *getZoomConstraint() const { return 0; }
Chris@137 68
Chris@137 69 /**
Chris@137 70 * Return true if this layer can handle zoom levels other than
Chris@137 71 * those supported by its zoom constraint (presumably less
Chris@137 72 * efficiently or accurately than the officially supported zoom
Chris@137 73 * levels). If true, the layer will unenthusistically accept any
Chris@137 74 * integer zoom level from 1 to the maximum returned by its zoom
Chris@137 75 * constraint.
Chris@137 76 */
Chris@137 77 virtual bool supportsOtherZoomLevels() const { return true; }
Chris@137 78
Chris@389 79 /**
Chris@389 80 * Paint the given rectangle of this layer onto the given view
Chris@389 81 * using the given painter, superimposing it on top of any
Chris@389 82 * existing material in that view. The view is provided here
Chris@389 83 * because it is possible for one layer to exist in more than one
Chris@389 84 * view, so the dimensions of the view may vary from one paint
Chris@389 85 * call to another (without any view having been resized).
Chris@389 86 */
Chris@127 87 virtual void paint(View *, QPainter &, QRect) const = 0;
Chris@127 88
Chris@389 89 /**
Chris@389 90 * Enable or disable synchronous painting. If synchronous
Chris@389 91 * painting is enabled, a call to paint() must complete painting
Chris@389 92 * the entire rectangle before it returns. If synchronous
Chris@389 93 * painting is disabled (which should be the default), the paint()
Chris@389 94 * call may defer painting some regions if data is not yet
Chris@389 95 * available, by calling back on its view to schedule another
Chris@389 96 * update. Synchronous painting is necessary when rendering to an
Chris@389 97 * image. Simple layer types will always paint synchronously, and
Chris@389 98 * so may ignore this.
Chris@389 99 */
Chris@389 100 virtual void setSynchronousPainting(bool /* synchronous */) { }
Chris@389 101
Chris@127 102 enum VerticalPosition {
Chris@127 103 PositionTop, PositionMiddle, PositionBottom
Chris@127 104 };
Chris@127 105 virtual VerticalPosition getPreferredTimeRulerPosition() const {
Chris@127 106 return PositionMiddle;
Chris@127 107 }
Chris@127 108 virtual VerticalPosition getPreferredFrameCountPosition() const {
Chris@127 109 return PositionBottom;
Chris@127 110 }
Chris@224 111 virtual bool hasLightBackground() const {
Chris@224 112 return true;
Chris@224 113 }
Chris@127 114
Chris@127 115 virtual QString getPropertyContainerIconName() const;
Chris@127 116
Chris@127 117 virtual QString getPropertyContainerName() const {
Chris@363 118 if (m_presentationName != "") return m_presentationName;
Chris@363 119 else return objectName();
Chris@127 120 }
Chris@127 121
Chris@363 122 virtual void setPresentationName(QString name);
Chris@363 123
Chris@127 124 virtual QString getLayerPresentationName() const;
Chris@299 125 virtual QPixmap getLayerPresentationPixmap(QSize) const { return QPixmap(); }
Chris@127 126
Chris@127 127 virtual int getVerticalScaleWidth(View *, QPainter &) const { return 0; }
Chris@127 128 virtual void paintVerticalScale(View *, QPainter &, QRect) const { }
Chris@127 129
Chris@127 130 virtual bool getCrosshairExtents(View *, QPainter &, QPoint /* cursorPos */,
Chris@127 131 std::vector<QRect> &) const {
Chris@127 132 return false;
Chris@127 133 }
Chris@127 134 virtual void paintCrosshairs(View *, QPainter &, QPoint) const { }
Chris@127 135
Chris@272 136 virtual void paintMeasurementRects(View *, QPainter &,
Chris@272 137 bool showFocus, QPoint focusPoint) const;
Chris@272 138
Chris@272 139 virtual bool nearestMeasurementRectChanged(View *, QPoint prev,
Chris@272 140 QPoint now) const;
Chris@267 141
Chris@127 142 virtual QString getFeatureDescription(View *, QPoint &) const {
Chris@127 143 return "";
Chris@127 144 }
Chris@127 145
Chris@127 146 enum SnapType {
Chris@127 147 SnapLeft,
Chris@127 148 SnapRight,
Chris@127 149 SnapNearest,
Chris@127 150 SnapNeighbouring
Chris@127 151 };
Chris@127 152
Chris@127 153 /**
Chris@127 154 * Adjust the given frame to snap to the nearest feature, if
Chris@127 155 * possible.
Chris@127 156 *
Chris@127 157 * If snap is SnapLeft or SnapRight, adjust the frame to match
Chris@127 158 * that of the nearest feature in the given direction regardless
Chris@127 159 * of how far away it is. If snap is SnapNearest, adjust the
Chris@127 160 * frame to that of the nearest feature in either direction. If
Chris@127 161 * snap is SnapNeighbouring, adjust the frame to that of the
Chris@127 162 * nearest feature if it is close, and leave it alone (returning
Chris@127 163 * false) otherwise. SnapNeighbouring should always choose the
Chris@127 164 * same feature that would be used in an editing operation through
Chris@127 165 * calls to editStart etc.
Chris@127 166 *
Chris@127 167 * Return true if a suitable feature was found and frame adjusted
Chris@180 168 * accordingly. Return false if no suitable feature was available
Chris@517 169 * (and leave frame unmodified). If returning true, also return
Chris@517 170 * the resolution of the model in this layer in sample frames.
Chris@127 171 */
Chris@127 172 virtual bool snapToFeatureFrame(View * /* v */,
Chris@127 173 int & /* frame */,
Chris@127 174 size_t &resolution,
Chris@127 175 SnapType /* snap */) const {
Chris@127 176 resolution = 1;
Chris@127 177 return false;
Chris@127 178 }
Chris@127 179
Chris@517 180 /**
Chris@517 181 * Adjust the given frame to snap to the next feature that has
Chris@517 182 * "effectively" the same value as the feature prior to the given
Chris@517 183 * frame, if possible.
Chris@517 184 *
Chris@517 185 * The snap type must be SnapLeft (snap to the time of the next
Chris@517 186 * feature prior to the one preceding the given frame that has a
Chris@517 187 * similar value to it) or SnapRight (snap to the time of the next
Chris@517 188 * feature following the given frame that has a similar value to
Chris@517 189 * the feature preceding it). Other values are not permitted.
Chris@517 190 *
Chris@517 191 * Return true if a suitable feature was found and frame adjusted
Chris@517 192 * accordingly. Return false if no suitable feature was available
Chris@517 193 * (and leave frame unmodified). If returning true, also return
Chris@517 194 * the resolution of the model in this layer in sample frames.
Chris@517 195 */
Chris@517 196 virtual bool snapToSimilarFeature(View * /* v */,
Chris@517 197 int & /* source frame */,
Chris@517 198 size_t &resolution,
Chris@517 199 SnapType /* snap */) const {
Chris@517 200 resolution = 1;
Chris@517 201 return false;
Chris@517 202 }
Chris@517 203
Chris@335 204 // Draw, erase, and edit modes:
Chris@127 205 //
Chris@127 206 // Layer needs to get actual mouse events, I guess. Draw mode is
Chris@127 207 // probably the easier.
Chris@127 208
Chris@127 209 virtual void drawStart(View *, QMouseEvent *) { }
Chris@127 210 virtual void drawDrag(View *, QMouseEvent *) { }
Chris@127 211 virtual void drawEnd(View *, QMouseEvent *) { }
Chris@127 212
Chris@335 213 virtual void eraseStart(View *, QMouseEvent *) { }
Chris@335 214 virtual void eraseDrag(View *, QMouseEvent *) { }
Chris@335 215 virtual void eraseEnd(View *, QMouseEvent *) { }
Chris@335 216
Chris@127 217 virtual void editStart(View *, QMouseEvent *) { }
Chris@127 218 virtual void editDrag(View *, QMouseEvent *) { }
Chris@127 219 virtual void editEnd(View *, QMouseEvent *) { }
Chris@127 220
Chris@267 221 // Measurement rectangle (or equivalent). Unlike draw and edit,
Chris@267 222 // the base Layer class can provide working implementations of
Chris@267 223 // these for most situations.
Chris@267 224 //
Chris@267 225 virtual void measureStart(View *, QMouseEvent *);
Chris@267 226 virtual void measureDrag(View *, QMouseEvent *);
Chris@267 227 virtual void measureEnd(View *, QMouseEvent *);
Chris@280 228 virtual void measureDoubleClick(View *, QMouseEvent *);
Chris@267 229
Chris@283 230 virtual bool haveCurrentMeasureRect() const {
Chris@283 231 return m_haveCurrentMeasureRect;
Chris@283 232 }
Chris@283 233 virtual void deleteCurrentMeasureRect(); // using a command
Chris@283 234
Chris@255 235 /**
Chris@255 236 * Open an editor on the item under the mouse (e.g. on
Chris@255 237 * double-click). If there is no item or editing is not
Chris@255 238 * supported, return false.
Chris@255 239 */
Chris@255 240 virtual bool editOpen(View *, QMouseEvent *) { return false; }
Chris@127 241
Chris@127 242 virtual void moveSelection(Selection, size_t /* newStartFrame */) { }
Chris@127 243 virtual void resizeSelection(Selection, Selection /* newSize */) { }
Chris@127 244 virtual void deleteSelection(Selection) { }
Chris@127 245
Chris@359 246 virtual void copy(View *, Selection, Clipboard & /* to */) { }
Chris@127 247
Chris@127 248 /**
Chris@127 249 * Paste from the given clipboard onto the layer at the given
Chris@127 250 * frame offset. If interactive is true, the layer may ask the
Chris@127 251 * user about paste options through a dialog if desired, and may
Chris@127 252 * return false if the user cancelled the paste operation. This
Chris@127 253 * function should return true if a paste actually occurred.
Chris@127 254 */
Chris@359 255 virtual bool paste(View *,
Chris@359 256 const Clipboard & /* from */,
Chris@127 257 int /* frameOffset */,
Chris@127 258 bool /* interactive */) { return false; }
Chris@127 259
Chris@127 260 // Text mode:
Chris@127 261 //
Chris@127 262 // Label nearest feature. We need to get the feature coordinates
Chris@127 263 // and current label from the layer, and then the pane can pop up
Chris@127 264 // a little text entry dialog at the right location. Or we edit
Chris@127 265 // in place? Probably the dialog is easier.
Chris@127 266
Chris@127 267 /**
Chris@127 268 * This should return true if the layer can safely be scrolled
Chris@127 269 * automatically by a given view (simply copying the existing data
Chris@127 270 * and then refreshing the exposed area) without altering its
Chris@127 271 * meaning. For the view widget as a whole this is usually not
Chris@127 272 * possible because of invariant (non-scrolling) material
Chris@127 273 * displayed over the top, but the widget may be able to optimise
Chris@127 274 * scrolling better if it is known that individual views can be
Chris@127 275 * scrolled safely in this way.
Chris@127 276 */
Chris@127 277 virtual bool isLayerScrollable(const View *) const { return true; }
Chris@127 278
Chris@127 279 /**
Chris@127 280 * This should return true if the layer completely obscures any
Chris@127 281 * underlying layers. It's used to determine whether the view can
Chris@127 282 * safely draw any selection rectangles under the layer instead of
Chris@127 283 * over it, in the case where the layer is not scrollable and
Chris@127 284 * therefore needs to be redrawn each time (so that the selection
Chris@127 285 * rectangle can be cached).
Chris@127 286 */
Chris@127 287 virtual bool isLayerOpaque() const { return false; }
Chris@127 288
Chris@287 289 enum ColourSignificance {
Chris@287 290 ColourAbsent,
Chris@287 291 ColourIrrelevant,
Chris@287 292 ColourDistinguishes,
Chris@287 293 ColourAndBackgroundSignificant,
Chris@287 294 ColourHasMeaningfulValue
Chris@287 295 };
Chris@287 296
Chris@127 297 /**
Chris@287 298 * This should return the degree of meaning associated with colour
Chris@287 299 * in this layer.
Chris@287 300 *
Chris@287 301 * If ColourAbsent, the layer does not use colour. If
Chris@287 302 * ColourIrrelevant, the layer is coloured and the colour may be
Chris@287 303 * set by the user, but it doesn't really matter what the colour
Chris@287 304 * is (for example, in a time ruler layer). If
Chris@287 305 * ColourDistinguishes, then the colour is used to distinguish
Chris@287 306 * this layer from other similar layers (e.g. for data layers).
Chris@287 307 * If ColourAndBackgroundSignificant, then the layer should be
Chris@287 308 * given greater weight than ColourDistinguishes layers when
Chris@287 309 * choosing a background colour (e.g. for waveforms). If
Chris@287 310 * ColourHasMeaningfulValue, colours are actually meaningful --
Chris@287 311 * the view will then show selections using unfilled rectangles
Chris@287 312 * instead of translucent filled rectangles, so as not to disturb
Chris@287 313 * the colours underneath.
Chris@183 314 */
Chris@287 315 virtual ColourSignificance getLayerColourSignificance() const = 0;
Chris@183 316
Chris@183 317 /**
Chris@127 318 * This should return true if the layer can be edited by the user.
Chris@127 319 * If this is the case, the appropriate edit tools may be made
Chris@127 320 * available by the application and the layer's drawStart/Drag/End
Chris@127 321 * and editStart/Drag/End methods should be implemented.
Chris@127 322 */
Chris@127 323 virtual bool isLayerEditable() const { return false; }
Chris@127 324
Chris@127 325 /**
Chris@127 326 * Return the proportion of background work complete in drawing
Chris@127 327 * this view, as a percentage -- in most cases this will be the
Chris@127 328 * value returned by pointer from a call to the underlying model's
Chris@226 329 * isReady(int *) call. The view may choose to show a progress
Chris@127 330 * meter if it finds that this returns < 100 at any given moment.
Chris@127 331 */
Chris@127 332 virtual int getCompletion(View *) const { return 100; }
Chris@127 333
Chris@127 334 virtual void setObjectName(const QString &name);
Chris@127 335
Chris@127 336 /**
Chris@127 337 * Convert the layer's data (though not those of the model it
Chris@316 338 * refers to) into XML for file output. This class implements the
Chris@316 339 * basic name/type/model-id output; subclasses will typically call
Chris@316 340 * this superclass implementation with extra attributes describing
Chris@316 341 * their particular properties.
Chris@127 342 */
Chris@316 343 virtual void toXml(QTextStream &stream, QString indent = "",
Chris@316 344 QString extraAttributes = "") const;
Chris@127 345
Chris@127 346 /**
Chris@127 347 * Set the particular properties of a layer (those specific to the
Chris@127 348 * subclass) from a set of XML attributes. This is the effective
Chris@316 349 * inverse of the toXml method.
Chris@127 350 */
Chris@127 351 virtual void setProperties(const QXmlAttributes &) = 0;
Chris@127 352
Chris@127 353 /**
Chris@316 354 * Produce XML containing the layer's ID and type. This is used
Chris@316 355 * to refer to the layer in the display section of the SV session
Chris@316 356 * file, for a layer that has already been described in the data
Chris@316 357 * section.
Chris@269 358 */
Chris@316 359 virtual void toBriefXml(QTextStream &stream,
Chris@316 360 QString indent = "",
Chris@316 361 QString extraAttributes = "") const;
Chris@269 362
Chris@269 363 /**
Chris@269 364 * Add a measurement rectangle from the given XML attributes
Chris@269 365 * (presumably taken from a measurement element).
Chris@269 366 * Does not use a command.
Chris@269 367 */
Chris@269 368 virtual void addMeasurementRect(const QXmlAttributes &);
Chris@269 369
Chris@269 370 /**
Chris@127 371 * Indicate that a layer is not currently visible in the given
Chris@127 372 * view and is not expected to become visible in the near future
Chris@127 373 * (for example because the user has explicitly removed or hidden
Chris@127 374 * it). The layer may respond by (for example) freeing any cache
Chris@127 375 * memory it is using, until next time its paint method is called,
Chris@127 376 * when it should set itself un-dormant again.
Chris@131 377 *
Chris@131 378 * A layer class that overrides this function must also call this
Chris@131 379 * class's implementation.
Chris@127 380 */
Chris@131 381 virtual void setLayerDormant(const View *v, bool dormant);
Chris@127 382
Chris@127 383 /**
Chris@127 384 * Return whether the layer is dormant (i.e. hidden) in the given
Chris@127 385 * view.
Chris@127 386 */
Chris@131 387 virtual bool isLayerDormant(const View *v) const;
Chris@127 388
Chris@127 389 virtual PlayParameters *getPlayParameters();
Chris@127 390
Chris@127 391 virtual bool needsTextLabelHeight() const { return false; }
Chris@127 392
Chris@217 393 virtual bool hasTimeXAxis() const { return true; }
Chris@217 394
Chris@127 395 /**
Chris@127 396 * Return the minimum and maximum values for the y axis of the
Chris@127 397 * model in this layer, as well as whether the layer is configured
Chris@127 398 * to use a logarithmic y axis display. Also return the unit for
Chris@127 399 * these values if known.
Chris@127 400 *
Chris@127 401 * This function returns the "normal" extents for the layer, not
Chris@127 402 * necessarily the extents actually in use in the display.
Chris@127 403 */
Chris@127 404 virtual bool getValueExtents(float &min, float &max,
Chris@127 405 bool &logarithmic, QString &unit) const = 0;
Chris@127 406
Chris@127 407 /**
Chris@127 408 * Return the minimum and maximum values within the displayed
Chris@127 409 * range for the y axis, if only a subset of the whole range of
Chris@127 410 * the model (returned by getValueExtents) is being displayed.
Chris@127 411 * Return false if the layer is not imposing a particular display
Chris@127 412 * extent (using the normal layer extents or deferring to whatever
Chris@127 413 * is in use for the same units elsewhere in the view).
Chris@127 414 */
Chris@127 415 virtual bool getDisplayExtents(float & /* min */,
Chris@127 416 float & /* max */) const {
Chris@127 417 return false;
Chris@127 418 }
Chris@127 419
Chris@127 420 /**
Chris@127 421 * Set the displayed minimum and maximum values for the y axis to
Chris@127 422 * the given range, if supported. Return false if not supported
Chris@127 423 * on this layer (and set nothing). In most cases, layers that
Chris@127 424 * return false for getDisplayExtents should also return false for
Chris@127 425 * this function.
Chris@127 426 */
Chris@127 427 virtual bool setDisplayExtents(float /* min */,
Chris@127 428 float /* max */) {
Chris@127 429 return false;
Chris@127 430 }
Chris@127 431
Chris@133 432 /**
Chris@260 433 * Return the value and unit at the given x coordinate in the
Chris@260 434 * given view. This is for descriptive purposes using the
Chris@260 435 * measurement tool. The default implementation works correctly
Chris@260 436 * if the layer hasTimeXAxis().
Chris@260 437 */
Chris@267 438 virtual bool getXScaleValue(const View *v, int x,
Chris@260 439 float &value, QString &unit) const;
Chris@260 440
Chris@260 441 /**
Chris@260 442 * Return the value and unit at the given y coordinate in the
Chris@260 443 * given view.
Chris@260 444 */
Chris@267 445 virtual bool getYScaleValue(const View *, int /* y */,
Chris@260 446 float &/* value */, QString &/* unit */) const {
Chris@260 447 return false;
Chris@260 448 }
Chris@260 449
Chris@260 450 /**
Chris@274 451 * Return the difference between the values at the given y
Chris@274 452 * coordinates in the given view, and the unit of the difference.
Chris@274 453 * The default implementation just calls getYScaleValue twice and
Chris@274 454 * returns the difference, with the same unit.
Chris@274 455 */
Chris@274 456 virtual bool getYScaleDifference(const View *v, int y0, int y1,
Chris@274 457 float &diff, QString &unit) const;
Chris@274 458
Chris@274 459 /**
Chris@133 460 * Get the number of vertical zoom steps available for this layer.
Chris@133 461 * If vertical zooming is not available, return 0. The meaning of
Chris@133 462 * "zooming" is entirely up to the layer -- changing the zoom
Chris@133 463 * level may cause the layer to reset its display extents or
Chris@180 464 * change another property such as display gain. However, layers
Chris@180 465 * are advised for consistency to treat smaller zoom steps as
Chris@180 466 * "more distant" or "zoomed out" and larger ones as "closer" or
Chris@180 467 * "zoomed in".
Chris@180 468 *
Chris@133 469 * Layers that provide this facility should also emit the
Chris@133 470 * verticalZoomChanged signal if their vertical zoom changes
Chris@133 471 * due to factors other than setVerticalZoomStep being called.
Chris@133 472 */
Chris@248 473 virtual int getVerticalZoomSteps(int & /* defaultStep */) const { return 0; }
Chris@133 474
Chris@133 475 /**
Chris@133 476 * Get the current vertical zoom step. A layer may support finer
Chris@133 477 * control over ranges etc than is available through the integer
Chris@133 478 * zoom step mechanism; if this one does, it should just return
Chris@133 479 * the nearest of the available zoom steps to the current settings.
Chris@133 480 */
Chris@133 481 virtual int getCurrentVerticalZoomStep() const { return 0; }
Chris@133 482
Chris@133 483 /**
Chris@133 484 * Set the vertical zoom step. The meaning of "zooming" is
Chris@133 485 * entirely up to the layer -- changing the zoom level may cause
Chris@133 486 * the layer to reset its display extents or change another
Chris@133 487 * property such as display gain.
Chris@133 488 */
Chris@133 489 virtual void setVerticalZoomStep(int) { }
Chris@133 490
Chris@187 491 /**
Chris@187 492 * Create and return a range mapper for vertical zoom step values.
Chris@187 493 * See the RangeMapper documentation for more details. The
Chris@187 494 * returned value is allocated on the heap and will be deleted by
Chris@187 495 * the caller.
Chris@187 496 */
Chris@187 497 virtual RangeMapper *getNewVerticalZoomRangeMapper() const { return 0; }
Chris@187 498
Chris@127 499 public slots:
Chris@127 500 void showLayer(View *, bool show);
Chris@127 501
Chris@127 502 signals:
Chris@127 503 void modelChanged();
Chris@127 504 void modelCompletionChanged();
Chris@320 505 void modelAlignmentCompletionChanged();
Chris@127 506 void modelChanged(size_t startFrame, size_t endFrame);
Chris@127 507 void modelReplaced();
Chris@127 508
Chris@127 509 void layerParametersChanged();
Chris@197 510 void layerParameterRangesChanged();
Chris@268 511 void layerMeasurementRectsChanged();
Chris@127 512 void layerNameChanged();
Chris@127 513
Chris@133 514 void verticalZoomChanged();
Chris@133 515
Chris@267 516 protected:
Chris@320 517 void connectSignals(const Model *);
Chris@320 518
Chris@359 519 virtual size_t alignToReference(View *v, size_t frame) const;
Chris@359 520 virtual size_t alignFromReference(View *v, size_t frame) const;
Chris@360 521 bool clipboardHasDifferentAlignment(View *v, const Clipboard &clip) const;
Chris@359 522
Chris@267 523 struct MeasureRect {
Chris@268 524
Chris@267 525 mutable QRect pixrect;
Chris@268 526 bool haveFrames;
Chris@268 527 long startFrame; // only valid if haveFrames
Chris@267 528 long endFrame; // ditto
Chris@273 529 double startY;
Chris@273 530 double endY;
Chris@268 531
Chris@268 532 bool operator<(const MeasureRect &mr) const;
Chris@316 533 void toXml(QTextStream &stream, QString indent) const;
Chris@267 534 };
Chris@267 535
Chris@268 536 class AddMeasurementRectCommand : public Command
Chris@268 537 {
Chris@268 538 public:
Chris@268 539 AddMeasurementRectCommand(Layer *layer, MeasureRect rect) :
Chris@268 540 m_layer(layer), m_rect(rect) { }
Chris@268 541
Chris@268 542 virtual QString getName() const;
Chris@268 543 virtual void execute();
Chris@268 544 virtual void unexecute();
Chris@268 545
Chris@268 546 private:
Chris@268 547 Layer *m_layer;
Chris@268 548 MeasureRect m_rect;
Chris@268 549 };
Chris@268 550
Chris@283 551 class DeleteMeasurementRectCommand : public Command
Chris@283 552 {
Chris@283 553 public:
Chris@283 554 DeleteMeasurementRectCommand(Layer *layer, MeasureRect rect) :
Chris@283 555 m_layer(layer), m_rect(rect) { }
Chris@283 556
Chris@283 557 virtual QString getName() const;
Chris@283 558 virtual void execute();
Chris@283 559 virtual void unexecute();
Chris@283 560
Chris@283 561 private:
Chris@283 562 Layer *m_layer;
Chris@283 563 MeasureRect m_rect;
Chris@283 564 };
Chris@283 565
Chris@269 566 void addMeasureRectToSet(const MeasureRect &r) {
Chris@268 567 m_measureRects.insert(r);
Chris@268 568 emit layerMeasurementRectsChanged();
Chris@268 569 }
Chris@268 570
Chris@269 571 void deleteMeasureRectFromSet(const MeasureRect &r) {
Chris@268 572 m_measureRects.erase(r);
Chris@268 573 emit layerMeasurementRectsChanged();
Chris@268 574 }
Chris@268 575
Chris@268 576 typedef std::set<MeasureRect> MeasureRectSet;
Chris@268 577 MeasureRectSet m_measureRects;
Chris@267 578 MeasureRect m_draggingRect;
Chris@267 579 bool m_haveDraggingRect;
Chris@283 580 mutable bool m_haveCurrentMeasureRect;
Chris@283 581 mutable QPoint m_currentMeasureRectPoint;
Chris@272 582
Chris@272 583 // Note that pixrects are only correct for a single view.
Chris@272 584 // So we should update them at the start of the paint procedure
Chris@272 585 // (painting is single threaded) and only use them after that.
Chris@273 586 void updateMeasurePixrects(View *v) const;
Chris@273 587
Chris@273 588 virtual void updateMeasureRectYCoords(View *v, const MeasureRect &r) const;
Chris@273 589 virtual void setMeasureRectYCoord(View *v, MeasureRect &r, bool start, int y) const;
Chris@283 590 virtual void setMeasureRectFromPixrect(View *v, MeasureRect &r, QRect pixrect) const;
Chris@272 591
Chris@272 592 // This assumes updateMeasurementPixrects has been called
Chris@272 593 MeasureRectSet::const_iterator findFocusedMeasureRect(QPoint) const;
Chris@267 594
Chris@269 595 void paintMeasurementRect(View *v, QPainter &paint,
Chris@270 596 const MeasureRect &r, bool focus) const;
Chris@268 597
Chris@363 598 QString m_presentationName;
Chris@363 599
Chris@131 600 private:
Chris@131 601 mutable QMutex m_dormancyMutex;
Chris@127 602 mutable std::map<const void *, bool> m_dormancy;
Chris@127 603 };
Chris@127 604
Chris@127 605 #endif
Chris@127 606