From ebc10d1b84fd067f2d2c4ee80a54362d62c792dc Mon Sep 17 00:00:00 2001 From: Joao Carreira Date: Thu, 23 Mar 2017 04:29:34 +0000 Subject: [PATCH] Re-format code --- .clang-format | 7 +- app/AboutDialog.cpp | 18 +- app/AboutDialog.h | 3 +- app/ConfigureFormatDialog.cpp | 50 +- app/DialogSubWindowSelector.cpp | 16 +- app/DialogSubWindowSelector.h | 2 +- app/FramePropertiesDock.cpp | 32 +- app/FramePropertiesDock.h | 8 +- app/GridManager.cpp | 8 +- app/GridManager.h | 4 +- app/HistogramWidget.cpp | 32 +- app/HistogramWidget.h | 6 +- app/ModuleHandleDock.cpp | 4 +- app/ModuleHandleDock.h | 4 +- app/ModulesHandle.cpp | 122 +- app/ModulesHandle.h | 4 +- app/ModulesHandleOptDialog.cpp | 17 +- app/ModulesHandleOptDialog.h | 2 +- app/PlaYUVerApp.cpp | 94 +- app/PlaYUVerApp.h | 4 +- app/PlaYUVerAppAdaptor.cpp | 5 +- app/PlaYUVerAppAdaptor.h | 5 +- app/PlaYUVerAppModuleIf.cpp | 22 +- app/PlaYUVerAppModuleIf.h | 14 +- app/PlaYUVerMdiSubWindow.cpp | 2 +- app/PlaYUVerMdiSubWindow.h | 2 +- app/PlaYUVerSubWindowHandle.cpp | 82 +- app/PlaYUVerSubWindowHandle.h | 2 +- app/PlotSubWindow.cpp | 29 +- app/PlotSubWindow.h | 6 +- app/ProgressBar.cpp | 6 +- app/ProgressBar.h | 2 +- app/QualityHandle.cpp | 46 +- app/QualityHandle.h | 2 +- app/QualityMeasurementSidebar.cpp | 16 +- app/QualityMeasurementSidebar.h | 8 +- app/SeekStreamDialog.cpp | 9 +- app/SeekStreamDialog.h | 2 +- app/SubWindowAbstract.cpp | 13 +- app/SubWindowAbstract.h | 12 +- app/VideoHandle.cpp | 97 +- app/VideoHandle.h | 6 +- app/VideoSubWindow.cpp | 96 +- app/VideoSubWindow.h | 14 +- app/ViewArea.cpp | 76 +- app/ViewArea.h | 13 +- app/WidgetFrameNumber.h | 2 +- app/external/qcustomplot.cpp | 10029 +++++++++++++++-------- app/external/qcustomplot.h | 627 +- app/main.cpp | 25 +- lib/PlaYUVerDefs.h | 15 +- lib/PlaYUVerFrame.cpp | 89 +- lib/PlaYUVerFramePixelFormats.cpp | 222 +- lib/PlaYUVerFramePixelFormats.h | 5 +- lib/PlaYUVerOptions.cpp | 46 +- lib/PlaYUVerOptions.h | 8 +- lib/PlaYUVerPixel.cpp | 6 +- lib/PlaYUVerPixel.h | 22 +- lib/PlaYUVerStream.cpp | 33 +- lib/StreamHandlerLibav.cpp | 48 +- lib/StreamHandlerLibav.h | 4 +- lib/StreamHandlerOpenCV.cpp | 11 +- lib/StreamHandlerPortableMap.cpp | 9 +- modules/AbsoluteFrameDifference.cpp | 21 +- modules/DisparityStereoBM.cpp | 14 +- modules/DisparityStereoBM.h | 3 +- modules/DisparityStereoSGBM.cpp | 21 +- modules/DisparityStereoSGBM.h | 24 +- modules/DisparityStereoVar.cpp | 15 +- modules/DisparityStereoVar.h | 3 +- modules/EightBitsSampling.cpp | 5 +- modules/FilterComponent.cpp | 16 +- modules/FrameCrop.cpp | 13 +- modules/FrameDifference.cpp | 13 +- modules/FrameMask.cpp | 10 +- modules/FrameShift.cpp | 6 +- modules/InterFrameVariance.cpp | 15 +- modules/LumaAverage.cpp | 13 +- modules/MeasureOpticalFlowDualTVL1.cpp | 9 +- modules/OpticalFlow.cpp | 9 +- modules/PlaYUVerModuleFactory.cpp | 4 +- modules/SetChromaHalfScale.cpp | 4 +- modules/WeightedPSNR.cpp | 3 +- tools/PlaYUVerTools.cpp | 56 +- tools/PlaYUVerToolsCmdParser.cpp | 9 +- 85 files changed, 8092 insertions(+), 4419 deletions(-) diff --git a/.clang-format b/.clang-format index d8f4194..f775df4 100644 --- a/.clang-format +++ b/.clang-format @@ -1,8 +1,7 @@ --- Language: Cpp # BasedOnStyle: Chromium -ColumnLimit: 80 -ColumnLimit: 120 +ColumnLimit: 100 AccessModifierOffset: -1 AlignAfterOpenBracket: Align AlignConsecutiveAssignments: false @@ -37,8 +36,10 @@ BraceWrapping: BreakBeforeBinaryOperators: None #BreakBeforeBraces: Attach BreakBeforeBraces: Allman +#BreakBeforeInheritanceComma: true BreakBeforeTernaryOperators: true -BreakConstructorInitializersBeforeComma: false +BreakConstructorInitializersBeforeComma: true +BreakConstructorInitializersBeforeComma: true BreakAfterJavaFieldAnnotations: false BreakStringLiterals: true CommentPragmas: '^ IWYU pragma:' diff --git a/app/AboutDialog.cpp b/app/AboutDialog.cpp index db81251..475f14d 100644 --- a/app/AboutDialog.cpp +++ b/app/AboutDialog.cpp @@ -20,7 +20,8 @@ /** * \file AboutDialog.cpp * \brief About Dialog - * Based on the work of Glad Deschrijver in KTikZ project + * Based on the work of Glad Deschrijver + * in KTikZ project */ #include @@ -36,14 +37,16 @@ AboutDialog::AboutDialog( QWidget* parent ) : QDialog( parent ) { - QPixmap logo = QPixmap( ":/images/playuver-backgroud-logo.png" ).scaled( QSize( 500, 350 ), Qt::KeepAspectRatio ); + QPixmap logo = QPixmap( ":/images/playuver-backgroud-logo.png" ) + .scaled( QSize( 500, 350 ), Qt::KeepAspectRatio ); QLabel* pixmapLabel = new QLabel; pixmapLabel->setPixmap( logo ); - QLabel* label = new QLabel( QString( "

%1 Version %2

%3

" ) - .arg( QApplication::applicationName() ) - .arg( QApplication::applicationVersion() ) - .arg( tr( "Enhanced open-source Qt-based raw video player" ) ) ); + QLabel* label = + new QLabel( QString( "

%1 Version %2

%3

" ) + .arg( QApplication::applicationName() ) + .arg( QApplication::applicationVersion() ) + .arg( tr( "Enhanced open-source Qt-based raw video player" ) ) ); label->setWordWrap( true ); QString featuresList = QStringLiteral( "

Features:

    " ); @@ -61,7 +64,8 @@ AboutDialog::AboutDialog( QWidget* parent ) : QDialog( parent ) QLabel* labelFeatures = new QLabel( featuresList ); - QLabel* labelCopyright = new QLabel( QStringLiteral( "Copyright © 2014–2015 Luis Lucas and Joao Carreira" ) ); + QLabel* labelCopyright = + new QLabel( QStringLiteral( "Copyright © 2014–2015 Luis Lucas and Joao Carreira" ) ); QWidget* topWidget = new QWidget; QVBoxLayout* topLayout = new QVBoxLayout; diff --git a/app/AboutDialog.h b/app/AboutDialog.h index 317ea3c..9d316ed 100644 --- a/app/AboutDialog.h +++ b/app/AboutDialog.h @@ -20,7 +20,8 @@ /** * \file AboutDialog.h * \brief About Dialog - * Based on the work of Glad Deschrijver in KTikZ project + * Based on the work of Glad Deschrijver + * in KTikZ project */ #ifndef __ABOUTDIALOG_H__ diff --git a/app/ConfigureFormatDialog.cpp b/app/ConfigureFormatDialog.cpp index 52831a3..9a9f836 100644 --- a/app/ConfigureFormatDialog.cpp +++ b/app/ConfigureFormatDialog.cpp @@ -23,6 +23,7 @@ */ #include +#include #include #include #include @@ -33,7 +34,6 @@ #include #include #include -#include #include "lib/PlaYUVerFrame.h" @@ -147,17 +147,20 @@ ConfigureFormatDialog::ConfigureFormatDialog( QWidget* parent ) : QDialog( paren Name = QString::fromStdString( aRCustomFileFormats[i].shortName ); uiWidth = aRCustomFileFormats[i].uiWidth; uiHeight = aRCustomFileFormats[i].uiHeight; - standardResolutionNames.append( QString( "%1 (%2x%3)" ).arg( Name ).arg( uiWidth ).arg( uiHeight ) ); + standardResolutionNames.append( + QString( "%1 (%2x%3)" ).arg( Name ).arg( uiWidth ).arg( uiHeight ) ); standardResolutionSizes.append( QSize( uiWidth, uiHeight ) ); } - std::vector listPlaYUVerStdResolution = PlaYUVerStream::stdResolutionSizes(); + std::vector listPlaYUVerStdResolution = + PlaYUVerStream::stdResolutionSizes(); for( UInt i = 0; i < listPlaYUVerStdResolution.size(); i++ ) { Name = QString::fromStdString( listPlaYUVerStdResolution[i].shortName ); uiWidth = listPlaYUVerStdResolution[i].uiWidth; uiHeight = listPlaYUVerStdResolution[i].uiHeight; - standardResolutionNames.append( QString( "%1 (%2x%3)" ).arg( Name ).arg( uiWidth ).arg( uiHeight ) ); + standardResolutionNames.append( + QString( "%1 (%2x%3)" ).arg( Name ).arg( uiWidth ).arg( uiHeight ) ); standardResolutionSizes.append( QSize( uiWidth, uiHeight ) ); } @@ -189,7 +192,8 @@ ConfigureFormatDialog::ConfigureFormatDialog( QWidget* parent ) : QDialog( paren // dialogTitleLabel->setFont( titleFont ); // dialogTitleLabel->setText( "Configure Resolution" ); // headLayout->addWidget( dialogTitleLabel ); - // headLayout->addItem( new QSpacerItem( 20, 20, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); + // headLayout->addItem( new QSpacerItem( 20, 20, QSizePolicy::Expanding, + // QSizePolicy::Minimum ) ); // // MainLayout->addLayout( headLayout ); // MainLayout->addItem( new QSpacerItem( 10, 20, QSizePolicy::Minimum ) ); @@ -204,7 +208,8 @@ ConfigureFormatDialog::ConfigureFormatDialog( QWidget* parent ) : QDialog( paren m_labelFilename = new QLabel(); m_labelFilename->setFont( titleFont ); filenameLayout->addWidget( filenameLabel ); - filenameLayout->addItem( new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); + filenameLayout->addItem( + new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); filenameLayout->addWidget( m_labelFilename ); MainLayout->addLayout( filenameLayout ); @@ -282,16 +287,19 @@ ConfigureFormatDialog::ConfigureFormatDialog( QWidget* parent ) : QDialog( paren for( UInt i = 0; i < PlaYUVerFrame::supportedColorSpacesListNames().size(); i++ ) { - m_comboBoxColorSpace->insertItem( i, PlaYUVerFrame::supportedColorSpacesListNames()[i].c_str() ); + m_comboBoxColorSpace->insertItem( i, + PlaYUVerFrame::supportedColorSpacesListNames()[i].c_str() ); } m_comboBoxColorSpace->setCurrentIndex( 1 ); pixelGridLayout->addWidget( colorSpaceLabel, 0, 0 ); - pixelGridLayout->addItem( new QSpacerItem( 10, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ), 0, 1 ); + pixelGridLayout->addItem( new QSpacerItem( 10, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ), + 0, 1 ); pixelGridLayout->addWidget( m_comboBoxColorSpace, 0, 2 ); pixelGridLayout->addWidget( pixelFormatLabel, 1, 0 ); - pixelGridLayout->addItem( new QSpacerItem( 10, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ), 1, 1 ); + pixelGridLayout->addItem( new QSpacerItem( 10, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ), + 1, 1 ); pixelGridLayout->addWidget( m_comboBoxPixelFormat, 1, 2 ); QLabel* bitsPerPelLabel = new QLabel(); @@ -303,7 +311,8 @@ ConfigureFormatDialog::ConfigureFormatDialog( QWidget* parent ) : QDialog( paren m_spinBoxBits->setRange( 0, 16 ); m_spinBoxBits->setValue( 8 ); pixelGridLayout->addWidget( bitsPerPelLabel, 2, 0 ); - pixelGridLayout->addItem( new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ), 2, 1 ); + pixelGridLayout->addItem( new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ), + 2, 1 ); pixelGridLayout->addWidget( m_spinBoxBits, 2, 2 ); /* @@ -320,7 +329,8 @@ ConfigureFormatDialog::ConfigureFormatDialog( QWidget* parent ) : QDialog( paren m_comboBoxEndianness->addItem( QStringLiteral( "Big Endian" ) ); m_comboBoxEndianness->addItem( QStringLiteral( "Little Endian" ) ); endiannessLayout->addWidget( endiannessLabel ); - endiannessLayout->addItem( new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); + endiannessLayout->addItem( + new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); endiannessLayout->addWidget( m_comboBoxEndianness ); m_widgetEndianness = new QWidget(); m_widgetEndianness->setContentsMargins( 0, 0, 0, 0 ); @@ -340,7 +350,8 @@ ConfigureFormatDialog::ConfigureFormatDialog( QWidget* parent ) : QDialog( paren m_spinBoxFrameRate->setRange( 0, 200 ); m_spinBoxFrameRate->setValue( 30 ); framerateFormatLayout->addWidget( framerateFormatLabel ); - framerateFormatLayout->addItem( new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); + framerateFormatLayout->addItem( + new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); framerateFormatLayout->addWidget( m_spinBoxFrameRate ); QWidget* framerateWidget = new QWidget(); framerateWidget->setContentsMargins( 0, 0, 0, 0 ); @@ -368,7 +379,8 @@ ConfigureFormatDialog::ConfigureFormatDialog( QWidget* parent ) : QDialog( paren SLOT( slotStandardResolutionSelected( int ) ) ); connect( m_spinBoxWidth, SIGNAL( valueChanged( int ) ), this, SLOT( slotResolutionChange() ) ); connect( m_spinBoxheight, SIGNAL( valueChanged( int ) ), this, SLOT( slotResolutionChange() ) ); - connect( m_comboBoxColorSpace, SIGNAL( currentIndexChanged( int ) ), this, SLOT( slotColorSpaceChange( int ) ) ); + connect( m_comboBoxColorSpace, SIGNAL( currentIndexChanged( int ) ), this, + SLOT( slotColorSpaceChange( int ) ) ); connect( m_spinBoxBits, SIGNAL( valueChanged( int ) ), this, SLOT( slotBitsChange( int ) ) ); connect( dialogButtonOkCancel, SIGNAL( accepted() ), this, SLOT( accept() ) ); @@ -471,9 +483,11 @@ void ConfigureFormatDialog::slotStandardResolutionSelected( Int idx ) if( customResolution.shortName != "" ) { QString name = QString::fromStdString( customResolution.shortName ); - name.append( QString( " (%2x%3)" ).arg( customResolution.uiWidth ).arg( customResolution.uiHeight ) ); + name.append( + QString( " (%2x%3)" ).arg( customResolution.uiWidth ).arg( customResolution.uiHeight ) ); standardResolutionNames.insert( 0, name ); - standardResolutionSizes.insert( 0, QSize( customResolution.uiWidth, customResolution.uiHeight ) ); + standardResolutionSizes.insert( + 0, QSize( customResolution.uiWidth, customResolution.uiHeight ) ); m_comboBoxStandardResolution->blockSignals( true ); m_comboBoxStandardResolution->insertItem( 0, name ); @@ -499,7 +513,8 @@ void ConfigureFormatDialog::slotResolutionChange() Int newIdx = -1; for( Int i = 0; i < standardResolutionSizes.size(); i++ ) { - if( standardResolutionSizes.at( i ) == QSize( m_spinBoxWidth->value(), m_spinBoxheight->value() ) ) + if( standardResolutionSizes.at( i ) == + QSize( m_spinBoxWidth->value(), m_spinBoxheight->value() ) ) { newIdx = i; break; @@ -517,7 +532,8 @@ Void ConfigureFormatDialog::slotColorSpaceChange( Int idx ) m_comboBoxPixelFormat->clear(); for( UInt i = 0; i < PlaYUVerFrame::supportedPixelFormatListNames( idx ).size(); i++ ) { - m_comboBoxPixelFormat->insertItem( i, PlaYUVerFrame::supportedPixelFormatListNames( idx )[i].c_str() ); + m_comboBoxPixelFormat->insertItem( + i, PlaYUVerFrame::supportedPixelFormatListNames( idx )[i].c_str() ); } m_comboBoxPixelFormat->setCurrentIndex( 0 ); } diff --git a/app/DialogSubWindowSelector.cpp b/app/DialogSubWindowSelector.cpp index 9c51ac3..062aa75 100644 --- a/app/DialogSubWindowSelector.cpp +++ b/app/DialogSubWindowSelector.cpp @@ -22,22 +22,22 @@ * \brief Dialog box to select sub windows */ +#include "DialogSubWindowSelector.h" +#include "PlaYUVerSubWindowHandle.h" +#include "VideoSubWindow.h" #include #include -#include "PlaYUVerSubWindowHandle.h" -#include "DialogSubWindowSelector.h" -#include "VideoSubWindow.h" DialogSubWindowSelector::DialogSubWindowSelector( QWidget* parent, PlaYUVerSubWindowHandle* windowManager, UInt uiCategory, Int minWindowsSelected, Int maxWindowsSelected ) - : QDialog( parent ), - m_uiCategory( uiCategory ), - m_iMinSelectedWindows( minWindowsSelected ), - m_iMaxSlectedWindows( maxWindowsSelected ), - m_pcMainWindowManager( windowManager ) + : QDialog( parent ) + , m_uiCategory( uiCategory ) + , m_iMinSelectedWindows( minWindowsSelected ) + , m_iMaxSlectedWindows( maxWindowsSelected ) + , m_pcMainWindowManager( windowManager ) { QSize windowSize( 350, 80 ); resize( windowSize ); diff --git a/app/DialogSubWindowSelector.h b/app/DialogSubWindowSelector.h index 36df182..3182942 100644 --- a/app/DialogSubWindowSelector.h +++ b/app/DialogSubWindowSelector.h @@ -25,8 +25,8 @@ #ifndef __DIALOGSUBWINDOWSELECTOR_H__ #define __DIALOGSUBWINDOWSELECTOR_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" #if( QT_VERSION_PLAYUVER == 5 ) #include #elif( QT_VERSION_PLAYUVER == 4 ) diff --git a/app/FramePropertiesDock.cpp b/app/FramePropertiesDock.cpp index 17f281e..315e0ea 100644 --- a/app/FramePropertiesDock.cpp +++ b/app/FramePropertiesDock.cpp @@ -22,10 +22,10 @@ * \brief Main side bar definition */ -#include -#include -#include #include "FramePropertiesDock.h" +#include +#include +#include FramePropertiesDock::FramePropertiesDock( QWidget* parent, Bool* pbMainPlaySwitch ) : QWidget( parent ), m_pbIsPlaying( pbMainPlaySwitch ) @@ -240,12 +240,17 @@ FramePropertiesDock::FramePropertiesDock( QWidget* parent, Bool* pbMainPlaySwitc setEnabled( false ); connect( channelCB, SIGNAL( activated( int ) ), this, SLOT( slotChannelChanged( int ) ) ); - connect( scaleButtonGroup, SIGNAL( buttonClicked( int ) ), this, SLOT( slotScaleChanged( int ) ) ); + connect( scaleButtonGroup, SIGNAL( buttonClicked( int ) ), this, + SLOT( slotScaleChanged( int ) ) ); connect( colorsCB, SIGNAL( activated( int ) ), this, SLOT( slotColorsChanged( int ) ) ); - connect( renderingButtonGroup, SIGNAL( buttonClicked( int ) ), this, SLOT( slotRenderingChanged( int ) ) ); - connect( histogramWidget, SIGNAL( signalIntervalChanged( int, int ) ), this, SLOT( slotUpdateInterval( int, int ) ) ); - connect( histogramWidget, SIGNAL( signalMaximumValueChanged( int ) ), this, SLOT( slotUpdateIntervRange( int ) ) ); - connect( histogramWidget, SIGNAL( signalHistogramComputationDone( int ) ), this, SLOT( slotRefreshOptions( int ) ) ); + connect( renderingButtonGroup, SIGNAL( buttonClicked( int ) ), this, + SLOT( slotRenderingChanged( int ) ) ); + connect( histogramWidget, SIGNAL( signalIntervalChanged( int, int ) ), this, + SLOT( slotUpdateInterval( int, int ) ) ); + connect( histogramWidget, SIGNAL( signalMaximumValueChanged( int ) ), this, + SLOT( slotUpdateIntervRange( int ) ) ); + connect( histogramWidget, SIGNAL( signalHistogramComputationDone( int ) ), this, + SLOT( slotRefreshOptions( int ) ) ); connect( histogramWidget, SIGNAL( signalHistogramComputationFailed( void ) ), this, SLOT( slotHistogramComputationFailed( void ) ) ); connect( minInterv, SIGNAL( valueChanged( int ) ), this, SLOT( slotMinValueChanged( int ) ) ); @@ -343,7 +348,8 @@ Void FramePropertiesDock::setFrame( PlaYUVerFrame* pcFrame ) colorsCB->setEnabled( false ); colorsCB->setWhatsThis( tr( "

    Select here the main color displayed with Colors Channel mode:" - "

    Luminance: DraupdateDataw the Luminance channel in the foreground.

    " + "

    Luminance: DraupdateDataw the Luminance channel in the " + "foreground.

    " "Chroma U: Draw the Chroma U channel in the foreground.

    " "Chroma V: Draw the Chroma V channel in the foreground.

    " ) ); colorsCB->show(); @@ -386,8 +392,8 @@ Void FramePropertiesDock::setSelection( const QRect& selectionArea ) { delete m_pcSelectedFrame; } - m_pcSelectedFrame = new PlaYUVerFrame( m_pcFrame, selectionArea.x(), selectionArea.y(), selectionArea.width(), - selectionArea.height() ); + m_pcSelectedFrame = new PlaYUVerFrame( m_pcFrame, selectionArea.x(), selectionArea.y(), + selectionArea.width(), selectionArea.height() ); } updateDataHistogram(); selectionImageButton->click(); @@ -454,8 +460,8 @@ Void FramePropertiesDock::updateStatistiques() if( frame ) { - QString rangeText = - "[" + QString::number( frame->getMin( channel ) ) + ":" + QString::number( frame->getMax( channel ) ) + "]"; + QString rangeText = "[" + QString::number( frame->getMin( channel ) ) + ":" + + QString::number( frame->getMax( channel ) ) + "]"; labelRangeValue->setText( rangeText ); double mean = frame->getMean( channel, min, max ); diff --git a/app/FramePropertiesDock.h b/app/FramePropertiesDock.h index fe777bc..1f69deb 100644 --- a/app/FramePropertiesDock.h +++ b/app/FramePropertiesDock.h @@ -25,17 +25,17 @@ #ifndef __FRAMEPROPERTIESDOCK_H__ #define __FRAMEPROPERTIESDOCK_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" #if( QT_VERSION_PLAYUVER == 5 ) #include #elif( QT_VERSION_PLAYUVER == 4 ) -#include #include +#include #endif -#include "lib/PlaYUVerStream.h" -#include "lib/PlaYUVerFrame.h" #include "HistogramWidget.h" +#include "lib/PlaYUVerFrame.h" +#include "lib/PlaYUVerStream.h" class FramePropertiesDock : public QWidget { diff --git a/app/GridManager.cpp b/app/GridManager.cpp index 68c4ffa..d78e5f6 100644 --- a/app/GridManager.cpp +++ b/app/GridManager.cpp @@ -24,13 +24,13 @@ */ #include +#include +#include #include +#include +#include #include #include -#include -#include -#include -#include #include "GridManager.h" diff --git a/app/GridManager.h b/app/GridManager.h index f68a439..578aab3 100644 --- a/app/GridManager.h +++ b/app/GridManager.h @@ -26,11 +26,11 @@ #ifndef __GRIDMANAGER_H__ #define __GRIDMANAGER_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" -#include +#include "config.h" #include #include +#include class QPoint; class QBitmap; diff --git a/app/HistogramWidget.cpp b/app/HistogramWidget.cpp index c36abf2..6b404d5 100644 --- a/app/HistogramWidget.cpp +++ b/app/HistogramWidget.cpp @@ -25,11 +25,11 @@ // TODO: // - Optimizar paintEvent. Parece haver codigo redundante !! -#include "config.h" -#include -#include -#include #include "HistogramWidget.h" +#include "config.h" +#include +#include +#include class HistogramWorker : public QThread { @@ -177,7 +177,8 @@ HistogramWidget::HistogramWidget( Int width, Int height, QWidget* parent ) : QWi m_colorType = FirstChannelColor; m_renderingType = FullImageHistogram; - setOptions( HistogramWidget::BlinkComputation | HistogramWidget::SelectMode | HistogramWidget::ShowLumaChannel ); + setOptions( HistogramWidget::BlinkComputation | HistogramWidget::SelectMode | + HistogramWidget::ShowLumaChannel ); setMouseTracking( true ); setMinimumSize( width, height ); @@ -439,7 +440,8 @@ Void HistogramWidget::paintEvent( QPaintEvent* ) QPainter p1( this ); p1.fillRect( 0, 0, maxX, maxY, palette().color( QPalette::Disabled, QPalette::Window ) ); - p1.setPen( QPen( palette().color( QPalette::Disabled, QPalette::WindowText ), 1, Qt::SolidLine ) ); + p1.setPen( + QPen( palette().color( QPalette::Disabled, QPalette::WindowText ), 1, Qt::SolidLine ) ); p1.drawRect( 0, 0, maxX, maxY ); return; @@ -461,7 +463,8 @@ Void HistogramWidget::paintEvent( QPaintEvent* ) if( d->clearFlag == HistogramWidgetPrivate::HistogramDataLoading ) p1.drawText( 0, 0, maxX, maxY, Qt::AlignCenter, tr( "Loading image..." ) ); else - p1.drawText( 0, 0, maxX, maxY, Qt::AlignCenter, tr( "Histogram\ncalculation\nin progress..." ) ); + p1.drawText( 0, 0, maxX, maxY, Qt::AlignCenter, + tr( "Histogram\ncalculation\nin progress..." ) ); return; } @@ -526,7 +529,8 @@ Void HistogramWidget::paintEvent( QPaintEvent* ) break; case HistogramWidget::ColorChannelsHistogram: // All color channels. - max = qMax( qMax( frame->getMaximum( LUMA ), frame->getMaximum( CHROMA_U ) ), frame->getMaximum( CHROMA_V ) ); + max = qMax( qMax( frame->getMaximum( LUMA ), frame->getMaximum( CHROMA_U ) ), + frame->getMaximum( CHROMA_V ) ); break; // case HistogramWidget::LumaHistogram: // Luminance. // max = frame->getMaximum( LUMA ); @@ -893,7 +897,8 @@ Void HistogramWidget::paintEvent( QPaintEvent* ) break; // case HistogramWidget::LumaHistogram: - // guidePos = qMax( qMax( d->colorGuide.red(), d->colorGuide.green() ), d->colorGuide.blue() ); + // guidePos = qMax( qMax( d->colorGuide.red(), d->colorGuide.green() + // ), d->colorGuide.blue() ); // break; default: // Alpha. @@ -1025,7 +1030,8 @@ Void HistogramWidget::mouseMoveEvent( QMouseEvent* e ) if( d->inSelected ) { double max = ( (double)e->pos().x() ) / ( (double)width() ); - // int max = (int)(e->pos().x()*((float)m_imageHistogram->getHistogramSegment()/(float)width())); + // int max = + // (int)(e->pos().x()*((float)m_imageHistogram->getHistogramSegment()/(float)width())); if( max < d->xminOrg ) { @@ -1040,7 +1046,8 @@ Void HistogramWidget::mouseMoveEvent( QMouseEvent* e ) } notifyValuesChanged(); - // emit signalMaxValueChanged( d->xmax == 0.0 ? d->range : (int)(d->xmax * d->range) ); + // emit signalMaxValueChanged( d->xmax == 0.0 ? d->range : (int)(d->xmax * + // d->range) ); update(); } @@ -1051,7 +1058,8 @@ Void HistogramWidget::mouseMoveEvent( QMouseEvent* e ) Void HistogramWidget::notifyValuesChanged() { - emit signalIntervalChanged( (int)( d->xmin * d->range ), d->xmax == 0.0 ? d->range : (int)( d->xmax * d->range ) ); + emit signalIntervalChanged( (int)( d->xmin * d->range ), + d->xmax == 0.0 ? d->range : (int)( d->xmax * d->range ) ); } Void HistogramWidget::slotMinValueChanged( int min ) diff --git a/app/HistogramWidget.h b/app/HistogramWidget.h index 23104a5..53ff76d 100644 --- a/app/HistogramWidget.h +++ b/app/HistogramWidget.h @@ -26,11 +26,11 @@ #ifndef __HISTOGRAMWIDGET_H__ #define __HISTOGRAMWIDGET_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" -#include -#include +#include "config.h" #include "lib/PlaYUVerFrame.h" +#include +#include class QEvent; diff --git a/app/ModuleHandleDock.cpp b/app/ModuleHandleDock.cpp index ca2cc6a..f96cda1 100644 --- a/app/ModuleHandleDock.cpp +++ b/app/ModuleHandleDock.cpp @@ -22,10 +22,10 @@ * \brief Module handle dock */ -#include #include "ModuleHandleDock.h" -#include "PlaYUVerAppModuleIf.h" #include "ModulesHandle.h" +#include "PlaYUVerAppModuleIf.h" +#include ModuleHandleDock::ModuleHandleDock( QWidget* parent, PlaYUVerAppModuleIf* moduleIf ) : QWidget( parent ), m_pcCurrModuleIf( moduleIf ) diff --git a/app/ModuleHandleDock.h b/app/ModuleHandleDock.h index f86a7a0..4ae5819 100644 --- a/app/ModuleHandleDock.h +++ b/app/ModuleHandleDock.h @@ -25,13 +25,13 @@ #ifndef __MODULEHANDLEDOCK_H__ #define __MODULEHANDLEDOCK_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" #if( QT_VERSION_PLAYUVER == 5 ) #include #elif( QT_VERSION_PLAYUVER == 4 ) -#include #include +#include #endif class PlaYUVerAppModuleIf; diff --git a/app/ModulesHandle.cpp b/app/ModulesHandle.cpp index f430c9f..6aa9773 100644 --- a/app/ModulesHandle.cpp +++ b/app/ModulesHandle.cpp @@ -22,18 +22,23 @@ * \brief PlaYUVer modules handle */ -#include -#include "PlaYUVerApp.h" #include "ModulesHandle.h" -#include "PlaYUVerSubWindowHandle.h" -#include "VideoSubWindow.h" -#include "VideoHandle.h" #include "DialogSubWindowSelector.h" #include "ModulesHandleOptDialog.h" +#include "PlaYUVerApp.h" +#include "PlaYUVerSubWindowHandle.h" +#include "VideoHandle.h" +#include "VideoSubWindow.h" #include "modules/PlaYUVerModuleFactory.h" +#include -ModulesHandle::ModulesHandle( QWidget* parent, PlaYUVerSubWindowHandle* windowManager, VideoHandle* moduleVideo ) - : QWidget( parent ), m_pcParent( parent ), m_pcMainWindowManager( windowManager ), m_appModuleVideo( moduleVideo ) +ModulesHandle::ModulesHandle( QWidget* parent, + PlaYUVerSubWindowHandle* windowManager, + VideoHandle* moduleVideo ) + : QWidget( parent ) + , m_pcParent( parent ) + , m_pcMainWindowManager( windowManager ) + , m_appModuleVideo( moduleVideo ) { setParent( m_pcParent ); } @@ -49,13 +54,16 @@ Void ModulesHandle::createActions() m_pcActionMapper = new QSignalMapper( this ); connect( m_pcActionMapper, SIGNAL( mapped( int ) ), this, SLOT( processOpt( int ) ) ); - // m_arrayActions[FORCE_PLAYING_REFRESH_ACT] = new QAction( "Refresh while playing", parent() ); - // m_arrayActions[FORCE_PLAYING_REFRESH_ACT]->setStatusTip( "Force module refreshing while playing" ); + // m_arrayActions[FORCE_PLAYING_REFRESH_ACT] = new QAction( "Refresh while + // playing", parent() ); + // m_arrayActions[FORCE_PLAYING_REFRESH_ACT]->setStatusTip( "Force module + // refreshing while playing" ); // m_arrayActions[FORCE_PLAYING_REFRESH_ACT]->setCheckable( true ); m_arrayActions[LOAD_EXTERNAL_ACT] = new QAction( "Load external module", parent() ); m_arrayActions[LOAD_EXTERNAL_ACT]->setStatusTip( "Load an externally build module" ); - connect( m_arrayActions[LOAD_EXTERNAL_ACT], SIGNAL( triggered() ), this, SLOT( loadExternalModule() ) ); + connect( m_arrayActions[LOAD_EXTERNAL_ACT], SIGNAL( triggered() ), this, + SLOT( loadExternalModule() ) ); m_arrayActions[APPLY_ALL_ACT] = new QAction( "Apply to All", parent() ); m_arrayActions[APPLY_ALL_ACT]->setStatusTip( "Apply module to all frames and save the result" ); @@ -64,18 +72,22 @@ Void ModulesHandle::createActions() m_arrayActions[SWAP_FRAMES_ACT] = new QAction( "Swap frames", parent() ); m_arrayActions[SWAP_FRAMES_ACT]->setStatusTip( "Swap Sub Window order" ); - connect( m_arrayActions[SWAP_FRAMES_ACT], SIGNAL( triggered() ), m_pcActionMapper, SLOT( map() ) ); + connect( m_arrayActions[SWAP_FRAMES_ACT], SIGNAL( triggered() ), m_pcActionMapper, + SLOT( map() ) ); m_pcActionMapper->setMapping( m_arrayActions[SWAP_FRAMES_ACT], SWAP_FRAMES_ACT ); m_arrayActions[DISABLE_ACT] = new QAction( "Disable Modules", parent() ); - connect( m_arrayActions[DISABLE_ACT], SIGNAL( triggered() ), this, SLOT( destroyWindowModules() ) ); + connect( m_arrayActions[DISABLE_ACT], SIGNAL( triggered() ), this, + SLOT( destroyWindowModules() ) ); m_arrayActions[DISABLE_ALL_ACT] = new QAction( "Disable All Modules", parent() ); - connect( m_arrayActions[DISABLE_ALL_ACT], SIGNAL( triggered() ), this, SLOT( destroyAllModulesIf() ) ); + connect( m_arrayActions[DISABLE_ALL_ACT], SIGNAL( triggered() ), this, + SLOT( destroyAllModulesIf() ) ); m_arrayActions[FORCE_NEW_WINDOW_ACT] = new QAction( "Use New Window", parent() ); m_arrayActions[FORCE_NEW_WINDOW_ACT]->setStatusTip( - "Show module result in a new window. Some modules already force this feature" ); + "Show module result in a new window. Some modules already force this " + "feature" ); m_arrayActions[FORCE_NEW_WINDOW_ACT]->setCheckable( true ); } @@ -113,7 +125,8 @@ Void ModulesHandle::buildMenu() { for( Int j = 0; j < m_pcModulesSubMenuList.size(); j++ ) { - if( m_pcModulesSubMenuList.at( j )->title() == QString( pcCurrModuleIf->m_pchModuleCategory ) ) + if( m_pcModulesSubMenuList.at( j )->title() == + QString( pcCurrModuleIf->m_pchModuleCategory ) ) { currSubMenu = m_pcModulesSubMenuList.at( j ); break; @@ -152,7 +165,8 @@ Void ModulesHandle::buildMenu() Void ModulesHandle::updateMenus() { - VideoSubWindow* pcSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); Bool hasSubWindow = pcSubWindow ? true : false; QAction* currModuleAction; @@ -195,18 +209,21 @@ Void ModulesHandle::updateMenus() Void ModulesHandle::readSettings() { QSettings appSettings; - m_arrayActions[FORCE_NEW_WINDOW_ACT]->setChecked( appSettings.value( "ModulesHandle/UseNewWindow", false ).toBool() ); + m_arrayActions[FORCE_NEW_WINDOW_ACT]->setChecked( + appSettings.value( "ModulesHandle/UseNewWindow", false ).toBool() ); } Void ModulesHandle::writeSettings() { QSettings appSettings; - appSettings.setValue( "ModulesHandle/UseNewWindow", m_arrayActions[FORCE_NEW_WINDOW_ACT]->isChecked() ); + appSettings.setValue( "ModulesHandle/UseNewWindow", + m_arrayActions[FORCE_NEW_WINDOW_ACT]->isChecked() ); } Void ModulesHandle::processOpt( Int index ) { - VideoSubWindow* pcSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); if( pcSubWindow ) { PlaYUVerAppModuleIf* pcCurrentModule = pcSubWindow->getDisplayModule(); @@ -239,8 +256,8 @@ Void ModulesHandle::loadExternalModule() formatsList << "Shared Libraries (*.so)"; QStringList filter; filter << supported << formatsList << tr( "All Files (*)" ); - QStringList fileNames = - QFileDialog::getOpenFileNames( m_pcParent, tr( "Open File" ), QString(), filter.join( ";;" ) ); + QStringList fileNames = QFileDialog::getOpenFileNames( m_pcParent, tr( "Open File" ), QString(), + filter.join( ";;" ) ); for( Int i = 0; i < fileNames.size(); i++ ) { @@ -256,13 +273,15 @@ Void ModulesHandle::activateModule() Qt::KeyboardModifiers keyModifiers = QApplication::keyboardModifiers(); Bool bTmpForceNewWindow = false; - VideoSubWindow* pcVideoSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcVideoSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); if( !pcVideoSubWindow ) { return; } - if( ( keyModifiers & Qt::ControlModifier ) || pcVideoSubWindow->checkCategory( VideoSubWindow::MODULE_SUBWINDOW ) ) + if( ( keyModifiers & Qt::ControlModifier ) || + pcVideoSubWindow->checkCategory( VideoSubWindow::MODULE_SUBWINDOW ) ) { bTmpForceNewWindow = true; } @@ -270,7 +289,8 @@ Void ModulesHandle::activateModule() QString ModuleIfName = pcAction->data().toString(); PlaYUVerModuleIf* pcCurrModuleIf = PlaYUVerModuleFactory::Get()->CreateModule( ModuleIfName.toLocal8Bit().constData() ); - PlaYUVerAppModuleIf* pcCurrAppModuleIf = new PlaYUVerAppModuleIf( this, pcAction, pcCurrModuleIf ); + PlaYUVerAppModuleIf* pcCurrAppModuleIf = + new PlaYUVerAppModuleIf( this, pcAction, pcCurrModuleIf ); QList videoSubWindowList; Int numberOfFrames = pcCurrAppModuleIf->m_pcModule->m_uiNumberOfFrames; @@ -284,8 +304,10 @@ Void ModulesHandle::activateModule() maxNumFrames = 255; } DialogSubWindowSelector dialogWindowsSelection( m_pcParent, m_pcMainWindowManager, - SubWindowAbstract::VIDEO_SUBWINDOW, minNumFrames, maxNumFrames ); - QList windowsList = m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); + SubWindowAbstract::VIDEO_SUBWINDOW, + minNumFrames, maxNumFrames ); + QList windowsList = + m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); if( windowsList.size() == minNumFrames && windowsList.size() == maxNumFrames ) { @@ -323,10 +345,12 @@ Void ModulesHandle::activateModule() // Check for same fmt in more than one frame modules for( Int i = 1; i < videoSubWindowList.size(); i++ ) { - if( !videoSubWindowList.at( i )->getCurrFrame()->haveSameFmt( videoSubWindowList.at( 0 )->getCurrFrame() ) ) + if( !videoSubWindowList.at( i )->getCurrFrame()->haveSameFmt( + videoSubWindowList.at( 0 )->getCurrFrame() ) ) { videoSubWindowList.clear(); - qobject_cast( m_pcParent )->printMessage( "Error! Incompatible frames", LOG_ERROR ); + qobject_cast( m_pcParent ) + ->printMessage( "Error! Incompatible frames", LOG_ERROR ); destroyModuleIf( pcCurrAppModuleIf ); return; } @@ -356,13 +380,15 @@ Void ModulesHandle::activateModule() ModulesHandleOptDialog moduleOptDialog( m_pcParent, pcCurrAppModuleIf ); if( moduleOptDialog.runConfiguration() == QDialog::Rejected ) { - qobject_cast( m_pcParent )->printMessage( "Module canceled by user!", LOG_WARNINGS ); + qobject_cast( m_pcParent ) + ->printMessage( "Module canceled by user!", LOG_WARNINGS ); destroyModuleIf( pcCurrAppModuleIf ); return; } } - Bool bShowModulesNewWindow = m_arrayActions[FORCE_NEW_WINDOW_ACT]->isChecked() | bTmpForceNewWindow; + Bool bShowModulesNewWindow = + m_arrayActions[FORCE_NEW_WINDOW_ACT]->isChecked() | bTmpForceNewWindow; QString windowName; @@ -376,12 +402,12 @@ Void ModulesHandle::activateModule() windowName.append( QStringLiteral( "Module " ) ); windowName.append( pcCurrAppModuleIf->m_pcModule->m_pchModuleName ); - connect( pcModuleSubWindow->getViewArea(), SIGNAL( selectionChanged( QRect ) ), m_appModuleVideo, - SLOT( updateSelectionArea( QRect ) ) ); - connect( pcModuleSubWindow, SIGNAL( zoomFactorChanged_SWindow( const double, const QPoint ) ), m_appModuleVideo, - SLOT( zoomToFactorAll( double, QPoint ) ) ); - connect( pcModuleSubWindow, SIGNAL( scrollBarMoved_SWindow( const QPoint ) ), m_appModuleVideo, - SLOT( moveAllScrollBars( const QPoint ) ) ); + connect( pcModuleSubWindow->getViewArea(), SIGNAL( selectionChanged( QRect ) ), + m_appModuleVideo, SLOT( updateSelectionArea( QRect ) ) ); + connect( pcModuleSubWindow, SIGNAL( zoomFactorChanged_SWindow( const double, const QPoint ) ), + m_appModuleVideo, SLOT( zoomToFactorAll( double, QPoint ) ) ); + connect( pcModuleSubWindow, SIGNAL( scrollBarMoved_SWindow( const QPoint ) ), + m_appModuleVideo, SLOT( moveAllScrollBars( const QPoint ) ) ); pcCurrAppModuleIf->m_pcDisplaySubWindow = pcModuleSubWindow; } @@ -394,8 +420,10 @@ Void ModulesHandle::activateModule() titleDockWidget.append( pcCurrAppModuleIf->m_pcModule->m_pchModuleName ); titleDockWidget.append( " Information" ); pcCurrAppModuleIf->m_pcDockWidget = new QDockWidget( titleDockWidget, m_pcParent ); - pcCurrAppModuleIf->m_pcDockWidget->setFeatures( QDockWidget::DockWidgetMovable | QDockWidget::DockWidgetFloatable ); - pcCurrAppModuleIf->m_pcDockWidget->setAllowedAreas( Qt::LeftDockWidgetArea | Qt::RightDockWidgetArea ); + pcCurrAppModuleIf->m_pcDockWidget->setFeatures( QDockWidget::DockWidgetMovable | + QDockWidget::DockWidgetFloatable ); + pcCurrAppModuleIf->m_pcDockWidget->setAllowedAreas( Qt::LeftDockWidgetArea | + Qt::RightDockWidgetArea ); pcCurrAppModuleIf->m_pcDockWidget->setWidget( pcCurrAppModuleIf->m_pcModuleDock ); qobject_cast( m_pcParent ) ->addDockWidget( Qt::RightDockWidgetArea, pcCurrAppModuleIf->m_pcDockWidget ); @@ -435,7 +463,8 @@ Void ModulesHandle::activateModule() if( !moduleCreated ) { - qobject_cast( m_pcParent )->printMessage( "Error! Module cannot be created", LOG_ERROR ); + qobject_cast( m_pcParent ) + ->printMessage( "Error! Module cannot be created", LOG_ERROR ); destroyModuleIf( pcCurrAppModuleIf ); return; } @@ -472,7 +501,8 @@ Void ModulesHandle::destroyModuleIf( PlaYUVerAppModuleIf* pcCurrModuleIf ) Void ModulesHandle::destroyWindowModules() { - VideoSubWindow* pcVideoSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcVideoSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); if( pcVideoSubWindow ) { pcVideoSubWindow->disableModule(); @@ -489,7 +519,9 @@ Void ModulesHandle::destroyAllModulesIf() emit changed(); } -Void ModulesHandle::applyModuleIf( QList pcCurrModuleIfList, Bool isPlaying, Bool disableThreads ) +Void ModulesHandle::applyModuleIf( QList pcCurrModuleIfList, + Bool isPlaying, + Bool disableThreads ) { for( Int i = 0; i < pcCurrModuleIfList.size() && !isPlaying; i++ ) { @@ -526,7 +558,8 @@ Void ModulesHandle::applyAllModuleIf( PlaYUVerAppModuleIf* pcCurrModuleIf ) QStringList filter; filter << supported << formatsList << tr( "All Files (*)" ); - QString fileName = QFileDialog::getSaveFileName( m_pcParent, tr( "Open File" ), QString(), filter.join( ";;" ) ); + QString fileName = QFileDialog::getSaveFileName( m_pcParent, tr( "Open File" ), QString(), + filter.join( ";;" ) ); Width = pcCurrModuleIf->m_pcProcessedFrame->getWidth(); Height = pcCurrModuleIf->m_pcProcessedFrame->getHeight(); @@ -535,8 +568,9 @@ Void ModulesHandle::applyAllModuleIf( PlaYUVerAppModuleIf* pcCurrModuleIf ) FrameRate = pcCurrModuleIf->m_pcSubWindow[0]->getInputStream()->getFrameRate(); pcCurrModuleIf->m_pcModuleStream = new PlaYUVerStream; - if( !pcCurrModuleIf->m_pcModuleStream->open( fileName.toStdString(), Width, Height, InputFormat, BitsPixel, - PLAYUVER_LITTLE_ENDIAN, FrameRate, false ) ) + if( !pcCurrModuleIf->m_pcModuleStream->open( fileName.toStdString(), Width, Height, + InputFormat, BitsPixel, PLAYUVER_LITTLE_ENDIAN, + FrameRate, false ) ) { delete pcCurrModuleIf->m_pcModuleStream; pcCurrModuleIf->m_pcModuleStream = NULL; diff --git a/app/ModulesHandle.h b/app/ModulesHandle.h index aebd565..12afbbf 100644 --- a/app/ModulesHandle.h +++ b/app/ModulesHandle.h @@ -26,8 +26,8 @@ #include "config.h" -#include #include +#include #include #if( QT_VERSION_PLAYUVER == 5 ) @@ -35,8 +35,8 @@ #elif( QT_VERSION_PLAYUVER == 4 ) #include #endif -#include "PlaYUVerAppModuleIf.h" #include "PlaYUVerAppDefs.h" +#include "PlaYUVerAppModuleIf.h" #include "lib/PlaYUVerFrame.h" class VideoHandle; diff --git a/app/ModulesHandleOptDialog.cpp b/app/ModulesHandleOptDialog.cpp index fecb4fe..d316897 100644 --- a/app/ModulesHandleOptDialog.cpp +++ b/app/ModulesHandleOptDialog.cpp @@ -24,11 +24,11 @@ #include "ModulesHandleOptDialog.h" -#include -#include -#include -#include #include +#include +#include +#include +#include #include "lib/PlaYUVerOptions.h" @@ -75,17 +75,20 @@ class OpionConfiguration : public QWidget String m_cName; }; -ModulesHandleOptDialog::ModulesHandleOptDialog( QWidget* parent, PlaYUVerAppModuleIf* pcCurrModuleIf ) +ModulesHandleOptDialog::ModulesHandleOptDialog( QWidget* parent, + PlaYUVerAppModuleIf* pcCurrModuleIf ) : QDialog( parent ), m_pcCurrModuleIf( pcCurrModuleIf ) { resize( 400, 10 ); setWindowTitle( "Select module parameters" ); - const PlaYUVerOptions::OptionsList& moduleOptions = m_pcCurrModuleIf->m_pcModule->m_cModuleOptions.getOptionList(); + const PlaYUVerOptions::OptionsList& moduleOptions = + m_pcCurrModuleIf->m_pcModule->m_cModuleOptions.getOptionList(); QVBoxLayout* optionsLayout = new QVBoxLayout; OpionConfiguration* pcOption; - for( PlaYUVerOptions::OptionsList::const_iterator it = moduleOptions.begin(); it != moduleOptions.end(); ++it ) + for( PlaYUVerOptions::OptionsList::const_iterator it = moduleOptions.begin(); + it != moduleOptions.end(); ++it ) { pcOption = new OpionConfiguration( ( *it )->opt ); m_apcOptionList.append( pcOption ); diff --git a/app/ModulesHandleOptDialog.h b/app/ModulesHandleOptDialog.h index 48973ca..2451121 100644 --- a/app/ModulesHandleOptDialog.h +++ b/app/ModulesHandleOptDialog.h @@ -25,9 +25,9 @@ #ifndef __MODULEHANDLEOPTDIALOG_H__ #define __MODULEHANDLEOPTDIALOG_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" #include "PlaYUVerAppModuleIf.h" +#include "config.h" #include #include diff --git a/app/PlaYUVerApp.cpp b/app/PlaYUVerApp.cpp index 6b018c7..269a8e2 100644 --- a/app/PlaYUVerApp.cpp +++ b/app/PlaYUVerApp.cpp @@ -22,31 +22,32 @@ * \brief Main definition of the PlaYUVerApp app */ -#include +#include "PlaYUVerApp.h" +#include +#include #include +#include #include #include -#include -#include -#include #include -#include "PlaYUVerApp.h" +#include #ifdef USE_FERVOR #include "fvupdater.h" #endif -#include "lib/PlaYUVerOptions.h" -#include "PlaYUVerSubWindowHandle.h" #include "AboutDialog.h" -#include "SubWindowAbstract.h" -#include "VideoSubWindow.h" -#include "VideoHandle.h" -#include "QualityHandle.h" -#include "ModulesHandle.h" #include "DialogSubWindowSelector.h" +#include "ModulesHandle.h" +#include "PlaYUVerSubWindowHandle.h" +#include "QualityHandle.h" +#include "SubWindowAbstract.h" +#include "VideoHandle.h" +#include "VideoSubWindow.h" +#include "lib/PlaYUVerOptions.h" #define SYNCHRONISED_ZOON 1 -PlaYUVerApp::PlaYUVerApp() : m_pcCurrentSubWindow( NULL ), m_pcCurrentVideoSubWindow( NULL ), m_pcAboutDialog( NULL ) +PlaYUVerApp::PlaYUVerApp() + : m_pcCurrentSubWindow( NULL ), m_pcCurrentVideoSubWindow( NULL ), m_pcAboutDialog( NULL ) { setWindowModality( Qt::ApplicationModal ); setWindowModality( Qt::NonModal ); @@ -118,7 +119,8 @@ Bool PlaYUVerApp::parseArgs( Int argc, Char* argv[] ) } } std::list& argv_unhandled = pcCmdParser.getUnhandledArgs(); - for( std::list::const_iterator it = argv_unhandled.begin(); it != argv_unhandled.end(); it++ ) + for( std::list::const_iterator it = argv_unhandled.begin(); + it != argv_unhandled.end(); it++ ) { loadFile( QString::fromStdString( *it ) ); } @@ -187,13 +189,15 @@ Void PlaYUVerApp::loadFile( QString fileName, PlaYUVerStreamInfo* pStreamInfo ) printMessage( "File " + fileName + " do not exist!", LOG_ERROR ); return; } - VideoSubWindow* videoSubWindow = PlaYUVerApp::findVideoStreamSubWindow( m_pcWindowHandle, fileName ); + VideoSubWindow* videoSubWindow = + PlaYUVerApp::findVideoStreamSubWindow( m_pcWindowHandle, fileName ); if( videoSubWindow ) { m_pcWindowHandle->setActiveSubWindow( videoSubWindow ); return; } - videoSubWindow = new VideoSubWindow( VideoSubWindow::VIDEO_STREAM_SUBWINDOW ); // createSubWindow(); + videoSubWindow = + new VideoSubWindow( VideoSubWindow::VIDEO_STREAM_SUBWINDOW ); // createSubWindow(); SubWindowAbstract* subWindow = videoSubWindow; if( !pStreamInfo ) { @@ -218,8 +222,8 @@ Void PlaYUVerApp::loadFile( QString fileName, PlaYUVerStreamInfo* pStreamInfo ) connect( subWindow, SIGNAL( aboutToClose( SubWindowAbstract* ) ), m_appModuleVideo, SLOT( closeSubWindow( SubWindowAbstract* ) ) ); - connect( subWindow, SIGNAL( zoomFactorChanged_SWindow( const double, const QPoint ) ), m_appModuleVideo, - SLOT( zoomToFactorAll( double, QPoint ) ) ); + connect( subWindow, SIGNAL( zoomFactorChanged_SWindow( const double, const QPoint ) ), + m_appModuleVideo, SLOT( zoomToFactorAll( double, QPoint ) ) ); connect( subWindow, SIGNAL( scrollBarMoved_SWindow( const QPoint ) ), m_appModuleVideo, SLOT( moveAllScrollBars( const QPoint ) ) ); @@ -241,8 +245,8 @@ Void PlaYUVerApp::loadFile( QString fileName, PlaYUVerStreamInfo* pStreamInfo ) catch( PlaYUVerFailure& e ) { videoSubWindow->close(); - QString warningMsg = - "Cannot open file " + QFileInfo( fileName ).fileName() + " with the following error: \n" + e.what(); + QString warningMsg = "Cannot open file " + QFileInfo( fileName ).fileName() + + " with the following error: \n" + e.what(); QMessageBox::warning( this, QApplication::applicationName(), warningMsg ); printMessage( warningMsg, LOG_ERROR ); } @@ -272,8 +276,8 @@ Void PlaYUVerApp::open() QStringList filter; filter << supported << formatsList << tr( "All Files (*)" ); - QStringList fileNameList = - QFileDialog::getOpenFileNames( this, tr( "Open File" ), m_cLastOpenPath, filter.join( ";;" ) ); + QStringList fileNameList = QFileDialog::getOpenFileNames( this, tr( "Open File" ), + m_cLastOpenPath, filter.join( ";;" ) ); for( Int i = 0; i < fileNameList.size(); i++ ) { @@ -317,7 +321,8 @@ Void PlaYUVerApp::save() QStringList filter; filter << supported << formatsList << tr( "All Files (*)" ); - QString fileName = QFileDialog::getSaveFileName( this, tr( "Open File" ), m_cLastOpenPath, filter.join( ";;" ) ); + QString fileName = QFileDialog::getSaveFileName( this, tr( "Open File" ), m_cLastOpenPath, + filter.join( ";;" ) ); if( !fileName.isEmpty() ) { @@ -329,8 +334,8 @@ Void PlaYUVerApp::save() catch( PlaYUVerFailure& e ) { QApplication::restoreOverrideCursor(); - QString warningMsg = - "Cannot save file " + QFileInfo( fileName ).fileName() + " with the following error: \n" + e.what(); + QString warningMsg = "Cannot save file " + QFileInfo( fileName ).fileName() + + " with the following error: \n" + e.what(); QMessageBox::warning( this, QApplication::applicationName(), warningMsg ); printMessage( warningMsg, LOG_ERROR ); return; @@ -353,7 +358,8 @@ Void PlaYUVerApp::format() } catch( PlaYUVerFailure& e ) { - QString warningMsg = "Cannot change format of " + QFileInfo( pcVideoSubWindow->getCurrentFileName() ).fileName() + + QString warningMsg = "Cannot change format of " + + QFileInfo( pcVideoSubWindow->getCurrentFileName() ).fileName() + " with the following error: \n" + e.what(); QMessageBox::warning( this, QApplication::applicationName(), warningMsg ); printMessage( warningMsg, LOG_ERROR ); @@ -384,7 +390,8 @@ Void PlaYUVerApp::reloadAll() for( UInt c = 0; c < 3; c++ ) { - QList subWindowList = m_pcWindowHandle->findSubWindow( windowCategoryOrder[c] ); + QList subWindowList = + m_pcWindowHandle->findSubWindow( windowCategoryOrder[c] ); for( Int i = 0; i < subWindowList.size(); i++ ) { subWindowList.at( i )->refreshSubWindow(); @@ -427,7 +434,8 @@ Void PlaYUVerApp::zoomToFit() Void PlaYUVerApp::zoomToFitAll() { VideoSubWindow* videoSubWindow; - QList subWindowList = m_pcWindowHandle->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); + QList subWindowList = + m_pcWindowHandle->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); for( Int i = 0; i < subWindowList.size(); i++ ) { videoSubWindow = qobject_cast( subWindowList.at( i ) ); @@ -494,7 +502,8 @@ VideoSubWindow* PlaYUVerApp::findVideoStreamSubWindow( const PlaYUVerSubWindowHa { QString canonicalFilePath = QFileInfo( fileName ).canonicalFilePath(); VideoSubWindow* pcSubWindow; - QList subWindowList = windowManager->findSubWindow( SubWindowAbstract::VIDEO_STREAM_SUBWINDOW ); + QList subWindowList = + windowManager->findSubWindow( SubWindowAbstract::VIDEO_STREAM_SUBWINDOW ); for( Int i = 0; i < subWindowList.size(); i++ ) { pcSubWindow = qobject_cast( subWindowList.at( i ) ); @@ -616,7 +625,8 @@ Void PlaYUVerApp::createActions() connect( m_arrayActions[SAVE_ACT], SIGNAL( triggered() ), this, SLOT( save() ) ); m_arrayActions[FORMAT_ACT] = new QAction( tr( "&Format" ), this ); - m_arrayActions[FORMAT_ACT]->setIcon( QIcon::fromTheme( "transform-scale", QIcon( ":/images/configuredialog.png" ) ) ); + m_arrayActions[FORMAT_ACT]->setIcon( + QIcon::fromTheme( "transform-scale", QIcon( ":/images/configuredialog.png" ) ) ); m_arrayActions[FORMAT_ACT]->setShortcut( Qt::CTRL + Qt::Key_F ); m_arrayActions[FORMAT_ACT]->setStatusTip( tr( "Open format dialog" ) ); connect( m_arrayActions[FORMAT_ACT], SIGNAL( triggered() ), this, SLOT( format() ) ); @@ -640,11 +650,13 @@ Void PlaYUVerApp::createActions() m_arrayActions[CLOSE_ACT] = new QAction( tr( "&Close" ), this ); m_arrayActions[CLOSE_ACT]->setIcon( style()->standardIcon( QStyle::SP_DialogCloseButton ) ); m_arrayActions[CLOSE_ACT]->setStatusTip( tr( "Close the active window" ) ); - connect( m_arrayActions[CLOSE_ACT], SIGNAL( triggered() ), m_pcWindowHandle, SLOT( removeActiveSubWindow() ) ); + connect( m_arrayActions[CLOSE_ACT], SIGNAL( triggered() ), m_pcWindowHandle, + SLOT( removeActiveSubWindow() ) ); m_arrayActions[CLOSEALL_ACT] = new QAction( tr( "Close &All" ), this ); m_arrayActions[CLOSEALL_ACT]->setStatusTip( tr( "Close all the windows" ) ); - connect( m_arrayActions[CLOSEALL_ACT], SIGNAL( triggered() ), m_pcWindowHandle, SLOT( removeAllSubWindow() ) ); + connect( m_arrayActions[CLOSEALL_ACT], SIGNAL( triggered() ), m_pcWindowHandle, + SLOT( removeAllSubWindow() ) ); m_arrayActions[EXIT_ACT] = new QAction( tr( "E&xit" ), this ); m_arrayActions[EXIT_ACT]->setShortcuts( QKeySequence::Quit ); @@ -656,32 +668,37 @@ Void PlaYUVerApp::createActions() connect( mapperZoom, SIGNAL( mapped( int ) ), this, SLOT( scaleFrame( int ) ) ); m_arrayActions[ZOOM_IN_ACT] = new QAction( tr( "Zoom &In (+25%)" ), this ); - m_arrayActions[ZOOM_IN_ACT]->setIcon( QIcon::fromTheme( "zoom-in", QIcon( ":/images/zoomin.png" ) ) ); + m_arrayActions[ZOOM_IN_ACT]->setIcon( + QIcon::fromTheme( "zoom-in", QIcon( ":/images/zoomin.png" ) ) ); m_arrayActions[ZOOM_IN_ACT]->setShortcut( tr( "Ctrl++" ) ); m_arrayActions[ZOOM_IN_ACT]->setStatusTip( tr( "Scale the image up by 25%" ) ); connect( m_arrayActions[ZOOM_IN_ACT], SIGNAL( triggered() ), mapperZoom, SLOT( map() ) ); mapperZoom->setMapping( m_arrayActions[ZOOM_IN_ACT], 125 ); m_arrayActions[ZOOM_OUT_ACT] = new QAction( tr( "Zoom &Out (-25%)" ), this ); - m_arrayActions[ZOOM_OUT_ACT]->setIcon( QIcon::fromTheme( "zoom-out", QIcon( ":/images/zoomout.png" ) ) ); + m_arrayActions[ZOOM_OUT_ACT]->setIcon( + QIcon::fromTheme( "zoom-out", QIcon( ":/images/zoomout.png" ) ) ); m_arrayActions[ZOOM_OUT_ACT]->setShortcut( tr( "Ctrl+-" ) ); m_arrayActions[ZOOM_OUT_ACT]->setStatusTip( tr( "Scale the image down by 25%" ) ); connect( m_arrayActions[ZOOM_OUT_ACT], SIGNAL( triggered() ), mapperZoom, SLOT( map() ) ); mapperZoom->setMapping( m_arrayActions[ZOOM_OUT_ACT], 80 ); m_arrayActions[ZOOM_NORMAL_ACT] = new QAction( tr( "&Normal Size" ), this ); - m_arrayActions[ZOOM_NORMAL_ACT]->setIcon( QIcon::fromTheme( "zoom-original", QIcon( ":/images/zoomtonormal.png" ) ) ); + m_arrayActions[ZOOM_NORMAL_ACT]->setIcon( + QIcon::fromTheme( "zoom-original", QIcon( ":/images/zoomtonormal.png" ) ) ); m_arrayActions[ZOOM_NORMAL_ACT]->setShortcut( tr( "Ctrl+N" ) ); m_arrayActions[ZOOM_NORMAL_ACT]->setStatusTip( tr( "Show the image at its original size" ) ); connect( m_arrayActions[ZOOM_NORMAL_ACT], SIGNAL( triggered() ), this, SLOT( normalSize() ) ); m_arrayActions[ZOOM_FIT_ACT] = new QAction( tr( "Zoom to &Fit" ), this ); - m_arrayActions[ZOOM_FIT_ACT]->setIcon( QIcon::fromTheme( "zoom-fit-best", QIcon( ":/images/fittowindow.png" ) ) ); + m_arrayActions[ZOOM_FIT_ACT]->setIcon( + QIcon::fromTheme( "zoom-fit-best", QIcon( ":/images/fittowindow.png" ) ) ); m_arrayActions[ZOOM_FIT_ACT]->setStatusTip( tr( "Zoom in or out to fit on the window." ) ); connect( m_arrayActions[ZOOM_FIT_ACT], SIGNAL( triggered() ), this, SLOT( zoomToFit() ) ); m_arrayActions[ZOOM_FIT_ALL_ACT] = new QAction( tr( "Zoom to Fit All" ), this ); - // m_arrayActions[ZOOM_FIT_ALL_ACT]->setIcon( QIcon::fromTheme( "zoom-fit-best", QIcon( ":/images/fittowindow.png" ) ) + // m_arrayActions[ZOOM_FIT_ALL_ACT]->setIcon( QIcon::fromTheme( + // "zoom-fit-best", QIcon( ":/images/fittowindow.png" ) ) // ); m_arrayActions[ZOOM_FIT_ALL_ACT]->setStatusTip( tr( "Apply zoom to fit to all windows" ) ); connect( m_arrayActions[ZOOM_FIT_ALL_ACT], SIGNAL( triggered() ), this, SLOT( zoomToFitAll() ) ); @@ -791,7 +808,8 @@ Void PlaYUVerApp::createToolBars() m_pcZoomFactorSBox->setSingleStep( 10.0 ); m_pcZoomFactorSBox->setValue( 100.0 ); m_pcZoomFactorSBox->setSuffix( "%" ); - connect( m_pcZoomFactorSBox, SIGNAL( valueChanged( double ) ), this, SLOT( zoomFromSBox( double ) ) ); + connect( m_pcZoomFactorSBox, SIGNAL( valueChanged( double ) ), this, + SLOT( zoomFromSBox( double ) ) ); m_arrayToolBars[VIEW_TOOLBAR]->addWidget( m_pcZoomFactorSBox ); m_arrayToolBars[VIEW_TOOLBAR]->addAction( m_arrayActions[ZOOM_IN_ACT] ); m_arrayToolBars[VIEW_TOOLBAR]->addAction( m_arrayActions[ZOOM_OUT_ACT] ); diff --git a/app/PlaYUVerApp.h b/app/PlaYUVerApp.h index 996ea2e..3edfbe6 100644 --- a/app/PlaYUVerApp.h +++ b/app/PlaYUVerApp.h @@ -36,11 +36,11 @@ #ifndef __PLAYUVERAPP_H__ #define __PLAYUVERAPP_H__ +#include "PlaYUVerAppDefs.h" #include "config.h" #include -#include #include -#include "PlaYUVerAppDefs.h" +#include #ifdef USE_QTDBUS #include "PlaYUVerAppAdaptor.h" #endif diff --git a/app/PlaYUVerAppAdaptor.cpp b/app/PlaYUVerAppAdaptor.cpp index 806089a..bdddbbb 100644 --- a/app/PlaYUVerAppAdaptor.cpp +++ b/app/PlaYUVerAppAdaptor.cpp @@ -22,11 +22,12 @@ * \brief Define function to manage the interface in DBus */ -#include #include "PlaYUVerAppAdaptor.h" #include "PlaYUVerApp.h" +#include -PlaYUVerAppAdaptor::PlaYUVerAppAdaptor( PlaYUVerApp* app ) : QDBusAbstractAdaptor( app ), m_app( app ) +PlaYUVerAppAdaptor::PlaYUVerAppAdaptor( PlaYUVerApp* app ) + : QDBusAbstractAdaptor( app ), m_app( app ) { // application dbus interface QDBusConnection::sessionBus().registerObject( QStringLiteral( PLAYUVER_DBUS_PATH ), this, diff --git a/app/PlaYUVerAppAdaptor.h b/app/PlaYUVerAppAdaptor.h index 8853485..d57236a 100644 --- a/app/PlaYUVerAppAdaptor.h +++ b/app/PlaYUVerAppAdaptor.h @@ -29,8 +29,8 @@ #include #include #include -#include #include +#include #define PLAYUVER_DBUS_SESSION_NAME "org.pixlra.PlaYUVer.application" #define PLAYUVER_DBUS_PATH "/MainApplication" @@ -68,7 +68,8 @@ class PlaYUVerAppAdaptor : public QDBusAbstractAdaptor Q_SIGNALS: /** * Notify the world that this kate instance is exiting. - * All apps should stop using the dbus interface of this instance after this signal got emitted. + * All apps should stop using the dbus interface of this instance after this + * signal got emitted. */ // void exiting(); // void documentClosed(const QString &token); diff --git a/app/PlaYUVerAppModuleIf.cpp b/app/PlaYUVerAppModuleIf.cpp index 5d334a6..7eed200 100644 --- a/app/PlaYUVerAppModuleIf.cpp +++ b/app/PlaYUVerAppModuleIf.cpp @@ -26,16 +26,18 @@ #include "VideoSubWindow.h" #include "VideoSubWindow.h" -PlaYUVerAppModuleIf::PlaYUVerAppModuleIf( QObject* parent, QAction* action, PlaYUVerModuleIf* module ) - : m_bIsRunning( false ), - m_pcModuleAction( action ), - m_pcModule( module ), - m_pcDisplaySubWindow( NULL ), - m_pcDockWidget( NULL ), - m_pcModuleDock( NULL ), - m_pcModuleStream( NULL ), - m_pcProcessedFrame( NULL ), - m_dMeasurementResult( 0 ) +PlaYUVerAppModuleIf::PlaYUVerAppModuleIf( QObject* parent, + QAction* action, + PlaYUVerModuleIf* module ) + : m_bIsRunning( false ) + , m_pcModuleAction( action ) + , m_pcModule( module ) + , m_pcDisplaySubWindow( NULL ) + , m_pcDockWidget( NULL ) + , m_pcModuleDock( NULL ) + , m_pcModuleStream( NULL ) + , m_pcProcessedFrame( NULL ) + , m_dMeasurementResult( 0 ) { setParent( parent ); for( Int i = 0; i < MODULE_REQUIRES_MAX_NUM_FRAMES; i++ ) diff --git a/app/PlaYUVerAppModuleIf.h b/app/PlaYUVerAppModuleIf.h index c5dbc9a..4483e27 100644 --- a/app/PlaYUVerAppModuleIf.h +++ b/app/PlaYUVerAppModuleIf.h @@ -25,15 +25,15 @@ #ifndef __PLAYUVERAPPMODULESIF_H__ #define __PLAYUVERAPPMODULESIF_H__ -#include "config.h" -#include "PlaYUVerAppDefs.h" -#include -#include -#include -#include "lib/PlaYUVerFrame.h" -#include "lib/PlaYUVerStream.h" #include "ModuleHandleDock.h" +#include "PlaYUVerAppDefs.h" +#include "config.h" +#include "lib/PlaYUVerFrame.h" #include "lib/PlaYUVerModuleIf.h" +#include "lib/PlaYUVerStream.h" +#include +#include +#include class QAction; diff --git a/app/PlaYUVerMdiSubWindow.cpp b/app/PlaYUVerMdiSubWindow.cpp index efac05e..230a2bb 100644 --- a/app/PlaYUVerMdiSubWindow.cpp +++ b/app/PlaYUVerMdiSubWindow.cpp @@ -22,9 +22,9 @@ * \brief Re-implementation QMdiSubWindow */ -#include #include "PlaYUVerMdiSubWindow.h" #include "SubWindowAbstract.h" +#include PlaYUVerMdiSubWindow::PlaYUVerMdiSubWindow( QWidget* parent ) : QMdiSubWindow( parent ) { diff --git a/app/PlaYUVerMdiSubWindow.h b/app/PlaYUVerMdiSubWindow.h index 6a74a4a..f622de7 100644 --- a/app/PlaYUVerMdiSubWindow.h +++ b/app/PlaYUVerMdiSubWindow.h @@ -25,8 +25,8 @@ #ifndef __PLAYUVERMDISUBWINDOW_H__ #define __PLAYUVERMDISUBWINDOW_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" #include class PlaYUVerMdiSubWindow : public QMdiSubWindow diff --git a/app/PlaYUVerSubWindowHandle.cpp b/app/PlaYUVerSubWindowHandle.cpp index e351e12..8132375 100644 --- a/app/PlaYUVerSubWindowHandle.cpp +++ b/app/PlaYUVerSubWindowHandle.cpp @@ -43,7 +43,8 @@ class PlaYUVerMdiArea : public QMdiArea { public: - PlaYUVerMdiArea( QWidget* parent = 0 ) : QMdiArea( parent ), m_pixmapLogo( ":/images/playuver-backgroud-logo.png" ) + PlaYUVerMdiArea( QWidget* parent = 0 ) + : QMdiArea( parent ), m_pixmapLogo( ":/images/playuver-backgroud-logo.png" ) { setBackgroundRole( QPalette::Background ); } @@ -69,7 +70,8 @@ class PlaYUVerMdiArea : public QMdiArea // for( Int i = 0; i < m_acLogMessages.size(); i++ ) // { - // painter.drawText( 5, height() - 5 - i * 15, m_acLogMessages.at( i ) ); + // painter.drawText( 5, height() - 5 - i * 15, m_acLogMessages.at( i ) + // ); // } // QPoint bottomLeftCorner( 0, viewport()->height() ); } @@ -118,8 +120,8 @@ Void PlaYUVerSubWindowHandle::resetWindowMode() } for( Int i = 0; i < m_apcMdiSubWindowList.size(); i++ ) { - disconnect( m_apcMdiSubWindowList.at( i ), SIGNAL( aboutToClose( PlaYUVerMdiSubWindow* ) ), this, - SLOT( removeMdiSubWindow( PlaYUVerMdiSubWindow* ) ) ); + disconnect( m_apcMdiSubWindowList.at( i ), SIGNAL( aboutToClose( PlaYUVerMdiSubWindow* ) ), + this, SLOT( removeMdiSubWindow( PlaYUVerMdiSubWindow* ) ) ); m_apcMdiSubWindowList.at( i )->close(); } m_apcMdiSubWindowList.clear(); @@ -161,7 +163,8 @@ Void PlaYUVerSubWindowHandle::setWindowMode( Int iWindowMode ) setVisible( true ); m_pcMdiArea = new PlaYUVerMdiArea; m_pcMdiArea->setActivationOrder( QMdiArea::ActivationHistoryOrder ); - connect( m_pcMdiArea, SIGNAL( subWindowActivated( QMdiSubWindow* ) ), this, SLOT( updateActiveSubWindow() ) ); + connect( m_pcMdiArea, SIGNAL( subWindowActivated( QMdiSubWindow* ) ), this, + SLOT( updateActiveSubWindow() ) ); m_pcWindowManagerLayout = new QHBoxLayout( this ); m_pcWindowManagerLayout->addWidget( m_pcMdiArea ); setLayout( m_pcWindowManagerLayout ); @@ -174,7 +177,8 @@ Void PlaYUVerSubWindowHandle::setWindowMode( Int iWindowMode ) // m_pcApp->resize( m_cMdiModeWindowSize ); if( m_pcActiveWindow ) { - m_pcApp->setWindowTitle( QApplication::applicationName() + " :: " + m_pcActiveWindow->getWindowName() ); + m_pcApp->setWindowTitle( QApplication::applicationName() + " :: " + + m_pcActiveWindow->getWindowName() ); } } m_iWindowMode = iWindowMode; @@ -201,7 +205,8 @@ Void PlaYUVerSubWindowHandle::updateActiveSubWindow( SubWindowAbstract* window ) if( mdiSubWindow ) { QWidget* activeWidget = m_pcMdiArea->activeSubWindow()->widget(); - Int windowIdx = m_apcSubWindowList.indexOf( qobject_cast( activeWidget ) ); + Int windowIdx = + m_apcSubWindowList.indexOf( qobject_cast( activeWidget ) ); if( windowIdx >= 0 ) { m_pcActiveWindow = m_apcSubWindowList.at( windowIdx ); @@ -210,7 +215,8 @@ Void PlaYUVerSubWindowHandle::updateActiveSubWindow( SubWindowAbstract* window ) } if( m_pcActiveWindow ) { - m_pcApp->setWindowTitle( QApplication::applicationName() + " :: " + m_pcActiveWindow->getWindowName() ); + m_pcApp->setWindowTitle( QApplication::applicationName() + " :: " + + m_pcActiveWindow->getWindowName() ); } } } @@ -230,7 +236,8 @@ Void PlaYUVerSubWindowHandle::addSubWindow( SubWindowAbstract* window, Qt::Windo { if( window ) { - connect( window, SIGNAL( updateStatusBar( const QString& ) ), m_pcApp, SLOT( printMessage( const QString& ) ) ); + connect( window, SIGNAL( updateStatusBar( const QString& ) ), m_pcApp, + SLOT( printMessage( const QString& ) ) ); connect( window, SIGNAL( zoomFactorChanged_SWindow( const double, const QPoint ) ), m_pcApp, SLOT( updateZoomFactorSBox() ) ); if( m_iWindowMode == DETACHEDSUBWINDOWMODE ) @@ -339,7 +346,8 @@ QList PlaYUVerSubWindowHandle::findSubWindow( const QString& return apcSubWindowList; } -SubWindowAbstract* PlaYUVerSubWindowHandle::findSubWindow( const SubWindowAbstract* subWindow ) const +SubWindowAbstract* PlaYUVerSubWindowHandle::findSubWindow( + const SubWindowAbstract* subWindow ) const { QList subWindowList = findSubWindow(); for( Int i = 0; i < subWindowList.size(); i++ ) @@ -418,7 +426,8 @@ Void PlaYUVerSubWindowHandle::tileSubWindows() } QSize totalWindowsSize( screenSize.width(), screenSize.height() - topLeftCornerWindow.y() ); - QSize windowsSize( totalWindowsSize.width() / numberTillingColumns, totalWindowsSize.height() / numberTillingRows ); + QSize windowsSize( totalWindowsSize.width() / numberTillingColumns, + totalWindowsSize.height() / numberTillingRows ); QPoint windowRelativePos; for( Int i = 0; i < m_apcSubWindowList.size(); i++ ) { @@ -445,7 +454,8 @@ Void PlaYUVerSubWindowHandle::cascadeSubWindows() Void PlaYUVerSubWindowHandle::createActions() { m_mapperWindow = new QSignalMapper( this ); - connect( m_mapperWindow, SIGNAL( mapped( QWidget* ) ), this, SLOT( setActiveSubWindow( QWidget* ) ) ); + connect( m_mapperWindow, SIGNAL( mapped( QWidget* ) ), this, + SLOT( setActiveSubWindow( QWidget* ) ) ); m_arrayActions.resize( TOTAL_ACT ); @@ -459,13 +469,16 @@ Void PlaYUVerSubWindowHandle::createActions() m_arrayActions[NORMAL_SUBWINDOW_MODE_ACT] = new QAction( tr( "&Detached SubWindows" ), this ); m_arrayActions[NORMAL_SUBWINDOW_MODE_ACT]->setCheckable( true ); m_actionGroupWindowMode->addAction( m_arrayActions[NORMAL_SUBWINDOW_MODE_ACT] ); - connect( m_arrayActions[NORMAL_SUBWINDOW_MODE_ACT], SIGNAL( triggered() ), m_mapperWindowMode, SLOT( map() ) ); - m_mapperWindowMode->setMapping( m_arrayActions[NORMAL_SUBWINDOW_MODE_ACT], DETACHEDSUBWINDOWMODE ); + connect( m_arrayActions[NORMAL_SUBWINDOW_MODE_ACT], SIGNAL( triggered() ), m_mapperWindowMode, + SLOT( map() ) ); + m_mapperWindowMode->setMapping( m_arrayActions[NORMAL_SUBWINDOW_MODE_ACT], + DETACHEDSUBWINDOWMODE ); m_arrayActions[MDI_SUBWINDOW_MODE_ACT] = new QAction( "&MDI SubWindows", this ); m_arrayActions[MDI_SUBWINDOW_MODE_ACT]->setCheckable( true ); m_actionGroupWindowMode->addAction( m_arrayActions[MDI_SUBWINDOW_MODE_ACT] ); - connect( m_arrayActions[MDI_SUBWINDOW_MODE_ACT], SIGNAL( triggered() ), m_mapperWindowMode, SLOT( map() ) ); + connect( m_arrayActions[MDI_SUBWINDOW_MODE_ACT], SIGNAL( triggered() ), m_mapperWindowMode, + SLOT( map() ) ); m_mapperWindowMode->setMapping( m_arrayActions[MDI_SUBWINDOW_MODE_ACT], MDISUBWINDOWMODE ); m_actionGroupWindowMode->actions().at( m_iWindowMode )->setChecked( true ); @@ -473,40 +486,51 @@ Void PlaYUVerSubWindowHandle::createActions() m_arrayActions[CLOSE_ACT] = new QAction( tr( "&Close" ), this ); m_arrayActions[CLOSE_ACT]->setIcon( style()->standardIcon( QStyle::SP_DialogCloseButton ) ); m_arrayActions[CLOSE_ACT]->setStatusTip( tr( "Close the active window" ) ); - connect( m_arrayActions[CLOSE_ACT], SIGNAL( triggered() ), this, SLOT( removeActiveSubWindow() ) ); + connect( m_arrayActions[CLOSE_ACT], SIGNAL( triggered() ), this, + SLOT( removeActiveSubWindow() ) ); m_arrayActions[CLOSE_ACT] = new QAction( tr( "&Close" ), this ); m_arrayActions[CLOSE_ACT]->setIcon( style()->standardIcon( QStyle::SP_DialogCloseButton ) ); m_arrayActions[CLOSE_ACT]->setStatusTip( tr( "Close the active window" ) ); - connect( m_arrayActions[CLOSE_ACT], SIGNAL( triggered() ), this, SLOT( removeActiveSubWindow() ) ); + connect( m_arrayActions[CLOSE_ACT], SIGNAL( triggered() ), this, + SLOT( removeActiveSubWindow() ) ); m_arrayActions[CLOSE_ALL_ACT] = new QAction( tr( "Close &All" ), this ); m_arrayActions[CLOSE_ALL_ACT]->setStatusTip( tr( "Close all the windows" ) ); - connect( m_arrayActions[CLOSE_ALL_ACT], SIGNAL( triggered() ), this, SLOT( removeAllSubWindow() ) ); + connect( m_arrayActions[CLOSE_ALL_ACT], SIGNAL( triggered() ), this, + SLOT( removeAllSubWindow() ) ); m_arrayActions[TILE_WINDOWS_ACT] = new QAction( tr( "Tile" ), this ); m_arrayActions[TILE_WINDOWS_ACT]->setIcon( QIcon( ":images/windowstile.png" ) ); m_arrayActions[TILE_WINDOWS_ACT]->setStatusTip( tr( "Tile the windows" ) ); m_arrayActions[TILE_WINDOWS_ACT]->setShortcut( tr( "Ctrl+T" ) ); - // connect( m_arrayActions[TILE_WINDOWS_ACT], SIGNAL( triggered() ), mdiArea, SLOT( tileSubWindows() ) ); - connect( m_arrayActions[TILE_WINDOWS_ACT], SIGNAL( triggered() ), this, SLOT( tileSubWindows() ) ); + // connect( m_arrayActions[TILE_WINDOWS_ACT], SIGNAL( triggered() ), mdiArea, + // SLOT( tileSubWindows() ) ); + connect( m_arrayActions[TILE_WINDOWS_ACT], SIGNAL( triggered() ), this, + SLOT( tileSubWindows() ) ); m_arrayActions[CASCADE_WINDOWS_ACT] = new QAction( tr( "Cascade" ), this ); m_arrayActions[CASCADE_WINDOWS_ACT]->setIcon( QIcon( ":images/windowscascade.png" ) ); m_arrayActions[CASCADE_WINDOWS_ACT]->setStatusTip( tr( "Cascade the windows" ) ); - connect( m_arrayActions[CASCADE_WINDOWS_ACT], SIGNAL( triggered() ), this, SLOT( cascadeSubWindows() ) ); + connect( m_arrayActions[CASCADE_WINDOWS_ACT], SIGNAL( triggered() ), this, + SLOT( cascadeSubWindows() ) ); m_arrayActions[NEXT_WINDOWS_ACT] = new QAction( tr( "Ne&xt" ), this ); m_arrayActions[NEXT_WINDOWS_ACT]->setShortcuts( QKeySequence::NextChild ); - m_arrayActions[NEXT_WINDOWS_ACT]->setIcon( QIcon( style()->standardIcon( QStyle::SP_ArrowRight ) ) ); + m_arrayActions[NEXT_WINDOWS_ACT]->setIcon( + QIcon( style()->standardIcon( QStyle::SP_ArrowRight ) ) ); m_arrayActions[NEXT_WINDOWS_ACT]->setStatusTip( tr( "Move the focus to the next window" ) ); - // connect( m_arrayActions[NEXT_WINDOWS_ACT], SIGNAL( triggered() ), this, SLOT( activateNextSubWindow() ) ); + // connect( m_arrayActions[NEXT_WINDOWS_ACT], SIGNAL( triggered() ), this, + // SLOT( activateNextSubWindow() ) ); m_arrayActions[PREVIOUS_WINDOWS_ACT] = new QAction( tr( "Pre&vious" ), this ); m_arrayActions[PREVIOUS_WINDOWS_ACT]->setShortcuts( QKeySequence::PreviousChild ); - m_arrayActions[PREVIOUS_WINDOWS_ACT]->setIcon( QIcon( style()->standardIcon( QStyle::SP_ArrowLeft ) ) ); - m_arrayActions[PREVIOUS_WINDOWS_ACT]->setStatusTip( tr( "Move the focus to the previous window" ) ); - // connect( m_arrayActions[PREVIOUS_WINDOWS_ACT], SIGNAL( triggered() ), this, SLOT( activatePreviousSubWindow() ) ); + m_arrayActions[PREVIOUS_WINDOWS_ACT]->setIcon( + QIcon( style()->standardIcon( QStyle::SP_ArrowLeft ) ) ); + m_arrayActions[PREVIOUS_WINDOWS_ACT]->setStatusTip( + tr( "Move the focus to the previous window" ) ); + // connect( m_arrayActions[PREVIOUS_WINDOWS_ACT], SIGNAL( triggered() ), + // this, SLOT( activatePreviousSubWindow() ) ); m_arrayActions[SEPARATOR_ACT] = new QAction( this ); m_arrayActions[SEPARATOR_ACT]->setSeparator( true ); @@ -574,8 +598,10 @@ Void PlaYUVerSubWindowHandle::updateMenu() Void PlaYUVerSubWindowHandle::readSettings() { QSettings appSettings; - m_cMdiModeWindowPosition = appSettings.value( "SubWindowManager/LastMdiPosition", QPoint( 200, 200 ) ).toPoint(); - m_cMdiModeWindowSize = appSettings.value( "SubWindowManager/LastMdiSize", QSize( 500, 400 ) ).toSize(); + m_cMdiModeWindowPosition = + appSettings.value( "SubWindowManager/LastMdiPosition", QPoint( 200, 200 ) ).toPoint(); + m_cMdiModeWindowSize = + appSettings.value( "SubWindowManager/LastMdiSize", QSize( 500, 400 ) ).toSize(); Int iWindowMode = appSettings.value( "SubWindowManager/SubWindowMode", MDISUBWINDOWMODE ).toInt(); setWindowMode( iWindowMode ); m_actionGroupWindowMode->actions().at( iWindowMode )->setChecked( true ); diff --git a/app/PlaYUVerSubWindowHandle.h b/app/PlaYUVerSubWindowHandle.h index 240f160..5865e02 100644 --- a/app/PlaYUVerSubWindowHandle.h +++ b/app/PlaYUVerSubWindowHandle.h @@ -25,9 +25,9 @@ #ifndef __PLAYUVERSUBWINDOWHANDLE_H__ #define __PLAYUVERSUBWINDOWHANDLE_H__ +#include #include #include -#include #include "PlaYUVerAppDefs.h" diff --git a/app/PlotSubWindow.cpp b/app/PlotSubWindow.cpp index 9cfb771..6d26720 100644 --- a/app/PlotSubWindow.cpp +++ b/app/PlotSubWindow.cpp @@ -92,16 +92,20 @@ PlotSubWindow::PlotSubWindow( const QString& windowTitle, QWidget* parent ) m_cPlotArea->xAxis2->setTickLabels( false ); m_cPlotArea->yAxis2->setVisible( true ); m_cPlotArea->yAxis2->setTickLabels( false ); - // make left and bottom axes always transfer their ranges to right and top axes: - connect( m_cPlotArea->xAxis, SIGNAL( rangeChanged( QCPRange ) ), m_cPlotArea->xAxis2, SLOT( setRange( QCPRange ) ) ); - connect( m_cPlotArea->yAxis, SIGNAL( rangeChanged( QCPRange ) ), m_cPlotArea->yAxis2, SLOT( setRange( QCPRange ) ) ); + // make left and bottom axes always transfer their ranges to right and top + // axes: + connect( m_cPlotArea->xAxis, SIGNAL( rangeChanged( QCPRange ) ), m_cPlotArea->xAxis2, + SLOT( setRange( QCPRange ) ) ); + connect( m_cPlotArea->yAxis, SIGNAL( rangeChanged( QCPRange ) ), m_cPlotArea->yAxis2, + SLOT( setRange( QCPRange ) ) ); QFont legendFont = font(); // start out with MainWindow's font.. legendFont.setPointSize( 9 ); // and make a bit smaller for legend m_cPlotArea->legend->setFont( legendFont ); m_cPlotArea->legend->setBrush( backgroundBrush ); m_cPlotArea->legend->setTextColor( palette().text().color() ); - m_cPlotArea->legend->setBorderPen( QPen( palette().brush( QPalette::Active, QPalette::Shadow ), 1 ) ); + m_cPlotArea->legend->setBorderPen( + QPen( palette().brush( QPalette::Active, QPalette::Shadow ), 1 ) ); m_cPlotArea->legend->setVisible( false ); m_cPlotArea->setInteractions( QCP::iRangeZoom | QCP::iRangeDrag ); // QCP::iSelectPlottables @@ -148,8 +152,10 @@ Void PlotSubWindow::scaleView( Double scale, QPoint center ) // for( UInt dim = 0; dim < 2; dim++ ) // aNewAxisRange[axis][dim] = m_aAxisRange[axis][dim] / m_dScaleFactor; // - // m_cPlotArea->xAxis->setRange( aNewAxisRange[HORIZONTAL][0], aNewAxisRange[HORIZONTAL][1] ); - // m_cPlotArea->yAxis->setRange( aNewAxisRange[VERTICAL][0], aNewAxisRange[VERTICAL][1] ); + // m_cPlotArea->xAxis->setRange( aNewAxisRange[HORIZONTAL][0], + // aNewAxisRange[HORIZONTAL][1] ); + // m_cPlotArea->yAxis->setRange( aNewAxisRange[VERTICAL][0], + // aNewAxisRange[VERTICAL][1] ); m_cPlotArea->xAxis->scaleRange( scale, 0 ); m_cPlotArea->yAxis->scaleRange( scale, 0 ); @@ -188,7 +194,9 @@ Void PlotSubWindow::setAxisRange( const QLine& axisLimits ) setAxisRange( VERTICAL, axisLimits.y1(), axisLimits.y2() ); } -Void PlotSubWindow::setAxisRange( PlotSubWindow::Axis eAxis, const Int& axisStart, const Int& axisEnd ) +Void PlotSubWindow::setAxisRange( PlotSubWindow::Axis eAxis, + const Int& axisStart, + const Int& axisEnd ) { if( eAxis == HORIZONTAL ) { @@ -207,7 +215,9 @@ Void PlotSubWindow::setAxisRange( PlotSubWindow::Axis eAxis, const Int& axisStar m_cPlotArea->replot(); } -Void PlotSubWindow::addPlot( const QVector& arrayX, const QVector& arrayY, const QString& key ) +Void PlotSubWindow::addPlot( const QVector& arrayX, + const QVector& arrayY, + const QString& key ) { QCPGraph* newPlot = m_cPlotArea->addGraph(); QColor plotColor = m_arrayColorList.at( 0 ); @@ -219,7 +229,8 @@ Void PlotSubWindow::addPlot( const QVector& arrayX, const QVectorsetPen( m_cPlotPen ); // line style // pass data points to graphs: newPlot->setData( arrayX, arrayY ); - // let the ranges scale themselves so graph 0 fits perfectly in the visible area: + // let the ranges scale themselves so graph 0 fits perfectly in the visible + // area: newPlot->rescaleAxes( m_iNumberPlots > 1 ? true : false ); if( !key.isEmpty() ) diff --git a/app/PlotSubWindow.h b/app/PlotSubWindow.h index 2f35501..8d5780d 100644 --- a/app/PlotSubWindow.h +++ b/app/PlotSubWindow.h @@ -25,8 +25,8 @@ #ifndef __PLOTWINDOWHANDLE_H__ #define __PLOTWINDOWHANDLE_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" #if( QT_VERSION_PLAYUVER == 5 ) #include #elif( QT_VERSION_PLAYUVER == 4 ) @@ -84,7 +84,9 @@ class PlotSubWindow : public SubWindowAbstract Void setKey( const QString& key ); - Void addPlot( const QVector& arrayX, const QVector& arrayY, const QString& key = QString() ); + Void addPlot( const QVector& arrayX, + const QVector& arrayY, + const QString& key = QString() ); }; #endif // __PLOTWINDOWHANDLE_H__ diff --git a/app/ProgressBar.cpp b/app/ProgressBar.cpp index b37c06d..237e7c9 100644 --- a/app/ProgressBar.cpp +++ b/app/ProgressBar.cpp @@ -24,10 +24,10 @@ #include "ProgressBar.h" #include -#include -#include -#include #include +#include +#include +#include ProgressBar::ProgressBar( QWidget* parent, UInt maxValue ) : QWidget( parent ), m_uiTotalProgress( maxValue ), m_uiProgress( 0 ) diff --git a/app/ProgressBar.h b/app/ProgressBar.h index 7a10a21..5a4079a 100644 --- a/app/ProgressBar.h +++ b/app/ProgressBar.h @@ -26,8 +26,8 @@ #define __PROGRESSBAR_H__ #include "PlaYUVerAppDefs.h" -#include #include +#include class QProgressBar; diff --git a/app/QualityHandle.cpp b/app/QualityHandle.cpp index 03f6dbe..976776c 100644 --- a/app/QualityHandle.cpp +++ b/app/QualityHandle.cpp @@ -22,14 +22,14 @@ * \brief Definition of the quality measurement sidebar */ -#include -#include "lib/LibMemory.h" -#include "PlaYUVerSubWindowHandle.h" #include "QualityHandle.h" -#include "VideoSubWindow.h" -#include "PlotSubWindow.h" #include "DialogSubWindowSelector.h" +#include "PlaYUVerSubWindowHandle.h" +#include "PlotSubWindow.h" #include "ProgressBar.h" +#include "VideoSubWindow.h" +#include "lib/LibMemory.h" +#include #if( QT_VERSION_PLAYUVER == 5 ) #include "QtConcurrent/qtconcurrentrun.h" #endif @@ -63,12 +63,15 @@ Void QualityHandle::createActions() m_arrayActions.resize( TOTAL_ACT ); m_arrayActions[SELECT_CURR_REF_ACT] = new QAction( "Mark as Reference", this ); - connect( m_arrayActions[SELECT_CURR_REF_ACT], SIGNAL( triggered() ), this, SLOT( slotSelectCurrentAsReference() ) ); + connect( m_arrayActions[SELECT_CURR_REF_ACT], SIGNAL( triggered() ), this, + SLOT( slotSelectCurrentAsReference() ) ); m_arrayActions[PLOT_QUALITY] = new QAction( "Plot Window's Quality", this ); - connect( m_arrayActions[PLOT_QUALITY], SIGNAL( triggered() ), this, SLOT( slotPlotQualitySingle() ) ); + connect( m_arrayActions[PLOT_QUALITY], SIGNAL( triggered() ), this, + SLOT( slotPlotQualitySingle() ) ); m_arrayActions[PLOT_SEVERAL_QUALITY] = new QAction( "Plot Several Quality", this ); - connect( m_arrayActions[PLOT_SEVERAL_QUALITY], SIGNAL( triggered() ), this, SLOT( slotPlotQualitySeveral() ) ); + connect( m_arrayActions[PLOT_SEVERAL_QUALITY], SIGNAL( triggered() ), this, + SLOT( slotPlotQualitySeveral() ) ); } QMenu* QualityHandle::createMenu() @@ -92,7 +95,8 @@ QDockWidget* QualityHandle::createDock() connect( m_pcQualityHandleSideBar, SIGNAL( signalQualityMetricChanged( int ) ), this, SLOT( slotQualityMetricChanged( int ) ) ); - connect( m_mapperQualityMetric, SIGNAL( mapped( int ) ), this, SLOT( slotQualityMetricChanged( int ) ) ); + connect( m_mapperQualityMetric, SIGNAL( mapped( int ) ), this, + SLOT( slotQualityMetricChanged( int ) ) ); slotQualityMetricChanged( 0 ); @@ -101,7 +105,8 @@ QDockWidget* QualityHandle::createDock() Void QualityHandle::updateMenus() { - VideoSubWindow* pcCurrentVideoSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcCurrentVideoSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); Bool hasSubWindow = pcCurrentVideoSubWindow ? true : false; Bool hasReference = false; Bool isReference = false; @@ -196,7 +201,8 @@ Void QualityHandle::measureQuality( QVector apcWindowList ) for( UInt i = 0; i < numberOfWindows; i++ ) { pcCurrFrame = apcWindowList.at( i )->getCurrFrame(); - padQualityValues[i + 1].append( pcCurrFrame->getQuality( m_iQualityMetricIdx, pcReferenceFrame, LUMA ) ); + padQualityValues[i + 1].append( + pcCurrFrame->getQuality( m_iQualityMetricIdx, pcReferenceFrame, LUMA ) ); apcWindowList.at( i )->seekRelativeEvent( true ); } pcReferenceWindow->seekRelativeEvent( true ); @@ -215,7 +221,8 @@ Void QualityHandle::measureQuality( QVector apcWindowList ) } PlotSubWindow* pcPlotWindow = new PlotSubWindow( plotWindowTitle ); pcPlotWindow->setAxisName( - "Frame Number", QString::fromStdString( PlaYUVerFrame::supportedQualityMetricsList()[m_iQualityMetricIdx] ) ); + "Frame Number", + QString::fromStdString( PlaYUVerFrame::supportedQualityMetricsList()[m_iQualityMetricIdx] ) ); if( apcWindowList.size() > 1 ) { @@ -247,7 +254,8 @@ Void QualityHandle::slotQualityMetricChanged( Int idx ) Void QualityHandle::slotSelectCurrentAsReference() { - VideoSubWindow* pcRefSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcRefSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); if( pcRefSubWindow ) { VideoSubWindow* pcVideoSubWindow; @@ -267,7 +275,8 @@ Void QualityHandle::slotSelectCurrentAsReference() Void QualityHandle::slotPlotQualitySingle() { - VideoSubWindow* pcSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); if( pcSubWindow ) { if( pcSubWindow->getRefSubWindow() ) @@ -277,7 +286,8 @@ Void QualityHandle::slotPlotQualitySingle() //#ifndef QT_NO_CONCURRENT // m_cMeasurementResult.waitForFinished(); - // m_cMeasurementResult = QtConcurrent::run( this, &QualityHandle::measureQuality, apcWindowList ); + // m_cMeasurementResult = QtConcurrent::run( this, + // &QualityHandle::measureQuality, apcWindowList ); //#else QApplication::setOverrideCursor( Qt::WaitCursor ); measureQuality( apcWindowList ); @@ -290,7 +300,8 @@ Void QualityHandle::slotPlotQualitySingle() Void QualityHandle::slotPlotQualitySeveral() { - VideoSubWindow* pcSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); if( pcSubWindow ) { QVector apcWindowList; @@ -317,7 +328,8 @@ Void QualityHandle::slotPlotQualitySeveral() { //#ifndef QT_NO_CONCURRENT // m_cMeasurementResult.waitForFinished(); - // m_cMeasurementResult = QtConcurrent::run( this, &QualityHandle::measureQuality, apcWindowList ); + // m_cMeasurementResult = QtConcurrent::run( this, + // &QualityHandle::measureQuality, apcWindowList ); //#else QApplication::setOverrideCursor( Qt::WaitCursor ); measureQuality( apcWindowList ); diff --git a/app/QualityHandle.h b/app/QualityHandle.h index 9b14912..d36c97b 100644 --- a/app/QualityHandle.h +++ b/app/QualityHandle.h @@ -25,8 +25,8 @@ #ifndef __QUALITYMEASUREMENT_H__ #define __QUALITYMEASUREMENT_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" #include #if( QT_VERSION_PLAYUVER == 5 ) #include diff --git a/app/QualityMeasurementSidebar.cpp b/app/QualityMeasurementSidebar.cpp index 2e72f0f..e9a5784 100644 --- a/app/QualityMeasurementSidebar.cpp +++ b/app/QualityMeasurementSidebar.cpp @@ -22,12 +22,13 @@ * \brief Definition of the quality measurement sidebar */ -#include -#include "PlaYUVerSubWindowHandle.h" #include "QualityMeasurementSidebar.h" +#include "PlaYUVerSubWindowHandle.h" #include "VideoSubWindow.h" +#include -QualityMeasurementSidebar::QualityMeasurementSidebar( QWidget* parent, PlaYUVerSubWindowHandle* windowManager ) +QualityMeasurementSidebar::QualityMeasurementSidebar( QWidget* parent, + PlaYUVerSubWindowHandle* windowManager ) : QWidget( parent ), m_pcMainWindowManager( windowManager ), m_pcCurrentVideoSubWindow( NULL ) { // Side bar area ----------------------------------------------------- @@ -98,7 +99,8 @@ QualityMeasurementSidebar::QualityMeasurementSidebar( QWidget* parent, PlaYUVerS setLayout( mainLayout ); connect( m_comboBoxRef, SIGNAL( activated( int ) ), this, SLOT( slotReferenceChanged( int ) ) ); - connect( m_comboBoxMetric, SIGNAL( currentIndexChanged( int ) ), this, SLOT( slotQualityMetricChanged( int ) ) ); + connect( m_comboBoxMetric, SIGNAL( currentIndexChanged( int ) ), this, + SLOT( slotQualityMetricChanged( int ) ) ); } QualityMeasurementSidebar::~QualityMeasurementSidebar() @@ -129,7 +131,8 @@ Void QualityMeasurementSidebar::updateSubWindowList() m_pcVideoWindowList.clear(); VideoSubWindow* pcVideoSubWindow; - QList subWindowList = m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); + QList subWindowList = + m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); for( Int i = 0; i < subWindowList.size(); i++ ) { pcVideoSubWindow = qobject_cast( subWindowList.at( i ) ); @@ -139,7 +142,8 @@ Void QualityMeasurementSidebar::updateSubWindowList() } if( m_pcCurrentVideoSubWindow ) { - if( !m_pcCurrentVideoSubWindow->getCurrFrame()->haveSameFmt( pcVideoSubWindow->getCurrFrame() ) ) + if( !m_pcCurrentVideoSubWindow->getCurrFrame()->haveSameFmt( + pcVideoSubWindow->getCurrFrame() ) ) { continue; } diff --git a/app/QualityMeasurementSidebar.h b/app/QualityMeasurementSidebar.h index 9fb4e1b..de41690 100644 --- a/app/QualityMeasurementSidebar.h +++ b/app/QualityMeasurementSidebar.h @@ -25,17 +25,17 @@ #ifndef __QUALITYMEASUREMENTSIDEBAR_H__ #define __QUALITYMEASUREMENTSIDEBAR_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" #if( QT_VERSION_PLAYUVER == 5 ) #include #elif( QT_VERSION_PLAYUVER == 4 ) -#include #include +#include #endif -#include "lib/PlaYUVerStream.h" -#include "lib/PlaYUVerFrame.h" #include "HistogramWidget.h" +#include "lib/PlaYUVerFrame.h" +#include "lib/PlaYUVerStream.h" class PlaYUVerSubWindowHandle; class VideoSubWindow; diff --git a/app/SeekStreamDialog.cpp b/app/SeekStreamDialog.cpp index f165cfb..b8c4bbb 100644 --- a/app/SeekStreamDialog.cpp +++ b/app/SeekStreamDialog.cpp @@ -24,11 +24,11 @@ #include "SeekStreamDialog.h" #include "lib/PlaYUVerStream.h" -#include -#include -#include #include +#include #include +#include +#include SeekStreamDialog::SeekStreamDialog( PlaYUVerStream* pcCurrStream, QWidget* parent ) : QDialog( parent, Qt::Dialog | Qt::WindowTitleHint ), m_iSelectedFrameNum() @@ -57,7 +57,8 @@ SeekStreamDialog::SeekStreamDialog( PlaYUVerStream* pcCurrStream, QWidget* paren QVBoxLayout* verticalLayout = new QVBoxLayout; QHBoxLayout* horizontalLayout = new QHBoxLayout; horizontalLayout->addWidget( pcLabel ); - horizontalLayout->addItem( new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); + horizontalLayout->addItem( + new QSpacerItem( 20, 10, QSizePolicy::Expanding, QSizePolicy::Minimum ) ); horizontalLayout->addWidget( m_spinFrameNum ); verticalLayout->addLayout( horizontalLayout ); verticalLayout->addWidget( dialogButtonOkCancel, Qt::AlignRight ); diff --git a/app/SeekStreamDialog.h b/app/SeekStreamDialog.h index b74bb5d..7f4c9b1 100644 --- a/app/SeekStreamDialog.h +++ b/app/SeekStreamDialog.h @@ -25,9 +25,9 @@ #ifndef __SEEKSTREAMDIALOG_H__ #define __SEEKSTREAMDIALOG_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" #include "PlaYUVerAppModuleIf.h" +#include "config.h" #include #include diff --git a/app/SubWindowAbstract.cpp b/app/SubWindowAbstract.cpp index e58b559..429097a 100644 --- a/app/SubWindowAbstract.cpp +++ b/app/SubWindowAbstract.cpp @@ -22,15 +22,16 @@ * \brief Abstract class to handle subwindows */ -#include -#include -#include -#include -#include #include "SubWindowAbstract.h" #include "PlaYUVerMdiSubWindow.h" +#include +#include +#include +#include +#include -SubWindowAbstract::SubWindowAbstract( QWidget* parent, UInt category ) : QWidget( parent ), m_cSubWindow( NULL ) +SubWindowAbstract::SubWindowAbstract( QWidget* parent, UInt category ) + : QWidget( parent ), m_cSubWindow( NULL ) { setParent( parent ); setVisible( false ); diff --git a/app/SubWindowAbstract.h b/app/SubWindowAbstract.h index 04b06cc..a326564 100644 --- a/app/SubWindowAbstract.h +++ b/app/SubWindowAbstract.h @@ -37,12 +37,12 @@ #ifndef __SUBWINDOWABSTRACT_H__ #define __SUBWINDOWABSTRACT_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" -#include -#include +#include "config.h" #include #include +#include +#include class QHBoxLayout; class QFocusEvent; @@ -89,7 +89,8 @@ class SubWindowAbstract : public QWidget */ virtual Void zoomToFit() = 0; /** - * Scale the image (zoomed in or out) to speficied absolute zoom value (1.0 = original size). + * Scale the image (zoomed in or out) to speficied absolute zoom value (1.0 = + * original size). */ virtual Void zoomToFactor( Double factor, QPoint center = QPoint() ) = 0; /** @@ -145,7 +146,8 @@ class SubWindowAbstract : public QWidget */ void zoomFactorChanged_SWindow( const double, const QPoint ); /** - * Notify that scrollbar position was changed by internal event (e.g. by mouse panning ) + * Notify that scrollbar position was changed by internal event (e.g. by mouse + * panning ) */ void scrollBarMoved_SWindow( const QPoint ); /** diff --git a/app/VideoHandle.cpp b/app/VideoHandle.cpp index a7dcd08..2199474 100644 --- a/app/VideoHandle.cpp +++ b/app/VideoHandle.cpp @@ -22,21 +22,21 @@ * \brief Class to handle video playback */ -#include "PlaYUVerApp.h" #include "VideoHandle.h" -#include "VideoSubWindow.h" -#include "PlaYUVerSubWindowHandle.h" #include "DialogSubWindowSelector.h" -#include "SeekStreamDialog.h" #include "FramePropertiesDock.h" +#include "PlaYUVerApp.h" +#include "PlaYUVerSubWindowHandle.h" +#include "SeekStreamDialog.h" +#include "VideoSubWindow.h" #include "WidgetFrameNumber.h" -#include -#include #include +#include +#include #include #include -#include -#include +#include +#include #if( _CONTROL_PLAYING_TIME_ == 1 ) #include #endif @@ -77,16 +77,20 @@ Void VideoHandle::createActions() m_arrayActions[VIDEO_BACKWARD_ACT] = new QAction( "Video Backward", this ); m_arrayActions[VIDEO_BACKWARD_ACT]->setStatusTip( "Seek backward" ); - m_arrayActions[VIDEO_BACKWARD_ACT]->setIcon( QIcon( style()->standardIcon( QStyle::SP_MediaSeekBackward ) ) ); + m_arrayActions[VIDEO_BACKWARD_ACT]->setIcon( + QIcon( style()->standardIcon( QStyle::SP_MediaSeekBackward ) ) ); m_arrayActions[VIDEO_BACKWARD_ACT]->setShortcut( Qt::Key_Left ); - connect( m_arrayActions[VIDEO_BACKWARD_ACT], SIGNAL( triggered() ), m_mapperVideoSeek, SLOT( map() ) ); + connect( m_arrayActions[VIDEO_BACKWARD_ACT], SIGNAL( triggered() ), m_mapperVideoSeek, + SLOT( map() ) ); m_mapperVideoSeek->setMapping( m_arrayActions[VIDEO_BACKWARD_ACT], 0 ); m_arrayActions[VIDEO_FORWARD_ACT] = new QAction( "Video Forward", this ); m_arrayActions[VIDEO_FORWARD_ACT]->setStatusTip( "Seek forward" ); - m_arrayActions[VIDEO_FORWARD_ACT]->setIcon( QIcon( style()->standardIcon( QStyle::SP_MediaSeekForward ) ) ); + m_arrayActions[VIDEO_FORWARD_ACT]->setIcon( + QIcon( style()->standardIcon( QStyle::SP_MediaSeekForward ) ) ); m_arrayActions[VIDEO_FORWARD_ACT]->setShortcut( Qt::Key_Right ); - connect( m_arrayActions[VIDEO_FORWARD_ACT], SIGNAL( triggered() ), m_mapperVideoSeek, SLOT( map() ) ); + connect( m_arrayActions[VIDEO_FORWARD_ACT], SIGNAL( triggered() ), m_mapperVideoSeek, + SLOT( map() ) ); m_mapperVideoSeek->setMapping( m_arrayActions[VIDEO_FORWARD_ACT], 1 ); m_arrayActions[VIDEO_GOTO_ACT] = new QAction( "Go to", this ); @@ -108,13 +112,16 @@ Void VideoHandle::createActions() m_arrayActions[VIDEO_LOCK_SELECTION_ACT] = new QAction( "Sync Play", this ); m_arrayActions[VIDEO_LOCK_SELECTION_ACT]->setStatusTip( - "Select which windows should be played synchronized. Press Ctrl while click to quickly to select all!" ); - connect( m_arrayActions[VIDEO_LOCK_SELECTION_ACT], SIGNAL( triggered() ), this, SLOT( videoSelectionButtonEvent() ) ); + "Select which windows should be played synchronized. Press Ctrl while " + "click to quickly to select all!" ); + connect( m_arrayActions[VIDEO_LOCK_SELECTION_ACT], SIGNAL( triggered() ), this, + SLOT( videoSelectionButtonEvent() ) ); m_pcFrameSlider = new QSlider; m_pcFrameSlider->setOrientation( Qt::Horizontal ); m_pcFrameSlider->setMaximumWidth( 2000 ); - m_pcFrameSlider->setSizePolicy( QSizePolicy( QSizePolicy::MinimumExpanding, QSizePolicy::Fixed ) ); + m_pcFrameSlider->setSizePolicy( + QSizePolicy( QSizePolicy::MinimumExpanding, QSizePolicy::Fixed ) ); m_pcFrameSlider->setEnabled( false ); m_pcFrameSlider->setTracking( false ); connect( m_pcFrameSlider, SIGNAL( valueChanged( int ) ), this, SLOT( seekSliderEvent( int ) ) ); @@ -133,7 +140,8 @@ Void VideoHandle::createActions() m_arrayActions[NAVIGATION_TOOL_ACT]->setChecked( true ); m_arrayActions[NAVIGATION_TOOL_ACT]->setShortcut( Qt::CTRL + Qt::Key_1 ); actionGroupTools->addAction( m_arrayActions[NAVIGATION_TOOL_ACT] ); - connect( m_arrayActions[NAVIGATION_TOOL_ACT], SIGNAL( triggered() ), m_mapperTools, SLOT( map() ) ); + connect( m_arrayActions[NAVIGATION_TOOL_ACT], SIGNAL( triggered() ), m_mapperTools, + SLOT( map() ) ); m_mapperTools->setMapping( m_arrayActions[NAVIGATION_TOOL_ACT], ViewArea::NavigationView ); m_arrayActions[SELECTION_TOOL_ACT] = new QAction( "Selection Tool", this ); @@ -141,7 +149,8 @@ Void VideoHandle::createActions() m_arrayActions[SELECTION_TOOL_ACT]->setChecked( false ); m_arrayActions[SELECTION_TOOL_ACT]->setShortcut( Qt::CTRL + Qt::Key_2 ); actionGroupTools->addAction( m_arrayActions[SELECTION_TOOL_ACT] ); - connect( m_arrayActions[SELECTION_TOOL_ACT], SIGNAL( triggered() ), m_mapperTools, SLOT( map() ) ); + connect( m_arrayActions[SELECTION_TOOL_ACT], SIGNAL( triggered() ), m_mapperTools, + SLOT( map() ) ); m_mapperTools->setMapping( m_arrayActions[SELECTION_TOOL_ACT], ViewArea::NormalSelectionView ); m_arrayActions[BLOCK_SELECTION_TOOL_ACT] = new QAction( "Block Selection Tool", this ); @@ -149,13 +158,16 @@ Void VideoHandle::createActions() m_arrayActions[BLOCK_SELECTION_TOOL_ACT]->setChecked( false ); m_arrayActions[BLOCK_SELECTION_TOOL_ACT]->setShortcut( Qt::CTRL + Qt::Key_3 ); actionGroupTools->addAction( m_arrayActions[BLOCK_SELECTION_TOOL_ACT] ); - connect( m_arrayActions[BLOCK_SELECTION_TOOL_ACT], SIGNAL( triggered() ), m_mapperTools, SLOT( map() ) ); - m_mapperTools->setMapping( m_arrayActions[BLOCK_SELECTION_TOOL_ACT], ViewArea::BlockSelectionView ); + connect( m_arrayActions[BLOCK_SELECTION_TOOL_ACT], SIGNAL( triggered() ), m_mapperTools, + SLOT( map() ) ); + m_mapperTools->setMapping( m_arrayActions[BLOCK_SELECTION_TOOL_ACT], + ViewArea::BlockSelectionView ); m_arrayActions[SHOW_GRID_ACT] = new QAction( "Show grid", this ); m_arrayActions[SHOW_GRID_ACT]->setCheckable( true ); m_arrayActions[SHOW_GRID_ACT]->setChecked( false ); - connect( m_arrayActions[SHOW_GRID_ACT], SIGNAL( toggled( bool ) ), this, SLOT( toggleGrid( bool ) ) ); + connect( m_arrayActions[SHOW_GRID_ACT], SIGNAL( toggled( bool ) ), this, + SLOT( toggleGrid( bool ) ) ); } QMenu* VideoHandle::createVideoMenu() @@ -243,7 +255,8 @@ QWidget* VideoHandle::createStatusBarMessage() Void VideoHandle::updateMenus() { - VideoSubWindow* pcSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); + VideoSubWindow* pcSubWindow = + qobject_cast( m_pcMainWindowManager->activeSubWindow() ); Bool hasSubWindow = pcSubWindow ? true : false; m_arrayActions[PLAY_ACT]->setEnabled( hasSubWindow ); @@ -270,8 +283,10 @@ Void VideoHandle::updateMenus() Void VideoHandle::readSettings() { QSettings appSettings; - m_arrayActions[VIDEO_REPEAT_ACT]->setChecked( appSettings.value( "VideoHandle/Repeat", false ).toBool() ); - m_arrayActions[VIDEO_ZOOM_LOCK_ACT]->setChecked( appSettings.value( "VideoHandle/VideoZoomLock", false ).toBool() ); + m_arrayActions[VIDEO_REPEAT_ACT]->setChecked( + appSettings.value( "VideoHandle/Repeat", false ).toBool() ); + m_arrayActions[VIDEO_ZOOM_LOCK_ACT]->setChecked( + appSettings.value( "VideoHandle/VideoZoomLock", false ).toBool() ); if( !appSettings.value( "VideoHandle/FrameProperties", true ).toBool() ) m_pcFramePropertiesDock->close(); @@ -283,7 +298,8 @@ Void VideoHandle::writeSettings() { QSettings appSettings; appSettings.setValue( "VideoHandle/Repeat", m_arrayActions[VIDEO_REPEAT_ACT]->isChecked() ); - appSettings.setValue( "VideoHandle/VideoZoomLock", m_arrayActions[VIDEO_ZOOM_LOCK_ACT]->isChecked() ); + appSettings.setValue( "VideoHandle/VideoZoomLock", + m_arrayActions[VIDEO_ZOOM_LOCK_ACT]->isChecked() ); appSettings.setValue( "VideoHandle/FrameProperties", m_pcFramePropertiesSideBar->isVisible() ); appSettings.setValue( "VideoHandle/SelectedTool", m_uiViewTool ); } @@ -303,7 +319,8 @@ Void VideoHandle::update() QString resolution; if( pcFrame ) { - resolution.append( QString( "%1x%2" ).arg( pcFrame->getWidth() ).arg( pcFrame->getHeight() ) ); + resolution.append( + QString( "%1x%2" ).arg( pcFrame->getWidth() ).arg( pcFrame->getHeight() ) ); } if( pcStream ) @@ -376,7 +393,8 @@ Void VideoHandle::updateSelectionArea( QRect area ) Void VideoHandle::openSubWindow( VideoSubWindow* subWindow ) { - connect( subWindow->getViewArea(), SIGNAL( selectionChanged( QRect ) ), this, SLOT( updateSelectionArea( QRect ) ) ); + connect( subWindow->getViewArea(), SIGNAL( selectionChanged( QRect ) ), this, + SLOT( updateSelectionArea( QRect ) ) ); subWindow->getViewArea()->setTool( m_uiViewTool ); subWindow->getViewArea()->setGridVisible( m_arrayActions[SHOW_GRID_ACT]->isChecked() ); } @@ -433,7 +451,8 @@ Void VideoHandle::moveAllScrollBars( const QPoint offset ) QScrollBar* scrollBar; scrollBar = m_pcCurrentVideoSubWindow->getScroll()->horizontalScrollBar(); - // Do not move other images, if current image reached maximum or minimum scroll position + // Do not move other images, if current image reached maximum or minimum + // scroll position if( scrollBar->value() == scrollBar->maximum() && offset.x() > 0 ) newOffset.setX( 0 ); if( scrollBar->value() == scrollBar->minimum() && offset.x() < 0 ) @@ -511,7 +530,8 @@ Void VideoHandle::setTimerStatus() #if( _CONTROL_PLAYING_TIME_ == 1 ) if( m_pcPlayControlTimer && m_pcPlayingTimer->interval() > 0 ) { - qDebug() << "Desired Fps: " << 1000 / m_pcPlayingTimer->interval() << "Real Fps: " << 1000 / m_dAverageFps; + qDebug() << "Desired Fps: " << 1000 / m_pcPlayingTimer->interval() + << "Real Fps: " << 1000 / m_dAverageFps; delete m_pcPlayControlTimer; m_pcPlayControlTimer = NULL; @@ -599,8 +619,9 @@ Void VideoHandle::playEvent() { Bool bEndOfSequence = false; #if( _CONTROL_PLAYING_TIME_ == 1 ) - m_dAverageFps = Double( m_dAverageFps * m_uiNumberPlayedFrames + m_pcPlayControlTimer->elapsed() ) / - Double( m_uiNumberPlayedFrames + 1 ); + m_dAverageFps = + Double( m_dAverageFps * m_uiNumberPlayedFrames + m_pcPlayControlTimer->elapsed() ) / + Double( m_uiNumberPlayedFrames + 1 ); m_uiNumberPlayedFrames++; m_pcPlayControlTimer->restart(); #endif @@ -638,7 +659,8 @@ Void VideoHandle::seekEvent( Int direction ) { if( m_acPlayingSubWindows.contains( m_pcCurrentVideoSubWindow ) ) { - if( !( ( UInt )( m_pcCurrentVideoSubWindow->getInputStream()->getCurrFrameNum() + 1 ) >= getMaxFrameNumber() && + if( !( ( UInt )( m_pcCurrentVideoSubWindow->getInputStream()->getCurrFrameNum() + 1 ) >= + getMaxFrameNumber() && direction > 0 ) ) { for( Int i = 0; i < m_acPlayingSubWindows.size(); i++ ) @@ -662,7 +684,8 @@ Void VideoHandle::seekVideo() { if( m_pcCurrentVideoSubWindow->getInputStream() ) { - SeekStreamDialog* dialogSeekVideo = new SeekStreamDialog( m_pcCurrentVideoSubWindow->getInputStream(), this ); + SeekStreamDialog* dialogSeekVideo = + new SeekStreamDialog( m_pcCurrentVideoSubWindow->getInputStream(), this ); Int newFrameNum = dialogSeekVideo->runDialog(); if( newFrameNum >= 0 ) { @@ -769,7 +792,8 @@ Void VideoHandle::setTool( Int tool ) { m_uiViewTool = tool; actionGroupTools->actions().at( m_uiViewTool )->setChecked( true ); - QList subWindowList = m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); + QList subWindowList = + m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); for( Int i = 0; i < subWindowList.size(); i++ ) { qobject_cast( subWindowList.at( i ) )->getViewArea()->setTool( m_uiViewTool ); @@ -778,9 +802,12 @@ Void VideoHandle::setTool( Int tool ) Void VideoHandle::toggleGrid( Bool checked ) { - QList subWindowList = m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); + QList subWindowList = + m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); for( Int i = 0; i < subWindowList.size(); i++ ) { - qobject_cast( subWindowList.at( i ) )->getViewArea()->setGridVisible( checked ); + qobject_cast( subWindowList.at( i ) ) + ->getViewArea() + ->setGridVisible( checked ); } } diff --git a/app/VideoHandle.h b/app/VideoHandle.h index 9add246..8330a81 100644 --- a/app/VideoHandle.h +++ b/app/VideoHandle.h @@ -25,13 +25,13 @@ #ifndef __VIDEOHANDLE_H__ #define __VIDEOHANDLE_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" -#include #include -#include #include +#include +#include #define _CONTROL_PLAYING_TIME_ 0 diff --git a/app/VideoSubWindow.cpp b/app/VideoSubWindow.cpp index 1fc9474..973105b 100644 --- a/app/VideoSubWindow.cpp +++ b/app/VideoSubWindow.cpp @@ -22,12 +22,12 @@ * \brief Video Sub windows handling */ -#include #include "VideoSubWindow.h" -#include "ModulesHandle.h" #include "ConfigureFormatDialog.h" +#include "ModulesHandle.h" #include "SubWindowAbstract.h" #include +#include #if( QT_VERSION_PLAYUVER == 5 ) #include "QtConcurrent/qtconcurrentrun.h" #endif @@ -43,8 +43,8 @@ QDataStream& operator<<( QDataStream& out, const PlaYUVerStreamInfoVector& array for( Int i = 0; i < array.size(); i++ ) { d = array.at( i ); - out << d.m_cFilename << d.m_uiWidth << d.m_uiHeight << d.m_iPelFormat << d.m_uiBitsPelPixel << d.m_iEndianness - << d.m_uiFrameRate << d.m_uiFileSize; + out << d.m_cFilename << d.m_uiWidth << d.m_uiHeight << d.m_iPelFormat << d.m_uiBitsPelPixel + << d.m_iEndianness << d.m_uiFrameRate << d.m_uiFileSize; } return out; } @@ -124,20 +124,21 @@ class VideoInformation : public QWidget if( m_bBusyWindow ) { painter.setFont( m_cCenterTextFont ); - painter.drawText( rect(), Qt::AlignHCenter | Qt::AlignVCenter, QStringLiteral( "Refreshing..." ) ); + painter.drawText( rect(), Qt::AlignHCenter | Qt::AlignVCenter, + QStringLiteral( "Refreshing..." ) ); painter.fillRect( rect(), QBrush( QColor::fromRgb( 255, 255, 255, 50 ), Qt::SolidPattern ) ); } } }; VideoSubWindow::VideoSubWindow( enum VideoSubWindowCategories category, QWidget* parent ) - : SubWindowAbstract( parent, SubWindowAbstract::VIDEO_SUBWINDOW | category ), - m_bWindowBusy( false ), - m_pCurrStream( NULL ), - m_pcCurrFrame( NULL ), - m_pcCurrentDisplayModule( NULL ), - m_pcReferenceSubWindow( NULL ), - m_bIsPlaying( false ) + : SubWindowAbstract( parent, SubWindowAbstract::VIDEO_SUBWINDOW | category ) + , m_bWindowBusy( false ) + , m_pCurrStream( NULL ) + , m_pcCurrFrame( NULL ) + , m_pcCurrentDisplayModule( NULL ) + , m_pcReferenceSubWindow( NULL ) + , m_bIsPlaying( false ) { // Create a new scroll area inside the sub-window m_pcScrollArea = new QScrollArea; @@ -153,10 +154,13 @@ VideoSubWindow::VideoSubWindow( enum VideoSubWindowCategories category, QWidget* connect( m_cViewArea, SIGNAL( zoomFactorChanged_byWheel( double, QPoint ) ), this, SIGNAL( zoomFactorChanged_SWindow( double, QPoint ) ) ); - connect( m_cViewArea, SIGNAL( scrollBarMoved( QPoint ) ), this, SLOT( adjustScrollBarByOffset( QPoint ) ) ); - connect( m_cViewArea, SIGNAL( scrollBarMoved( QPoint ) ), this, SIGNAL( scrollBarMoved_SWindow( QPoint ) ) ); + connect( m_cViewArea, SIGNAL( scrollBarMoved( QPoint ) ), this, + SLOT( adjustScrollBarByOffset( QPoint ) ) ); + connect( m_cViewArea, SIGNAL( scrollBarMoved( QPoint ) ), this, + SIGNAL( scrollBarMoved_SWindow( QPoint ) ) ); - connect( m_cViewArea, SIGNAL( selectionChanged( QRect ) ), this, SLOT( updateSelectedArea( QRect ) ) ); + connect( m_cViewArea, SIGNAL( selectionChanged( QRect ) ), this, + SLOT( updateSelectedArea( QRect ) ) ); connect( m_cViewArea, SIGNAL( positionChanged( const QPoint& ) ), this, SLOT( updatePixelValueStatusBar( const QPoint& ) ) ); @@ -313,8 +317,9 @@ Bool VideoSubWindow::loadFile( QString cFilename, Bool bForceDialog ) if( guessFormat( cFilename, Width, Height, InputFormat, BitsPel, Endianness ) || bForceDialog ) { - if( formatDialog.runConfigureFormatDialog( QFileInfo( cFilename ).fileName(), Width, Height, InputFormat, BitsPel, - Endianness, FrameRate ) == QDialog::Rejected ) + if( formatDialog.runConfigureFormatDialog( QFileInfo( cFilename ).fileName(), Width, Height, + InputFormat, BitsPel, Endianness, + FrameRate ) == QDialog::Rejected ) { return false; } @@ -322,16 +327,19 @@ Bool VideoSubWindow::loadFile( QString cFilename, Bool bForceDialog ) try { - m_pCurrStream->open( cFilename.toStdString(), Width, Height, InputFormat, BitsPel, Endianness, FrameRate, true ); + m_pCurrStream->open( cFilename.toStdString(), Width, Height, InputFormat, BitsPel, Endianness, + FrameRate, true ); } catch( ... ) { - if( formatDialog.runConfigureFormatDialog( QFileInfo( cFilename ).fileName(), Width, Height, InputFormat, BitsPel, - Endianness, FrameRate ) == QDialog::Rejected ) + if( formatDialog.runConfigureFormatDialog( QFileInfo( cFilename ).fileName(), Width, Height, + InputFormat, BitsPel, Endianness, + FrameRate ) == QDialog::Rejected ) { return false; } - m_pCurrStream->open( cFilename.toStdString(), Width, Height, InputFormat, BitsPel, Endianness, FrameRate, true ); + m_pCurrStream->open( cFilename.toStdString(), Width, Height, InputFormat, BitsPel, Endianness, + FrameRate, true ); } m_sStreamInfo.m_cFilename = cFilename; @@ -361,8 +369,9 @@ Bool VideoSubWindow::loadFile( PlaYUVerStreamInfo* streamInfo ) m_pCurrStream = new PlaYUVerStream; } - if( !m_pCurrStream->open( streamInfo->m_cFilename.toStdString(), streamInfo->m_uiWidth, streamInfo->m_uiHeight, - streamInfo->m_iPelFormat, streamInfo->m_uiBitsPelPixel, streamInfo->m_iEndianness, + if( !m_pCurrStream->open( streamInfo->m_cFilename.toStdString(), streamInfo->m_uiWidth, + streamInfo->m_uiHeight, streamInfo->m_iPelFormat, + streamInfo->m_uiBitsPelPixel, streamInfo->m_iEndianness, streamInfo->m_uiFrameRate, true ) ) { return false; @@ -394,7 +403,8 @@ Void VideoSubWindow::updateVideoWindowInfo() { if( arraySubWindows.at( i )->getWindowName() != getWindowName() ) { - sourceWindowList.append( QString( "Input %1 - " + arraySubWindows.at( i )->getWindowName() ).arg( i + 1 ) ); + sourceWindowList.append( + QString( "Input %1 - " + arraySubWindows.at( i )->getWindowName() ).arg( i + 1 ) ); } } } @@ -440,11 +450,13 @@ Bool VideoSubWindow::guessFormat( QString filename, { return false; } - if( !fileExtension.compare( "yuv" ) || !fileExtension.compare( "rgb" ) || !fileExtension.compare( "gray" ) ) + if( !fileExtension.compare( "yuv" ) || !fileExtension.compare( "rgb" ) || + !fileExtension.compare( "gray" ) ) { bGuessed = false; // Guess pixel format - QVector formats_list = QVector::fromStdVector( PlaYUVerFrame::supportedPixelFormatListNames() ); + QVector formats_list = + QVector::fromStdVector( PlaYUVerFrame::supportedPixelFormatListNames() ); for( Int i = 0; i < formats_list.size(); i++ ) { if( FilenameShort.contains( formats_list.at( i ).c_str(), Qt::CaseInsensitive ) ) @@ -473,7 +485,8 @@ Bool VideoSubWindow::guessFormat( QString filename, #if( QT_VERSION_PLAYUVER == 5 ) // Guess resolution - match %dx%d - QRegularExpressionMatch resolutionMatch = QRegularExpression( "_\\d*x\\d*" ).match( FilenameShort ); + QRegularExpressionMatch resolutionMatch = + QRegularExpression( "_\\d*x\\d*" ).match( FilenameShort ); if( resolutionMatch.hasMatch() ) { QString resolutionString = resolutionMatch.captured( 0 ); @@ -504,8 +517,8 @@ Bool VideoSubWindow::guessFormat( QString filename, Int count = 0, module, frame_bytes, match; for( UInt i = 0; i < stdResList.size(); i++ ) { - frame_bytes = - PlaYUVerFrame::getBytesPerFrame( stdResList[i].uiWidth, stdResList[i].uiHeight, rInputFormat, 8 ); + frame_bytes = PlaYUVerFrame::getBytesPerFrame( stdResList[i].uiWidth, + stdResList[i].uiHeight, rInputFormat, 8 ); module = uiFileSize % frame_bytes; if( module == 0 ) { @@ -683,8 +696,8 @@ Bool VideoSubWindow::save( QString filename ) PlaYUVerFrame* saveFrame = m_pcCurrFrame; if( m_cSelectedArea.isValid() ) { - saveFrame = new PlaYUVerFrame( m_pcCurrFrame, m_cSelectedArea.x(), m_cSelectedArea.y(), m_cSelectedArea.width(), - m_cSelectedArea.height() ); + saveFrame = new PlaYUVerFrame( m_pcCurrFrame, m_cSelectedArea.x(), m_cSelectedArea.y(), + m_cSelectedArea.width(), m_cSelectedArea.height() ); } if( !saveFrame ) { @@ -768,7 +781,8 @@ Void VideoSubWindow::stop() QSize VideoSubWindow::getScrollSize() { - return QSize( m_pcScrollArea->viewport()->size().width() - 5, m_pcScrollArea->viewport()->size().height() - 5 ); + return QSize( m_pcScrollArea->viewport()->size().width() - 5, + m_pcScrollArea->viewport()->size().height() - 5 ); } Void VideoSubWindow::adjustScrollBarByOffset( QPoint Offset ) @@ -809,7 +823,8 @@ Void VideoSubWindow::adjustScrollBarByScale( Double scale, QPoint center ) scrollBarH = m_pcScrollArea->horizontalScrollBar(); if( center.isNull() ) { - m_cCurrScroll.setX( int( scale * cLastScroll.x() + ( ( scale - 1 ) * scrollBarH->pageStep() / 2 ) ) ); + m_cCurrScroll.setX( + int( scale * cLastScroll.x() + ( ( scale - 1 ) * scrollBarH->pageStep() / 2 ) ) ); } else { @@ -825,7 +840,8 @@ Void VideoSubWindow::adjustScrollBarByScale( Double scale, QPoint center ) scrollBarV = m_pcScrollArea->verticalScrollBar(); if( center.isNull() ) { - m_cCurrScroll.setY( int( scale * cLastScroll.y() + ( ( scale - 1 ) * scrollBarV->pageStep() / 2 ) ) ); + m_cCurrScroll.setY( + int( scale * cLastScroll.y() + ( ( scale - 1 ) * scrollBarV->pageStep() / 2 ) ) ); } else { @@ -958,15 +974,19 @@ Void VideoSubWindow::updatePixelValueStatusBar( const QPoint& pos ) if( ColorSpace == PlaYUVerPixel::COLOR_YUV ) { sPixelValue = m_pcCurrFrame->getPixelValue( pos.x(), pos.y() ); - strStatus.append( - QString( "Y: %1 U: %2 V: %3" ).arg( sPixelValue.Y() ).arg( sPixelValue.Cb() ).arg( sPixelValue.Cr() ) ); + strStatus.append( QString( "Y: %1 U: %2 V: %3" ) + .arg( sPixelValue.Y() ) + .arg( sPixelValue.Cb() ) + .arg( sPixelValue.Cr() ) ); } if( ( ColorSpace == PlaYUVerPixel::COLOR_RGB ) ) { sPixelValue = m_pcCurrFrame->getPixelValue( pos.x(), pos.y() ); - strStatus.append( - QString( "R: %1 G: %2 B: %3" ).arg( sPixelValue.R() ).arg( sPixelValue.G() ).arg( sPixelValue.B() ) ); + strStatus.append( QString( "R: %1 G: %2 B: %3" ) + .arg( sPixelValue.R() ) + .arg( sPixelValue.G() ) + .arg( sPixelValue.B() ) ); } emit updateStatusBar( strStatus ); } diff --git a/app/VideoSubWindow.h b/app/VideoSubWindow.h index 78d1f39..ffcb74e 100644 --- a/app/VideoSubWindow.h +++ b/app/VideoSubWindow.h @@ -25,16 +25,16 @@ #ifndef __VIDEOSUBWINDOW_H__ #define __VIDEOSUBWINDOW_H__ -#include "config.h" -#include -#include -#include -#include -#include #include "PlaYUVerAppDefs.h" -#include "lib/PlaYUVerStream.h" #include "SubWindowAbstract.h" #include "ViewArea.h" +#include "config.h" +#include "lib/PlaYUVerStream.h" +#include +#include +#include +#include +#include class QScrollArea; diff --git a/app/ViewArea.cpp b/app/ViewArea.cpp index 397802b..22d4058 100644 --- a/app/ViewArea.cpp +++ b/app/ViewArea.cpp @@ -25,19 +25,19 @@ #include +#include "GridManager.h" +#include "ViewArea.h" +#include #include -#include +#include +#include +#include #include #include -#include -#include -#include -#include #include #include -#include -#include "ViewArea.h" -#include "GridManager.h" +#include +#include static const QColor selectionColor = Qt::cyan; static const QColor imageMaskColor = Qt::green; @@ -72,8 +72,8 @@ Void ViewArea::setImage( PlaYUVerFrame* pcFrame ) m_pcCurrFrame = pcFrame; m_uiPixelHalfScale = 1 << ( m_pcCurrFrame->getBitsPel() - 1 ); m_pcCurrFrame->fillRGBBuffer(); - QImage qimg = QImage( m_pcCurrFrame->getRGBBuffer(), m_pcCurrFrame->getWidth(), m_pcCurrFrame->getHeight(), - QImage::Format_RGB32 ); + QImage qimg = QImage( m_pcCurrFrame->getRGBBuffer(), m_pcCurrFrame->getWidth(), + m_pcCurrFrame->getHeight(), QImage::Format_RGB32 ); setImage( QPixmap::fromImage( qimg ) ); } @@ -432,11 +432,15 @@ Void ViewArea::paintEvent( QPaintEvent* event ) paInter.scale( m_dZoomFactor, m_dZoomFactor ); // This line is for fast paiting. Only visible area of the image is paInted. - // We take the exposed rect from the event (that gives us scroll/expose optimizations for free – no need - // to draw the whole pixmap if your widget is only partially exposed), and reverse map it with the paInter matrix. + // We take the exposed rect from the event (that gives us scroll/expose + // optimizations for free – no need + // to draw the whole pixmap if your widget is only partially exposed), and + // reverse map it with the paInter matrix. // That gives us the part of the pixmap that has actually been exposed. - // See: http://blog.qt.digia.com/blog/2006/05/13/fast-transformed-pixmapimage-drawing/ - QRect exposedRect = paInter.worldTransform().inverted().mapRect( event->rect() ).adjusted( -1, -1, 1, 1 ); + // See: + // http://blog.qt.digia.com/blog/2006/05/13/fast-transformed-pixmapimage-drawing/ + QRect exposedRect = + paInter.worldTransform().inverted().mapRect( event->rect() ).adjusted( -1, -1, 1, 1 ); // Draw the pixmap. paInter.drawPixmap( exposedRect, m_pixmap, exposedRect ); @@ -471,7 +475,8 @@ Void ViewArea::paintEvent( QPaintEvent* event ) /* if( m_xOffset || m_yOffset ) { paInter.setPen( Qt::black ); - paInter.drawRect( m_xOffset - 1, m_yOffset - 1, m_pixmap.width() * m_dZoomFactor + 1, m_pixmap.height() * + paInter.drawRect( m_xOffset - 1, m_yOffset - 1, m_pixmap.width() * + m_dZoomFactor + 1, m_pixmap.height() * m_dZoomFactor + 1 ); }*/ @@ -508,9 +513,10 @@ Void ViewArea::paintEvent( QPaintEvent* event ) else paInter.setPen( QColor( Qt::black ) ); - paInter.drawText( pixelRect, Qt::AlignCenter, "Y: " + QString::number( sPixelValue.Y() ) + "\n" + "U: " + - QString::number( sPixelValue.Cb() ) + "\n" + "V: " + - QString::number( sPixelValue.Cr() ) ); + paInter.drawText( pixelRect, Qt::AlignCenter, + "Y: " + QString::number( sPixelValue.Y() ) + "\n" + "U: " + + QString::number( sPixelValue.Cb() ) + "\n" + "V: " + + QString::number( sPixelValue.Cr() ) ); } if( frFormat == PlaYUVerPixel::COLOR_GRAY ) { @@ -521,7 +527,8 @@ Void ViewArea::paintEvent( QPaintEvent* event ) else paInter.setPen( QColor( Qt::black ) ); - paInter.drawText( pixelRect, Qt::AlignCenter, "Y: " + QString::number( sPixelValue.Y() ) ); + paInter.drawText( pixelRect, Qt::AlignCenter, + "Y: " + QString::number( sPixelValue.Y() ) ); } if( ( frFormat == PlaYUVerPixel::COLOR_RGB ) ) @@ -533,9 +540,10 @@ Void ViewArea::paintEvent( QPaintEvent* event ) else paInter.setPen( QColor( Qt::black ) ); - paInter.drawText( pixelRect, Qt::AlignCenter, "R: " + QString::number( sPixelValue.R() ) + "\n" + "G: " + - QString::number( sPixelValue.G() ) + "\n" + "B: " + - QString::number( sPixelValue.B() ) ); + paInter.drawText( pixelRect, Qt::AlignCenter, + "R: " + QString::number( sPixelValue.R() ) + "\n" + "G: " + + QString::number( sPixelValue.G() ) + "\n" + "B: " + + QString::number( sPixelValue.B() ) ); } } } @@ -1021,8 +1029,10 @@ QRect ViewArea::windowToView( const QRect& rc ) const r.setTopLeft( windowToView( rc.topLeft() ) ); // r.setRight ( (Int)( ceil(( rc.right() - m_xOffset)/m_dZoomFactor ))); // r.setBottom( (Int)( ceil(( rc.bottom()- m_yOffset)/m_dZoomFactor ))); - // r.setRight ( static_cast(( rc.right() - m_xOffset ) / m_dZoomFactor +1)); - // r.setBottom( static_cast(( rc.bottom() - m_xOffset ) / m_dZoomFactor+1)); + // r.setRight ( static_cast(( rc.right() - m_xOffset ) / + // m_dZoomFactor +1)); + // r.setBottom( static_cast(( rc.bottom() - m_xOffset ) / + // m_dZoomFactor+1)); r.setBottomRight( windowToView( rc.bottomRight() ) ); return r; } @@ -1042,13 +1052,19 @@ QRect ViewArea::viewToWindow( const QRect& rc ) const QRect r; r.setTopLeft( viewToWindow( rc.topLeft() ) ); - // r.setRight ( (Int)( ceil(( rc.right() +1+m_xOffset )*m_dZoomFactor ) - 1 )); - // r.setBottom( (Int)( ceil(( rc.bottom()+1+m_yOffset )*m_dZoomFactor ) - 1 )); - // r.setRight ( (Int)( ceil(( rc.right()+0.5)*m_dZoomFactor )+ m_xOffset )-1); - // r.setBottom( (Int)( ceil(( rc.bottom()+0.5)*m_dZoomFactor ) +m_yOffset )-1); + // r.setRight ( (Int)( ceil(( rc.right() +1+m_xOffset )*m_dZoomFactor ) - + // 1 )); + // r.setBottom( (Int)( ceil(( rc.bottom()+1+m_yOffset )*m_dZoomFactor ) - + // 1 )); + // r.setRight ( (Int)( ceil(( rc.right()+0.5)*m_dZoomFactor )+ m_xOffset + // )-1); + // r.setBottom( (Int)( ceil(( rc.bottom()+0.5)*m_dZoomFactor ) +m_yOffset + // )-1); // qDebug()<<"Right = "<< r.right(); - // r.setRight ( static_cast(( rc.right()+1) * m_dZoomFactor + m_xOffset -1) ); - // r.setBottom( static_cast(( rc.bottom()+1) * m_dZoomFactor + m_yOffset -1)); + // r.setRight ( static_cast(( rc.right()+1) * m_dZoomFactor + + // m_xOffset -1) ); + // r.setBottom( static_cast(( rc.bottom()+1) * m_dZoomFactor + + // m_yOffset -1)); r.setBottomRight( viewToWindow( rc.bottomRight() ) ); return r; diff --git a/app/ViewArea.h b/app/ViewArea.h index 1edd931..068d799 100644 --- a/app/ViewArea.h +++ b/app/ViewArea.h @@ -26,15 +26,15 @@ #ifndef __VIEWAREA_H__ #define __VIEWAREA_H__ -#include "config.h" +#include "GridManager.h" #include "PlaYUVerAppDefs.h" -#include -#include +#include "config.h" +#include "lib/PlaYUVerFrame.h" #include #include +#include #include -#include "GridManager.h" -#include "lib/PlaYUVerFrame.h" +#include class PlaYUVerStream; @@ -84,7 +84,8 @@ class ViewArea : public QWidget GridManager gridManager() const { return m_grid; } QColor maskColor() const { return m_maskColor; } Double getZoomFactor() { return m_dZoomFactor; } - // Scale function. Return used scale value (it may change when it touches the min or max zoom value) + // Scale function. Return used scale value (it may change when it touches the + // min or max zoom value) Double scaleZoomFactor( Double scale, QPoint center, QSize minimumSize ); Q_SIGNALS: diff --git a/app/WidgetFrameNumber.h b/app/WidgetFrameNumber.h index 495f0ef..afe3304 100644 --- a/app/WidgetFrameNumber.h +++ b/app/WidgetFrameNumber.h @@ -25,8 +25,8 @@ #ifndef __WIDGETFRAMENUMBER_H__ #define __WIDGETFRAMENUMBER_H__ -#include "config.h" #include "PlaYUVerAppDefs.h" +#include "config.h" #include #if( QT_VERSION_PLAYUVER == 5 ) #include diff --git a/app/external/qcustomplot.cpp b/app/external/qcustomplot.cpp index 41905a8..7efd181 100644 --- a/app/external/qcustomplot.cpp +++ b/app/external/qcustomplot.cpp @@ -32,14 +32,20 @@ /*! \class QCPPainter \brief QPainter subclass used internally - This QPainter subclass is used to provide some extended functionality e.g. for tweaking position - consistency between antialiased and non-antialiased painting. Further it provides workarounds + This QPainter subclass is used to provide some extended functionality e.g. for + tweaking position + consistency between antialiased and non-antialiased painting. Further it + provides workarounds for QPainter quirks. - \warning This class intentionally hides non-virtual functions of QPainter, e.g. setPen, save and - restore. So while it is possible to pass a QCPPainter instance to a function that expects a - QPainter pointer, some of the workarounds and tweaks will be unavailable to the function (because - it will call the base class implementations of the functions actually hidden by QCPPainter). + \warning This class intentionally hides non-virtual functions of QPainter, + e.g. setPen, save and + restore. So while it is possible to pass a QCPPainter instance to a function + that expects a + QPainter pointer, some of the workarounds and tweaks will be unavailable to + the function (because + it will call the base class implementations of the functions actually hidden + by QCPPainter). */ /*! @@ -47,20 +53,27 @@ */ QCPPainter::QCPPainter() : QPainter(), mModes( pmDefault ), mIsAntialiasing( false ) { - // don't setRenderHint(QPainter::NonCosmeticDefautPen) here, because painter isn't active yet and + // don't setRenderHint(QPainter::NonCosmeticDefautPen) here, because painter + // isn't active yet and // a call to begin() will follow } /*! - Creates a new QCPPainter instance on the specified paint \a device and sets default values. Just - like the analogous QPainter constructor, begins painting on \a device immediately. + Creates a new QCPPainter instance on the specified paint \a device and sets + default values. Just + like the analogous QPainter constructor, begins painting on \a device + immediately. - Like \ref begin, this method sets QPainter::NonCosmeticDefaultPen in Qt versions before Qt5. + Like \ref begin, this method sets QPainter::NonCosmeticDefaultPen in Qt + versions before Qt5. */ -QCPPainter::QCPPainter( QPaintDevice* device ) : QPainter( device ), mModes( pmDefault ), mIsAntialiasing( false ) +QCPPainter::QCPPainter( QPaintDevice* device ) + : QPainter( device ), mModes( pmDefault ), mIsAntialiasing( false ) { -#if QT_VERSION < QT_VERSION_CHECK( 5, 0, 0 ) // before Qt5, default pens used to be cosmetic if NonCosmeticDefaultPen - // flag isn't set. So we set it to get consistency across Qt versions. +#if QT_VERSION < QT_VERSION_CHECK( 5, 0, 0 ) // before Qt5, default pens used to + // be cosmetic if + // NonCosmeticDefaultPen + // flag isn't set. So we set it to get consistency across Qt versions. if( isActive() ) setRenderHint( QPainter::NonCosmeticDefaultPen ); #endif @@ -71,7 +84,8 @@ QCPPainter::~QCPPainter() } /*! - Sets the pen of the painter and applies certain fixes to it, depending on the mode of this + Sets the pen of the painter and applies certain fixes to it, depending on the + mode of this QCPPainter. \note this function hides the non-virtual base class implementation. @@ -85,7 +99,8 @@ void QCPPainter::setPen( const QPen& pen ) /*! \overload - Sets the pen (by color) of the painter and applies certain fixes to it, depending on the mode of + Sets the pen (by color) of the painter and applies certain fixes to it, + depending on the mode of this QCPPainter. \note this function hides the non-virtual base class implementation. @@ -99,7 +114,8 @@ void QCPPainter::setPen( const QColor& color ) /*! \overload - Sets the pen (by style) of the painter and applies certain fixes to it, depending on the mode of + Sets the pen (by style) of the painter and applies certain fixes to it, + depending on the mode of this QCPPainter. \note this function hides the non-virtual base class implementation. @@ -113,8 +129,10 @@ void QCPPainter::setPen( Qt::PenStyle penStyle ) /*! \overload - Works around a Qt bug introduced with Qt 4.8 which makes drawing QLineF unpredictable when - antialiasing is disabled. Thus when antialiasing is disabled, it rounds the \a line to + Works around a Qt bug introduced with Qt 4.8 which makes drawing QLineF + unpredictable when + antialiasing is disabled. Thus when antialiasing is disabled, it rounds the \a + line to integer coordinates and then passes it to the original drawLine. \note this function hides the non-virtual base class implementation. @@ -128,9 +146,12 @@ void QCPPainter::drawLine( const QLineF& line ) } /*! - Sets whether painting uses antialiasing or not. Use this method instead of using setRenderHint - with QPainter::Antialiasing directly, as it allows QCPPainter to regain pixel exactness between - antialiased and non-antialiased painting (Since Qt < 5.0 uses slightly different coordinate systems for + Sets whether painting uses antialiasing or not. Use this method instead of + using setRenderHint + with QPainter::Antialiasing directly, as it allows QCPPainter to regain pixel + exactness between + antialiased and non-antialiased painting (Since Qt < 5.0 uses slightly + different coordinate systems for AA/Non-AA painting). */ void QCPPainter::setAntialiasing( bool enabled ) @@ -139,7 +160,8 @@ void QCPPainter::setAntialiasing( bool enabled ) if( mIsAntialiasing != enabled ) { mIsAntialiasing = enabled; - if( !mModes.testFlag( pmVectorized ) ) // antialiasing half-pixel shift only needed for rasterized outputs + if( !mModes.testFlag( pmVectorized ) ) // antialiasing half-pixel shift only + // needed for rasterized outputs { if( mIsAntialiasing ) translate( 0.5, 0.5 ); @@ -150,7 +172,8 @@ void QCPPainter::setAntialiasing( bool enabled ) } /*! - Sets the mode of the painter. This controls whether the painter shall adjust its + Sets the mode of the painter. This controls whether the painter shall adjust + its fixes/workarounds optimized for certain output devices. */ void QCPPainter::setModes( QCPPainter::PainterModes modes ) @@ -159,12 +182,16 @@ void QCPPainter::setModes( QCPPainter::PainterModes modes ) } /*! - Sets the QPainter::NonCosmeticDefaultPen in Qt versions before Qt5 after beginning painting on \a - device. This is necessary to get cosmetic pen consistency across Qt versions, because since Qt5, - all pens are non-cosmetic by default, and in Qt4 this render hint must be set to get that + Sets the QPainter::NonCosmeticDefaultPen in Qt versions before Qt5 after + beginning painting on \a + device. This is necessary to get cosmetic pen consistency across Qt versions, + because since Qt5, + all pens are non-cosmetic by default, and in Qt4 this render hint must be set + to get that behaviour. - The Constructor \ref QCPPainter(QPaintDevice *device) which directly starts painting also sets + The Constructor \ref QCPPainter(QPaintDevice *device) which directly starts + painting also sets the render hint as appropriate. \note this function hides the non-virtual base class implementation. @@ -172,8 +199,10 @@ void QCPPainter::setModes( QCPPainter::PainterModes modes ) bool QCPPainter::begin( QPaintDevice* device ) { bool result = QPainter::begin( device ); -#if QT_VERSION < QT_VERSION_CHECK( 5, 0, 0 ) // before Qt5, default pens used to be cosmetic if NonCosmeticDefaultPen - // flag isn't set. So we set it to get consistency across Qt versions. +#if QT_VERSION < QT_VERSION_CHECK( 5, 0, 0 ) // before Qt5, default pens used to + // be cosmetic if + // NonCosmeticDefaultPen + // flag isn't set. So we set it to get consistency across Qt versions. if( result ) setRenderHint( QPainter::NonCosmeticDefaultPen ); #endif @@ -182,7 +211,8 @@ bool QCPPainter::begin( QPaintDevice* device ) /*! \overload - Sets the mode of the painter. This controls whether the painter shall adjust its + Sets the mode of the painter. This controls whether the painter shall adjust + its fixes/workarounds optimized for certain output devices. */ void QCPPainter::setMode( QCPPainter::PainterMode mode, bool enabled ) @@ -194,8 +224,10 @@ void QCPPainter::setMode( QCPPainter::PainterMode mode, bool enabled ) } /*! - Saves the painter (see QPainter::save). Since QCPPainter adds some new internal state to - QPainter, the save/restore functions are reimplemented to also save/restore those members. + Saves the painter (see QPainter::save). Since QCPPainter adds some new + internal state to + QPainter, the save/restore functions are reimplemented to also save/restore + those members. \note this function hides the non-virtual base class implementation. @@ -208,8 +240,10 @@ void QCPPainter::save() } /*! - Restores the painter (see QPainter::restore). Since QCPPainter adds some new internal state to - QPainter, the save/restore functions are reimplemented to also save/restore those members. + Restores the painter (see QPainter::restore). Since QCPPainter adds some new + internal state to + QPainter, the save/restore functions are reimplemented to also save/restore + those members. \note this function hides the non-virtual base class implementation. @@ -225,7 +259,8 @@ void QCPPainter::restore() } /*! - Changes the pen width to 1 if it currently is 0. This function is called in the \ref setPen + Changes the pen width to 1 if it currently is 0. This function is called in + the \ref setPen overrides when the \ref pmNonCosmetic mode is set. */ void QCPPainter::makeNonCosmetic() @@ -245,17 +280,22 @@ void QCPPainter::makeNonCosmetic() /*! \class QCPScatterStyle \brief Represents the visual appearance of scatter points - This class holds information about shape, color and size of scatter points. In plottables like - QCPGraph it is used to store how scatter points shall be drawn. For example, \ref + This class holds information about shape, color and size of scatter points. In + plottables like + QCPGraph it is used to store how scatter points shall be drawn. For example, + \ref QCPGraph::setScatterStyle takes a QCPScatterStyle instance. - A scatter style consists of a shape (\ref setShape), a line color (\ref setPen) and possibly a - fill (\ref setBrush), if the shape provides a fillable area. Further, the size of the shape can + A scatter style consists of a shape (\ref setShape), a line color (\ref + setPen) and possibly a + fill (\ref setBrush), if the shape provides a fillable area. Further, the size + of the shape can be controlled with \ref setSize. \section QCPScatterStyle-defining Specifying a scatter style - You can set all these configurations either by calling the respective functions on an instance: + You can set all these configurations either by calling the respective + functions on an instance: \code QCPScatterStyle myScatter; myScatter.setShape(QCPScatterStyle::ssCircle); @@ -265,41 +305,58 @@ void QCPPainter::makeNonCosmetic() customPlot->graph(0)->setScatterStyle(myScatter); \endcode - Or you can use one of the various constructors that take different parameter combinations, making + Or you can use one of the various constructors that take different parameter + combinations, making it easy to specify a scatter style in a single call, like so: \code - customPlot->graph(0)->setScatterStyle(QCPScatterStyle(QCPScatterStyle::ssCircle, Qt::blue, Qt::white, 5)); + customPlot->graph(0)->setScatterStyle(QCPScatterStyle(QCPScatterStyle::ssCircle, + Qt::blue, Qt::white, 5)); \endcode - \section QCPScatterStyle-undefinedpen Leaving the color/pen up to the plottable + \section QCPScatterStyle-undefinedpen Leaving the color/pen up to the + plottable - There are two constructors which leave the pen undefined: \ref QCPScatterStyle() and \ref - QCPScatterStyle(ScatterShape shape, double size). If those constructors are used, a call to \ref - isPenDefined will return false. It leads to scatter points that inherit the pen from the - plottable that uses the scatter style. Thus, if such a scatter style is passed to QCPGraph, the line - color of the graph (\ref QCPGraph::setPen) will be used by the scatter points. This makes + There are two constructors which leave the pen undefined: \ref + QCPScatterStyle() and \ref + QCPScatterStyle(ScatterShape shape, double size). If those constructors are + used, a call to \ref + isPenDefined will return false. It leads to scatter points that inherit the + pen from the + plottable that uses the scatter style. Thus, if such a scatter style is passed + to QCPGraph, the line + color of the graph (\ref QCPGraph::setPen) will be used by the scatter points. + This makes it very convenient to set up typical scatter settings: \code customPlot->graph(0)->setScatterStyle(QCPScatterStyle::ssPlus); \endcode - Notice that it wasn't even necessary to explicitly call a QCPScatterStyle constructor. This works - because QCPScatterStyle provides a constructor that can transform a \ref ScatterShape directly - into a QCPScatterStyle instance (that's the \ref QCPScatterStyle(ScatterShape shape, double size) - constructor with a default for \a size). In those cases, C++ allows directly supplying a \ref + Notice that it wasn't even necessary to explicitly call a QCPScatterStyle + constructor. This works + because QCPScatterStyle provides a constructor that can transform a \ref + ScatterShape directly + into a QCPScatterStyle instance (that's the \ref QCPScatterStyle(ScatterShape + shape, double size) + constructor with a default for \a size). In those cases, C++ allows directly + supplying a \ref ScatterShape, where actually a QCPScatterStyle is expected. \section QCPScatterStyle-custompath-and-pixmap Custom shapes and pixmaps - QCPScatterStyle supports drawing custom shapes and arbitrary pixmaps as scatter points. + QCPScatterStyle supports drawing custom shapes and arbitrary pixmaps as + scatter points. - For custom shapes, you can provide a QPainterPath with the desired shape to the \ref - setCustomPath function or call the constructor that takes a painter path. The scatter shape will + For custom shapes, you can provide a QPainterPath with the desired shape to + the \ref + setCustomPath function or call the constructor that takes a painter path. The + scatter shape will automatically be set to \ref ssCustom. - For pixmaps, you call \ref setPixmap with the desired QPixmap. Alternatively you can use the - constructor that takes a QPixmap. The scatter shape will automatically be set to \ref ssPixmap. + For pixmaps, you call \ref setPixmap with the desired QPixmap. Alternatively + you can use the + constructor that takes a QPixmap. The scatter shape will automatically be set + to \ref ssPixmap. Note that \ref setSize does not influence the appearance of the pixmap. */ @@ -316,9 +373,12 @@ void QCPPainter::makeNonCosmetic() Returns whether a pen has been defined for this scatter style. - The pen is undefined if a constructor is called that does not carry \a pen as parameter. Those are - \ref QCPScatterStyle() and \ref QCPScatterStyle(ScatterShape shape, double size). If the pen is - left undefined, the scatter color will be inherited from the plottable that uses this scatter + The pen is undefined if a constructor is called that does not carry \a pen as + parameter. Those are + \ref QCPScatterStyle() and \ref QCPScatterStyle(ScatterShape shape, double + size). If the pen is + left undefined, the scatter color will be inherited from the plottable that + uses this scatter style. \see setPen @@ -327,9 +387,11 @@ void QCPPainter::makeNonCosmetic() /* end documentation of inline functions */ /*! - Creates a new QCPScatterStyle instance with size set to 6. No shape, pen or brush is defined. + Creates a new QCPScatterStyle instance with size set to 6. No shape, pen or + brush is defined. - Since the pen is undefined (\ref isPenDefined returns false), the scatter color will be inherited + Since the pen is undefined (\ref isPenDefined returns false), the scatter + color will be inherited from the plottable that uses this scatter style. */ QCPScatterStyle::QCPScatterStyle() @@ -338,10 +400,12 @@ QCPScatterStyle::QCPScatterStyle() } /*! - Creates a new QCPScatterStyle instance with shape set to \a shape and size to \a size. No pen or + Creates a new QCPScatterStyle instance with shape set to \a shape and size to + \a size. No pen or brush is defined. - Since the pen is undefined (\ref isPenDefined returns false), the scatter color will be inherited + Since the pen is undefined (\ref isPenDefined returns false), the scatter + color will be inherited from the plottable that uses this scatter style. */ QCPScatterStyle::QCPScatterStyle( ScatterShape shape, double size ) @@ -350,63 +414,111 @@ QCPScatterStyle::QCPScatterStyle( ScatterShape shape, double size ) } /*! - Creates a new QCPScatterStyle instance with shape set to \a shape, the pen color set to \a color, - and size to \a size. No brush is defined, i.e. the scatter point will not be filled. + Creates a new QCPScatterStyle instance with shape set to \a shape, the pen + color set to \a color, + and size to \a size. No brush is defined, i.e. the scatter point will not be + filled. */ QCPScatterStyle::QCPScatterStyle( ScatterShape shape, const QColor& color, double size ) - : mSize( size ), mShape( shape ), mPen( QPen( color ) ), mBrush( Qt::NoBrush ), mPenDefined( true ) + : mSize( size ) + , mShape( shape ) + , mPen( QPen( color ) ) + , mBrush( Qt::NoBrush ) + , mPenDefined( true ) { } /*! - Creates a new QCPScatterStyle instance with shape set to \a shape, the pen color set to \a color, + Creates a new QCPScatterStyle instance with shape set to \a shape, the pen + color set to \a color, the brush color to \a fill (with a solid pattern), and size to \a size. */ -QCPScatterStyle::QCPScatterStyle( ScatterShape shape, const QColor& color, const QColor& fill, double size ) - : mSize( size ), mShape( shape ), mPen( QPen( color ) ), mBrush( QBrush( fill ) ), mPenDefined( true ) +QCPScatterStyle::QCPScatterStyle( ScatterShape shape, + const QColor& color, + const QColor& fill, + double size ) + : mSize( size ) + , mShape( shape ) + , mPen( QPen( color ) ) + , mBrush( QBrush( fill ) ) + , mPenDefined( true ) { } /*! - Creates a new QCPScatterStyle instance with shape set to \a shape, the pen set to \a pen, the + Creates a new QCPScatterStyle instance with shape set to \a shape, the pen set + to \a pen, the brush to \a brush, and size to \a size. - \warning In some cases it might be tempting to directly use a pen style like Qt::NoPen as \a pen - and a color like Qt::blue as \a brush. Notice however, that the corresponding call\n + \warning In some cases it might be tempting to directly use a pen style like + Qt::NoPen as \a pen + and a color like Qt::blue as \a brush. Notice however, that the + corresponding call\n QCPScatterStyle(QCPScatterShape::ssCircle, Qt::NoPen, Qt::blue, 5)\n - doesn't necessarily lead C++ to use this constructor in some cases, but might mistake + doesn't necessarily lead C++ to use this constructor in some cases, but might + mistake Qt::NoPen for a QColor and use the - \ref QCPScatterStyle(ScatterShape shape, const QColor &color, const QColor &fill, double size) - constructor instead (which will lead to an unexpected look of the scatter points). To prevent - this, be more explicit with the parameter types. For example, use QBrush(Qt::blue) - instead of just Qt::blue, to clearly point out to the compiler that this constructor is + \ref QCPScatterStyle(ScatterShape shape, const QColor &color, const QColor + &fill, double size) + constructor instead (which will lead to an unexpected look of the scatter + points). To prevent + this, be more explicit with the parameter types. For example, use + QBrush(Qt::blue) + instead of just Qt::blue, to clearly point out to the compiler that + this constructor is wanted. */ -QCPScatterStyle::QCPScatterStyle( ScatterShape shape, const QPen& pen, const QBrush& brush, double size ) - : mSize( size ), mShape( shape ), mPen( pen ), mBrush( brush ), mPenDefined( pen.style() != Qt::NoPen ) +QCPScatterStyle::QCPScatterStyle( ScatterShape shape, + const QPen& pen, + const QBrush& brush, + double size ) + : mSize( size ) + , mShape( shape ) + , mPen( pen ) + , mBrush( brush ) + , mPenDefined( pen.style() != Qt::NoPen ) { } /*! - Creates a new QCPScatterStyle instance which will show the specified \a pixmap. The scatter shape + Creates a new QCPScatterStyle instance which will show the specified \a + pixmap. The scatter shape is set to \ref ssPixmap. */ QCPScatterStyle::QCPScatterStyle( const QPixmap& pixmap ) - : mSize( 5 ), mShape( ssPixmap ), mPen( Qt::NoPen ), mBrush( Qt::NoBrush ), mPixmap( pixmap ), mPenDefined( false ) + : mSize( 5 ) + , mShape( ssPixmap ) + , mPen( Qt::NoPen ) + , mBrush( Qt::NoBrush ) + , mPixmap( pixmap ) + , mPenDefined( false ) { } /*! - Creates a new QCPScatterStyle instance with a custom shape that is defined via \a customPath. The + Creates a new QCPScatterStyle instance with a custom shape that is defined via + \a customPath. The scatter shape is set to \ref ssCustom. - The custom shape line will be drawn with \a pen and filled with \a brush. The size has a slightly - different meaning than for built-in scatter points: The custom path will be drawn scaled by a - factor of \a size/6.0. Since the default \a size is 6, the custom path will appear at a its - natural size by default. To double the size of the path for example, set \a size to 12. + The custom shape line will be drawn with \a pen and filled with \a brush. The + size has a slightly + different meaning than for built-in scatter points: The custom path will be + drawn scaled by a + factor of \a size/6.0. Since the default \a size is 6, the custom path will + appear at a its + natural size by default. To double the size of the path for example, set \a + size to 12. */ -QCPScatterStyle::QCPScatterStyle( const QPainterPath& customPath, const QPen& pen, const QBrush& brush, double size ) - : mSize( size ), mShape( ssCustom ), mPen( pen ), mBrush( brush ), mCustomPath( customPath ), mPenDefined( false ) +QCPScatterStyle::QCPScatterStyle( const QPainterPath& customPath, + const QPen& pen, + const QBrush& brush, + double size ) + : mSize( size ) + , mShape( ssCustom ) + , mPen( pen ) + , mBrush( brush ) + , mCustomPath( customPath ) + , mPenDefined( false ) { } @@ -423,7 +535,8 @@ void QCPScatterStyle::setSize( double size ) /*! Sets the shape to \a shape. - Note that the calls \ref setPixmap and \ref setCustomPath automatically set the shape to \ref + Note that the calls \ref setPixmap and \ref setCustomPath automatically set + the shape to \ref ssPixmap and \ref ssCustom, respectively. \see setSize @@ -436,7 +549,8 @@ void QCPScatterStyle::setShape( QCPScatterStyle::ScatterShape shape ) /*! Sets the pen that will be used to draw scatter points to \a pen. - If the pen was previously undefined (see \ref isPenDefined), the pen is considered defined after + If the pen was previously undefined (see \ref isPenDefined), the pen is + considered defined after a call to this function, even if \a pen is Qt::NoPen. \see setBrush @@ -448,8 +562,10 @@ void QCPScatterStyle::setPen( const QPen& pen ) } /*! - Sets the brush that will be used to fill scatter points to \a brush. Note that not all scatter - shapes have fillable areas. For example, \ref ssPlus does not while \ref ssCircle does. + Sets the brush that will be used to fill scatter points to \a brush. Note that + not all scatter + shapes have fillable areas. For example, \ref ssPlus does not while \ref + ssCircle does. \see setPen */ @@ -483,10 +599,13 @@ void QCPScatterStyle::setCustomPath( const QPainterPath& customPath ) } /*! - Applies the pen and the brush of this scatter style to \a painter. If this scatter style has an - undefined pen (\ref isPenDefined), sets the pen of \a painter to \a defaultPen instead. + Applies the pen and the brush of this scatter style to \a painter. If this + scatter style has an + undefined pen (\ref isPenDefined), sets the pen of \a painter to \a defaultPen + instead. - This function is used by plottables (or any class that wants to draw scatters) just before a + This function is used by plottables (or any class that wants to draw scatters) + just before a number of scatters with this style shall be drawn with the \a painter. \see drawShape @@ -500,7 +619,8 @@ void QCPScatterStyle::applyTo( QCPPainter* painter, const QPen& defaultPen ) con /*! Draws the scatter shape with \a painter at position \a pos. - This function does not modify the pen or the brush on the painter, as \ref applyTo is meant to be + This function does not modify the pen or the brush on the painter, as \ref + applyTo is meant to be called before scatter points are drawn with \ref drawShape. \see applyTo @@ -645,42 +765,65 @@ void QCPScatterStyle::drawShape( QCPPainter* painter, double x, double y ) const /*! \class QCPLayer \brief A layer that may contain objects, to control the rendering order - The Layering system of QCustomPlot is the mechanism to control the rendering order of the + The Layering system of QCustomPlot is the mechanism to control the rendering + order of the elements inside the plot. - It is based on the two classes QCPLayer and QCPLayerable. QCustomPlot holds an ordered list of - one or more instances of QCPLayer (see QCustomPlot::addLayer, QCustomPlot::layer, - QCustomPlot::moveLayer, etc.). When replotting, QCustomPlot goes through the list of layers + It is based on the two classes QCPLayer and QCPLayerable. QCustomPlot holds an + ordered list of + one or more instances of QCPLayer (see QCustomPlot::addLayer, + QCustomPlot::layer, + QCustomPlot::moveLayer, etc.). When replotting, QCustomPlot goes through the + list of layers bottom to top and successively draws the layerables of the layers. - A QCPLayer contains an ordered list of QCPLayerable instances. QCPLayerable is an abstract base - class from which almost all visible objects derive, like axes, grids, graphs, items, etc. + A QCPLayer contains an ordered list of QCPLayerable instances. QCPLayerable is + an abstract base + class from which almost all visible objects derive, like axes, grids, graphs, + items, etc. - Initially, QCustomPlot has five layers: "background", "grid", "main", "axes" and "legend" (in - that order). The top two layers "axes" and "legend" contain the default axes and legend, so they - will be drawn on top. In the middle, there is the "main" layer. It is initially empty and set as - the current layer (see QCustomPlot::setCurrentLayer). This means, all new plottables, items etc. - are created on this layer by default. Then comes the "grid" layer which contains the QCPGrid - instances (which belong tightly to QCPAxis, see \ref QCPAxis::grid). The Axis rect background - shall be drawn behind everything else, thus the default QCPAxisRect instance is placed on the - "background" layer. Of course, the layer affiliation of the individual objects can be changed as + Initially, QCustomPlot has five layers: "background", "grid", "main", "axes" + and "legend" (in + that order). The top two layers "axes" and "legend" contain the default axes + and legend, so they + will be drawn on top. In the middle, there is the "main" layer. It is + initially empty and set as + the current layer (see QCustomPlot::setCurrentLayer). This means, all new + plottables, items etc. + are created on this layer by default. Then comes the "grid" layer which + contains the QCPGrid + instances (which belong tightly to QCPAxis, see \ref QCPAxis::grid). The Axis + rect background + shall be drawn behind everything else, thus the default QCPAxisRect instance + is placed on the + "background" layer. Of course, the layer affiliation of the individual objects + can be changed as required (\ref QCPLayerable::setLayer). - Controlling the ordering of objects is easy: Create a new layer in the position you want it to - be, e.g. above "main", with QCustomPlot::addLayer. Then set the current layer with - QCustomPlot::setCurrentLayer to that new layer and finally create the objects normally. They will - be placed on the new layer automatically, due to the current layer setting. Alternatively you - could have also ignored the current layer setting and just moved the objects with + Controlling the ordering of objects is easy: Create a new layer in the + position you want it to + be, e.g. above "main", with QCustomPlot::addLayer. Then set the current layer + with + QCustomPlot::setCurrentLayer to that new layer and finally create the objects + normally. They will + be placed on the new layer automatically, due to the current layer setting. + Alternatively you + could have also ignored the current layer setting and just moved the objects + with QCPLayerable::setLayer to the desired layer after creating them. - It is also possible to move whole layers. For example, If you want the grid to be shown in front + It is also possible to move whole layers. For example, If you want the grid to + be shown in front of all plottables/items on the "main" layer, just move it above "main" with QCustomPlot::moveLayer. - The rendering order within one layer is simply by order of creation or insertion. The item - created last (or added last to the layer), is drawn on top of all other objects on that layer. + The rendering order within one layer is simply by order of creation or + insertion. The item + created last (or added last to the layer), is drawn on top of all other + objects on that layer. - When a layer is deleted, the objects on it are not deleted with it, but fall on the layer below + When a layer is deleted, the objects on it are not deleted with it, but fall + on the layer below the deleted layer, see QCustomPlot::removeLayer. */ @@ -688,13 +831,15 @@ void QCPScatterStyle::drawShape( QCPPainter* painter, double x, double y ) const /*! \fn QList QCPLayer::children() const - Returns a list of all layerables on this layer. The order corresponds to the rendering order: + Returns a list of all layerables on this layer. The order corresponds to the + rendering order: layerables with higher indices are drawn above layerables with lower indices. */ /*! \fn int QCPLayer::index() const - Returns the index this layer has in the QCustomPlot. The index is the integer number by which this layer can be + Returns the index this layer has in the QCustomPlot. The index is the integer + number by which this layer can be accessed via \ref QCustomPlot::layer. Layers with higher indices will be drawn above layers with lower indices. @@ -705,17 +850,21 @@ void QCPScatterStyle::drawShape( QCPPainter* painter, double x, double y ) const /*! Creates a new QCPLayer instance. - Normally you shouldn't directly instantiate layers, use \ref QCustomPlot::addLayer instead. + Normally you shouldn't directly instantiate layers, use \ref + QCustomPlot::addLayer instead. - \warning It is not checked that \a layerName is actually a unique layer name in \a parentPlot. + \warning It is not checked that \a layerName is actually a unique layer name + in \a parentPlot. This check is only performed by \ref QCustomPlot::addLayer. */ QCPLayer::QCPLayer( QCustomPlot* parentPlot, const QString& layerName ) - : QObject( parentPlot ), - mParentPlot( parentPlot ), - mName( layerName ), - mIndex( -1 ), // will be set to a proper value by the QCustomPlot layer creation function - mVisible( true ) + : QObject( parentPlot ) + , mParentPlot( parentPlot ) + , mName( layerName ) + , mIndex( -1 ) + , // will be set to a proper value by the QCustomPlot layer + // creation function + mVisible( true ) { // Note: no need to make sure layerName is unique, because layer // management is done with QCustomPlot functions. @@ -723,25 +872,32 @@ QCPLayer::QCPLayer( QCustomPlot* parentPlot, const QString& layerName ) QCPLayer::~QCPLayer() { - // If child layerables are still on this layer, detach them, so they don't try to reach back to this - // then invalid layer once they get deleted/moved themselves. This only happens when layers are deleted - // directly, like in the QCustomPlot destructor. (The regular layer removal procedure for the user is to - // call QCustomPlot::removeLayer, which moves all layerables off this layer before deleting it.) + // If child layerables are still on this layer, detach them, so they don't try + // to reach back to this + // then invalid layer once they get deleted/moved themselves. This only + // happens when layers are deleted + // directly, like in the QCustomPlot destructor. (The regular layer removal + // procedure for the user is to + // call QCustomPlot::removeLayer, which moves all layerables off this layer + // before deleting it.) while( !mChildren.isEmpty() ) mChildren.last()->setLayer( 0 ); // removes itself from mChildren via removeChild() if( mParentPlot->currentLayer() == this ) - qDebug() << Q_FUNC_INFO << "The parent plot's mCurrentLayer will be a dangling pointer. Should have been set to a " + qDebug() << Q_FUNC_INFO << "The parent plot's mCurrentLayer will be a " + "dangling pointer. Should have been set to a " "valid layer or 0 beforehand."; } /*! - Sets whether this layer is visible or not. If \a visible is set to false, all layerables on this + Sets whether this layer is visible or not. If \a visible is set to false, all + layerables on this layer will be invisible. This function doesn't change the visibility property of the layerables (\ref - QCPLayerable::setVisible), but the \ref QCPLayerable::realVisibility of each layerable takes the + QCPLayerable::setVisible), but the \ref QCPLayerable::realVisibility of each + layerable takes the visibility of the parent layer into account. */ void QCPLayer::setVisible( bool visible ) @@ -751,10 +907,13 @@ void QCPLayer::setVisible( bool visible ) /*! \internal - Adds the \a layerable to the list of this layer. If \a prepend is set to true, the layerable will - be prepended to the list, i.e. be drawn beneath the other layerables already in the list. + Adds the \a layerable to the list of this layer. If \a prepend is set to true, + the layerable will + be prepended to the list, i.e. be drawn beneath the other layerables already + in the list. - This function does not change the \a mLayer member of \a layerable to this layer. (Use + This function does not change the \a mLayer member of \a layerable to this + layer. (Use QCPLayerable::setLayer to change the layer of an object, not this function.) \see removeChild @@ -769,14 +928,16 @@ void QCPLayer::addChild( QCPLayerable* layerable, bool prepend ) mChildren.append( layerable ); } else - qDebug() << Q_FUNC_INFO << "layerable is already child of this layer" << reinterpret_cast( layerable ); + qDebug() << Q_FUNC_INFO << "layerable is already child of this layer" + << reinterpret_cast( layerable ); } /*! \internal Removes the \a layerable from the list of this layer. - This function does not change the \a mLayer member of \a layerable. (Use QCPLayerable::setLayer + This function does not change the \a mLayer member of \a layerable. (Use + QCPLayerable::setLayer to change the layer of an object, not this function.) \see addChild @@ -784,7 +945,8 @@ void QCPLayer::addChild( QCPLayerable* layerable, bool prepend ) void QCPLayer::removeChild( QCPLayerable* layerable ) { if( !mChildren.removeOne( layerable ) ) - qDebug() << Q_FUNC_INFO << "layerable is not child of this layer" << reinterpret_cast( layerable ); + qDebug() << Q_FUNC_INFO << "layerable is not child of this layer" + << reinterpret_cast( layerable ); } //////////////////////////////////////////////////////////////////////////////////////////////////// @@ -794,10 +956,12 @@ void QCPLayer::removeChild( QCPLayerable* layerable ) /*! \class QCPLayerable \brief Base class for all drawable objects - This is the abstract base class most visible objects derive from, e.g. plottables, axes, grid + This is the abstract base class most visible objects derive from, e.g. + plottables, axes, grid etc. - Every layerable is on a layer (QCPLayer) which allows controlling the rendering order by stacking + Every layerable is on a layer (QCPLayer) which allows controlling the + rendering order by stacking the layers accordingly. For details about the layering mechanism, see the QCPLayer documentation. @@ -807,57 +971,84 @@ void QCPLayer::removeChild( QCPLayerable* layerable ) /*! \fn QCPLayerable *QCPLayerable::parentLayerable() const - Returns the parent layerable of this layerable. The parent layerable is used to provide - visibility hierarchies in conjunction with the method \ref realVisibility. This way, layerables + Returns the parent layerable of this layerable. The parent layerable is used + to provide + visibility hierarchies in conjunction with the method \ref realVisibility. + This way, layerables only get drawn if their parent layerables are visible, too. - Note that a parent layerable is not necessarily also the QObject parent for memory management. - Further, a layerable doesn't always have a parent layerable, so this function may return 0. + Note that a parent layerable is not necessarily also the QObject parent for + memory management. + Further, a layerable doesn't always have a parent layerable, so this function + may return 0. - A parent layerable is set implicitly with when placed inside layout elements and doesn't need to be + A parent layerable is set implicitly with when placed inside layout elements + and doesn't need to be set manually by the user. */ /* end documentation of inline functions */ /* start documentation of pure virtual functions */ -/*! \fn virtual void QCPLayerable::applyDefaultAntialiasingHint(QCPPainter *painter) const = 0 +/*! \fn virtual void QCPLayerable::applyDefaultAntialiasingHint(QCPPainter + *painter) const = 0 \internal - This function applies the default antialiasing setting to the specified \a painter, using the - function \ref applyAntialiasingHint. It is the antialiasing state the painter is put in, when - \ref draw is called on the layerable. If the layerable has multiple entities whose antialiasing - setting may be specified individually, this function should set the antialiasing state of the - most prominent entity. In this case however, the \ref draw function usually calls the specialized - versions of this function before drawing each entity, effectively overriding the setting of the + This function applies the default antialiasing setting to the specified \a + painter, using the + function \ref applyAntialiasingHint. It is the antialiasing state the painter + is put in, when + \ref draw is called on the layerable. If the layerable has multiple entities + whose antialiasing + setting may be specified individually, this function should set the + antialiasing state of the + most prominent entity. In this case however, the \ref draw function usually + calls the specialized + versions of this function before drawing each entity, effectively overriding + the setting of the default antialiasing hint. - First example: QCPGraph has multiple entities that have an antialiasing setting: The graph - line, fills, scatters and error bars. Those can be configured via QCPGraph::setAntialiased, - QCPGraph::setAntialiasedFill, QCPGraph::setAntialiasedScatters etc. Consequently, there isn't - only the QCPGraph::applyDefaultAntialiasingHint function (which corresponds to the graph line's - antialiasing), but specialized ones like QCPGraph::applyFillAntialiasingHint and - QCPGraph::applyScattersAntialiasingHint. So before drawing one of those entities, QCPGraph::draw + First example: QCPGraph has multiple entities that have an antialiasing + setting: The graph + line, fills, scatters and error bars. Those can be configured via + QCPGraph::setAntialiased, + QCPGraph::setAntialiasedFill, QCPGraph::setAntialiasedScatters etc. + Consequently, there isn't + only the QCPGraph::applyDefaultAntialiasingHint function (which corresponds to + the graph line's + antialiasing), but specialized ones like QCPGraph::applyFillAntialiasingHint + and + QCPGraph::applyScattersAntialiasingHint. So before drawing one of those + entities, QCPGraph::draw calls the respective specialized applyAntialiasingHint function. - Second example: QCPItemLine consists only of a line so there is only one antialiasing - setting which can be controlled with QCPItemLine::setAntialiased. (This function is inherited by - all layerables. The specialized functions, as seen on QCPGraph, must be added explicitly to the + Second example: QCPItemLine consists only of a line so there is only + one antialiasing + setting which can be controlled with QCPItemLine::setAntialiased. (This + function is inherited by + all layerables. The specialized functions, as seen on QCPGraph, must be added + explicitly to the respective layerable subclass.) Consequently it only has the normal - QCPItemLine::applyDefaultAntialiasingHint. The \ref QCPItemLine::draw function doesn't need to - care about setting any antialiasing states, because the default antialiasing hint is already set - on the painter when the \ref draw function is called, and that's the state it wants to draw the + QCPItemLine::applyDefaultAntialiasingHint. The \ref QCPItemLine::draw function + doesn't need to + care about setting any antialiasing states, because the default antialiasing + hint is already set + on the painter when the \ref draw function is called, and that's the state it + wants to draw the line with. */ /*! \fn virtual void QCPLayerable::draw(QCPPainter *painter) const = 0 \internal - This function draws the layerable with the specified \a painter. It is only called by + This function draws the layerable with the specified \a painter. It is only + called by QCustomPlot, if the layerable is visible (\ref setVisible). - Before this function is called, the painter's antialiasing state is set via \ref - applyDefaultAntialiasingHint, see the documentation there. Further, the clipping rectangle was + Before this function is called, the painter's antialiasing state is set via + \ref + applyDefaultAntialiasingHint, see the documentation there. Further, the + clipping rectangle was set to \ref clipRect. */ @@ -866,7 +1057,8 @@ void QCPLayer::removeChild( QCPLayerable* layerable ) /*! \fn void QCPLayerable::layerChanged(QCPLayer *newLayer); - This signal is emitted when the layer of this layerable changes, i.e. this layerable is moved to + This signal is emitted when the layer of this layerable changes, i.e. this + layerable is moved to a different layer. \see setLayer @@ -877,35 +1069,44 @@ void QCPLayer::removeChild( QCPLayerable* layerable ) /*! Creates a new QCPLayerable instance. - Since QCPLayerable is an abstract base class, it can't be instantiated directly. Use one of the + Since QCPLayerable is an abstract base class, it can't be instantiated + directly. Use one of the derived classes. - If \a plot is provided, it automatically places itself on the layer named \a targetLayer. If \a - targetLayer is an empty string, it places itself on the current layer of the plot (see \ref + If \a plot is provided, it automatically places itself on the layer named \a + targetLayer. If \a + targetLayer is an empty string, it places itself on the current layer of the + plot (see \ref QCustomPlot::setCurrentLayer). - It is possible to provide 0 as \a plot. In that case, you should assign a parent plot at a later + It is possible to provide 0 as \a plot. In that case, you should assign a + parent plot at a later time with \ref initializeParentPlot. - The layerable's parent layerable is set to \a parentLayerable, if provided. Direct layerable parents - are mainly used to control visibility in a hierarchy of layerables. This means a layerable is - only drawn, if all its ancestor layerables are also visible. Note that \a parentLayerable does - not become the QObject-parent (for memory management) of this layerable, \a plot does. + The layerable's parent layerable is set to \a parentLayerable, if provided. + Direct layerable parents + are mainly used to control visibility in a hierarchy of layerables. This means + a layerable is + only drawn, if all its ancestor layerables are also visible. Note that \a + parentLayerable does + not become the QObject-parent (for memory management) of this layerable, \a + plot does. */ QCPLayerable::QCPLayerable( QCustomPlot* plot, QString targetLayer, QCPLayerable* parentLayerable ) - : QObject( plot ), - mVisible( true ), - mParentPlot( plot ), - mParentLayerable( parentLayerable ), - mLayer( 0 ), - mAntialiased( true ) + : QObject( plot ) + , mVisible( true ) + , mParentPlot( plot ) + , mParentLayerable( parentLayerable ) + , mLayer( 0 ) + , mAntialiased( true ) { if( mParentPlot ) { if( targetLayer.isEmpty() ) setLayer( mParentPlot->currentLayer() ); else if( !setLayer( targetLayer ) ) - qDebug() << Q_FUNC_INFO << "setting QCPlayerable initial layer to" << targetLayer << "failed."; + qDebug() << Q_FUNC_INFO << "setting QCPlayerable initial layer to" << targetLayer + << "failed."; } } @@ -919,8 +1120,10 @@ QCPLayerable::~QCPLayerable() } /*! - Sets the visibility of this layerable object. If an object is not visible, it will not be drawn - on the QCustomPlot surface, and user interaction with it (e.g. click and selection) is not + Sets the visibility of this layerable object. If an object is not visible, it + will not be drawn + on the QCustomPlot surface, and user interaction with it (e.g. click and + selection) is not possible. */ void QCPLayerable::setVisible( bool on ) @@ -929,7 +1132,8 @@ void QCPLayerable::setVisible( bool on ) } /*! - Sets the \a layer of this layerable object. The object will be placed on top of the other objects + Sets the \a layer of this layerable object. The object will be placed on top + of the other objects already on \a layer. Returns true on success, i.e. if \a layer is a valid layer. @@ -965,7 +1169,8 @@ bool QCPLayerable::setLayer( const QString& layerName ) /*! Sets whether this object will be drawn antialiased or not. - Note that antialiasing settings may be overridden by QCustomPlot::setAntialiasedElements and + Note that antialiasing settings may be overridden by + QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements. */ void QCPLayerable::setAntialiased( bool enabled ) @@ -974,16 +1179,22 @@ void QCPLayerable::setAntialiased( bool enabled ) } /*! - Returns whether this layerable is visible, taking the visibility of the layerable parent and the - visibility of the layer this layerable is on into account. This is the method that is consulted + Returns whether this layerable is visible, taking the visibility of the + layerable parent and the + visibility of the layer this layerable is on into account. This is the method + that is consulted to decide whether a layerable shall be drawn or not. - If this layerable has a direct layerable parent (usually set via hierarchies implemented in - subclasses, like in the case of QCPLayoutElement), this function returns true only if this - layerable has its visibility set to true and the parent layerable's \ref realVisibility returns + If this layerable has a direct layerable parent (usually set via hierarchies + implemented in + subclasses, like in the case of QCPLayoutElement), this function returns true + only if this + layerable has its visibility set to true and the parent layerable's \ref + realVisibility returns true. - If this layerable doesn't have a direct layerable parent, returns the state of this layerable's + If this layerable doesn't have a direct layerable parent, returns the state of + this layerable's visibility. */ bool QCPLayerable::realVisibility() const @@ -993,36 +1204,56 @@ bool QCPLayerable::realVisibility() const } /*! - This function is used to decide whether a click hits a layerable object or not. + This function is used to decide whether a click hits a layerable object or + not. - \a pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the - shortest pixel distance of this point to the object. If the object is either invisible or the - distance couldn't be determined, -1.0 is returned. Further, if \a onlySelectable is true and the + \a pos is a point in pixel coordinates on the QCustomPlot surface. This + function returns the + shortest pixel distance of this point to the object. If the object is either + invisible or the + distance couldn't be determined, -1.0 is returned. Further, if \a + onlySelectable is true and the object is not selectable, -1.0 is returned, too. - If the item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a - click inside the area returns a constant value greater zero (typically the selectionTolerance of - the parent QCustomPlot multiplied by 0.99). If the click lies outside the area, this function + If the item is represented not by single lines but by an area like QCPItemRect + or QCPItemText, a + click inside the area returns a constant value greater zero (typically the + selectionTolerance of + the parent QCustomPlot multiplied by 0.99). If the click lies outside the + area, this function returns -1.0. - Providing a constant value for area objects allows selecting line objects even when they are - obscured by such area objects, by clicking close to the lines (i.e. closer than + Providing a constant value for area objects allows selecting line objects even + when they are + obscured by such area objects, by clicking close to the lines (i.e. closer + than 0.99*selectionTolerance). - The actual setting of the selection state is not done by this function. This is handled by the - parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified + The actual setting of the selection state is not done by this function. This + is handled by the + parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected + object is notified via the selectEvent/deselectEvent methods. - \a details is an optional output parameter. Every layerable subclass may place any information - in \a details. This information will be passed to \ref selectEvent when the parent QCustomPlot - decides on the basis of this selectTest call, that the object was successfully selected. The - subsequent call to \ref selectEvent will carry the \a details. This is useful for multi-part - objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked - is only done once in \ref selectTest. The result (i.e. the actually clicked part) can then be - placed in \a details. So in the subsequent \ref selectEvent, the decision which part was - selected doesn't have to be done a second time for a single selection operation. + \a details is an optional output parameter. Every layerable subclass may place + any information + in \a details. This information will be passed to \ref selectEvent when the + parent QCustomPlot + decides on the basis of this selectTest call, that the object was successfully + selected. The + subsequent call to \ref selectEvent will carry the \a details. This is useful + for multi-part + objects (like QCPAxis). This way, a possibly complex calculation to decide + which part was clicked + is only done once in \ref selectTest. The result (i.e. the actually clicked + part) can then be + placed in \a details. So in the subsequent \ref selectEvent, the decision + which part was + selected doesn't have to be done a second time for a single selection + operation. - You may pass 0 as \a details to indicate that you are not interested in those selection details. + You may pass 0 as \a details to indicate that you are not interested in those + selection details. \see selectEvent, deselectEvent, QCustomPlot::setInteractions */ @@ -1036,19 +1267,26 @@ double QCPLayerable::selectTest( const QPointF& pos, bool onlySelectable, QVaria /*! \internal - Sets the parent plot of this layerable. Use this function once to set the parent plot if you have - passed 0 in the constructor. It can not be used to move a layerable from one QCustomPlot to + Sets the parent plot of this layerable. Use this function once to set the + parent plot if you have + passed 0 in the constructor. It can not be used to move a layerable from one + QCustomPlot to another one. - Note that, unlike when passing a non-null parent plot in the constructor, this function does not - make \a parentPlot the QObject-parent of this layerable. If you want this, call + Note that, unlike when passing a non-null parent plot in the constructor, this + function does not + make \a parentPlot the QObject-parent of this layerable. If you want this, + call QObject::setParent(\a parentPlot) in addition to this function. - Further, you will probably want to set a layer (\ref setLayer) after calling this function, to + Further, you will probably want to set a layer (\ref setLayer) after calling + this function, to make the layerable appear on the QCustomPlot. - The parent plot change will be propagated to subclasses via a call to \ref parentPlotInitialized - so they can react accordingly (e.g. also initialize the parent plot of child layerables, like + The parent plot change will be propagated to subclasses via a call to \ref + parentPlotInitialized + so they can react accordingly (e.g. also initialize the parent plot of child + layerables, like QCPLayout does). */ void QCPLayerable::initializeParentPlot( QCustomPlot* parentPlot ) @@ -1068,11 +1306,14 @@ void QCPLayerable::initializeParentPlot( QCustomPlot* parentPlot ) /*! \internal - Sets the parent layerable of this layerable to \a parentLayerable. Note that \a parentLayerable does not + Sets the parent layerable of this layerable to \a parentLayerable. Note that + \a parentLayerable does not become the QObject-parent (for memory management) of this layerable. - The parent layerable has influence on the return value of the \ref realVisibility method. Only - layerables with a fully visible parent tree will return true for \ref realVisibility, and thus be + The parent layerable has influence on the return value of the \ref + realVisibility method. Only + layerables with a fully visible parent tree will return true for \ref + realVisibility, and thus be drawn. \see realVisibility @@ -1084,8 +1325,10 @@ void QCPLayerable::setParentLayerable( QCPLayerable* parentLayerable ) /*! \internal - Moves this layerable object to \a layer. If \a prepend is true, this object will be prepended to - the new layer's list, i.e. it will be drawn below the objects already on the layer. If it is + Moves this layerable object to \a layer. If \a prepend is true, this object + will be prepended to + the new layer's list, i.e. it will be drawn below the objects already on the + layer. If it is false, the object will be appended. Returns true on success, i.e. if \a layer is a valid layer. @@ -1099,7 +1342,8 @@ bool QCPLayerable::moveToLayer( QCPLayer* layer, bool prepend ) } if( layer && layer->parentPlot() != mParentPlot ) { - qDebug() << Q_FUNC_INFO << "layer" << layer->name() << "is not in same QCustomPlot as this layerable"; + qDebug() << Q_FUNC_INFO << "layer" << layer->name() + << "is not in same QCustomPlot as this layerable"; return false; } @@ -1116,9 +1360,12 @@ bool QCPLayerable::moveToLayer( QCPLayer* layer, bool prepend ) /*! \internal - Sets the QCPainter::setAntialiasing state on the provided \a painter, depending on the \a - localAntialiased value as well as the overrides \ref QCustomPlot::setAntialiasedElements and \ref - QCustomPlot::setNotAntialiasedElements. Which override enum this function takes into account is + Sets the QCPainter::setAntialiasing state on the provided \a painter, + depending on the \a + localAntialiased value as well as the overrides \ref + QCustomPlot::setAntialiasedElements and \ref + QCustomPlot::setNotAntialiasedElements. Which override enum this function + takes into account is controlled via \a overrideElement. */ void QCPLayerable::applyAntialiasingHint( QCPPainter* painter, @@ -1135,14 +1382,20 @@ void QCPLayerable::applyAntialiasingHint( QCPPainter* painter, /*! \internal - This function is called by \ref initializeParentPlot, to allow subclasses to react on the setting - of a parent plot. This is the case when 0 was passed as parent plot in the constructor, and the + This function is called by \ref initializeParentPlot, to allow subclasses to + react on the setting + of a parent plot. This is the case when 0 was passed as parent plot in the + constructor, and the parent plot is set at a later time. - For example, QCPLayoutElement/QCPLayout hierarchies may be created independently of any - QCustomPlot at first. When they are then added to a layout inside the QCustomPlot, the top level - element of the hierarchy gets its parent plot initialized with \ref initializeParentPlot. To - propagate the parent plot to all the children of the hierarchy, the top level element then uses + For example, QCPLayoutElement/QCPLayout hierarchies may be created + independently of any + QCustomPlot at first. When they are then added to a layout inside the + QCustomPlot, the top level + element of the hierarchy gets its parent plot initialized with \ref + initializeParentPlot. To + propagate the parent plot to all the children of the hierarchy, the top level + element then uses this function to pass the parent plot on to its child elements. The default implementation does nothing. @@ -1156,11 +1409,14 @@ void QCPLayerable::parentPlotInitialized( QCustomPlot* parentPlot ) /*! \internal - Returns the selection category this layerable shall belong to. The selection category is used in - conjunction with \ref QCustomPlot::setInteractions to control which objects are selectable and + Returns the selection category this layerable shall belong to. The selection + category is used in + conjunction with \ref QCustomPlot::setInteractions to control which objects + are selectable and which aren't. - Subclasses that don't fit any of the normal \ref QCP::Interaction values can use \ref + Subclasses that don't fit any of the normal \ref QCP::Interaction values can + use \ref QCP::iSelectOther. This is what the default implementation returns. \see QCustomPlot::setInteractions @@ -1172,11 +1428,14 @@ QCP::Interaction QCPLayerable::selectionCategory() const /*! \internal - Returns the clipping rectangle of this layerable object. By default, this is the viewport of the - parent QCustomPlot. Specific subclasses may reimplement this function to provide different + Returns the clipping rectangle of this layerable object. By default, this is + the viewport of the + parent QCustomPlot. Specific subclasses may reimplement this function to + provide different clipping rects. - The returned clipping rect is set on the painter before the draw function of the respective + The returned clipping rect is set on the painter before the draw function of + the respective object is called. */ QRect QCPLayerable::clipRect() const @@ -1189,28 +1448,43 @@ QRect QCPLayerable::clipRect() const /*! \internal - This event is called when the layerable shall be selected, as a consequence of a click by the - user. Subclasses should react to it by setting their selection state appropriately. The default + This event is called when the layerable shall be selected, as a consequence of + a click by the + user. Subclasses should react to it by setting their selection state + appropriately. The default implementation does nothing. - \a event is the mouse event that caused the selection. \a additive indicates, whether the user + \a event is the mouse event that caused the selection. \a additive indicates, + whether the user was holding the multi-select-modifier while performing the selection (see \ref - QCustomPlot::setMultiSelectModifier). if \a additive is true, the selection state must be toggled + QCustomPlot::setMultiSelectModifier). if \a additive is true, the selection + state must be toggled (i.e. become selected when unselected and unselected when selected). - Every selectEvent is preceded by a call to \ref selectTest, which has returned positively (i.e. - returned a value greater than 0 and less than the selection tolerance of the parent QCustomPlot). - The \a details data you output from \ref selectTest is fed back via \a details here. You may - use it to transport any kind of information from the selectTest to the possibly subsequent - selectEvent. Usually \a details is used to transfer which part was clicked, if it is a layerable - that has multiple individually selectable parts (like QCPAxis). This way selectEvent doesn't need + Every selectEvent is preceded by a call to \ref selectTest, which has returned + positively (i.e. + returned a value greater than 0 and less than the selection tolerance of the + parent QCustomPlot). + The \a details data you output from \ref selectTest is fed back via \a details + here. You may + use it to transport any kind of information from the selectTest to the + possibly subsequent + selectEvent. Usually \a details is used to transfer which part was clicked, if + it is a layerable + that has multiple individually selectable parts (like QCPAxis). This way + selectEvent doesn't need to do the calculation again to find out which part was actually clicked. - \a selectionStateChanged is an output parameter. If the pointer is non-null, this function must - set the value either to true or false, depending on whether the selection state of this layerable - was actually changed. For layerables that only are selectable as a whole and not in parts, this - is simple: if \a additive is true, \a selectionStateChanged must also be set to true, because the - selection toggles. If \a additive is false, \a selectionStateChanged is only set to true, if the + \a selectionStateChanged is an output parameter. If the pointer is non-null, + this function must + set the value either to true or false, depending on whether the selection + state of this layerable + was actually changed. For layerables that only are selectable as a whole and + not in parts, this + is simple: if \a additive is true, \a selectionStateChanged must also be set + to true, because the + selection toggles. If \a additive is false, \a selectionStateChanged is only + set to true, if the layerable was previously unselected and now is switched to the selected state. \see selectTest, deselectEvent @@ -1228,12 +1502,16 @@ void QCPLayerable::selectEvent( QMouseEvent* event, /*! \internal - This event is called when the layerable shall be deselected, either as consequence of a user - interaction or a call to \ref QCustomPlot::deselectAll. Subclasses should react to it by + This event is called when the layerable shall be deselected, either as + consequence of a user + interaction or a call to \ref QCustomPlot::deselectAll. Subclasses should + react to it by unsetting their selection appropriately. - just as in \ref selectEvent, the output parameter \a selectionStateChanged (if non-null), must - return true or false when the selection state of this layerable has changed or not changed, + just as in \ref selectEvent, the output parameter \a selectionStateChanged (if + non-null), must + return true or false when the selection state of this layerable has changed or + not changed, respectively. \see selectTest, selectEvent @@ -1249,25 +1527,31 @@ void QCPLayerable::deselectEvent( bool* selectionStateChanged ) /*! \class QCPRange \brief Represents the range an axis is encompassing. - contains a \a lower and \a upper double value and provides convenience input, output and + contains a \a lower and \a upper double value and provides convenience input, + output and modification functions. \see QCPAxis::setRange */ /*! - Minimum range size (\a upper - \a lower) the range changing functions will accept. Smaller - intervals would cause errors due to the 11-bit exponent of double precision numbers, + Minimum range size (\a upper - \a lower) the range changing functions will + accept. Smaller + intervals would cause errors due to the 11-bit exponent of double precision + numbers, corresponding to a minimum magnitude of roughly 1e-308. \see validRange, maxRange */ const double QCPRange::minRange = 1e-280; /*! - Maximum values (negative and positive) the range will accept in range-changing functions. - Larger absolute values would cause errors due to the 11-bit exponent of double precision numbers, + Maximum values (negative and positive) the range will accept in range-changing + functions. + Larger absolute values would cause errors due to the 11-bit exponent of double + precision numbers, corresponding to a maximum magnitude of roughly 1e308. - Since the number of planck-volumes in the entire visible universe is only ~1e183, this should + Since the number of planck-volumes in the entire visible universe is only + ~1e183, this should be enough. \see validRange, minRange */ @@ -1305,7 +1589,8 @@ double QCPRange::center() const } /*! - Makes sure \a lower is numerically smaller than \a upper. If this is not the case, the values + Makes sure \a lower is numerically smaller than \a upper. If this is not the + case, the values are swapped. */ void QCPRange::normalize() @@ -1315,10 +1600,12 @@ void QCPRange::normalize() } /*! - Expands this range such that \a otherRange is contained in the new range. It is assumed that both + Expands this range such that \a otherRange is contained in the new range. It + is assumed that both this range and \a otherRange are normalized (see \ref normalize). - If \a otherRange is already inside the current range, this function does nothing. + If \a otherRange is already inside the current range, this function does + nothing. \see expanded */ @@ -1331,7 +1618,8 @@ void QCPRange::expand( const QCPRange& otherRange ) } /*! - Returns an expanded range that contains this and \a otherRange. It is assumed that both this + Returns an expanded range that contains this and \a otherRange. It is assumed + that both this range and \a otherRange are normalized (see \ref normalize). \see expand @@ -1344,15 +1632,22 @@ QCPRange QCPRange::expanded( const QCPRange& otherRange ) const } /*! - Returns a sanitized version of the range. Sanitized means for logarithmic scales, that - the range won't span the positive and negative sign domain, i.e. contain zero. Further + Returns a sanitized version of the range. Sanitized means for logarithmic + scales, that + the range won't span the positive and negative sign domain, i.e. contain zero. + Further \a lower will always be numerically smaller (or equal) to \a upper. - If the original range does span positive and negative sign domains or contains zero, - the returned range will try to approximate the original range as good as possible. - If the positive interval of the original range is wider than the negative interval, the - returned range will only contain the positive interval, with lower bound set to \a rangeFac or - \a rangeFac *\a upper, whichever is closer to zero. Same procedure is used if the negative interval + If the original range does span positive and negative sign domains or contains + zero, + the returned range will try to approximate the original range as good as + possible. + If the positive interval of the original range is wider than the negative + interval, the + returned range will only contain the positive interval, with lower bound set + to \a rangeFac or + \a rangeFac *\a upper, whichever is closer to zero. Same procedure is used if + the negative interval is wider than the positive interval, this time by changing the \a upper bound. */ QCPRange QCPRange::sanitizedForLogScale() const @@ -1360,8 +1655,10 @@ QCPRange QCPRange::sanitizedForLogScale() const double rangeFac = 1e-3; QCPRange sanitizedRange( lower, upper ); sanitizedRange.normalize(); - // can't have range spanning negative and positive values in log plot, so change range to fix it - // if (qFuzzyCompare(sanitizedRange.lower+1, 1) && !qFuzzyCompare(sanitizedRange.upper+1, 1)) + // can't have range spanning negative and positive values in log plot, so + // change range to fix it + // if (qFuzzyCompare(sanitizedRange.lower+1, 1) && + // !qFuzzyCompare(sanitizedRange.upper+1, 1)) if( sanitizedRange.lower == 0.0 && sanitizedRange.upper != 0.0 ) { // case lower is 0 @@ -1380,7 +1677,8 @@ QCPRange QCPRange::sanitizedForLogScale() const } else if( sanitizedRange.lower < 0 && sanitizedRange.upper > 0 ) { - // find out whether negative or positive interval is wider to decide which sign domain will be chosen + // find out whether negative or positive interval is wider to decide which + // sign domain will be chosen if( -sanitizedRange.lower > sanitizedRange.upper ) { // negative is wider, do same as in case upper is 0 @@ -1398,12 +1696,14 @@ QCPRange QCPRange::sanitizedForLogScale() const sanitizedRange.lower = sanitizedRange.upper * rangeFac; } } - // due to normalization, case lower>0 && upper<0 should never occur, because that implies upper0 && upper<0 should never occur, because + // that implies upper minRange) && (range.upper < -minRange || range.upper > minRange)); */ - return ( range.lower > -maxRange && range.upper < maxRange && qAbs( range.lower - range.upper ) > minRange && + return ( range.lower > -maxRange && range.upper < maxRange && + qAbs( range.lower - range.upper ) > minRange && qAbs( range.lower - range.upper ) < maxRange ); } /*! \page thelayoutsystem The Layout System - The layout system is responsible for positioning and scaling layout elements such as axis rects, + The layout system is responsible for positioning and scaling layout elements + such as axis rects, legends and plot titles in a QCustomPlot. \section layoutsystem-classesandmechanisms Classes and mechanisms - The layout system is based on the abstract base class \ref QCPLayoutElement. All objects that - take part in the layout system derive from this class, either directly or indirectly. + The layout system is based on the abstract base class \ref QCPLayoutElement. + All objects that + take part in the layout system derive from this class, either directly or + indirectly. - Since QCPLayoutElement itself derives from \ref QCPLayerable, a layout element may draw its own - content. However, it is perfectly possible for a layout element to only serve as a structuring + Since QCPLayoutElement itself derives from \ref QCPLayerable, a layout element + may draw its own + content. However, it is perfectly possible for a layout element to only serve + as a structuring and/or positioning element, not drawing anything on its own. \subsection layoutsystem-rects Rects of a layout element - A layout element is a rectangular object described by two rects: the inner rect (\ref - QCPLayoutElement::rect) and the outer rect (\ref QCPLayoutElement::setOuterRect). The inner rect - is calculated automatically by applying the margin (\ref QCPLayoutElement::setMargins) inward - from the outer rect. The inner rect is meant for main content while the margin area may either be - left blank or serve for displaying peripheral graphics. For example, \ref QCPAxisRect positions - the four main axes at the sides of the inner rect, so graphs end up inside it and the axis labels + A layout element is a rectangular object described by two rects: the inner + rect (\ref + QCPLayoutElement::rect) and the outer rect (\ref + QCPLayoutElement::setOuterRect). The inner rect + is calculated automatically by applying the margin (\ref + QCPLayoutElement::setMargins) inward + from the outer rect. The inner rect is meant for main content while the margin + area may either be + left blank or serve for displaying peripheral graphics. For example, \ref + QCPAxisRect positions + the four main axes at the sides of the inner rect, so graphs end up inside it + and the axis labels and tick labels are in the margin area. \subsection layoutsystem-margins Margins - Each layout element may provide a mechanism to automatically determine its margins. Internally, - this is realized with the \ref QCPLayoutElement::calculateAutoMargin function which takes a \ref - QCP::MarginSide and returns an integer value which represents the ideal margin for the specified + Each layout element may provide a mechanism to automatically determine its + margins. Internally, + this is realized with the \ref QCPLayoutElement::calculateAutoMargin function + which takes a \ref + QCP::MarginSide and returns an integer value which represents the ideal margin + for the specified side. The automatic margin will be used on the sides specified in \ref - QCPLayoutElement::setAutoMargins. By default, it is set to \ref QCP::msAll meaning automatic - margin calculation is enabled for all four sides. In this case, a minimum margin may be set with - \ref QCPLayoutElement::setMinimumMargins, to prevent the automatic margin mechanism from setting - margins smaller than desired for a specific situation. If automatic margin calculation is unset - for a specific side, the margin of that side can be controlled directy via \ref + QCPLayoutElement::setAutoMargins. By default, it is set to \ref QCP::msAll + meaning automatic + margin calculation is enabled for all four sides. In this case, a minimum + margin may be set with + \ref QCPLayoutElement::setMinimumMargins, to prevent the automatic margin + mechanism from setting + margins smaller than desired for a specific situation. If automatic margin + calculation is unset + for a specific side, the margin of that side can be controlled directy via + \ref QCPLayoutElement::setMargins. - If multiple layout ements are arranged next to or beneath each other, it may be desirable to - align their inner rects on certain sides. Since they all might have different automatic margins, + If multiple layout ements are arranged next to or beneath each other, it may + be desirable to + align their inner rects on certain sides. Since they all might have different + automatic margins, this usually isn't the case. The class \ref QCPMarginGroup and \ref - QCPLayoutElement::setMarginGroup fix this by allowing to synchronize multiple margins. See the + QCPLayoutElement::setMarginGroup fix this by allowing to synchronize multiple + margins. See the documentation there for details. \subsection layoutsystem-layout Layouts - As mentioned, a QCPLayoutElement may have an arbitrary number of child layout elements and in - princple can have the only purpose to manage/arrange those child elements. This is what the - subclass \ref QCPLayout specializes on. It is a QCPLayoutElement itself but has no visual - representation. It defines an interface to add, remove and manage child layout elements. - QCPLayout isn't a usable layout though, it's an abstract base class that concrete layouts derive - from, like \ref QCPLayoutGrid which arranges its child elements in a grid and \ref QCPLayoutInset + As mentioned, a QCPLayoutElement may have an arbitrary number of child layout + elements and in + princple can have the only purpose to manage/arrange those child elements. + This is what the + subclass \ref QCPLayout specializes on. It is a QCPLayoutElement itself but + has no visual + representation. It defines an interface to add, remove and manage child layout + elements. + QCPLayout isn't a usable layout though, it's an abstract base class that + concrete layouts derive + from, like \ref QCPLayoutGrid which arranges its child elements in a grid and + \ref QCPLayoutInset which allows placing child elements freely inside its rect. - Since a QCPLayout is a layout element itself, it may be placed inside other layouts. This way, + Since a QCPLayout is a layout element itself, it may be placed inside other + layouts. This way, complex hierarchies may be created, offering very flexible arrangements. \image html LayoutsystemSketch.png - Above is a sketch of the default \ref QCPLayoutGrid accessible via \ref QCustomPlot::plotLayout. - It shows how two child layout elements are placed inside the grid layout next to each other in + Above is a sketch of the default \ref QCPLayoutGrid accessible via \ref + QCustomPlot::plotLayout. + It shows how two child layout elements are placed inside the grid layout next + to each other in cells (0, 0) and (0, 1). \subsection layoutsystem-plotlayout The top level plot layout - Every QCustomPlot has one top level layout of type \ref QCPLayoutGrid. It is accessible via \ref - QCustomPlot::plotLayout and contains (directly or indirectly via other sub-layouts) all layout - elements in the QCustomPlot. By default, this top level grid layout contains a single cell which + Every QCustomPlot has one top level layout of type \ref QCPLayoutGrid. It is + accessible via \ref + QCustomPlot::plotLayout and contains (directly or indirectly via other + sub-layouts) all layout + elements in the QCustomPlot. By default, this top level grid layout contains a + single cell which holds the main axis rect. \subsection layoutsystem-examples Examples - Adding a plot title is a typical and simple case to demonstrate basic workings of the layout system. + Adding a plot title is a typical and simple case to demonstrate basic + workings of the layout system. \code // first we create and prepare a plot title layout element: QCPPlotTitle *title = new QCPPlotTitle(customPlot); title->setText("Plot Title Example"); title->setFont(QFont("sans", 12, QFont::Bold)); // then we add it to the main plot layout: - customPlot->plotLayout()->insertRow(0); // insert an empty row above the axis rect - customPlot->plotLayout()->addElement(0, 0, title); // place the title in the empty cell we've just created + customPlot->plotLayout()->insertRow(0); // insert an empty row above the axis + rect + customPlot->plotLayout()->addElement(0, 0, title); // place the title in the + empty cell we've just created \endcode \image html layoutsystem-addingplottitle.png - Arranging multiple axis rects actually is the central purpose of the layout system. + Arranging multiple axis rects actually is the central purpose of the + layout system. \code - customPlot->plotLayout()->clear(); // let's start from scratch and remove the default axis rect + customPlot->plotLayout()->clear(); // let's start from scratch and remove the + default axis rect // add the first axis rect in second row (row index 1): QCPAxisRect *topAxisRect = new QCPAxisRect(customPlot); customPlot->plotLayout()->addElement(1, 0, topAxisRect); @@ -1562,13 +1902,17 @@ bool QCPRange::validRange( const QCPRange& range ) QCPAxisRect *rightAxisRect = new QCPAxisRect(customPlot); subLayout->addElement(0, 0, leftAxisRect); subLayout->addElement(0, 1, rightAxisRect); - subLayout->setColumnStretchFactor(0, 3); // left axis rect shall have 60% of width + subLayout->setColumnStretchFactor(0, 3); // left axis rect shall have 60% of + width subLayout->setColumnStretchFactor(1, 2); // right one only 40% (3:2 = 60:40) - // since we've created the axis rects and axes from scratch, we need to place them on + // since we've created the axis rects and axes from scratch, we need to place + them on // according layers, if we don't want the grid to be drawn above the axes etc. - // place the axis on "axes" layer and grids on the "grid" layer, which is below "axes": + // place the axis on "axes" layer and grids on the "grid" layer, which is + below "axes": QList allAxes; - allAxes << topAxisRect->axes() << leftAxisRect->axes() << rightAxisRect->axes(); + allAxes << topAxisRect->axes() << leftAxisRect->axes() << + rightAxisRect->axes(); foreach (QCPAxis *axis, allAxes) { axis->setLayer("axes"); @@ -1584,24 +1928,34 @@ bool QCPRange::validRange( const QCPRange& range ) //////////////////////////////////////////////////////////////////////////////////////////////////// /*! \class QCPMarginGroup - \brief A margin group allows synchronization of margin sides if working with multiple layout elements. + \brief A margin group allows synchronization of margin sides if working with + multiple layout elements. - QCPMarginGroup allows you to tie a margin side of two or more layout elements together, such that - they will all have the same size, based on the largest required margin in the group. + QCPMarginGroup allows you to tie a margin side of two or more layout elements + together, such that + they will all have the same size, based on the largest required margin in the + group. \n \image html QCPMarginGroup.png "Demonstration of QCPMarginGroup" \n - In certain situations it is desirable that margins at specific sides are synchronized across - layout elements. For example, if one QCPAxisRect is below another one in a grid layout, it will - provide a cleaner look to the user if the left and right margins of the two axis rects are of the - same size. The left axis of the top axis rect will then be at the same horizontal position as the - left axis of the lower axis rect, making them appear aligned. The same applies for the right + In certain situations it is desirable that margins at specific sides are + synchronized across + layout elements. For example, if one QCPAxisRect is below another one in a + grid layout, it will + provide a cleaner look to the user if the left and right margins of the two + axis rects are of the + same size. The left axis of the top axis rect will then be at the same + horizontal position as the + left axis of the lower axis rect, making them appear aligned. The same applies + for the right axes. This is what QCPMarginGroup makes possible. - To add/remove a specific side of a layout element to/from a margin group, use the \ref - QCPLayoutElement::setMarginGroup method. To completely break apart the margin group, either call + To add/remove a specific side of a layout element to/from a margin group, use + the \ref + QCPLayoutElement::setMarginGroup method. To completely break apart the margin + group, either call \ref clear, or just delete the margin group. \section QCPMarginGroup-example Example @@ -1615,15 +1969,18 @@ bool QCPRange::validRange( const QCPRange& range ) customPlot->axisRect(0)->setMarginGroup(QCP::msLeft|QCP::msRight, group); customPlot->axisRect(1)->setMarginGroup(QCP::msLeft|QCP::msRight, group); \endcode - Here, we've used the first two axis rects of the plot and synchronized their left margins with + Here, we've used the first two axis rects of the plot and synchronized their + left margins with each other and their right margins with each other. */ /* start documentation of inline functions */ -/*! \fn QList QCPMarginGroup::elements(QCP::MarginSide side) const +/*! \fn QList QCPMarginGroup::elements(QCP::MarginSide side) + const - Returns a list of all layout elements that have their margin \a side associated with this margin + Returns a list of all layout elements that have their margin \a side + associated with this margin group. */ @@ -1632,7 +1989,8 @@ bool QCPRange::validRange( const QCPRange& range ) /*! Creates a new QCPMarginGroup instance in \a parentPlot. */ -QCPMarginGroup::QCPMarginGroup( QCustomPlot* parentPlot ) : QObject( parentPlot ), mParentPlot( parentPlot ) +QCPMarginGroup::QCPMarginGroup( QCustomPlot* parentPlot ) + : QObject( parentPlot ), mParentPlot( parentPlot ) { mChildren.insert( QCP::msLeft, QList() ); mChildren.insert( QCP::msRight, QList() ); @@ -1646,12 +2004,13 @@ QCPMarginGroup::~QCPMarginGroup() } /*! - Returns whether this margin group is empty. If this function returns true, no layout elements use + Returns whether this margin group is empty. If this function returns true, no + layout elements use this margin group to synchronize margin sides. */ bool QCPMarginGroup::isEmpty() const { - QHashIterator > it( mChildren ); + QHashIterator> it( mChildren ); while( it.hasNext() ) { it.next(); @@ -1662,35 +2021,41 @@ bool QCPMarginGroup::isEmpty() const } /*! - Clears this margin group. The synchronization of the margin sides that use this margin group is + Clears this margin group. The synchronization of the margin sides that use + this margin group is lifted and they will use their individual margin sizes again. */ void QCPMarginGroup::clear() { // make all children remove themselves from this margin group: - QHashIterator > it( mChildren ); + QHashIterator> it( mChildren ); while( it.hasNext() ) { it.next(); const QList elements = it.value(); for( int i = elements.size() - 1; i >= 0; --i ) - elements.at( i )->setMarginGroup( it.key(), 0 ); // removes itself from mChildren via removeChild + elements.at( i )->setMarginGroup( it.key(), + 0 ); // removes itself from mChildren via removeChild } } /*! \internal - Returns the synchronized common margin for \a side. This is the margin value that will be used by + Returns the synchronized common margin for \a side. This is the margin value + that will be used by the layout element on the respective side, if it is part of this margin group. The common margin is calculated by requesting the automatic margin (\ref - QCPLayoutElement::calculateAutoMargin) of each element associated with \a side in this margin - group, and choosing the largest returned value. (QCPLayoutElement::minimumMargins is taken into + QCPLayoutElement::calculateAutoMargin) of each element associated with \a side + in this margin + group, and choosing the largest returned value. + (QCPLayoutElement::minimumMargins is taken into account, too.) */ int QCPMarginGroup::commonMargin( QCP::MarginSide side ) const { - // query all automatic margins of the layout elements in this margin group side and find maximum: + // query all automatic margins of the layout elements in this margin group + // side and find maximum: int result = 0; const QList elements = mChildren.value( side ); for( int i = 0; i < elements.size(); ++i ) @@ -1707,7 +2072,8 @@ int QCPMarginGroup::commonMargin( QCP::MarginSide side ) const /*! \internal - Adds \a element to the internal list of child elements, for the margin \a side. + Adds \a element to the internal list of child elements, for the margin \a + side. This function does not modify the margin group property of \a element. */ @@ -1722,7 +2088,8 @@ void QCPMarginGroup::addChild( QCP::MarginSide side, QCPLayoutElement* element ) /*! \internal - Removes \a element from the internal list of child elements, for the margin \a side. + Removes \a element from the internal list of child elements, for the margin \a + side. This function does not modify the margin group property of \a element. */ @@ -1738,28 +2105,45 @@ void QCPMarginGroup::removeChild( QCP::MarginSide side, QCPLayoutElement* elemen //////////////////////////////////////////////////////////////////////////////////////////////////// /*! \class QCPLayoutElement - \brief The abstract base class for all objects that form \ref thelayoutsystem "the layout system". + \brief The abstract base class for all objects that form \ref thelayoutsystem + "the layout system". - This is an abstract base class. As such, it can't be instantiated directly, rather use one of its subclasses. + This is an abstract base class. As such, it can't be instantiated directly, + rather use one of its subclasses. - A Layout element is a rectangular object which can be placed in layouts. It has an outer rect - (QCPLayoutElement::outerRect) and an inner rect (\ref QCPLayoutElement::rect). The difference - between outer and inner rect is called its margin. The margin can either be set to automatic or - manual (\ref setAutoMargins) on a per-side basis. If a side is set to manual, that margin can be - set explicitly with \ref setMargins and will stay fixed at that value. If it's set to automatic, - the layout element subclass will control the value itself (via \ref calculateAutoMargin). + A Layout element is a rectangular object which can be placed in layouts. It + has an outer rect + (QCPLayoutElement::outerRect) and an inner rect (\ref QCPLayoutElement::rect). + The difference + between outer and inner rect is called its margin. The margin can either be + set to automatic or + manual (\ref setAutoMargins) on a per-side basis. If a side is set to manual, + that margin can be + set explicitly with \ref setMargins and will stay fixed at that value. If it's + set to automatic, + the layout element subclass will control the value itself (via \ref + calculateAutoMargin). - Layout elements can be placed in layouts (base class QCPLayout) like QCPLayoutGrid. The top level - layout is reachable via \ref QCustomPlot::plotLayout, and is a \ref QCPLayoutGrid. Since \ref + Layout elements can be placed in layouts (base class QCPLayout) like + QCPLayoutGrid. The top level + layout is reachable via \ref QCustomPlot::plotLayout, and is a \ref + QCPLayoutGrid. Since \ref QCPLayout itself derives from \ref QCPLayoutElement, layouts can be nested. - Thus in QCustomPlot one can divide layout elements into two categories: The ones that are - invisible by themselves, because they don't draw anything. Their only purpose is to manage the - position and size of other layout elements. This category of layout elements usually use - QCPLayout as base class. Then there is the category of layout elements which actually draw - something. For example, QCPAxisRect, QCPLegend and QCPPlotTitle are of this category. This does - not necessarily mean that the latter category can't have child layout elements. QCPLegend for - instance, actually derives from QCPLayoutGrid and the individual legend items are child layout + Thus in QCustomPlot one can divide layout elements into two categories: The + ones that are + invisible by themselves, because they don't draw anything. Their only purpose + is to manage the + position and size of other layout elements. This category of layout elements + usually use + QCPLayout as base class. Then there is the category of layout elements which + actually draw + something. For example, QCPAxisRect, QCPLegend and QCPPlotTitle are of this + category. This does + not necessarily mean that the latter category can't have child layout + elements. QCPLegend for + instance, actually derives from QCPLayoutGrid and the individual legend items + are child layout elements in the grid layout. */ @@ -1772,43 +2156,55 @@ void QCPMarginGroup::removeChild( QCP::MarginSide side, QCPLayoutElement* elemen /*! \fn QRect QCPLayoutElement::rect() const - Returns the inner rect of this layout element. The inner rect is the outer rect (\ref + Returns the inner rect of this layout element. The inner rect is the outer + rect (\ref setOuterRect) shrinked by the margins (\ref setMargins, \ref setAutoMargins). - In some cases, the area between outer and inner rect is left blank. In other cases the margin - area is used to display peripheral graphics while the main content is in the inner rect. This is - where automatic margin calculation becomes interesting because it allows the layout element to - adapt the margins to the peripheral graphics it wants to draw. For example, \ref QCPAxisRect - draws the axis labels and tick labels in the margin area, thus needs to adjust the margins (if - \ref setAutoMargins is enabled) according to the space required by the labels of the axes. + In some cases, the area between outer and inner rect is left blank. In other + cases the margin + area is used to display peripheral graphics while the main content is in the + inner rect. This is + where automatic margin calculation becomes interesting because it allows the + layout element to + adapt the margins to the peripheral graphics it wants to draw. For example, + \ref QCPAxisRect + draws the axis labels and tick labels in the margin area, thus needs to adjust + the margins (if + \ref setAutoMargins is enabled) according to the space required by the labels + of the axes. */ /*! \fn virtual void QCPLayoutElement::mousePressEvent(QMouseEvent *event) - This event is called, if the mouse was pressed while being inside the outer rect of this layout + This event is called, if the mouse was pressed while being inside the outer + rect of this layout element. */ /*! \fn virtual void QCPLayoutElement::mouseMoveEvent(QMouseEvent *event) - This event is called, if the mouse is moved inside the outer rect of this layout element. + This event is called, if the mouse is moved inside the outer rect of this + layout element. */ /*! \fn virtual void QCPLayoutElement::mouseReleaseEvent(QMouseEvent *event) - This event is called, if the mouse was previously pressed inside the outer rect of this layout + This event is called, if the mouse was previously pressed inside the outer + rect of this layout element and is now released. */ /*! \fn virtual void QCPLayoutElement::mouseDoubleClickEvent(QMouseEvent *event) - This event is called, if the mouse is double-clicked inside the outer rect of this layout + This event is called, if the mouse is double-clicked inside the outer rect of + this layout element. */ /*! \fn virtual void QCPLayoutElement::wheelEvent(QWheelEvent *event) - This event is called, if the mouse wheel is scrolled while the cursor is inside the rect of this + This event is called, if the mouse wheel is scrolled while the cursor is + inside the rect of this layout element. */ @@ -1818,16 +2214,18 @@ void QCPMarginGroup::removeChild( QCP::MarginSide side, QCPLayoutElement* elemen Creates an instance of QCPLayoutElement and sets default values. */ QCPLayoutElement::QCPLayoutElement( QCustomPlot* parentPlot ) - : QCPLayerable( parentPlot ), // parenthood is changed as soon as layout element gets inserted into a layout - // (except for top level layout) - mParentLayout( 0 ), - mMinimumSize(), - mMaximumSize( QWIDGETSIZE_MAX, QWIDGETSIZE_MAX ), - mRect( 0, 0, 0, 0 ), - mOuterRect( 0, 0, 0, 0 ), - mMargins( 0, 0, 0, 0 ), - mMinimumMargins( 0, 0, 0, 0 ), - mAutoMargins( QCP::msAll ) + : QCPLayerable( parentPlot ) + , // parenthood is changed as soon as layout + // element gets inserted into a layout + // (except for top level layout) + mParentLayout( 0 ) + , mMinimumSize() + , mMaximumSize( QWIDGETSIZE_MAX, QWIDGETSIZE_MAX ) + , mRect( 0, 0, 0, 0 ) + , mOuterRect( 0, 0, 0, 0 ) + , mMargins( 0, 0, 0, 0 ) + , mMinimumMargins( 0, 0, 0, 0 ) + , mAutoMargins( QCP::msAll ) { } @@ -1835,19 +2233,24 @@ QCPLayoutElement::~QCPLayoutElement() { setMarginGroup( QCP::msAll, 0 ); // unregister at margin groups, if there are any // unregister at layout: - if( qobject_cast( mParentLayout ) ) // the qobject_cast is just a safeguard in case the layout forgets to - // call clear() in its dtor and this dtor is called by QObject dtor + if( qobject_cast( mParentLayout ) ) // the qobject_cast is just a + // safeguard in case the layout + // forgets to + // call clear() in its dtor and this dtor is called by QObject dtor mParentLayout->take( this ); } /*! - Sets the outer rect of this layout element. If the layout element is inside a layout, the layout + Sets the outer rect of this layout element. If the layout element is inside a + layout, the layout sets the position and size of this layout element using this function. - Calling this function externally has no effect, since the layout will overwrite any changes to + Calling this function externally has no effect, since the layout will + overwrite any changes to the outer rect upon the next replot. - The layout element will adapt its inner \ref rect by applying the margins inward to the outer rect. + The layout element will adapt its inner \ref rect by applying the margins + inward to the outer rect. \see rect */ @@ -1856,17 +2259,22 @@ void QCPLayoutElement::setOuterRect( const QRect& rect ) if( mOuterRect != rect ) { mOuterRect = rect; - mRect = mOuterRect.adjusted( mMargins.left(), mMargins.top(), -mMargins.right(), -mMargins.bottom() ); + mRect = mOuterRect.adjusted( mMargins.left(), mMargins.top(), -mMargins.right(), + -mMargins.bottom() ); } } /*! - Sets the margins of this layout element. If \ref setAutoMargins is disabled for some or all - sides, this function is used to manually set the margin on those sides. Sides that are still set + Sets the margins of this layout element. If \ref setAutoMargins is disabled + for some or all + sides, this function is used to manually set the margin on those sides. Sides + that are still set to be handled automatically are ignored and may have any value in \a margins. - The margin is the distance between the outer rect (controlled by the parent layout via \ref - setOuterRect) and the inner \ref rect (which usually contains the main content of this layout + The margin is the distance between the outer rect (controlled by the parent + layout via \ref + setOuterRect) and the inner \ref rect (which usually contains the main content + of this layout element). \see setAutoMargins @@ -1876,15 +2284,18 @@ void QCPLayoutElement::setMargins( const QMargins& margins ) if( mMargins != margins ) { mMargins = margins; - mRect = mOuterRect.adjusted( mMargins.left(), mMargins.top(), -mMargins.right(), -mMargins.bottom() ); + mRect = mOuterRect.adjusted( mMargins.left(), mMargins.top(), -mMargins.right(), + -mMargins.bottom() ); } } /*! - If \ref setAutoMargins is enabled on some or all margins, this function is used to provide + If \ref setAutoMargins is enabled on some or all margins, this function is + used to provide minimum values for those margins. - The minimum values are not enforced on margin sides that were set to be under manual control via + The minimum values are not enforced on margin sides that were set to be under + manual control via \ref setAutoMargins. \see setAutoMargins @@ -1898,12 +2309,17 @@ void QCPLayoutElement::setMinimumMargins( const QMargins& margins ) } /*! - Sets on which sides the margin shall be calculated automatically. If a side is calculated - automatically, a minimum margin value may be provided with \ref setMinimumMargins. If a side is - set to be controlled manually, the value may be specified with \ref setMargins. + Sets on which sides the margin shall be calculated automatically. If a side is + calculated + automatically, a minimum margin value may be provided with \ref + setMinimumMargins. If a side is + set to be controlled manually, the value may be specified with \ref + setMargins. - Margin sides that are under automatic control may participate in a \ref QCPMarginGroup (see \ref - setMarginGroup), to synchronize (align) it with other layout elements in the plot. + Margin sides that are under automatic control may participate in a \ref + QCPMarginGroup (see \ref + setMarginGroup), to synchronize (align) it with other layout elements in the + plot. \see setMinimumMargins, setMargins */ @@ -1913,12 +2329,17 @@ void QCPLayoutElement::setAutoMargins( QCP::MarginSides sides ) } /*! - Sets the minimum size for the inner \ref rect of this layout element. A parent layout tries to - respect the \a size here by changing row/column sizes in the layout accordingly. + Sets the minimum size for the inner \ref rect of this layout element. A parent + layout tries to + respect the \a size here by changing row/column sizes in the layout + accordingly. - If the parent layout size is not sufficient to satisfy all minimum size constraints of its child - layout elements, the layout may set a size that is actually smaller than \a size. QCustomPlot - propagates the layout's size constraints to the outside by setting its own minimum QWidget size + If the parent layout size is not sufficient to satisfy all minimum size + constraints of its child + layout elements, the layout may set a size that is actually smaller than \a + size. QCustomPlot + propagates the layout's size constraints to the outside by setting its own + minimum QWidget size accordingly, so violations of \a size should be exceptions. */ void QCPLayoutElement::setMinimumSize( const QSize& size ) @@ -1941,8 +2362,10 @@ void QCPLayoutElement::setMinimumSize( int width, int height ) } /*! - Sets the maximum size for the inner \ref rect of this layout element. A parent layout tries to - respect the \a size here by changing row/column sizes in the layout accordingly. + Sets the maximum size for the inner \ref rect of this layout element. A parent + layout tries to + respect the \a size here by changing row/column sizes in the layout + accordingly. */ void QCPLayoutElement::setMaximumSize( const QSize& size ) { @@ -1966,12 +2389,14 @@ void QCPLayoutElement::setMaximumSize( int width, int height ) /*! Sets the margin \a group of the specified margin \a sides. - Margin groups allow synchronizing specified margins across layout elements, see the documentation + Margin groups allow synchronizing specified margins across layout elements, + see the documentation of \ref QCPMarginGroup. To unset the margin group of \a sides, set \a group to 0. - Note that margin groups only work for margin sides that are set to automatic (\ref + Note that margin groups only work for margin sides that are set to automatic + (\ref setAutoMargins). */ void QCPLayoutElement::setMarginGroup( QCP::MarginSides sides, QCPMarginGroup* group ) @@ -1995,7 +2420,8 @@ void QCPLayoutElement::setMarginGroup( QCP::MarginSides sides, QCPMarginGroup* g if( oldGroup ) // unregister at old group oldGroup->removeChild( side, this ); - if( !group ) // if setting to 0, remove hash entry. Else set hash entry to new group and register there + if( !group ) // if setting to 0, remove hash entry. Else set hash entry to + // new group and register there { mMarginGroups.remove( side ); } @@ -2009,15 +2435,20 @@ void QCPLayoutElement::setMarginGroup( QCP::MarginSides sides, QCPMarginGroup* g } /*! - Updates the layout element and sub-elements. This function is automatically called before every - replot by the parent layout element. It is called multiple times, once for every \ref - UpdatePhase. The phases are run through in the order of the enum values. For details about what + Updates the layout element and sub-elements. This function is automatically + called before every + replot by the parent layout element. It is called multiple times, once for + every \ref + UpdatePhase. The phases are run through in the order of the enum values. For + details about what happens at the different phases, see the documentation of \ref UpdatePhase. - Layout elements that have child elements should call the \ref update method of their child + Layout elements that have child elements should call the \ref update method of + their child elements, and pass the current \a phase unchanged. - The default implementation executes the automatic margin mechanism in the \ref upMargins phase. + The default implementation executes the automatic margin mechanism in the \ref + upMargins phase. Subclasses should make sure to call the base class implementation. */ void QCPLayoutElement::update( UpdatePhase phase ) @@ -2026,25 +2457,29 @@ void QCPLayoutElement::update( UpdatePhase phase ) { if( mAutoMargins != QCP::msNone ) { - // set the margins of this layout element according to automatic margin calculation, either directly or via a + // set the margins of this layout element according to automatic margin + // calculation, either directly or via a // margin group: QMargins newMargins = mMargins; - foreach( QCP::MarginSide side, QList() << QCP::msLeft << QCP::msRight << QCP::msTop - << QCP::msBottom ) + foreach( QCP::MarginSide side, QList() << QCP::msLeft << QCP::msRight + << QCP::msTop << QCP::msBottom ) { if( mAutoMargins.testFlag( side ) ) // this side's margin shall be calculated automatically { if( mMarginGroups.contains( side ) ) - QCP::setMarginValue( - newMargins, side, - mMarginGroups[side]->commonMargin( - side ) ); // this side is part of a margin group, so get the margin value from that group + QCP::setMarginValue( newMargins, side, mMarginGroups[side]->commonMargin( + side ) ); // this side is part of a margin + // group, so get the margin value + // from that group else - QCP::setMarginValue( - newMargins, side, - calculateAutoMargin( side ) ); // this side is not part of a group, so calculate the value directly + QCP::setMarginValue( newMargins, side, + calculateAutoMargin( side ) ); // this side is not + // part of a group, + // so calculate the + // value directly // apply minimum margin restrictions: - if( QCP::getMarginValue( newMargins, side ) < QCP::getMarginValue( mMinimumMargins, side ) ) + if( QCP::getMarginValue( newMargins, side ) < + QCP::getMarginValue( mMinimumMargins, side ) ) QCP::setMarginValue( newMargins, side, QCP::getMarginValue( mMinimumMargins, side ) ); } } @@ -2054,10 +2489,13 @@ void QCPLayoutElement::update( UpdatePhase phase ) } /*! - Returns the minimum size this layout element (the inner \ref rect) may be compressed to. + Returns the minimum size this layout element (the inner \ref rect) may be + compressed to. - if a minimum size (\ref setMinimumSize) was not set manually, parent layouts consult this - function to determine the minimum allowed size of this layout element. (A manual minimum size is + if a minimum size (\ref setMinimumSize) was not set manually, parent layouts + consult this + function to determine the minimum allowed size of this layout element. (A + manual minimum size is considered set if it is non-zero.) */ QSize QCPLayoutElement::minimumSizeHint() const @@ -2066,10 +2504,13 @@ QSize QCPLayoutElement::minimumSizeHint() const } /*! - Returns the maximum size this layout element (the inner \ref rect) may be expanded to. + Returns the maximum size this layout element (the inner \ref rect) may be + expanded to. - if a maximum size (\ref setMaximumSize) was not set manually, parent layouts consult this - function to determine the maximum allowed size of this layout element. (A manual maximum size is + if a maximum size (\ref setMaximumSize) was not set manually, parent layouts + consult this + function to determine the maximum allowed size of this layout element. (A + manual maximum size is considered set if it is smaller than Qt's QWIDGETSIZE_MAX.) */ QSize QCPLayoutElement::maximumSizeHint() const @@ -2078,10 +2519,12 @@ QSize QCPLayoutElement::maximumSizeHint() const } /*! - Returns a list of all child elements in this layout element. If \a recursive is true, all + Returns a list of all child elements in this layout element. If \a recursive + is true, all sub-child elements are included in the list, too. - \warning There may be entries with value 0 in the returned list. (For example, QCPLayoutGrid may have + \warning There may be entries with value 0 in the returned list. (For example, + QCPLayoutGrid may have empty cells which yield 0 at the respective index.) */ QList QCPLayoutElement::elements( bool recursive ) const @@ -2091,17 +2534,24 @@ QList QCPLayoutElement::elements( bool recursive ) const } /*! - Layout elements are sensitive to events inside their outer rect. If \a pos is within the outer - rect, this method returns a value corresponding to 0.99 times the parent plot's selection - tolerance. However, layout elements are not selectable by default. So if \a onlySelectable is + Layout elements are sensitive to events inside their outer rect. If \a pos is + within the outer + rect, this method returns a value corresponding to 0.99 times the parent + plot's selection + tolerance. However, layout elements are not selectable by default. So if \a + onlySelectable is true, -1.0 is returned. - See \ref QCPLayerable::selectTest for a general explanation of this virtual method. + See \ref QCPLayerable::selectTest for a general explanation of this virtual + method. - QCPLayoutElement subclasses may reimplement this method to provide more specific selection test + QCPLayoutElement subclasses may reimplement this method to provide more + specific selection test behaviour. */ -double QCPLayoutElement::selectTest( const QPointF& pos, bool onlySelectable, QVariant* details ) const +double QCPLayoutElement::selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details ) const { Q_UNUSED( details ) @@ -2124,7 +2574,8 @@ double QCPLayoutElement::selectTest( const QPointF& pos, bool onlySelectable, QV /*! \internal - propagates the parent plot initialization to all child elements, by calling \ref + propagates the parent plot initialization to all child elements, by calling + \ref QCPLayerable::initializeParentPlot on them. */ void QCPLayoutElement::parentPlotInitialized( QCustomPlot* parentPlot ) @@ -2138,16 +2589,20 @@ void QCPLayoutElement::parentPlotInitialized( QCustomPlot* parentPlot ) /*! \internal - Returns the margin size for this \a side. It is used if automatic margins is enabled for this \a - side (see \ref setAutoMargins). If a minimum margin was set with \ref setMinimumMargins, the + Returns the margin size for this \a side. It is used if automatic margins is + enabled for this \a + side (see \ref setAutoMargins). If a minimum margin was set with \ref + setMinimumMargins, the returned value will not be smaller than the specified minimum margin. - The default implementation just returns the respective manual margin (\ref setMargins) or the + The default implementation just returns the respective manual margin (\ref + setMargins) or the minimum margin, whichever is larger. */ int QCPLayoutElement::calculateAutoMargin( QCP::MarginSide side ) { - return qMax( QCP::getMarginValue( mMargins, side ), QCP::getMarginValue( mMinimumMargins, side ) ); + return qMax( QCP::getMarginValue( mMargins, side ), + QCP::getMarginValue( mMinimumMargins, side ) ); } //////////////////////////////////////////////////////////////////////////////////////////////////// @@ -2157,23 +2612,33 @@ int QCPLayoutElement::calculateAutoMargin( QCP::MarginSide side ) /*! \class QCPLayout \brief The abstract base class for layouts - This is an abstract base class for layout elements whose main purpose is to define the position - and size of other child layout elements. In most cases, layouts don't draw anything themselves + This is an abstract base class for layout elements whose main purpose is to + define the position + and size of other child layout elements. In most cases, layouts don't draw + anything themselves (but there are exceptions to this, e.g. QCPLegend). - QCPLayout derives from QCPLayoutElement, and thus can itself be nested in other layouts. + QCPLayout derives from QCPLayoutElement, and thus can itself be nested in + other layouts. - QCPLayout introduces a common interface for accessing and manipulating the child elements. Those - functions are most notably \ref elementCount, \ref elementAt, \ref takeAt, \ref take, \ref - simplify, \ref removeAt, \ref remove and \ref clear. Individual subclasses may add more functions - to this interface which are more specialized to the form of the layout. For example, \ref - QCPLayoutGrid adds functions that take row and column indices to access cells of the layout grid + QCPLayout introduces a common interface for accessing and manipulating the + child elements. Those + functions are most notably \ref elementCount, \ref elementAt, \ref takeAt, + \ref take, \ref + simplify, \ref removeAt, \ref remove and \ref clear. Individual subclasses may + add more functions + to this interface which are more specialized to the form of the layout. For + example, \ref + QCPLayoutGrid adds functions that take row and column indices to access cells + of the layout grid more conveniently. - Since this is an abstract base class, you can't instantiate it directly. Rather use one of its + Since this is an abstract base class, you can't instantiate it directly. + Rather use one of its subclasses like QCPLayoutGrid or QCPLayoutInset. - For a general introduction to the layout system, see the dedicated documentation page \ref + For a general introduction to the layout system, see the dedicated + documentation page \ref thelayoutsystem "The Layout System". */ @@ -2188,10 +2653,13 @@ int QCPLayoutElement::calculateAutoMargin( QCP::MarginSide side ) /*! \fn virtual QCPLayoutElement* QCPLayout::elementAt(int index) const = 0 - Returns the element in the cell with the given \a index. If \a index is invalid, returns 0. + Returns the element in the cell with the given \a index. If \a index is + invalid, returns 0. - Note that even if \a index is valid, the respective cell may be empty in some layouts (e.g. - QCPLayoutGrid), so this function may return 0 in those cases. You may use this function to check + Note that even if \a index is valid, the respective cell may be empty in some + layouts (e.g. + QCPLayoutGrid), so this function may return 0 in those cases. You may use this + function to check whether a cell is empty or not. \see elements, elementCount, takeAt @@ -2203,8 +2671,10 @@ int QCPLayoutElement::calculateAutoMargin( QCP::MarginSide side ) If the \a index is invalid or the cell with that index is empty, returns 0. - Note that some layouts don't remove the respective cell right away but leave an empty cell after - successful removal of the layout element. To collapse empty cells, use \ref simplify. + Note that some layouts don't remove the respective cell right away but leave + an empty cell after + successful removal of the layout element. To collapse empty cells, use \ref + simplify. \see elementAt, take */ @@ -2215,8 +2685,10 @@ int QCPLayoutElement::calculateAutoMargin( QCP::MarginSide side ) If the \a element isn't in this layout, returns false. - Note that some layouts don't remove the respective cell right away but leave an empty cell after - successful removal of the layout element. To collapse empty cells, use \ref simplify. + Note that some layouts don't remove the respective cell right away but leave + an empty cell after + successful removal of the layout element. To collapse empty cells, use \ref + simplify. \see takeAt */ @@ -2224,7 +2696,8 @@ int QCPLayoutElement::calculateAutoMargin( QCP::MarginSide side ) /* end documentation of pure virtual functions */ /*! - Creates an instance of QCPLayout and sets default values. Note that since QCPLayout + Creates an instance of QCPLayout and sets default values. Note that since + QCPLayout is an abstract base class, it can't be instantiated directly. */ QCPLayout::QCPLayout() @@ -2232,10 +2705,12 @@ QCPLayout::QCPLayout() } /*! - First calls the QCPLayoutElement::update base class implementation to update the margins on this + First calls the QCPLayoutElement::update base class implementation to update + the margins on this layout. - Then calls \ref updateLayout which subclasses reimplement to reposition and resize their cells. + Then calls \ref updateLayout which subclasses reimplement to reposition and + resize their cells. Finally, \ref update is called on all child elements. */ @@ -2278,10 +2753,12 @@ QList QCPLayout::elements( bool recursive ) const } /*! - Simplifies the layout by collapsing empty cells. The exact behavior depends on subclasses, the + Simplifies the layout by collapsing empty cells. The exact behavior depends on + subclasses, the default implementation does nothing. - Not all layouts need simplification. For example, QCPLayoutInset doesn't use explicit + Not all layouts need simplification. For example, QCPLayoutInset doesn't use + explicit simplification while QCPLayoutGrid does. */ void QCPLayout::simplify() @@ -2289,10 +2766,12 @@ void QCPLayout::simplify() } /*! - Removes and deletes the element at the provided \a index. Returns true on success. If \a index is + Removes and deletes the element at the provided \a index. Returns true on + success. If \a index is invalid or points to an empty cell, returns false. - This function internally uses \ref takeAt to remove the element from the layout and then deletes + This function internally uses \ref takeAt to remove the element from the + layout and then deletes the returned element. \see remove, takeAt @@ -2309,10 +2788,12 @@ bool QCPLayout::removeAt( int index ) } /*! - Removes and deletes the provided \a element. Returns true on success. If \a element is not in the + Removes and deletes the provided \a element. Returns true on success. If \a + element is not in the layout, returns false. - This function internally uses \ref takeAt to remove the element from the layout and then deletes + This function internally uses \ref takeAt to remove the element from the + layout and then deletes the element. \see removeAt, take @@ -2344,11 +2825,15 @@ void QCPLayout::clear() } /*! - Subclasses call this method to report changed (minimum/maximum) size constraints. + Subclasses call this method to report changed (minimum/maximum) size + constraints. - If the parent of this layout is again a QCPLayout, forwards the call to the parent's \ref - sizeConstraintsChanged. If the parent is a QWidget (i.e. is the \ref QCustomPlot::plotLayout of - QCustomPlot), calls QWidget::updateGeometry, so if the QCustomPlot widget is inside a Qt QLayout, + If the parent of this layout is again a QCPLayout, forwards the call to the + parent's \ref + sizeConstraintsChanged. If the parent is a QWidget (i.e. is the \ref + QCustomPlot::plotLayout of + QCustomPlot), calls QWidget::updateGeometry, so if the QCustomPlot widget is + inside a Qt QLayout, it may update itself and resize cells accordingly. */ void QCPLayout::sizeConstraintsChanged() const @@ -2361,10 +2846,13 @@ void QCPLayout::sizeConstraintsChanged() const /*! \internal - Subclasses reimplement this method to update the position and sizes of the child elements/cells - via calling their \ref QCPLayoutElement::setOuterRect. The default implementation does nothing. + Subclasses reimplement this method to update the position and sizes of the + child elements/cells + via calling their \ref QCPLayoutElement::setOuterRect. The default + implementation does nothing. - The geometry used as a reference is the inner \ref rect of this layout. Child elements should stay + The geometry used as a reference is the inner \ref rect of this layout. Child + elements should stay within that rect. \ref getSectionSizes may help with the reimplementation of this function. @@ -2377,14 +2865,17 @@ void QCPLayout::updateLayout() /*! \internal - Associates \a el with this layout. This is done by setting the \ref QCPLayoutElement::layout, the + Associates \a el with this layout. This is done by setting the \ref + QCPLayoutElement::layout, the \ref QCPLayerable::parentLayerable and the QObject parent to this layout. Further, if \a el didn't previously have a parent plot, calls \ref QCPLayerable::initializeParentPlot on \a el to set the paret plot. - This method is used by subclass specific methods that add elements to the layout. Note that this - method only changes properties in \a el. The removal from the old layout and the insertion into + This method is used by subclass specific methods that add elements to the + layout. Note that this + method only changes properties in \a el. The removal from the old layout and + the insertion into the new layout must be done additionally. */ void QCPLayout::adoptElement( QCPLayoutElement* el ) @@ -2403,12 +2894,16 @@ void QCPLayout::adoptElement( QCPLayoutElement* el ) /*! \internal - Disassociates \a el from this layout. This is done by setting the \ref QCPLayoutElement::layout - and the \ref QCPLayerable::parentLayerable to zero. The QObject parent is set to the parent + Disassociates \a el from this layout. This is done by setting the \ref + QCPLayoutElement::layout + and the \ref QCPLayerable::parentLayerable to zero. The QObject parent is set + to the parent QCustomPlot. - This method is used by subclass specific methods that remove elements from the layout (e.g. \ref - take or \ref takeAt). Note that this method only changes properties in \a el. The removal from + This method is used by subclass specific methods that remove elements from the + layout (e.g. \ref + take or \ref takeAt). Note that this method only changes properties in \a el. + The removal from the old layout must be done additionally. */ void QCPLayout::releaseElement( QCPLayoutElement* el ) @@ -2418,7 +2913,8 @@ void QCPLayout::releaseElement( QCPLayoutElement* el ) el->mParentLayout = 0; el->setParentLayerable( 0 ); el->setParent( mParentPlot ); - // Note: Don't initializeParentPlot(0) here, because layout element will stay in same parent plot + // Note: Don't initializeParentPlot(0) here, because layout element will + // stay in same parent plot } else qDebug() << Q_FUNC_INFO << "Null element passed"; @@ -2426,29 +2922,43 @@ void QCPLayout::releaseElement( QCPLayoutElement* el ) /*! \internal - This is a helper function for the implementation of \ref updateLayout in subclasses. + This is a helper function for the implementation of \ref updateLayout in + subclasses. - It calculates the sizes of one-dimensional sections with provided constraints on maximum section - sizes, minimum section sizes, relative stretch factors and the final total size of all sections. + It calculates the sizes of one-dimensional sections with provided constraints + on maximum section + sizes, minimum section sizes, relative stretch factors and the final total + size of all sections. - The QVector entries refer to the sections. Thus all QVectors must have the same size. + The QVector entries refer to the sections. Thus all QVectors must have the + same size. - \a maxSizes gives the maximum allowed size of each section. If there shall be no maximum size + \a maxSizes gives the maximum allowed size of each section. If there shall be + no maximum size imposed, set all vector values to Qt's QWIDGETSIZE_MAX. - \a minSizes gives the minimum allowed size of each section. If there shall be no minimum size - imposed, set all vector values to zero. If the \a minSizes entries add up to a value greater than - \a totalSize, sections will be scaled smaller than the proposed minimum sizes. (In other words, - not exceeding the allowed total size is taken to be more important than not going below minimum + \a minSizes gives the minimum allowed size of each section. If there shall be + no minimum size + imposed, set all vector values to zero. If the \a minSizes entries add up to a + value greater than + \a totalSize, sections will be scaled smaller than the proposed minimum sizes. + (In other words, + not exceeding the allowed total size is taken to be more important than not + going below minimum section sizes.) - \a stretchFactors give the relative proportions of the sections to each other. If all sections - shall be scaled equally, set all values equal. If the first section shall be double the size of - each individual other section, set the first number of \a stretchFactors to double the value of + \a stretchFactors give the relative proportions of the sections to each other. + If all sections + shall be scaled equally, set all values equal. If the first section shall be + double the size of + each individual other section, set the first number of \a stretchFactors to + double the value of the other individual values (e.g. {2, 1, 1, 1}). - \a totalSize is the value that the final section sizes will add up to. Due to rounding, the - actual sum may differ slightly. If you want the section sizes to sum up to exactly that value, + \a totalSize is the value that the final section sizes will add up to. Due to + rounding, the + actual sum may differ slightly. If you want the section sizes to sum up to + exactly that value, you could distribute the remaining difference on the sections. The return value is a QVector containing the section sizes. @@ -2460,14 +2970,16 @@ QVector QCPLayout::getSectionSizes( QVector maxSizes, { if( maxSizes.size() != minSizes.size() || minSizes.size() != stretchFactors.size() ) { - qDebug() << Q_FUNC_INFO << "Passed vector sizes aren't equal:" << maxSizes << minSizes << stretchFactors; + qDebug() << Q_FUNC_INFO << "Passed vector sizes aren't equal:" << maxSizes << minSizes + << stretchFactors; return QVector(); } if( stretchFactors.isEmpty() ) return QVector(); int sectionCount = stretchFactors.size(); QVector sectionSizes( sectionCount ); - // if provided total size is forced smaller than total minimum size, ignore minimum sizes (squeeze sections): + // if provided total size is forced smaller than total minimum size, ignore + // minimum sizes (squeeze sections): int minSizeSum = 0; for( int i = 0; i < sectionCount; ++i ) minSizeSum += minSizes.at( i ); @@ -2489,14 +3001,16 @@ QVector QCPLayout::getSectionSizes( QVector maxSizes, int outerIterations = 0; while( !unfinishedSections.isEmpty() && - outerIterations < - sectionCount * 2 ) // the iteration check ist just a failsafe in case something really strange happens + outerIterations < sectionCount * 2 ) // the iteration check ist just a + // failsafe in case something + // really strange happens { ++outerIterations; int innerIterations = 0; while( !unfinishedSections.isEmpty() && - innerIterations < - sectionCount * 2 ) // the iteration check ist just a failsafe in case something really strange happens + innerIterations < sectionCount * 2 ) // the iteration check ist just a + // failsafe in case something + // really strange happens { ++innerIterations; // find section that hits its maximum next: @@ -2505,22 +3019,26 @@ QVector QCPLayout::getSectionSizes( QVector maxSizes, for( int i = 0; i < unfinishedSections.size(); ++i ) { int secId = unfinishedSections.at( i ); - double hitsMaxAt = ( maxSizes.at( secId ) - sectionSizes.at( secId ) ) / stretchFactors.at( secId ); + double hitsMaxAt = + ( maxSizes.at( secId ) - sectionSizes.at( secId ) ) / stretchFactors.at( secId ); if( hitsMaxAt < nextMax ) { nextMax = hitsMaxAt; nextId = secId; } } - // check if that maximum is actually within the bounds of the total size (i.e. can we stretch all remaining + // check if that maximum is actually within the bounds of the total size + // (i.e. can we stretch all remaining // sections so far that the found section - // actually hits its maximum, without exceeding the total size when we add up all sections) + // actually hits its maximum, without exceeding the total size when we add + // up all sections) double stretchFactorSum = 0; for( int i = 0; i < unfinishedSections.size(); ++i ) stretchFactorSum += stretchFactors.at( unfinishedSections.at( i ) ); double nextMaxLimit = freeSize / stretchFactorSum; - if( nextMax < - nextMaxLimit ) // next maximum is actually hit, move forward to that point and fix the size of that section + if( nextMax < nextMaxLimit ) // next maximum is actually hit, move forward + // to that point and fix the size of that + // section { for( int i = 0; i < unfinishedSections.size(); ++i ) { @@ -2528,22 +3046,26 @@ QVector QCPLayout::getSectionSizes( QVector maxSizes, nextMax * stretchFactors.at( unfinishedSections.at( i ) ); // increment all sections freeSize -= nextMax * stretchFactors.at( unfinishedSections.at( i ) ); } - unfinishedSections.removeOne( nextId ); // exclude the section that is now at maximum from further changes + unfinishedSections.removeOne( nextId ); // exclude the section that is now + // at maximum from further changes } - else // next maximum isn't hit, just distribute rest of free space on remaining sections + else // next maximum isn't hit, just distribute rest of free space on + // remaining sections { for( int i = 0; i < unfinishedSections.size(); ++i ) sectionSizes[unfinishedSections.at( i )] += - nextMaxLimit * stretchFactors.at( unfinishedSections.at( i ) ); // increment all sections + nextMaxLimit * + stretchFactors.at( unfinishedSections.at( i ) ); // increment all sections unfinishedSections.clear(); } } if( innerIterations == sectionCount * 2 ) - qDebug() << Q_FUNC_INFO - << "Exceeded maximum expected inner iteration count, layouting aborted. Input was:" << maxSizes - << minSizes << stretchFactors << totalSize; + qDebug() << Q_FUNC_INFO << "Exceeded maximum expected inner iteration " + "count, layouting aborted. Input was:" + << maxSizes << minSizes << stretchFactors << totalSize; - // now check whether the resulting section sizes violate minimum restrictions: + // now check whether the resulting section sizes violate minimum + // restrictions: bool foundMinimumViolation = false; for( int i = 0; i < sectionSizes.size(); ++i ) { @@ -2561,22 +3083,25 @@ QVector QCPLayout::getSectionSizes( QVector maxSizes, freeSize = totalSize; for( int i = 0; i < sectionCount; ++i ) { - if( !minimumLockedSections.contains( - i ) ) // only put sections that haven't hit their minimum back into the pool + if( !minimumLockedSections.contains( i ) ) // only put sections that + // haven't hit their minimum + // back into the pool unfinishedSections.append( i ); else - freeSize -= - sectionSizes.at( i ); // remove size of minimum locked sections from available space in next round + freeSize -= sectionSizes.at( i ); // remove size of minimum locked + // sections from available space in + // next round } - // reset all section sizes to zero that are in unfinished sections (all others have been set to their minimum): + // reset all section sizes to zero that are in unfinished sections (all + // others have been set to their minimum): for( int i = 0; i < unfinishedSections.size(); ++i ) sectionSizes[unfinishedSections.at( i )] = 0; } } if( outerIterations == sectionCount * 2 ) - qDebug() << Q_FUNC_INFO - << "Exceeded maximum expected outer iteration count, layouting aborted. Input was:" << maxSizes << minSizes - << stretchFactors << totalSize; + qDebug() << Q_FUNC_INFO << "Exceeded maximum expected outer iteration " + "count, layouting aborted. Input was:" + << maxSizes << minSizes << stretchFactors << totalSize; QVector result( sectionCount ); for( int i = 0; i < sectionCount; ++i ) @@ -2591,17 +3116,25 @@ QVector QCPLayout::getSectionSizes( QVector maxSizes, /*! \class QCPLayoutGrid \brief A layout that arranges child elements in a grid - Elements are laid out in a grid with configurable stretch factors (\ref setColumnStretchFactor, - \ref setRowStretchFactor) and spacing (\ref setColumnSpacing, \ref setRowSpacing). + Elements are laid out in a grid with configurable stretch factors (\ref + setColumnStretchFactor, + \ref setRowStretchFactor) and spacing (\ref setColumnSpacing, \ref + setRowSpacing). - Elements can be added to cells via \ref addElement. The grid is expanded if the specified row or - column doesn't exist yet. Whether a cell contains a valid layout element can be checked with \ref - hasElement, that element can be retrieved with \ref element. If rows and columns that only have - empty cells shall be removed, call \ref simplify. Removal of elements is either done by just - adding the element to a different layout or by using the QCPLayout interface \ref take or \ref + Elements can be added to cells via \ref addElement. The grid is expanded if + the specified row or + column doesn't exist yet. Whether a cell contains a valid layout element can + be checked with \ref + hasElement, that element can be retrieved with \ref element. If rows and + columns that only have + empty cells shall be removed, call \ref simplify. Removal of elements is + either done by just + adding the element to a different layout or by using the QCPLayout interface + \ref take or \ref remove. - Row and column insertion can be performed with \ref insertRow and \ref insertColumn. + Row and column insertion can be performed with \ref insertRow and \ref + insertColumn. */ /*! @@ -2613,16 +3146,20 @@ QCPLayoutGrid::QCPLayoutGrid() : mColumnSpacing( 5 ), mRowSpacing( 5 ) QCPLayoutGrid::~QCPLayoutGrid() { - // clear all child layout elements. This is important because only the specific layouts know how - // to handle removing elements (clear calls virtual removeAt method to do that). + // clear all child layout elements. This is important because only the + // specific layouts know how + // to handle removing elements (clear calls virtual removeAt method to do + // that). clear(); } /*! Returns the element in the cell in \a row and \a column. - Returns 0 if either the row/column is invalid or if the cell is empty. In those cases, a qDebug - message is printed. To check whether a cell exists and isn't empty, use \ref hasElement. + Returns 0 if either the row/column is invalid or if the cell is empty. In + those cases, a qDebug + message is printed. To check whether a cell exists and isn't empty, use \ref + hasElement. \see addElement, hasElement */ @@ -2669,11 +3206,14 @@ int QCPLayoutGrid::columnCount() const } /*! - Adds the \a element to cell with \a row and \a column. If \a element is already in a layout, it - is first removed from there. If \a row or \a column don't exist yet, the layout is expanded + Adds the \a element to cell with \a row and \a column. If \a element is + already in a layout, it + is first removed from there. If \a row or \a column don't exist yet, the + layout is expanded accordingly. - Returns true if the element was added successfully, i.e. if the cell at \a row and \a column + Returns true if the element was added successfully, i.e. if the cell at \a row + and \a column didn't already have an element. \see element, hasElement, take, remove @@ -2692,7 +3232,8 @@ bool QCPLayoutGrid::addElement( int row, int column, QCPLayoutElement* element ) return true; } else - qDebug() << Q_FUNC_INFO << "There is already an element in the specified row/column:" << row << column; + qDebug() << Q_FUNC_INFO << "There is already an element in the specified row/column:" << row + << column; } else qDebug() << Q_FUNC_INFO << "Can't add null element to row/column:" << row << column; @@ -2700,7 +3241,8 @@ bool QCPLayoutGrid::addElement( int row, int column, QCPLayoutElement* element ) } /*! - Returns whether the cell at \a row and \a column exists and contains a valid element, i.e. isn't + Returns whether the cell at \a row and \a column exists and contains a valid + element, i.e. isn't empty. \see element @@ -2716,8 +3258,10 @@ bool QCPLayoutGrid::hasElement( int row, int column ) /*! Sets the stretch \a factor of \a column. - Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond - their minimum and maximum widths/heights (\ref QCPLayoutElement::setMinimumSize, \ref + Stretch factors control the relative sizes of rows and columns. Cells will not + be resized beyond + their minimum and maximum widths/heights (\ref + QCPLayoutElement::setMinimumSize, \ref QCPLayoutElement::setMaximumSize), regardless of the stretch factor. The default stretch factor of newly created rows/columns is 1. @@ -2738,10 +3282,13 @@ void QCPLayoutGrid::setColumnStretchFactor( int column, double factor ) } /*! - Sets the stretch \a factors of all columns. \a factors must have the size \ref columnCount. + Sets the stretch \a factors of all columns. \a factors must have the size \ref + columnCount. - Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond - their minimum and maximum widths/heights (\ref QCPLayoutElement::setMinimumSize, \ref + Stretch factors control the relative sizes of rows and columns. Cells will not + be resized beyond + their minimum and maximum widths/heights (\ref + QCPLayoutElement::setMinimumSize, \ref QCPLayoutElement::setMaximumSize), regardless of the stretch factor. The default stretch factor of newly created rows/columns is 1. @@ -2757,7 +3304,8 @@ void QCPLayoutGrid::setColumnStretchFactors( const QList& factors ) { if( mColumnStretchFactors.at( i ) <= 0 ) { - qDebug() << Q_FUNC_INFO << "Invalid stretch factor, must be positive:" << mColumnStretchFactors.at( i ); + qDebug() << Q_FUNC_INFO + << "Invalid stretch factor, must be positive:" << mColumnStretchFactors.at( i ); mColumnStretchFactors[i] = 1; } } @@ -2769,8 +3317,10 @@ void QCPLayoutGrid::setColumnStretchFactors( const QList& factors ) /*! Sets the stretch \a factor of \a row. - Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond - their minimum and maximum widths/heights (\ref QCPLayoutElement::setMinimumSize, \ref + Stretch factors control the relative sizes of rows and columns. Cells will not + be resized beyond + their minimum and maximum widths/heights (\ref + QCPLayoutElement::setMinimumSize, \ref QCPLayoutElement::setMaximumSize), regardless of the stretch factor. The default stretch factor of newly created rows/columns is 1. @@ -2791,10 +3341,13 @@ void QCPLayoutGrid::setRowStretchFactor( int row, double factor ) } /*! - Sets the stretch \a factors of all rows. \a factors must have the size \ref rowCount. + Sets the stretch \a factors of all rows. \a factors must have the size \ref + rowCount. - Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond - their minimum and maximum widths/heights (\ref QCPLayoutElement::setMinimumSize, \ref + Stretch factors control the relative sizes of rows and columns. Cells will not + be resized beyond + their minimum and maximum widths/heights (\ref + QCPLayoutElement::setMinimumSize, \ref QCPLayoutElement::setMaximumSize), regardless of the stretch factor. The default stretch factor of newly created rows/columns is 1. @@ -2810,7 +3363,8 @@ void QCPLayoutGrid::setRowStretchFactors( const QList& factors ) { if( mRowStretchFactors.at( i ) <= 0 ) { - qDebug() << Q_FUNC_INFO << "Invalid stretch factor, must be positive:" << mRowStretchFactors.at( i ); + qDebug() << Q_FUNC_INFO + << "Invalid stretch factor, must be positive:" << mRowStretchFactors.at( i ); mRowStretchFactors[i] = 1; } } @@ -2840,15 +3394,19 @@ void QCPLayoutGrid::setRowSpacing( int pixels ) } /*! - Expands the layout to have \a newRowCount rows and \a newColumnCount columns. So the last valid - row index will be \a newRowCount-1, the last valid column index will be \a newColumnCount-1. + Expands the layout to have \a newRowCount rows and \a newColumnCount columns. + So the last valid + row index will be \a newRowCount-1, the last valid column index will be \a + newColumnCount-1. - If the current column/row count is already larger or equal to \a newColumnCount/\a newRowCount, + If the current column/row count is already larger or equal to \a + newColumnCount/\a newRowCount, this function does nothing in that dimension. Newly created cells are empty, new rows and columns have the stretch factor 1. - Note that upon a call to \ref addElement, the layout is expanded automatically to contain the + Note that upon a call to \ref addElement, the layout is expanded automatically + to contain the specified row and column, using this function. \see simplify @@ -2873,14 +3431,17 @@ void QCPLayoutGrid::expandTo( int newRowCount, int newColumnCount ) } /*! - Inserts a new row with empty cells at the row index \a newIndex. Valid values for \a newIndex - range from 0 (inserts a row at the top) to \a rowCount (appends a row at the bottom). + Inserts a new row with empty cells at the row index \a newIndex. Valid values + for \a newIndex + range from 0 (inserts a row at the top) to \a rowCount (appends a row at the + bottom). \see insertColumn */ void QCPLayoutGrid::insertRow( int newIndex ) { - if( mElements.isEmpty() || mElements.first().isEmpty() ) // if grid is completely empty, add first cell + if( mElements.isEmpty() || + mElements.first().isEmpty() ) // if grid is completely empty, add first cell { expandTo( 1, 1 ); return; @@ -2899,14 +3460,17 @@ void QCPLayoutGrid::insertRow( int newIndex ) } /*! - Inserts a new column with empty cells at the column index \a newIndex. Valid values for \a - newIndex range from 0 (inserts a row at the left) to \a rowCount (appends a row at the right). + Inserts a new column with empty cells at the column index \a newIndex. Valid + values for \a + newIndex range from 0 (inserts a row at the left) to \a rowCount (appends a + row at the right). \see insertRow */ void QCPLayoutGrid::insertColumn( int newIndex ) { - if( mElements.isEmpty() || mElements.first().isEmpty() ) // if grid is completely empty, add first cell + if( mElements.isEmpty() || + mElements.first().isEmpty() ) // if grid is completely empty, add first cell { expandTo( 1, 1 ); return; @@ -2932,9 +3496,11 @@ void QCPLayoutGrid::updateLayout() int totalRowSpacing = ( rowCount() - 1 ) * mRowSpacing; int totalColSpacing = ( columnCount() - 1 ) * mColumnSpacing; QVector colWidths = - getSectionSizes( maxColWidths, minColWidths, mColumnStretchFactors.toVector(), mRect.width() - totalColSpacing ); + getSectionSizes( maxColWidths, minColWidths, mColumnStretchFactors.toVector(), + mRect.width() - totalColSpacing ); QVector rowHeights = - getSectionSizes( maxRowHeights, minRowHeights, mRowStretchFactors.toVector(), mRect.height() - totalRowSpacing ); + getSectionSizes( maxRowHeights, minRowHeights, mRowStretchFactors.toVector(), + mRect.height() - totalRowSpacing ); // go through cells and set rects accordingly: int yOffset = mRect.top(); @@ -3034,7 +3600,8 @@ QList QCPLayoutGrid::elements( bool recursive ) const } /*! - Simplifies the layout by collapsing rows and columns which only contain empty cells. + Simplifies the layout by collapsing rows and columns which only contain empty + cells. */ void QCPLayoutGrid::simplify() { @@ -3054,7 +3621,8 @@ void QCPLayoutGrid::simplify() { mRowStretchFactors.removeAt( row ); mElements.removeAt( row ); - if( mElements.isEmpty() ) // removed last element, also remove stretch factor (wouldn't happen below because also + if( mElements.isEmpty() ) // removed last element, also remove stretch + // factor (wouldn't happen below because also // columnCount changed to 0 now) mColumnStretchFactors.clear(); } @@ -3091,7 +3659,8 @@ QSize QCPLayoutGrid::minimumSizeHint() const result.rwidth() += minColWidths.at( i ); for( int i = 0; i < minRowHeights.size(); ++i ) result.rheight() += minRowHeights.at( i ); - result.rwidth() += qMax( 0, columnCount() - 1 ) * mColumnSpacing + mMargins.left() + mMargins.right(); + result.rwidth() += + qMax( 0, columnCount() - 1 ) * mColumnSpacing + mMargins.left() + mMargins.right(); result.rheight() += qMax( 0, rowCount() - 1 ) * mRowSpacing + mMargins.top() + mMargins.bottom(); return result; } @@ -3107,24 +3676,28 @@ QSize QCPLayoutGrid::maximumSizeHint() const result.setWidth( qMin( result.width() + maxColWidths.at( i ), QWIDGETSIZE_MAX ) ); for( int i = 0; i < maxRowHeights.size(); ++i ) result.setHeight( qMin( result.height() + maxRowHeights.at( i ), QWIDGETSIZE_MAX ) ); - result.rwidth() += qMax( 0, columnCount() - 1 ) * mColumnSpacing + mMargins.left() + mMargins.right(); + result.rwidth() += + qMax( 0, columnCount() - 1 ) * mColumnSpacing + mMargins.left() + mMargins.right(); result.rheight() += qMax( 0, rowCount() - 1 ) * mRowSpacing + mMargins.top() + mMargins.bottom(); return result; } /*! \internal - Places the minimum column widths and row heights into \a minColWidths and \a minRowHeights + Places the minimum column widths and row heights into \a minColWidths and \a + minRowHeights respectively. - The minimum height of a row is the largest minimum height of any element in that row. The minimum + The minimum height of a row is the largest minimum height of any element in + that row. The minimum width of a column is the largest minimum width of any element in that column. This is a helper function for \ref updateLayout. \see getMaximumRowColSizes */ -void QCPLayoutGrid::getMinimumRowColSizes( QVector* minColWidths, QVector* minRowHeights ) const +void QCPLayoutGrid::getMinimumRowColSizes( QVector* minColWidths, + QVector* minRowHeights ) const { *minColWidths = QVector( columnCount(), 0 ); *minRowHeights = QVector( rowCount(), 0 ); @@ -3149,17 +3722,21 @@ void QCPLayoutGrid::getMinimumRowColSizes( QVector* minColWidths, QVector* maxColWidths, QVector* maxRowHeights ) const +void QCPLayoutGrid::getMaximumRowColSizes( QVector* maxColWidths, + QVector* maxRowHeights ) const { *maxColWidths = QVector( columnCount(), QWIDGETSIZE_MAX ); *maxRowHeights = QVector( rowCount(), QWIDGETSIZE_MAX ); @@ -3186,28 +3763,38 @@ void QCPLayoutGrid::getMaximumRowColSizes( QVector* maxColWidths, QVectorminimumSizeHint(); QSize maxSizeHint = mElements.at( i )->maximumSizeHint(); - finalMinSize.setWidth( mElements.at( i )->minimumSize().width() > 0 ? mElements.at( i )->minimumSize().width() - : minSizeHint.width() ); - finalMinSize.setHeight( mElements.at( i )->minimumSize().height() > 0 ? mElements.at( i )->minimumSize().height() - : minSizeHint.height() ); + finalMinSize.setWidth( mElements.at( i )->minimumSize().width() > 0 + ? mElements.at( i )->minimumSize().width() + : minSizeHint.width() ); + finalMinSize.setHeight( mElements.at( i )->minimumSize().height() > 0 + ? mElements.at( i )->minimumSize().height() + : minSizeHint.height() ); finalMaxSize.setWidth( mElements.at( i )->maximumSize().width() < QWIDGETSIZE_MAX ? mElements.at( i )->maximumSize().width() : maxSizeHint.width() ); @@ -3342,7 +3945,8 @@ void QCPLayoutInset::updateLayout() { insetRect = QRect( rect().x() + rect().width() * mInsetRect.at( i ).x(), rect().y() + rect().height() * mInsetRect.at( i ).y(), - rect().width() * mInsetRect.at( i ).width(), rect().height() * mInsetRect.at( i ).height() ); + rect().width() * mInsetRect.at( i ).width(), + rect().height() * mInsetRect.at( i ).height() ); if( insetRect.size().width() < finalMinSize.width() ) insetRect.setWidth( finalMinSize.width() ); if( insetRect.size().height() < finalMinSize.height() ) @@ -3430,15 +4034,22 @@ bool QCPLayoutInset::take( QCPLayoutElement* element ) } /*! - The inset layout is sensitive to events only at areas where its (visible) child elements are - sensitive. If the selectTest method of any of the child elements returns a positive number for \a - pos, this method returns a value corresponding to 0.99 times the parent plot's selection - tolerance. The inset layout is not selectable itself by default. So if \a onlySelectable is true, + The inset layout is sensitive to events only at areas where its (visible) + child elements are + sensitive. If the selectTest method of any of the child elements returns a + positive number for \a + pos, this method returns a value corresponding to 0.99 times the parent plot's + selection + tolerance. The inset layout is not selectable itself by default. So if \a + onlySelectable is true, -1.0 is returned. - See \ref QCPLayerable::selectTest for a general explanation of this virtual method. + See \ref QCPLayerable::selectTest for a general explanation of this virtual + method. */ -double QCPLayoutInset::selectTest( const QPointF& pos, bool onlySelectable, QVariant* details ) const +double QCPLayoutInset::selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details ) const { Q_UNUSED( details ) if( onlySelectable ) @@ -3446,21 +4057,27 @@ double QCPLayoutInset::selectTest( const QPointF& pos, bool onlySelectable, QVar for( int i = 0; i < mElements.size(); ++i ) { - // inset layout shall only return positive selectTest, if actually an inset object is at pos + // inset layout shall only return positive selectTest, if actually an inset + // object is at pos // else it would block the entire underlying QCPAxisRect with its surface. - if( mElements.at( i )->realVisibility() && mElements.at( i )->selectTest( pos, onlySelectable ) >= 0 ) + if( mElements.at( i )->realVisibility() && + mElements.at( i )->selectTest( pos, onlySelectable ) >= 0 ) return mParentPlot->selectionTolerance() * 0.99; } return -1; } /*! - Adds the specified \a element to the layout as an inset aligned at the border (\ref - setInsetAlignment is initialized with \ref ipBorderAligned). The alignment is set to \a + Adds the specified \a element to the layout as an inset aligned at the border + (\ref + setInsetAlignment is initialized with \ref ipBorderAligned). The alignment is + set to \a alignment. - \a alignment is an or combination of the following alignment flags: Qt::AlignLeft, - Qt::AlignHCenter, Qt::AlighRight, Qt::AlignTop, Qt::AlignVCenter, Qt::AlignBottom. Any other + \a alignment is an or combination of the following alignment flags: + Qt::AlignLeft, + Qt::AlignHCenter, Qt::AlighRight, Qt::AlignTop, Qt::AlignVCenter, + Qt::AlignBottom. Any other alignment flags will be ignored. \see addElement(QCPLayoutElement *element, const QRectF &rect) @@ -3482,12 +4099,16 @@ void QCPLayoutInset::addElement( QCPLayoutElement* element, Qt::Alignment alignm } /*! - Adds the specified \a element to the layout as an inset with free positioning/sizing (\ref - setInsetAlignment is initialized with \ref ipFree). The position and size is set to \a + Adds the specified \a element to the layout as an inset with free + positioning/sizing (\ref + setInsetAlignment is initialized with \ref ipFree). The position and size is + set to \a rect. - \a rect is given in fractions of the whole inset layout rect. So an inset with rect (0, 0, 1, 1) - will span the entire layout. An inset with rect (0.6, 0.1, 0.35, 0.35) will be in the top right + \a rect is given in fractions of the whole inset layout rect. So an inset with + rect (0, 0, 1, 1) + will span the entire layout. An inset with rect (0.6, 0.1, 0.35, 0.35) will be + in the top right corner of the layout, with 35% width and height of the parent layout. \see addElement(QCPLayoutElement *element, Qt::Alignment alignment) @@ -3517,18 +4138,27 @@ void QCPLayoutInset::addElement( QCPLayoutElement* element, const QRectF& rect ) \image html QCPLineEnding.png "The various ending styles currently supported" - For every ending a line-like item has, an instance of this class exists. For example, QCPItemLine - has two endings which can be set with QCPItemLine::setHead and QCPItemLine::setTail. + For every ending a line-like item has, an instance of this class exists. For + example, QCPItemLine + has two endings which can be set with QCPItemLine::setHead and + QCPItemLine::setTail. - The styles themselves are defined via the enum QCPLineEnding::EndingStyle. Most decorations can - be modified regarding width and length, see \ref setWidth and \ref setLength. The direction of - the ending decoration (e.g. direction an arrow is pointing) is controlled by the line-like item. - For example, when both endings of a QCPItemLine are set to be arrows, they will point to opposite - directions, e.g. "outward". This can be changed by \ref setInverted, which would make the + The styles themselves are defined via the enum QCPLineEnding::EndingStyle. + Most decorations can + be modified regarding width and length, see \ref setWidth and \ref setLength. + The direction of + the ending decoration (e.g. direction an arrow is pointing) is controlled by + the line-like item. + For example, when both endings of a QCPItemLine are set to be arrows, they + will point to opposite + directions, e.g. "outward". This can be changed by \ref setInverted, which + would make the respective arrow point inward. - Note that due to the overloaded QCPLineEnding constructor, you may directly specify a - QCPLineEnding::EndingStyle where actually a QCPLineEnding is expected, e.g. \code + Note that due to the overloaded QCPLineEnding constructor, you may directly + specify a + QCPLineEnding::EndingStyle where actually a QCPLineEnding is expected, e.g. + \code myItemLine->setHead(QCPLineEnding::esSpikeArrow) \endcode */ @@ -3542,7 +4172,10 @@ QCPLineEnding::QCPLineEnding() : mStyle( esNone ), mWidth( 8 ), mLength( 10 ), m /*! Creates a QCPLineEnding instance with the specified values. */ -QCPLineEnding::QCPLineEnding( QCPLineEnding::EndingStyle style, double width, double length, bool inverted ) +QCPLineEnding::QCPLineEnding( QCPLineEnding::EndingStyle style, + double width, + double length, + bool inverted ) : mStyle( style ), mWidth( width ), mLength( length ), mInverted( inverted ) { } @@ -3556,7 +4189,8 @@ void QCPLineEnding::setStyle( QCPLineEnding::EndingStyle style ) } /*! - Sets the width of the ending decoration, if the style supports it. On arrows, for example, the + Sets the width of the ending decoration, if the style supports it. On arrows, + for example, the width defines the size perpendicular to the arrow's pointing direction. \see setLength @@ -3567,7 +4201,8 @@ void QCPLineEnding::setWidth( double width ) } /*! - Sets the length of the ending decoration, if the style supports it. On arrows, for example, the + Sets the length of the ending decoration, if the style supports it. On arrows, + for example, the length defines the size in pointing direction. \see setWidth @@ -3578,12 +4213,16 @@ void QCPLineEnding::setLength( double length ) } /*! - Sets whether the ending decoration shall be inverted. For example, an arrow decoration will point + Sets whether the ending decoration shall be inverted. For example, an arrow + decoration will point inward when \a inverted is set to true. - Note that also the \a width direction is inverted. For symmetrical ending styles like arrows or - discs, this doesn't make a difference. However, asymmetric styles like \ref esHalfBar are - affected by it, which can be used to control to which side the half bar points to. + Note that also the \a width direction is inverted. For symmetrical ending + styles like arrows or + discs, this doesn't make a difference. However, asymmetric styles like \ref + esHalfBar are + affected by it, which can be used to control to which side the half bar points + to. */ void QCPLineEnding::setInverted( bool inverted ) { @@ -3592,11 +4231,15 @@ void QCPLineEnding::setInverted( bool inverted ) /*! \internal - Returns the maximum pixel radius the ending decoration might cover, starting from the position - the decoration is drawn at (typically a line ending/\ref QCPItemPosition of an item). + Returns the maximum pixel radius the ending decoration might cover, starting + from the position + the decoration is drawn at (typically a line ending/\ref QCPItemPosition of an + item). - This is relevant for clipping. Only omit painting of the decoration when the position where the - decoration is supposed to be drawn is farther away from the clipping rect than the returned + This is relevant for clipping. Only omit painting of the decoration when the + position where the + decoration is supposed to be drawn is farther away from the clipping rect than + the returned distance. */ double QCPLineEnding::boundingDistance() const @@ -3623,14 +4266,19 @@ double QCPLineEnding::boundingDistance() const } /*! - Starting from the origin of this line ending (which is style specific), returns the length + Starting from the origin of this line ending (which is style specific), + returns the length covered by the line ending symbol, in backward direction. - For example, the \ref esSpikeArrow has a shorter real length than a \ref esFlatArrow, even if - both have the same \ref setLength value, because the spike arrow has an inward curved back, which - reduces the length along its center axis (the drawing origin for arrows is at the tip). + For example, the \ref esSpikeArrow has a shorter real length than a \ref + esFlatArrow, even if + both have the same \ref setLength value, because the spike arrow has an inward + curved back, which + reduces the length along its center axis (the drawing origin for arrows is at + the tip). - This function is used for precise, style specific placement of line endings, for example in + This function is used for precise, style specific placement of line endings, + for example in QCPAxes. */ double QCPLineEnding::realLength() const @@ -3660,7 +4308,8 @@ double QCPLineEnding::realLength() const /*! \internal - Draws the line ending with the specified \a painter at the position \a pos. The direction of the + Draws the line ending with the specified \a painter at the position \a pos. + The direction of the line ending is controlled with \a dir. */ void QCPLineEnding::draw( QCPPainter* painter, const QVector2D& pos, const QVector2D& dir ) const @@ -3698,7 +4347,8 @@ void QCPLineEnding::draw( QCPPainter* painter, const QVector2D& pos, const QVect case esSpikeArrow: { QPointF points[4] = {pos.toPointF(), ( pos - lengthVec + widthVec ).toPointF(), - ( pos - lengthVec * 0.8f ).toPointF(), ( pos - lengthVec - widthVec ).toPointF()}; + ( pos - lengthVec * 0.8f ).toPointF(), + ( pos - lengthVec - widthVec ).toPointF()}; painter->setPen( miterPen ); painter->setBrush( brush ); painter->drawConvexPolygon( points, 4 ); @@ -3725,8 +4375,10 @@ void QCPLineEnding::draw( QCPPainter* painter, const QVector2D& pos, const QVect case esSquare: { QVector2D widthVecPerp( -widthVec.y(), widthVec.x() ); - QPointF points[4] = {( pos - widthVecPerp + widthVec ).toPointF(), ( pos - widthVecPerp - widthVec ).toPointF(), - ( pos + widthVecPerp - widthVec ).toPointF(), ( pos + widthVecPerp + widthVec ).toPointF()}; + QPointF points[4] = {( pos - widthVecPerp + widthVec ).toPointF(), + ( pos - widthVecPerp - widthVec ).toPointF(), + ( pos + widthVecPerp - widthVec ).toPointF(), + ( pos + widthVecPerp + widthVec ).toPointF()}; painter->setPen( miterPen ); painter->setBrush( brush ); painter->drawConvexPolygon( points, 4 ); @@ -3758,23 +4410,28 @@ void QCPLineEnding::draw( QCPPainter* painter, const QVector2D& pos, const QVect } case esSkewedBar: { - if( qFuzzyIsNull( painter->pen().widthF() ) && !painter->modes().testFlag( QCPPainter::pmNonCosmetic ) ) + if( qFuzzyIsNull( painter->pen().widthF() ) && + !painter->modes().testFlag( QCPPainter::pmNonCosmetic ) ) { - // if drawing with cosmetic pen (perfectly thin stroke, happens only in vector exports), draw bar exactly on tip + // if drawing with cosmetic pen (perfectly thin stroke, happens only in + // vector exports), draw bar exactly on tip // of line - painter->drawLine( ( pos + widthVec + lengthVec * 0.2f * ( mInverted ? -1 : 1 ) ).toPointF(), - ( pos - widthVec - lengthVec * 0.2f * ( mInverted ? -1 : 1 ) ).toPointF() ); + painter->drawLine( + ( pos + widthVec + lengthVec * 0.2f * ( mInverted ? -1 : 1 ) ).toPointF(), + ( pos - widthVec - lengthVec * 0.2f * ( mInverted ? -1 : 1 ) ).toPointF() ); } else { - // if drawing with thick (non-cosmetic) pen, shift bar a little in line direction to prevent line from sticking + // if drawing with thick (non-cosmetic) pen, shift bar a little in line + // direction to prevent line from sticking // through bar slightly - painter->drawLine( ( pos + widthVec + lengthVec * 0.2f * ( mInverted ? -1 : 1 ) + - dir.normalized() * qMax( 1.0f, (float)painter->pen().widthF() ) * 0.5f ) - .toPointF(), - ( pos - widthVec - lengthVec * 0.2f * ( mInverted ? -1 : 1 ) + - dir.normalized() * qMax( 1.0f, (float)painter->pen().widthF() ) * 0.5f ) - .toPointF() ); + painter->drawLine( + ( pos + widthVec + lengthVec * 0.2f * ( mInverted ? -1 : 1 ) + + dir.normalized() * qMax( 1.0f, (float)painter->pen().widthF() ) * 0.5f ) + .toPointF(), + ( pos - widthVec - lengthVec * 0.2f * ( mInverted ? -1 : 1 ) + + dir.normalized() * qMax( 1.0f, (float)painter->pen().widthF() ) * 0.5f ) + .toPointF() ); } break; } @@ -3784,7 +4441,8 @@ void QCPLineEnding::draw( QCPPainter* painter, const QVector2D& pos, const QVect /*! \internal \overload - Draws the line ending. The direction is controlled with the \a angle parameter in radians. + Draws the line ending. The direction is controlled with the \a angle parameter + in radians. */ void QCPLineEnding::draw( QCPPainter* painter, const QVector2D& pos, double angle ) const { @@ -3798,25 +4456,33 @@ void QCPLineEnding::draw( QCPPainter* painter, const QVector2D& pos, double angl /*! \class QCPGrid \brief Responsible for drawing the grid of a QCPAxis. - This class is tightly bound to QCPAxis. Every axis owns a grid instance and uses it to draw the - grid lines, sub grid lines and zero-line. You can interact with the grid of an axis via \ref - QCPAxis::grid. Normally, you don't need to create an instance of QCPGrid yourself. + This class is tightly bound to QCPAxis. Every axis owns a grid instance and + uses it to draw the + grid lines, sub grid lines and zero-line. You can interact with the grid of an + axis via \ref + QCPAxis::grid. Normally, you don't need to create an instance of QCPGrid + yourself. - The axis and grid drawing was split into two classes to allow them to be placed on different - layers (both QCPAxis and QCPGrid inherit from QCPLayerable). Thus it is possible to have the grid - in the background and the axes in the foreground, and any plottables/items in between. This + The axis and grid drawing was split into two classes to allow them to be + placed on different + layers (both QCPAxis and QCPGrid inherit from QCPLayerable). Thus it is + possible to have the grid + in the background and the axes in the foreground, and any plottables/items in + between. This described situation is the default setup, see the QCPLayer documentation. */ /*! Creates a QCPGrid instance and sets default values. - You shouldn't instantiate grids on their own, since every QCPAxis brings its own QCPGrid. + You shouldn't instantiate grids on their own, since every QCPAxis brings its + own QCPGrid. */ QCPGrid::QCPGrid( QCPAxis* parentAxis ) : QCPLayerable( parentAxis->parentPlot(), "", parentAxis ), mParentAxis( parentAxis ) { - // warning: this is called in QCPAxis constructor, so parentAxis members should not be accessed/called + // warning: this is called in QCPAxis constructor, so parentAxis members + // should not be accessed/called setParent( parentAxis ); setPen( QPen( QColor( 200, 200, 200 ), 0, Qt::DotLine ) ); setSubGridPen( QPen( QColor( 220, 220, 220 ), 0, Qt::DotLine ) ); @@ -3872,8 +4538,10 @@ void QCPGrid::setSubGridPen( const QPen& pen ) /*! Sets the pen with which zero lines are drawn. - Zero lines are lines at value coordinate 0 which may be drawn with a different pen than other grid - lines. To disable zero lines and just draw normal grid lines at zero, set \a pen to Qt::NoPen. + Zero lines are lines at value coordinate 0 which may be drawn with a different + pen than other grid + lines. To disable zero lines and just draw normal grid lines at zero, set \a + pen to Qt::NoPen. */ void QCPGrid::setZeroLinePen( const QPen& pen ) { @@ -3882,12 +4550,15 @@ void QCPGrid::setZeroLinePen( const QPen& pen ) /*! \internal - A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter + A convenience function to easily set the QPainter::Antialiased hint on the + provided \a painter before drawing the major grid lines. - This is the antialiasing state the painter passed to the \ref draw method is in by default. + This is the antialiasing state the painter passed to the \ref draw method is + in by default. - This function takes into account the local setting of the antialiasing flag as well as the + This function takes into account the local setting of the antialiasing flag as + well as the overrides set with \ref QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. @@ -3900,8 +4571,10 @@ void QCPGrid::applyDefaultAntialiasingHint( QCPPainter* painter ) const /*! \internal - Draws grid lines and sub grid lines at the positions of (sub) ticks of the parent axis, spanning - over the complete axis rect. Also draws the zero line, if appropriate (\ref setZeroLinePen). + Draws grid lines and sub grid lines at the positions of (sub) ticks of the + parent axis, spanning + over the complete axis rect. Also draws the zero line, if appropriate (\ref + setZeroLinePen). */ void QCPGrid::draw( QCPPainter* painter ) { @@ -3937,7 +4610,8 @@ void QCPGrid::drawGridLines( QCPPainter* painter ) const { // draw zeroline: int zeroLineIndex = -1; - if( mZeroLinePen.style() != Qt::NoPen && mParentAxis->mRange.lower < 0 && mParentAxis->mRange.upper > 0 ) + if( mZeroLinePen.style() != Qt::NoPen && mParentAxis->mRange.lower < 0 && + mParentAxis->mRange.upper > 0 ) { applyAntialiasingHint( painter, mAntialiasedZeroLine, QCP::aeZeroLine ); painter->setPen( mZeroLinePen ); @@ -3948,7 +4622,8 @@ void QCPGrid::drawGridLines( QCPPainter* painter ) const { zeroLineIndex = i; t = mParentAxis->coordToPixel( mParentAxis->mTickVector.at( i ) ); // x - painter->drawLine( QLineF( t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top() ) ); + painter->drawLine( + QLineF( t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top() ) ); break; } } @@ -3961,14 +4636,16 @@ void QCPGrid::drawGridLines( QCPPainter* painter ) const if( i == zeroLineIndex ) continue; // don't draw a gridline on top of the zeroline t = mParentAxis->coordToPixel( mParentAxis->mTickVector.at( i ) ); // x - painter->drawLine( QLineF( t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top() ) ); + painter->drawLine( + QLineF( t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top() ) ); } } else { // draw zeroline: int zeroLineIndex = -1; - if( mZeroLinePen.style() != Qt::NoPen && mParentAxis->mRange.lower < 0 && mParentAxis->mRange.upper > 0 ) + if( mZeroLinePen.style() != Qt::NoPen && mParentAxis->mRange.lower < 0 && + mParentAxis->mRange.upper > 0 ) { applyAntialiasingHint( painter, mAntialiasedZeroLine, QCP::aeZeroLine ); painter->setPen( mZeroLinePen ); @@ -3979,7 +4656,8 @@ void QCPGrid::drawGridLines( QCPPainter* painter ) const { zeroLineIndex = i; t = mParentAxis->coordToPixel( mParentAxis->mTickVector.at( i ) ); // y - painter->drawLine( QLineF( mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t ) ); + painter->drawLine( + QLineF( mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t ) ); break; } } @@ -3992,7 +4670,8 @@ void QCPGrid::drawGridLines( QCPPainter* painter ) const if( i == zeroLineIndex ) continue; // don't draw a gridline on top of the zeroline t = mParentAxis->coordToPixel( mParentAxis->mTickVector.at( i ) ); // y - painter->drawLine( QLineF( mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t ) ); + painter->drawLine( + QLineF( mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t ) ); } } } @@ -4019,7 +4698,8 @@ void QCPGrid::drawSubGridLines( QCPPainter* painter ) const for( int i = 0; i < mParentAxis->mSubTickVector.size(); ++i ) { t = mParentAxis->coordToPixel( mParentAxis->mSubTickVector.at( i ) ); // x - painter->drawLine( QLineF( t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top() ) ); + painter->drawLine( + QLineF( t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top() ) ); } } else @@ -4027,7 +4707,8 @@ void QCPGrid::drawSubGridLines( QCPPainter* painter ) const for( int i = 0; i < mParentAxis->mSubTickVector.size(); ++i ) { t = mParentAxis->coordToPixel( mParentAxis->mSubTickVector.at( i ) ); // y - painter->drawLine( QLineF( mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t ) ); + painter->drawLine( + QLineF( mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t ) ); } } } @@ -4039,8 +4720,10 @@ void QCPGrid::drawSubGridLines( QCPPainter* painter ) const /*! \class QCPAxis \brief Manages a single axis inside a QCustomPlot. - Usually doesn't need to be instantiated externally. Access %QCustomPlot's default four axes via - QCustomPlot::xAxis (bottom), QCustomPlot::yAxis (left), QCustomPlot::xAxis2 (top) and + Usually doesn't need to be instantiated externally. Access %QCustomPlot's + default four axes via + QCustomPlot::xAxis (bottom), QCustomPlot::yAxis (left), QCustomPlot::xAxis2 + (top) and QCustomPlot::yAxis2 (right). Axes are always part of an axis rect, see QCPAxisRect. @@ -4049,7 +4732,8 @@ void QCPGrid::drawSubGridLines( QCPPainter* painter ) const \n \image html AxisRectSpacingOverview.png -

    Overview of the spacings and paddings that define the geometry of an axis. The dashed gray line +
    Overview of the spacings and paddings that define the geometry of an + axis. The dashed gray line on the left represents the QCustomPlot widget border.
    */ @@ -4058,7 +4742,8 @@ void QCPGrid::drawSubGridLines( QCPPainter* painter ) const /*! \fn Qt::Orientation QCPAxis::orientation() const - Returns the orientation of this axis. The axis orientation (horizontal or vertical) is deduced + Returns the orientation of this axis. The axis orientation (horizontal or + vertical) is deduced from the axis type (left, top, right or bottom). \see orientation(AxisType type) @@ -4066,7 +4751,8 @@ void QCPGrid::drawSubGridLines( QCPPainter* painter ) const /*! \fn QCPGrid *QCPAxis::grid() const - Returns the \ref QCPGrid instance belonging to this axis. Access it to set details about the way the + Returns the \ref QCPGrid instance belonging to this axis. Access it to set + details about the way the grid is displayed. */ @@ -4082,47 +4768,60 @@ void QCPGrid::drawSubGridLines( QCPPainter* painter ) const /*! \fn void QCPAxis::ticksRequest() - This signal is emitted when \ref setAutoTicks is false and the axis is about to generate tick + This signal is emitted when \ref setAutoTicks is false and the axis is about + to generate tick labels for a replot. - Modifying the tick positions can be done with \ref setTickVector. If you also want to control the - tick labels, set \ref setAutoTickLabels to false and also provide the labels with \ref + Modifying the tick positions can be done with \ref setTickVector. If you also + want to control the + tick labels, set \ref setAutoTickLabels to false and also provide the labels + with \ref setTickVectorLabels. - If you only want static ticks you probably don't need this signal, since you can just set the - tick vector (and possibly tick label vector) once. However, if you want to provide ticks (and - maybe labels) dynamically, e.g. depending on the current axis range, connect a slot to this + If you only want static ticks you probably don't need this signal, since you + can just set the + tick vector (and possibly tick label vector) once. However, if you want to + provide ticks (and + maybe labels) dynamically, e.g. depending on the current axis range, connect a + slot to this signal and set the vector/vectors there. */ /*! \fn void QCPAxis::rangeChanged(const QCPRange &newRange) - This signal is emitted when the range of this axis has changed. You can connect it to the \ref - setRange slot of another axis to communicate the new range to the other axis, in order for it to + This signal is emitted when the range of this axis has changed. You can + connect it to the \ref + setRange slot of another axis to communicate the new range to the other axis, + in order for it to be synchronized. */ -/*! \fn void QCPAxis::rangeChanged(const QCPRange &newRange, const QCPRange &oldRange) +/*! \fn void QCPAxis::rangeChanged(const QCPRange &newRange, const QCPRange + &oldRange) \overload - Additionally to the new range, this signal also provides the previous range held by the axis as + Additionally to the new range, this signal also provides the previous range + held by the axis as \a oldRange. */ /*! \fn void QCPAxis::scaleTypeChanged(QCPAxis::ScaleType scaleType); - This signal is emitted when the scale type changes, by calls to \ref setScaleType + This signal is emitted when the scale type changes, by calls to \ref + setScaleType */ /*! \fn void QCPAxis::selectionChanged(QCPAxis::SelectableParts selection) - This signal is emitted when the selection state of this axis has changed, either by user interaction + This signal is emitted when the selection state of this axis has changed, + either by user interaction or by a direct call to \ref setSelectedParts. */ /*! \fn void QCPAxis::selectableChanged(const QCPAxis::SelectableParts &parts); - This signal is emitted when the selectability changes, by calls to \ref setSelectableParts + This signal is emitted when the selectability changes, by calls to \ref + setSelectableParts */ /* end of documentation of signals */ @@ -4132,64 +4831,72 @@ void QCPGrid::drawSubGridLines( QCPPainter* painter ) const You shouldn't instantiate axes directly, rather use \ref QCPAxisRect::addAxis. */ QCPAxis::QCPAxis( QCPAxisRect* parent, AxisType type ) - : QCPLayerable( parent->parentPlot(), "", parent ), - // axis base: - mAxisType( type ), - mAxisRect( parent ), - mPadding( 5 ), - mOrientation( orientation( type ) ), - mSelectableParts( spAxis | spTickLabels | spAxisLabel ), - mSelectedParts( spNone ), - mBasePen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ), - mSelectedBasePen( QPen( Qt::blue, 2 ) ), - // axis label: - mLabel( "" ), - mLabelFont( mParentPlot->font() ), - mSelectedLabelFont( QFont( mLabelFont.family(), mLabelFont.pointSize(), QFont::Bold ) ), - mLabelColor( Qt::black ), - mSelectedLabelColor( Qt::blue ), - // tick labels: - mTickLabels( true ), - mAutoTickLabels( true ), - mTickLabelType( ltNumber ), - mTickLabelFont( mParentPlot->font() ), - mSelectedTickLabelFont( QFont( mTickLabelFont.family(), mTickLabelFont.pointSize(), QFont::Bold ) ), - mTickLabelColor( Qt::black ), - mSelectedTickLabelColor( Qt::blue ), - mDateTimeFormat( "hh:mm:ss\ndd.MM.yy" ), - mDateTimeSpec( Qt::LocalTime ), - mNumberPrecision( 6 ), - mNumberFormatChar( 'g' ), - mNumberBeautifulPowers( true ), - // ticks and subticks: - mTicks( true ), - mTickStep( 1 ), - mSubTickCount( 4 ), - mAutoTickCount( 6 ), - mAutoTicks( true ), - mAutoTickStep( true ), - mAutoSubTicks( true ), - mTickPen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ), - mSelectedTickPen( QPen( Qt::blue, 2 ) ), - mSubTickPen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ), - mSelectedSubTickPen( QPen( Qt::blue, 2 ) ), - // scale and range: - mRange( 0, 5 ), - mRangeReversed( false ), - mScaleType( stLinear ), - mScaleLogBase( 10 ), - mScaleLogBaseLogInv( 1.0 / qLn( mScaleLogBase ) ), - // internal members: - mGrid( new QCPGrid( this ) ), - mAxisPainter( new QCPAxisPainterPrivate( parent->parentPlot() ) ), - mLowestVisibleTick( 0 ), - mHighestVisibleTick( -1 ), - mCachedMarginValid( false ), - mCachedMargin( 0 ) + : QCPLayerable( parent->parentPlot(), "", parent ) + , + // axis base: + mAxisType( type ) + , mAxisRect( parent ) + , mPadding( 5 ) + , mOrientation( orientation( type ) ) + , mSelectableParts( spAxis | spTickLabels | spAxisLabel ) + , mSelectedParts( spNone ) + , mBasePen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ) + , mSelectedBasePen( QPen( Qt::blue, 2 ) ) + , + // axis label: + mLabel( "" ) + , mLabelFont( mParentPlot->font() ) + , mSelectedLabelFont( QFont( mLabelFont.family(), mLabelFont.pointSize(), QFont::Bold ) ) + , mLabelColor( Qt::black ) + , mSelectedLabelColor( Qt::blue ) + , + // tick labels: + mTickLabels( true ) + , mAutoTickLabels( true ) + , mTickLabelType( ltNumber ) + , mTickLabelFont( mParentPlot->font() ) + , mSelectedTickLabelFont( + QFont( mTickLabelFont.family(), mTickLabelFont.pointSize(), QFont::Bold ) ) + , mTickLabelColor( Qt::black ) + , mSelectedTickLabelColor( Qt::blue ) + , mDateTimeFormat( "hh:mm:ss\ndd.MM.yy" ) + , mDateTimeSpec( Qt::LocalTime ) + , mNumberPrecision( 6 ) + , mNumberFormatChar( 'g' ) + , mNumberBeautifulPowers( true ) + , + // ticks and subticks: + mTicks( true ) + , mTickStep( 1 ) + , mSubTickCount( 4 ) + , mAutoTickCount( 6 ) + , mAutoTicks( true ) + , mAutoTickStep( true ) + , mAutoSubTicks( true ) + , mTickPen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ) + , mSelectedTickPen( QPen( Qt::blue, 2 ) ) + , mSubTickPen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ) + , mSelectedSubTickPen( QPen( Qt::blue, 2 ) ) + , + // scale and range: + mRange( 0, 5 ) + , mRangeReversed( false ) + , mScaleType( stLinear ) + , mScaleLogBase( 10 ) + , mScaleLogBaseLogInv( 1.0 / qLn( mScaleLogBase ) ) + , + // internal members: + mGrid( new QCPGrid( this ) ) + , mAxisPainter( new QCPAxisPainterPrivate( parent->parentPlot() ) ) + , mLowestVisibleTick( 0 ) + , mHighestVisibleTick( -1 ) + , mCachedMarginValid( false ) + , mCachedMargin( 0 ) { mGrid->setVisible( false ); setAntialiased( false ); - setLayer( mParentPlot->currentLayer() ); // it's actually on that layer already, but we want it in front of the grid, + setLayer( mParentPlot->currentLayer() ); // it's actually on that layer already, + // but we want it in front of the grid, // so we place it on there again if( type == atTop ) @@ -4294,16 +5001,24 @@ QCPLineEnding QCPAxis::upperEnding() const } /*! - Sets whether the axis uses a linear scale or a logarithmic scale. If \a type is set to \ref - stLogarithmic, the logarithm base can be set with \ref setScaleLogBase. In logarithmic axis - scaling, major tick marks appear at all powers of the logarithm base. Properties like tick step - (\ref setTickStep) don't apply in logarithmic scaling. If you wish a decimal base but less major + Sets whether the axis uses a linear scale or a logarithmic scale. If \a type + is set to \ref + stLogarithmic, the logarithm base can be set with \ref setScaleLogBase. In + logarithmic axis + scaling, major tick marks appear at all powers of the logarithm base. + Properties like tick step + (\ref setTickStep) don't apply in logarithmic scaling. If you wish a decimal + base but less major ticks, consider choosing a logarithm base of 100, 1000 or even higher. - If \a type is \ref stLogarithmic and the number format (\ref setNumberFormat) uses the 'b' option - (beautifully typeset decimal powers), the display usually is "1 [multiplication sign] 10 - [superscript] n", which looks unnatural for logarithmic scaling (the "1 [multiplication sign]" - part). To only display the decimal power, set the number precision to zero with + If \a type is \ref stLogarithmic and the number format (\ref setNumberFormat) + uses the 'b' option + (beautifully typeset decimal powers), the display usually is "1 + [multiplication sign] 10 + [superscript] n", which looks unnatural for logarithmic scaling (the "1 + [multiplication sign]" + part). To only display the decimal power, set the number precision to zero + with \ref setNumberPrecision. */ void QCPAxis::setScaleType( QCPAxis::ScaleType type ) @@ -4319,10 +5034,13 @@ void QCPAxis::setScaleType( QCPAxis::ScaleType type ) } /*! - If \ref setScaleType is set to \ref stLogarithmic, \a base will be the logarithm base of the - scaling. In logarithmic axis scaling, major tick marks appear at all powers of \a base. + If \ref setScaleType is set to \ref stLogarithmic, \a base will be the + logarithm base of the + scaling. In logarithmic axis scaling, major tick marks appear at all powers of + \a base. - Properties like tick step (\ref setTickStep) don't apply in logarithmic scaling. If you wish a decimal base but + Properties like tick step (\ref setTickStep) don't apply in logarithmic + scaling. If you wish a decimal base but less major ticks, consider choosing \a base 100, 1000 or even higher. */ void QCPAxis::setScaleLogBase( double base ) @@ -4340,7 +5058,8 @@ void QCPAxis::setScaleLogBase( double base ) /*! Sets the range of the axis. - This slot may be connected with the \ref rangeChanged signal of another axis so this axis + This slot may be connected with the \ref rangeChanged signal of another axis + so this axis is always synchronized with the other axis range, when it changes. To invert the direction of an axis, use \ref setRangeReversed. @@ -4367,11 +5086,14 @@ void QCPAxis::setRange( const QCPRange& range ) } /*! - Sets whether the user can (de-)select the parts in \a selectable by clicking on the QCustomPlot surface. + Sets whether the user can (de-)select the parts in \a selectable by clicking + on the QCustomPlot surface. (When \ref QCustomPlot::setInteractions contains iSelectAxes.) - However, even when \a selectable is set to a value not allowing the selection of a specific part, - it is still possible to set the selection of this part manually, by calling \ref setSelectedParts + However, even when \a selectable is set to a value not allowing the selection + of a specific part, + it is still possible to set the selection of this part manually, by calling + \ref setSelectedParts directly. \see SelectablePart, setSelectedParts @@ -4386,19 +5108,25 @@ void QCPAxis::setSelectableParts( const SelectableParts& selectable ) } /*! - Sets the selected state of the respective axis parts described by \ref SelectablePart. When a part + Sets the selected state of the respective axis parts described by \ref + SelectablePart. When a part is selected, it uses a different pen/font. The entire selection mechanism for axes is handled automatically when \ref - QCustomPlot::setInteractions contains iSelectAxes. You only need to call this function when you + QCustomPlot::setInteractions contains iSelectAxes. You only need to call this + function when you wish to change the selection state manually. - This function can change the selection state of a part, independent of the \ref setSelectableParts setting. + This function can change the selection state of a part, independent of the + \ref setSelectableParts setting. - emits the \ref selectionChanged signal when \a selected is different from the previous selection state. + emits the \ref selectionChanged signal when \a selected is different from the + previous selection state. - \see SelectablePart, setSelectableParts, selectTest, setSelectedBasePen, setSelectedTickPen, setSelectedSubTickPen, - setSelectedTickLabelFont, setSelectedLabelFont, setSelectedTickLabelColor, setSelectedLabelColor + \see SelectablePart, setSelectableParts, selectTest, setSelectedBasePen, + setSelectedTickPen, setSelectedSubTickPen, + setSelectedTickLabelFont, setSelectedLabelFont, setSelectedTickLabelColor, + setSelectedLabelColor */ void QCPAxis::setSelectedParts( const SelectableParts& selected ) { @@ -4446,10 +5174,14 @@ void QCPAxis::setRange( double lower, double upper ) Sets the range of the axis. - The \a position coordinate indicates together with the \a alignment parameter, where the new - range will be positioned. \a size defines the size of the new axis range. \a alignment may be - Qt::AlignLeft, Qt::AlignRight or Qt::AlignCenter. This will cause the left border, right border, - or center of the range to be aligned with \a position. Any other values of \a alignment will + The \a position coordinate indicates together with the \a alignment parameter, + where the new + range will be positioned. \a size defines the size of the new axis range. \a + alignment may be + Qt::AlignLeft, Qt::AlignRight or Qt::AlignCenter. This will cause the left + border, right border, + or center of the range to be aligned with \a position. Any other values of \a + alignment will default to Qt::AlignCenter. */ void QCPAxis::setRange( double position, double size, Qt::AlignmentFlag alignment ) @@ -4511,12 +5243,16 @@ void QCPAxis::setRangeUpper( double upper ) } /*! - Sets whether the axis range (direction) is displayed reversed. Normally, the values on horizontal - axes increase left to right, on vertical axes bottom to top. When \a reversed is set to true, the + Sets whether the axis range (direction) is displayed reversed. Normally, the + values on horizontal + axes increase left to right, on vertical axes bottom to top. When \a reversed + is set to true, the direction of increasing values is inverted. - Note that the range and data interface stays the same for reversed axes, e.g. the \a lower part - of the \ref setRange interface will still reference the mathematically smaller number than the \a + Note that the range and data interface stays the same for reversed axes, e.g. + the \a lower part + of the \ref setRange interface will still reference the mathematically smaller + number than the \a upper part. */ void QCPAxis::setRangeReversed( bool reversed ) @@ -4529,16 +5265,23 @@ void QCPAxis::setRangeReversed( bool reversed ) } /*! - Sets whether the tick positions should be calculated automatically (either from an automatically - generated tick step or a tick step provided manually via \ref setTickStep, see \ref setAutoTickStep). + Sets whether the tick positions should be calculated automatically (either + from an automatically + generated tick step or a tick step provided manually via \ref setTickStep, see + \ref setAutoTickStep). - If \a on is set to false, you must provide the tick positions manually via \ref setTickVector. - For these manual ticks you may let QCPAxis generate the appropriate labels automatically by - leaving \ref setAutoTickLabels set to true. If you also wish to control the displayed labels - manually, set \ref setAutoTickLabels to false and provide the label strings with \ref + If \a on is set to false, you must provide the tick positions manually via + \ref setTickVector. + For these manual ticks you may let QCPAxis generate the appropriate labels + automatically by + leaving \ref setAutoTickLabels set to true. If you also wish to control the + displayed labels + manually, set \ref setAutoTickLabels to false and provide the label strings + with \ref setTickVectorLabels. - If you need dynamically calculated tick vectors (and possibly tick label vectors), set the + If you need dynamically calculated tick vectors (and possibly tick label + vectors), set the vectors in a slot connected to the \ref ticksRequest signal. \see setAutoTickLabels, setAutoSubTicks, setAutoTickCount, setAutoTickStep @@ -4553,10 +5296,12 @@ void QCPAxis::setAutoTicks( bool on ) } /*! - When \ref setAutoTickStep is true, \a approximateCount determines how many ticks should be + When \ref setAutoTickStep is true, \a approximateCount determines how many + ticks should be generated in the visible range, approximately. - It's not guaranteed that this number of ticks is met exactly, but approximately within a + It's not guaranteed that this number of ticks is met exactly, but + approximately within a tolerance of about two. Only values greater than zero are accepted as \a approximateCount. @@ -4578,16 +5323,23 @@ void QCPAxis::setAutoTickCount( int approximateCount ) } /*! - Sets whether the tick labels are generated automatically. Depending on the tick label type (\ref - ltNumber or \ref ltDateTime), the labels will either show the coordinate as floating point - number (\ref setNumberFormat), or a date/time formatted according to \ref setDateTimeFormat. + Sets whether the tick labels are generated automatically. Depending on the + tick label type (\ref + ltNumber or \ref ltDateTime), the labels will either show the coordinate as + floating point + number (\ref setNumberFormat), or a date/time formatted according to \ref + setDateTimeFormat. - If \a on is set to false, you should provide the tick labels via \ref setTickVectorLabels. This - is usually used in a combination with \ref setAutoTicks set to false for complete control over - tick positions and labels, e.g. when the ticks should be at multiples of pi and show "2pi", "3pi" + If \a on is set to false, you should provide the tick labels via \ref + setTickVectorLabels. This + is usually used in a combination with \ref setAutoTicks set to false for + complete control over + tick positions and labels, e.g. when the ticks should be at multiples of pi + and show "2pi", "3pi" etc. as tick labels. - If you need dynamically calculated tick vectors (and possibly tick label vectors), set the + If you need dynamically calculated tick vectors (and possibly tick label + vectors), set the vectors in a slot connected to the \ref ticksRequest signal. \see setAutoTicks @@ -4602,14 +5354,18 @@ void QCPAxis::setAutoTickLabels( bool on ) } /*! - Sets whether the tick step, i.e. the interval between two (major) ticks, is calculated - automatically. If \a on is set to true, the axis finds a tick step that is reasonable for human + Sets whether the tick step, i.e. the interval between two (major) ticks, is + calculated + automatically. If \a on is set to true, the axis finds a tick step that is + reasonable for human readable plots. - The number of ticks the algorithm aims for within the visible range can be specified with \ref + The number of ticks the algorithm aims for within the visible range can be + specified with \ref setAutoTickCount. - If \a on is set to false, you may set the tick step manually with \ref setTickStep. + If \a on is set to false, you may set the tick step manually with \ref + setTickStep. \see setAutoTicks, setAutoSubTicks, setAutoTickCount */ @@ -4623,11 +5379,14 @@ void QCPAxis::setAutoTickStep( bool on ) } /*! - Sets whether the number of sub ticks in one tick interval is determined automatically. This - works, as long as the tick step mantissa is a multiple of 0.5. When \ref setAutoTickStep is + Sets whether the number of sub ticks in one tick interval is determined + automatically. This + works, as long as the tick step mantissa is a multiple of 0.5. When \ref + setAutoTickStep is enabled, this is always the case. - When \a on is set to false, you may set the sub tick count with \ref setSubTickCount manually. + When \a on is set to false, you may set the sub tick count with \ref + setSubTickCount manually. \see setAutoTickCount, setAutoTicks, setAutoTickStep */ @@ -4643,7 +5402,8 @@ void QCPAxis::setAutoSubTicks( bool on ) /*! Sets whether tick marks are displayed. - Note that setting \a show to false does not imply that tick labels are invisible, too. To achieve + Note that setting \a show to false does not imply that tick labels are + invisible, too. To achieve that, see \ref setTickLabels. */ void QCPAxis::setTicks( bool show ) @@ -4656,7 +5416,8 @@ void QCPAxis::setTicks( bool show ) } /*! - Sets whether tick labels are displayed. Tick labels are the numbers drawn next to tick marks. + Sets whether tick labels are displayed. Tick labels are the numbers drawn next + to tick marks. */ void QCPAxis::setTickLabels( bool show ) { @@ -4668,7 +5429,8 @@ void QCPAxis::setTickLabels( bool show ) } /*! - Sets the distance between the axis base line (including any outward ticks) and the tick labels. + Sets the distance between the axis base line (including any outward ticks) and + the tick labels. \see setLabelPadding, setPadding */ void QCPAxis::setTickLabelPadding( int padding ) @@ -4683,21 +5445,32 @@ void QCPAxis::setTickLabelPadding( int padding ) /*! Sets whether the tick labels display numbers or dates/times. - If \a type is set to \ref ltNumber, the format specifications of \ref setNumberFormat apply. + If \a type is set to \ref ltNumber, the format specifications of \ref + setNumberFormat apply. - If \a type is set to \ref ltDateTime, the format specifications of \ref setDateTimeFormat apply. + If \a type is set to \ref ltDateTime, the format specifications of \ref + setDateTimeFormat apply. - In QCustomPlot, date/time coordinates are double numbers representing the seconds since - 1970-01-01T00:00:00 UTC. This format can be retrieved from QDateTime objects with the - QDateTime::toTime_t() function. Since this only gives a resolution of one second, there is also - the QDateTime::toMSecsSinceEpoch() function which returns the timespan described above in - milliseconds. Divide its return value by 1000.0 to get a value with the format needed for + In QCustomPlot, date/time coordinates are double numbers representing + the seconds since + 1970-01-01T00:00:00 UTC. This format can be retrieved from QDateTime objects + with the + QDateTime::toTime_t() function. Since this only gives a resolution of one + second, there is also + the QDateTime::toMSecsSinceEpoch() function which returns the timespan + described above in + milliseconds. Divide its return value by 1000.0 to get a value with the format + needed for date/time plotting, with a resolution of one millisecond. - Using the toMSecsSinceEpoch function allows dates that go back to 2nd January 4713 B.C. - (represented by a negative number), unlike the toTime_t function, which works with unsigned - integers and thus only goes back to 1st January 1970. So both for range and accuracy, use of - toMSecsSinceEpoch()/1000.0 should be preferred as key coordinate for date/time axes. + Using the toMSecsSinceEpoch function allows dates that go back to 2nd January + 4713 B.C. + (represented by a negative number), unlike the toTime_t function, which works + with unsigned + integers and thus only goes back to 1st January 1970. So both for range and + accuracy, use of + toMSecsSinceEpoch()/1000.0 should be preferred as key coordinate for date/time + axes. \see setTickLabels */ @@ -4739,12 +5512,16 @@ void QCPAxis::setTickLabelColor( const QColor& color ) } /*! - Sets the rotation of the tick labels. If \a degrees is zero, the labels are drawn normally. Else, - the tick labels are drawn rotated by \a degrees clockwise. The specified angle is bound to values + Sets the rotation of the tick labels. If \a degrees is zero, the labels are + drawn normally. Else, + the tick labels are drawn rotated by \a degrees clockwise. The specified angle + is bound to values from -90 to 90 degrees. - If \a degrees is exactly -90, 0 or 90, the tick labels are centered on the tick coordinate. For - other angles, the label is drawn with an offset such that it seems to point toward or away from + If \a degrees is exactly -90, 0 or 90, the tick labels are centered on the + tick coordinate. For + other angles, the label is drawn with an offset such that it seems to point + toward or away from the tick mark. */ void QCPAxis::setTickLabelRotation( double degrees ) @@ -4757,8 +5534,10 @@ void QCPAxis::setTickLabelRotation( double degrees ) } /*! - Sets the format in which dates and times are displayed as tick labels, if \ref setTickLabelType is \ref ltDateTime. - for details about the \a format string, see the documentation of QDateTime::toString(). + Sets the format in which dates and times are displayed as tick labels, if \ref + setTickLabelType is \ref ltDateTime. + for details about the \a format string, see the documentation of + QDateTime::toString(). Newlines can be inserted with "\n". @@ -4774,11 +5553,14 @@ void QCPAxis::setDateTimeFormat( const QString& format ) } /*! - Sets the time spec that is used for the date time values when \ref setTickLabelType is \ref + Sets the time spec that is used for the date time values when \ref + setTickLabelType is \ref ltDateTime. - The default value of QDateTime objects (and also QCustomPlot) is Qt::LocalTime. However, - if the date time values passed to QCustomPlot are given in the UTC spec, set \a + The default value of QDateTime objects (and also QCustomPlot) is + Qt::LocalTime. However, + if the date time values passed to QCustomPlot are given in the UTC spec, set + \a timeSpec to Qt::UTC to get the correct axis labels. \see setDateTimeFormat @@ -4789,39 +5571,60 @@ void QCPAxis::setDateTimeSpec( const Qt::TimeSpec& timeSpec ) } /*! - Sets the number format for the numbers drawn as tick labels (if tick label type is \ref - ltNumber). This \a formatCode is an extended version of the format code used e.g. by - QString::number() and QLocale::toString(). For reference about that, see the "Argument Formats" - section in the detailed description of the QString class. \a formatCode is a string of one, two - or three characters. The first character is identical to the normal format code used by Qt. In - short, this means: 'e'/'E' scientific format, 'f' fixed format, 'g'/'G' scientific or fixed, + Sets the number format for the numbers drawn as tick labels (if tick label + type is \ref + ltNumber). This \a formatCode is an extended version of the format code used + e.g. by + QString::number() and QLocale::toString(). For reference about that, see the + "Argument Formats" + section in the detailed description of the QString class. \a formatCode is a + string of one, two + or three characters. The first character is identical to the normal format + code used by Qt. In + short, this means: 'e'/'E' scientific format, 'f' fixed format, 'g'/'G' + scientific or fixed, whichever is shorter. The second and third characters are optional and specific to QCustomPlot:\n - If the first char was 'e' or 'g', numbers are/might be displayed in the scientific format, e.g. - "5.5e9", which is ugly in a plot. So when the second char of \a formatCode is set to 'b' (for - "beautiful"), those exponential numbers are formatted in a more natural way, i.e. "5.5 - [multiplication sign] 10 [superscript] 9". By default, the multiplication sign is a centered dot. - If instead a cross should be shown (as is usual in the USA), the third char of \a formatCode can - be set to 'c'. The inserted multiplication signs are the UTF-8 characters 215 (0xD7) for the + If the first char was 'e' or 'g', numbers are/might be displayed in the + scientific format, e.g. + "5.5e9", which is ugly in a plot. So when the second char of \a formatCode is + set to 'b' (for + "beautiful"), those exponential numbers are formatted in a more natural way, + i.e. "5.5 + [multiplication sign] 10 [superscript] 9". By default, the multiplication sign + is a centered dot. + If instead a cross should be shown (as is usual in the USA), the third char of + \a formatCode can + be set to 'c'. The inserted multiplication signs are the UTF-8 characters 215 + (0xD7) for the cross and 183 (0xB7) for the dot. - If the scale type (\ref setScaleType) is \ref stLogarithmic and the \a formatCode uses the 'b' - option (beautifully typeset decimal powers), the display usually is "1 [multiplication sign] 10 - [superscript] n", which looks unnatural for logarithmic scaling (the "1 [multiplication sign]" - part). To only display the decimal power, set the number precision to zero with \ref + If the scale type (\ref setScaleType) is \ref stLogarithmic and the \a + formatCode uses the 'b' + option (beautifully typeset decimal powers), the display usually is "1 + [multiplication sign] 10 + [superscript] n", which looks unnatural for logarithmic scaling (the "1 + [multiplication sign]" + part). To only display the decimal power, set the number precision to zero + with \ref setNumberPrecision. Examples for \a formatCode: - \li \c g normal format code behaviour. If number is small, fixed format is used, if number is large, + \li \c g normal format code behaviour. If number is small, fixed format is + used, if number is large, normal scientific format is used - \li \c gb If number is small, fixed format is used, if number is large, scientific format is used with + \li \c gb If number is small, fixed format is used, if number is large, + scientific format is used with beautifully typeset decimal powers and a dot as multiplication sign - \li \c ebc All numbers are in scientific format with beautifully typeset decimal power and a cross as + \li \c ebc All numbers are in scientific format with beautifully typeset + decimal power and a cross as multiplication sign - \li \c fb illegal format code, since fixed format doesn't support (or need) beautifully typeset decimal + \li \c fb illegal format code, since fixed format doesn't support (or need) + beautifully typeset decimal powers. Format code will be reduced to 'f'. - \li \c hello illegal format code, since first char is not 'e', 'E', 'f', 'g' or 'G'. Current format + \li \c hello illegal format code, since first char is not 'e', 'E', 'f', 'g' + or 'G'. Current format code will not be changed. */ void QCPAxis::setNumberFormat( const QString& formatCode ) @@ -4841,7 +5644,8 @@ void QCPAxis::setNumberFormat( const QString& formatCode ) } else { - qDebug() << Q_FUNC_INFO << "Invalid number format code (first char not in 'eEfgG'):" << formatCode; + qDebug() << Q_FUNC_INFO + << "Invalid number format code (first char not in 'eEfgG'):" << formatCode; return; } if( formatCode.length() < 2 ) @@ -4858,8 +5662,9 @@ void QCPAxis::setNumberFormat( const QString& formatCode ) } else { - qDebug() << Q_FUNC_INFO - << "Invalid number format code (second char not 'b' or first char neither 'e' nor 'g'):" << formatCode; + qDebug() << Q_FUNC_INFO << "Invalid number format code (second char not " + "'b' or first char neither 'e' nor 'g'):" + << formatCode; return; } if( formatCode.length() < 3 ) @@ -4879,20 +5684,27 @@ void QCPAxis::setNumberFormat( const QString& formatCode ) } else { - qDebug() << Q_FUNC_INFO << "Invalid number format code (third char neither 'c' nor 'd'):" << formatCode; + qDebug() << Q_FUNC_INFO + << "Invalid number format code (third char neither 'c' nor 'd'):" << formatCode; return; } } /*! - Sets the precision of the tick label numbers. See QLocale::toString(double i, char f, int prec) - for details. The effect of precisions are most notably for number Formats starting with 'e', see + Sets the precision of the tick label numbers. See QLocale::toString(double i, + char f, int prec) + for details. The effect of precisions are most notably for number Formats + starting with 'e', see \ref setNumberFormat - If the scale type (\ref setScaleType) is \ref stLogarithmic and the number format (\ref - setNumberFormat) uses the 'b' format code (beautifully typeset decimal powers), the display - usually is "1 [multiplication sign] 10 [superscript] n", which looks unnatural for logarithmic - scaling (the redundant "1 [multiplication sign]" part). To only display the decimal power "10 + If the scale type (\ref setScaleType) is \ref stLogarithmic and the number + format (\ref + setNumberFormat) uses the 'b' format code (beautifully typeset decimal + powers), the display + usually is "1 [multiplication sign] 10 [superscript] n", which looks unnatural + for logarithmic + scaling (the redundant "1 [multiplication sign]" part). To only display the + decimal power "10 [superscript] n", set \a precision to zero. */ void QCPAxis::setNumberPrecision( int precision ) @@ -4905,7 +5717,8 @@ void QCPAxis::setNumberPrecision( int precision ) } /*! - If \ref setAutoTickStep is set to false, use this function to set the tick step manually. + If \ref setAutoTickStep is set to false, use this function to set the tick + step manually. The tick step is the interval between (major) ticks, in plot coordinates. \see setSubTickCount */ @@ -4919,47 +5732,62 @@ void QCPAxis::setTickStep( double step ) } /*! - If you want full control over what ticks (and possibly labels) the axes show, this function is - used to set the coordinates at which ticks will appear.\ref setAutoTicks must be disabled, else - the provided tick vector will be overwritten with automatically generated tick coordinates upon - replot. The labels of the ticks can be generated automatically when \ref setAutoTickLabels is - left enabled. If it is disabled, you can set the labels manually with \ref setTickVectorLabels. + If you want full control over what ticks (and possibly labels) the axes show, + this function is + used to set the coordinates at which ticks will appear.\ref setAutoTicks must + be disabled, else + the provided tick vector will be overwritten with automatically generated tick + coordinates upon + replot. The labels of the ticks can be generated automatically when \ref + setAutoTickLabels is + left enabled. If it is disabled, you can set the labels manually with \ref + setTickVectorLabels. \a vec is a vector containing the positions of the ticks, in plot coordinates. - \warning \a vec must be sorted in ascending order, no additional checks are made to ensure this. + \warning \a vec must be sorted in ascending order, no additional checks are + made to ensure this. \see setTickVectorLabels */ void QCPAxis::setTickVector( const QVector& vec ) { - // don't check whether mTickVector != vec here, because it takes longer than we would save + // don't check whether mTickVector != vec here, because it takes longer than + // we would save mTickVector = vec; mCachedMarginValid = false; } /*! - If you want full control over what ticks and labels the axes show, this function is used to set a - number of QStrings that will be displayed at the tick positions which you need to provide with - \ref setTickVector. These two vectors should have the same size. (Note that you need to disable + If you want full control over what ticks and labels the axes show, this + function is used to set a + number of QStrings that will be displayed at the tick positions which you need + to provide with + \ref setTickVector. These two vectors should have the same size. (Note that + you need to disable \ref setAutoTicks and \ref setAutoTickLabels first.) - \a vec is a vector containing the labels of the ticks. The entries correspond to the respective + \a vec is a vector containing the labels of the ticks. The entries correspond + to the respective indices in the tick vector, passed via \ref setTickVector. \see setTickVector */ void QCPAxis::setTickVectorLabels( const QVector& vec ) { - // don't check whether mTickVectorLabels != vec here, because it takes longer than we would save + // don't check whether mTickVectorLabels != vec here, because it takes longer + // than we would save mTickVectorLabels = vec; mCachedMarginValid = false; } /*! - Sets the length of the ticks in pixels. \a inside is the length the ticks will reach inside the - plot and \a outside is the length they will reach outside the plot. If \a outside is greater than - zero, the tick labels and axis label will increase their distance to the axis accordingly, so + Sets the length of the ticks in pixels. \a inside is the length the ticks will + reach inside the + plot and \a outside is the length they will reach outside the plot. If \a + outside is greater than + zero, the tick labels and axis label will increase their distance to the axis + accordingly, so they won't collide with the ticks. \see setSubTickLength, setTickLengthIn, setTickLengthOut @@ -4971,7 +5799,8 @@ void QCPAxis::setTickLength( int inside, int outside ) } /*! - Sets the length of the inward ticks in pixels. \a inside is the length the ticks will reach + Sets the length of the inward ticks in pixels. \a inside is the length the + ticks will reach inside the plot. \see setTickLengthOut, setTickLength, setSubTickLength @@ -4985,9 +5814,12 @@ void QCPAxis::setTickLengthIn( int inside ) } /*! - Sets the length of the outward ticks in pixels. \a outside is the length the ticks will reach - outside the plot. If \a outside is greater than zero, the tick labels and axis label will - increase their distance to the axis accordingly, so they won't collide with the ticks. + Sets the length of the outward ticks in pixels. \a outside is the length the + ticks will reach + outside the plot. If \a outside is greater than zero, the tick labels and axis + label will + increase their distance to the axis accordingly, so they won't collide with + the ticks. \see setTickLengthIn, setTickLength, setSubTickLength */ @@ -5001,14 +5833,18 @@ void QCPAxis::setTickLengthOut( int outside ) } /*! - Sets the number of sub ticks in one (major) tick step. A sub tick count of three for example, + Sets the number of sub ticks in one (major) tick step. A sub tick count of + three for example, divides the tick intervals in four sub intervals. - By default, the number of sub ticks is chosen automatically in a reasonable manner as long as the - mantissa of the tick step is a multiple of 0.5. When \ref setAutoTickStep is enabled, this is + By default, the number of sub ticks is chosen automatically in a reasonable + manner as long as the + mantissa of the tick step is a multiple of 0.5. When \ref setAutoTickStep is + enabled, this is always the case. - If you want to disable automatic sub tick count and use this function to set the count manually, + If you want to disable automatic sub tick count and use this function to set + the count manually, see \ref setAutoSubTicks. */ void QCPAxis::setSubTickCount( int count ) @@ -5017,9 +5853,12 @@ void QCPAxis::setSubTickCount( int count ) } /*! - Sets the length of the subticks in pixels. \a inside is the length the subticks will reach inside - the plot and \a outside is the length they will reach outside the plot. If \a outside is greater - than zero, the tick labels and axis label will increase their distance to the axis accordingly, + Sets the length of the subticks in pixels. \a inside is the length the + subticks will reach inside + the plot and \a outside is the length they will reach outside the plot. If \a + outside is greater + than zero, the tick labels and axis label will increase their distance to the + axis accordingly, so they won't collide with the ticks. \see setTickLength, setSubTickLengthIn, setSubTickLengthOut @@ -5031,7 +5870,8 @@ void QCPAxis::setSubTickLength( int inside, int outside ) } /*! - Sets the length of the inward subticks in pixels. \a inside is the length the subticks will reach inside + Sets the length of the inward subticks in pixels. \a inside is the length the + subticks will reach inside the plot. \see setSubTickLengthOut, setSubTickLength, setTickLength @@ -5045,8 +5885,10 @@ void QCPAxis::setSubTickLengthIn( int inside ) } /*! - Sets the length of the outward subticks in pixels. \a outside is the length the subticks will reach - outside the plot. If \a outside is greater than zero, the tick labels will increase their + Sets the length of the outward subticks in pixels. \a outside is the length + the subticks will reach + outside the plot. If \a outside is greater than zero, the tick labels will + increase their distance to the axis accordingly, so they won't collide with the ticks. \see setSubTickLengthIn, setSubTickLength, setTickLength @@ -5115,7 +5957,8 @@ void QCPAxis::setLabelColor( const QColor& color ) } /*! - Sets the text of the axis label that will be shown below/above or next to the axis, depending on + Sets the text of the axis label that will be shown below/above or next to the + axis, depending on its orientation. To disable axis labels, pass an empty string as \a str. */ void QCPAxis::setLabel( const QString& str ) @@ -5144,10 +5987,12 @@ void QCPAxis::setLabelPadding( int padding ) /*! Sets the padding of the axis. - When \ref QCPAxisRect::setAutoMargins is enabled, the padding is the additional outer most space, + When \ref QCPAxisRect::setAutoMargins is enabled, the padding is the + additional outer most space, that is left blank. - The axis padding has no meaning if \ref QCPAxisRect::setAutoMargins is disabled. + The axis padding has no meaning if \ref QCPAxisRect::setAutoMargins is + disabled. \see setLabelPadding, setTickLabelPadding */ @@ -5163,9 +6008,12 @@ void QCPAxis::setPadding( int padding ) /*! Sets the offset the axis has to its axis rect side. - If an axis rect side has multiple axes and automatic margin calculation is enabled for that side, - only the offset of the inner most axis has meaning (even if it is set to be invisible). The - offset of the other, outer axes is controlled automatically, to place them at appropriate + If an axis rect side has multiple axes and automatic margin calculation is + enabled for that side, + only the offset of the inner most axis has meaning (even if it is set to be + invisible). The + offset of the other, outer axes is controlled automatically, to place them at + appropriate positions. */ void QCPAxis::setOffset( int offset ) @@ -5176,32 +6024,37 @@ void QCPAxis::setOffset( int offset ) /*! Sets the font that is used for tick labels when they are selected. - \see setTickLabelFont, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions + \see setTickLabelFont, setSelectableParts, setSelectedParts, + QCustomPlot::setInteractions */ void QCPAxis::setSelectedTickLabelFont( const QFont& font ) { if( font != mSelectedTickLabelFont ) { mSelectedTickLabelFont = font; - // don't set mCachedMarginValid to false here because margin calculation is always done with non-selected fonts + // don't set mCachedMarginValid to false here because margin calculation is + // always done with non-selected fonts } } /*! Sets the font that is used for the axis label when it is selected. - \see setLabelFont, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions + \see setLabelFont, setSelectableParts, setSelectedParts, + QCustomPlot::setInteractions */ void QCPAxis::setSelectedLabelFont( const QFont& font ) { mSelectedLabelFont = font; - // don't set mCachedMarginValid to false here because margin calculation is always done with non-selected fonts + // don't set mCachedMarginValid to false here because margin calculation is + // always done with non-selected fonts } /*! Sets the color that is used for tick labels when they are selected. - \see setTickLabelColor, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions + \see setTickLabelColor, setSelectableParts, setSelectedParts, + QCustomPlot::setInteractions */ void QCPAxis::setSelectedTickLabelColor( const QColor& color ) { @@ -5214,7 +6067,8 @@ void QCPAxis::setSelectedTickLabelColor( const QColor& color ) /*! Sets the color that is used for the axis label when it is selected. - \see setLabelColor, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions + \see setLabelColor, setSelectableParts, setSelectedParts, + QCustomPlot::setInteractions */ void QCPAxis::setSelectedLabelColor( const QColor& color ) { @@ -5224,7 +6078,8 @@ void QCPAxis::setSelectedLabelColor( const QColor& color ) /*! Sets the pen that is used to draw the axis base line when selected. - \see setBasePen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions + \see setBasePen, setSelectableParts, setSelectedParts, + QCustomPlot::setInteractions */ void QCPAxis::setSelectedBasePen( const QPen& pen ) { @@ -5234,7 +6089,8 @@ void QCPAxis::setSelectedBasePen( const QPen& pen ) /*! Sets the pen that is used to draw the (major) ticks when selected. - \see setTickPen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions + \see setTickPen, setSelectableParts, setSelectedParts, + QCustomPlot::setInteractions */ void QCPAxis::setSelectedTickPen( const QPen& pen ) { @@ -5244,7 +6100,8 @@ void QCPAxis::setSelectedTickPen( const QPen& pen ) /*! Sets the pen that is used to draw the subticks when selected. - \see setSubTickPen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions + \see setSubTickPen, setSelectableParts, setSelectedParts, + QCustomPlot::setInteractions */ void QCPAxis::setSelectedSubTickPen( const QPen& pen ) { @@ -5252,11 +6109,14 @@ void QCPAxis::setSelectedSubTickPen( const QPen& pen ) } /*! - Sets the style for the lower axis ending. See the documentation of QCPLineEnding for available + Sets the style for the lower axis ending. See the documentation of + QCPLineEnding for available styles. - For horizontal axes, this method refers to the left ending, for vertical axes the bottom ending. - Note that this meaning does not change when the axis range is reversed with \ref + For horizontal axes, this method refers to the left ending, for vertical axes + the bottom ending. + Note that this meaning does not change when the axis range is reversed with + \ref setRangeReversed. \see setUpperEnding @@ -5267,11 +6127,14 @@ void QCPAxis::setLowerEnding( const QCPLineEnding& ending ) } /*! - Sets the style for the upper axis ending. See the documentation of QCPLineEnding for available + Sets the style for the upper axis ending. See the documentation of + QCPLineEnding for available styles. - For horizontal axes, this method refers to the right ending, for vertical axes the top ending. - Note that this meaning does not change when the axis range is reversed with \ref + For horizontal axes, this method refers to the right ending, for vertical axes + the top ending. + Note that this meaning does not change when the axis range is reversed with + \ref setRangeReversed. \see setLowerEnding @@ -5282,11 +6145,14 @@ void QCPAxis::setUpperEnding( const QCPLineEnding& ending ) } /*! - If the scale type (\ref setScaleType) is \ref stLinear, \a diff is added to the lower and upper + If the scale type (\ref setScaleType) is \ref stLinear, \a diff is added to + the lower and upper bounds of the range. The range is simply moved by \a diff. - If the scale type is \ref stLogarithmic, the range bounds are multiplied by \a diff. This - corresponds to an apparent "linear" move in logarithmic scaling by a distance of log(diff). + If the scale type is \ref stLogarithmic, the range bounds are multiplied by \a + diff. This + corresponds to an apparent "linear" move in logarithmic scaling by a distance + of log(diff). */ void QCPAxis::moveRange( double diff ) { @@ -5307,9 +6173,12 @@ void QCPAxis::moveRange( double diff ) } /*! - Scales the range of this axis by \a factor around the coordinate \a center. For example, if \a - factor is 2.0, \a center is 1.0, then the axis range will double its size, and the point at - coordinate 1.0 won't have changed its position in the QCustomPlot widget (i.e. coordinates + Scales the range of this axis by \a factor around the coordinate \a center. + For example, if \a + factor is 2.0, \a center is 1.0, then the axis range will double its size, and + the point at + coordinate 1.0 won't have changed its position in the QCustomPlot widget (i.e. + coordinates around 1.0 will have moved symmetrically closer to 1.0). */ void QCPAxis::scaleRange( double factor, double center ) @@ -5335,8 +6204,9 @@ void QCPAxis::scaleRange( double factor, double center ) mRange = newRange.sanitizedForLogScale(); } else - qDebug() << Q_FUNC_INFO - << "Center of scaling operation doesn't lie in same logarithmic sign domain as range:" << center; + qDebug() << Q_FUNC_INFO << "Center of scaling operation doesn't lie in " + "same logarithmic sign domain as range:" + << center; } mCachedMarginValid = false; emit rangeChanged( mRange ); @@ -5344,16 +6214,22 @@ void QCPAxis::scaleRange( double factor, double center ) } /*! - Scales the range of this axis to have a certain scale \a ratio to \a otherAxis. The scaling will + Scales the range of this axis to have a certain scale \a ratio to \a + otherAxis. The scaling will be done around the center of the current axis range. - For example, if \a ratio is 1, this axis is the \a yAxis and \a otherAxis is \a xAxis, graphs - plotted with those axes will appear in a 1:1 aspect ratio, independent of the aspect ratio the + For example, if \a ratio is 1, this axis is the \a yAxis and \a otherAxis is + \a xAxis, graphs + plotted with those axes will appear in a 1:1 aspect ratio, independent of the + aspect ratio the axis rect has. - This is an operation that changes the range of this axis once, it doesn't fix the scale ratio - indefinitely. Note that calling this function in the constructor of the QCustomPlot's parent - won't have the desired effect, since the widget dimensions aren't defined yet, and a resizeEvent + This is an operation that changes the range of this axis once, it doesn't fix + the scale ratio + indefinitely. Note that calling this function in the constructor of the + QCustomPlot's parent + won't have the desired effect, since the widget dimensions aren't defined yet, + and a resizeEvent will follow. */ void QCPAxis::setScaleRatio( const QCPAxis* otherAxis, double ratio ) @@ -5375,7 +6251,8 @@ void QCPAxis::setScaleRatio( const QCPAxis* otherAxis, double ratio ) } /*! - Changes the axis range such that all plottables associated with this axis are fully visible in + Changes the axis range such that all plottables associated with this axis are + fully visible in that dimension. \see QCPAbstractPlottable::rescaleAxes, QCustomPlot::rescaleAxes @@ -5393,7 +6270,8 @@ void QCPAxis::rescale( bool onlyVisiblePlottables ) bool currentFoundRange; QCPAbstractPlottable::SignDomain signDomain = QCPAbstractPlottable::sdBoth; if( mScaleType == stLogarithmic ) - signDomain = ( mRange.upper < 0 ? QCPAbstractPlottable::sdNegative : QCPAbstractPlottable::sdPositive ); + signDomain = ( mRange.upper < 0 ? QCPAbstractPlottable::sdNegative + : QCPAbstractPlottable::sdPositive ); if( p.at( i )->keyAxis() == this ) plottableRange = p.at( i )->getKeyRange( currentFoundRange, signDomain ); else @@ -5409,12 +6287,15 @@ void QCPAxis::rescale( bool onlyVisiblePlottables ) } if( haveRange ) { - if( !QCPRange::validRange( newRange ) ) // likely due to range being zero (plottable has only constant data in this - // axis dimension), shift current range to at least center the plottable + if( !QCPRange::validRange( newRange ) ) // likely due to range being zero + // (plottable has only constant data in + // this + // axis dimension), shift current range to at least center the plottable { - double center = ( newRange.lower + newRange.upper ) * 0.5; // upper and lower should be equal anyway, but just to - // make sure, incase validRange returned false for - // other reason + double center = ( newRange.lower + newRange.upper ) * + 0.5; // upper and lower should be equal anyway, but just to + // make sure, incase validRange returned false for + // other reason if( mScaleType == stLinear ) { newRange.lower = center - mRange.size() / 2.0; @@ -5431,7 +6312,8 @@ void QCPAxis::rescale( bool onlyVisiblePlottables ) } /*! - Transforms \a value, in pixel coordinates of the QCustomPlot widget, to axis coordinates. + Transforms \a value, in pixel coordinates of the QCustomPlot widget, to axis + coordinates. */ double QCPAxis::pixelToCoord( double value ) const { @@ -5440,17 +6322,21 @@ double QCPAxis::pixelToCoord( double value ) const if( mScaleType == stLinear ) { if( !mRangeReversed ) - return ( value - mAxisRect->left() ) / (double)mAxisRect->width() * mRange.size() + mRange.lower; + return ( value - mAxisRect->left() ) / (double)mAxisRect->width() * mRange.size() + + mRange.lower; else - return -( value - mAxisRect->left() ) / (double)mAxisRect->width() * mRange.size() + mRange.upper; + return -( value - mAxisRect->left() ) / (double)mAxisRect->width() * mRange.size() + + mRange.upper; } else // mScaleType == stLogarithmic { if( !mRangeReversed ) - return pow( mRange.upper / mRange.lower, ( value - mAxisRect->left() ) / (double)mAxisRect->width() ) * + return pow( mRange.upper / mRange.lower, + ( value - mAxisRect->left() ) / (double)mAxisRect->width() ) * mRange.lower; else - return pow( mRange.upper / mRange.lower, ( mAxisRect->left() - value ) / (double)mAxisRect->width() ) * + return pow( mRange.upper / mRange.lower, + ( mAxisRect->left() - value ) / (double)mAxisRect->width() ) * mRange.upper; } } @@ -5459,24 +6345,29 @@ double QCPAxis::pixelToCoord( double value ) const if( mScaleType == stLinear ) { if( !mRangeReversed ) - return ( mAxisRect->bottom() - value ) / (double)mAxisRect->height() * mRange.size() + mRange.lower; + return ( mAxisRect->bottom() - value ) / (double)mAxisRect->height() * mRange.size() + + mRange.lower; else - return -( mAxisRect->bottom() - value ) / (double)mAxisRect->height() * mRange.size() + mRange.upper; + return -( mAxisRect->bottom() - value ) / (double)mAxisRect->height() * mRange.size() + + mRange.upper; } else // mScaleType == stLogarithmic { if( !mRangeReversed ) - return pow( mRange.upper / mRange.lower, ( mAxisRect->bottom() - value ) / (double)mAxisRect->height() ) * + return pow( mRange.upper / mRange.lower, + ( mAxisRect->bottom() - value ) / (double)mAxisRect->height() ) * mRange.lower; else - return pow( mRange.upper / mRange.lower, ( value - mAxisRect->bottom() ) / (double)mAxisRect->height() ) * + return pow( mRange.upper / mRange.lower, + ( value - mAxisRect->bottom() ) / (double)mAxisRect->height() ) * mRange.upper; } } } /*! - Transforms \a value, in coordinates of the axis, to pixel coordinates of the QCustomPlot widget. + Transforms \a value, in coordinates of the axis, to pixel coordinates of the + QCustomPlot widget. */ double QCPAxis::coordToPixel( double value ) const { @@ -5491,18 +6382,23 @@ double QCPAxis::coordToPixel( double value ) const } else // mScaleType == stLogarithmic { - if( value >= 0 && mRange.upper < 0 ) // invalid value for logarithmic scale, just draw it outside visible range + if( value >= 0 && mRange.upper < 0 ) // invalid value for logarithmic + // scale, just draw it outside visible + // range return !mRangeReversed ? mAxisRect->right() + 200 : mAxisRect->left() - 200; - else if( value <= 0 && - mRange.upper > 0 ) // invalid value for logarithmic scale, just draw it outside visible range + else if( value <= 0 && mRange.upper > 0 ) // invalid value for logarithmic + // scale, just draw it outside + // visible range return !mRangeReversed ? mAxisRect->left() - 200 : mAxisRect->right() + 200; else { if( !mRangeReversed ) - return baseLog( value / mRange.lower ) / baseLog( mRange.upper / mRange.lower ) * mAxisRect->width() + + return baseLog( value / mRange.lower ) / baseLog( mRange.upper / mRange.lower ) * + mAxisRect->width() + mAxisRect->left(); else - return baseLog( mRange.upper / value ) / baseLog( mRange.upper / mRange.lower ) * mAxisRect->width() + + return baseLog( mRange.upper / value ) / baseLog( mRange.upper / mRange.lower ) * + mAxisRect->width() + mAxisRect->left(); } } @@ -5518,30 +6414,38 @@ double QCPAxis::coordToPixel( double value ) const } else // mScaleType == stLogarithmic { - if( value >= 0 && mRange.upper < 0 ) // invalid value for logarithmic scale, just draw it outside visible range + if( value >= 0 && mRange.upper < 0 ) // invalid value for logarithmic + // scale, just draw it outside visible + // range return !mRangeReversed ? mAxisRect->top() - 200 : mAxisRect->bottom() + 200; - else if( value <= 0 && - mRange.upper > 0 ) // invalid value for logarithmic scale, just draw it outside visible range + else if( value <= 0 && mRange.upper > 0 ) // invalid value for logarithmic + // scale, just draw it outside + // visible range return !mRangeReversed ? mAxisRect->bottom() + 200 : mAxisRect->top() - 200; else { if( !mRangeReversed ) return mAxisRect->bottom() - - baseLog( value / mRange.lower ) / baseLog( mRange.upper / mRange.lower ) * mAxisRect->height(); + baseLog( value / mRange.lower ) / baseLog( mRange.upper / mRange.lower ) * + mAxisRect->height(); else return mAxisRect->bottom() - - baseLog( mRange.upper / value ) / baseLog( mRange.upper / mRange.lower ) * mAxisRect->height(); + baseLog( mRange.upper / value ) / baseLog( mRange.upper / mRange.lower ) * + mAxisRect->height(); } } } } /*! - Returns the part of the axis that is hit by \a pos (in pixels). The return value of this function - is independent of the user-selectable parts defined with \ref setSelectableParts. Further, this + Returns the part of the axis that is hit by \a pos (in pixels). The return + value of this function + is independent of the user-selectable parts defined with \ref + setSelectableParts. Further, this function does not change the current selection state of the axis. - If the axis is not visible (\ref setVisible), this function always returns \ref spNone. + If the axis is not visible (\ref setVisible), this function always returns + \ref spNone. \see setSelectedParts, setSelectableParts, QCustomPlot::setInteractions */ @@ -5589,7 +6493,8 @@ QList QCPAxis::plottables() const for( int i = 0; i < mParentPlot->mPlottables.size(); ++i ) { - if( mParentPlot->mPlottables.at( i )->keyAxis() == this || mParentPlot->mPlottables.at( i )->valueAxis() == this ) + if( mParentPlot->mPlottables.at( i )->keyAxis() == this || + mParentPlot->mPlottables.at( i )->valueAxis() == this ) result.append( mParentPlot->mPlottables.at( i ) ); } return result; @@ -5608,15 +6513,18 @@ QList QCPAxis::graphs() const for( int i = 0; i < mParentPlot->mGraphs.size(); ++i ) { - if( mParentPlot->mGraphs.at( i )->keyAxis() == this || mParentPlot->mGraphs.at( i )->valueAxis() == this ) + if( mParentPlot->mGraphs.at( i )->keyAxis() == this || + mParentPlot->mGraphs.at( i )->valueAxis() == this ) result.append( mParentPlot->mGraphs.at( i ) ); } return result; } /*! - Returns a list of all the items that are associated with this axis. An item is considered - associated with an axis if at least one of its positions uses the axis as key or value axis. + Returns a list of all the items that are associated with this axis. An item is + considered + associated with an axis if at least one of its positions uses the axis as key + or value axis. \see plottables, graphs */ @@ -5642,7 +6550,8 @@ QList QCPAxis::items() const } /*! - Transforms a margin side to the logically corresponding axis type. (QCP::msLeft to + Transforms a margin side to the logically corresponding axis type. + (QCP::msLeft to QCPAxis::atLeft, QCP::msRight to QCPAxis::atRight, etc.) */ QCPAxis::AxisType QCPAxis::marginSideToAxisType( QCP::MarginSide side ) @@ -5665,7 +6574,8 @@ QCPAxis::AxisType QCPAxis::marginSideToAxisType( QCP::MarginSide side ) } /*! - Returns the axis type that describes the opposite axis of an axis with the specified \a type. + Returns the axis type that describes the opposite axis of an axis with the + specified \a type. */ QCPAxis::AxisType QCPAxis::opposite( QCPAxis::AxisType type ) { @@ -5692,10 +6602,14 @@ QCPAxis::AxisType QCPAxis::opposite( QCPAxis::AxisType type ) /*! \internal - This function is called to prepare the tick vector, sub tick vector and tick label vector. If - \ref setAutoTicks is set to true, appropriate tick values are determined automatically via \ref - generateAutoTicks. If it's set to false, the signal ticksRequest is emitted, which can be used to - provide external tick positions. Then the sub tick vectors and tick label vectors are created. + This function is called to prepare the tick vector, sub tick vector and tick + label vector. If + \ref setAutoTicks is set to true, appropriate tick values are determined + automatically via \ref + generateAutoTicks. If it's set to false, the signal ticksRequest is emitted, + which can be used to + provide external tick positions. Then the sub tick vectors and tick label + vectors are created. */ void QCPAxis::setupTickVectors() { @@ -5704,7 +6618,8 @@ void QCPAxis::setupTickVectors() if( ( !mTicks && !mTickLabels && !mGrid->visible() ) || mRange.size() <= 0 ) return; - // fill tick vectors, either by auto generating or by notifying user to fill the vectors himself + // fill tick vectors, either by auto generating or by notifying user to fill + // the vectors himself if( mAutoTicks ) { generateAutoTicks(); @@ -5730,10 +6645,12 @@ void QCPAxis::setupTickVectors() int subTickIndex = 0; bool done = false; int lowTick = mLowestVisibleTick > 0 ? mLowestVisibleTick - 1 : mLowestVisibleTick; - int highTick = mHighestVisibleTick < mTickVector.size() - 1 ? mHighestVisibleTick + 1 : mHighestVisibleTick; + int highTick = mHighestVisibleTick < mTickVector.size() - 1 ? mHighestVisibleTick + 1 + : mHighestVisibleTick; for( int i = lowTick + 1; i <= highTick; ++i ) { - subTickStep = ( mTickVector.at( i ) - mTickVector.at( i - 1 ) ) / (double)( mSubTickCount + 1 ); + subTickStep = + ( mTickVector.at( i ) - mTickVector.at( i - 1 ) ) / (double)( mSubTickCount + 1 ); for( int k = 1; k <= mSubTickCount; ++k ) { subTickPosition = mTickVector.at( i - 1 ) + k * subTickStep; @@ -5761,27 +6678,32 @@ void QCPAxis::setupTickVectors() if( mTickLabelType == ltNumber ) { for( int i = mLowestVisibleTick; i <= mHighestVisibleTick; ++i ) - mTickVectorLabels[i] = - mParentPlot->locale().toString( mTickVector.at( i ), mNumberFormatChar, mNumberPrecision ); + mTickVectorLabels[i] = mParentPlot->locale().toString( + mTickVector.at( i ), mNumberFormatChar, mNumberPrecision ); } else if( mTickLabelType == ltDateTime ) { for( int i = mLowestVisibleTick; i <= mHighestVisibleTick; ++i ) { -#if QT_VERSION < QT_VERSION_CHECK( 4, 7, 0 ) // use fromMSecsSinceEpoch function if available, to gain sub-second - // accuracy on tick labels (e.g. for format "hh:mm:ss:zzz") +#if QT_VERSION < QT_VERSION_CHECK( 4, 7, 0 ) // use fromMSecsSinceEpoch function + // if available, to gain sub-second + // accuracy on tick labels (e.g. for format "hh:mm:ss:zzz") mTickVectorLabels[i] = mParentPlot->locale().toString( - QDateTime::fromTime_t( mTickVector.at( i ) ).toTimeSpec( mDateTimeSpec ), mDateTimeFormat ); + QDateTime::fromTime_t( mTickVector.at( i ) ).toTimeSpec( mDateTimeSpec ), + mDateTimeFormat ); #else mTickVectorLabels[i] = mParentPlot->locale().toString( - QDateTime::fromMSecsSinceEpoch( mTickVector.at( i ) * 1000 ).toTimeSpec( mDateTimeSpec ), mDateTimeFormat ); + QDateTime::fromMSecsSinceEpoch( mTickVector.at( i ) * 1000 ) + .toTimeSpec( mDateTimeSpec ), + mDateTimeFormat ); #endif } } } else // mAutoTickLabels == false { - if( mAutoTicks ) // ticks generated automatically, but not ticklabels, so emit ticksRequest here for labels + if( mAutoTicks ) // ticks generated automatically, but not ticklabels, so + // emit ticksRequest here for labels { emit ticksRequest(); } @@ -5793,11 +6715,14 @@ void QCPAxis::setupTickVectors() /*! \internal - If \ref setAutoTicks is set to true, this function is called by \ref setupTickVectors to - generate reasonable tick positions (and subtick count). The algorithm tries to create + If \ref setAutoTicks is set to true, this function is called by \ref + setupTickVectors to + generate reasonable tick positions (and subtick count). The algorithm tries to + create approximately mAutoTickCount ticks (set via \ref setAutoTickCount). - If the scale is logarithmic, \ref setAutoTickCount is ignored, and one tick is generated at every + If the scale is logarithmic, \ref setAutoTickCount is ignored, and one tick is + generated at every power of the current logarithm base, set via \ref setScaleLogBase. */ void QCPAxis::generateAutoTicks() @@ -5807,11 +6732,13 @@ void QCPAxis::generateAutoTicks() if( mAutoTickStep ) { // Generate tick positions according to linear scaling: - mTickStep = mRange.size() / (double)( mAutoTickCount + 1e-10 ); // mAutoTickCount ticks on average, the small - // addition is to prevent jitter on exact - // integers + mTickStep = mRange.size() / + (double)( mAutoTickCount + 1e-10 ); // mAutoTickCount ticks on average, the small + // addition is to prevent jitter on exact + // integers double magnitudeFactor = - qPow( 10.0, qFloor( qLn( mTickStep ) / qLn( 10.0 ) ) ); // get magnitude factor e.g. 0.01, 1, 10, 1000 etc. + qPow( 10.0, qFloor( qLn( mTickStep ) / + qLn( 10.0 ) ) ); // get magnitude factor e.g. 0.01, 1, 10, 1000 etc. double tickStepMantissa = mTickStep / magnitudeFactor; if( tickStepMantissa < 5 ) { @@ -5845,8 +6772,10 @@ void QCPAxis::generateAutoTicks() double currentMag = lowerMag; mTickVector.clear(); mTickVector.append( currentMag ); - while( currentMag < mRange.upper && - currentMag > 0 ) // currentMag might be zero for ranges ~1e-300, just cancel in that case + while( currentMag < mRange.upper && currentMag > 0 ) // currentMag might be + // zero for ranges + // ~1e-300, just + // cancel in that case { currentMag *= mScaleLogBase; mTickVector.append( currentMag ); @@ -5858,41 +6787,54 @@ void QCPAxis::generateAutoTicks() double currentMag = lowerMag; mTickVector.clear(); mTickVector.append( currentMag ); - while( currentMag < mRange.upper && - currentMag < 0 ) // currentMag might be zero for ranges ~1e-300, just cancel in that case + while( currentMag < mRange.upper && currentMag < 0 ) // currentMag might be + // zero for ranges + // ~1e-300, just + // cancel in that case { currentMag /= mScaleLogBase; mTickVector.append( currentMag ); } } - else // invalid range for logarithmic scale, because lower and upper have different sign + else // invalid range for logarithmic scale, because lower and upper have + // different sign { mTickVector.clear(); - qDebug() << Q_FUNC_INFO << "Invalid range for logarithmic plot: " << mRange.lower << "-" << mRange.upper; + qDebug() << Q_FUNC_INFO << "Invalid range for logarithmic plot: " << mRange.lower << "-" + << mRange.upper; } } } /*! \internal - Called by generateAutoTicks when \ref setAutoSubTicks is set to true. Depending on the \a - tickStep between two major ticks on the axis, a different number of sub ticks is appropriate. For - Example taking 4 sub ticks for a \a tickStep of 1 makes more sense than taking 5 sub ticks, - because this corresponds to a sub tick step of 0.2, instead of the less intuitive 0.16667. Note + Called by generateAutoTicks when \ref setAutoSubTicks is set to true. + Depending on the \a + tickStep between two major ticks on the axis, a different number of sub ticks + is appropriate. For + Example taking 4 sub ticks for a \a tickStep of 1 makes more sense than taking + 5 sub ticks, + because this corresponds to a sub tick step of 0.2, instead of the less + intuitive 0.16667. Note that a subtick count of 4 means dividing the major tick step into 5 sections. - This is implemented by a hand made lookup for integer tick steps as well as fractional tick steps - with a fractional part of (approximately) 0.5. If a tick step is different (i.e. has no - fractional part close to 0.5), the currently set sub tick count (\ref setSubTickCount) is + This is implemented by a hand made lookup for integer tick steps as well as + fractional tick steps + with a fractional part of (approximately) 0.5. If a tick step is different + (i.e. has no + fractional part close to 0.5), the currently set sub tick count (\ref + setSubTickCount) is returned. */ int QCPAxis::calculateAutoSubTickCount( double tickStep ) const { - int result = mSubTickCount; // default to current setting, if no proper value can be found + int result = mSubTickCount; // default to current setting, if no proper value + // can be found // get mantissa of tickstep: double magnitudeFactor = - qPow( 10.0, qFloor( qLn( tickStep ) / qLn( 10.0 ) ) ); // get magnitude factor e.g. 0.01, 1, 10, 1000 etc. + qPow( 10.0, qFloor( qLn( tickStep ) / + qLn( 10.0 ) ) ); // get magnitude factor e.g. 0.01, 1, 10, 1000 etc. double tickStepMantissa = tickStep / magnitudeFactor; // separate integer and fractional part of mantissa: @@ -5959,7 +6901,8 @@ int QCPAxis::calculateAutoSubTickCount( double tickStep ) const break; // 4.5 -> 1.5 substep case 5: result = 4; - break; // 5.5 -> 1.1 substep (won't occur with autoTickStep from here on) + break; // 5.5 -> 1.1 substep (won't occur with autoTickStep from here + // on) case 6: result = 4; break; // 6.5 -> 1.3 substep @@ -5974,14 +6917,18 @@ int QCPAxis::calculateAutoSubTickCount( double tickStep ) const break; // 9.5 -> 1.9 substep } } - // if mantissa fraction isnt 0.0 or 0.5, don't bother finding good sub tick marks, leave default + // if mantissa fraction isnt 0.0 or 0.5, don't bother finding good sub tick + // marks, leave default } return result; } /* inherits documentation from base class */ -void QCPAxis::selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ) +void QCPAxis::selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ) { Q_UNUSED( event ) SelectablePart part = details.value(); @@ -6005,12 +6952,15 @@ void QCPAxis::deselectEvent( bool* selectionStateChanged ) /*! \internal - A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter + A convenience function to easily set the QPainter::Antialiased hint on the + provided \a painter before drawing axis lines. - This is the antialiasing state the painter passed to the \ref draw method is in by default. + This is the antialiasing state the painter passed to the \ref draw method is + in by default. - This function takes into account the local setting of the antialiasing flag as well as the + This function takes into account the local setting of the antialiasing flag as + well as the overrides set with \ref QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. @@ -6023,15 +6973,18 @@ void QCPAxis::applyDefaultAntialiasingHint( QCPPainter* painter ) const /*! \internal - Draws the axis with the specified \a painter, using the internal QCPAxisPainterPrivate instance. + Draws the axis with the specified \a painter, using the internal + QCPAxisPainterPrivate instance. */ void QCPAxis::draw( QCPPainter* painter ) { const int lowTick = mLowestVisibleTick; const int highTick = mHighestVisibleTick; - QVector subTickPositions; // the final coordToPixel transformed vector passed to QCPAxisPainter - QVector tickPositions; // the final coordToPixel transformed vector passed to QCPAxisPainter + QVector subTickPositions; // the final coordToPixel transformed vector + // passed to QCPAxisPainter + QVector tickPositions; // the final coordToPixel transformed vector + // passed to QCPAxisPainter QVector tickLabels; // the final vector passed to QCPAxisPainter tickPositions.reserve( highTick - lowTick + 1 ); tickLabels.reserve( highTick - lowTick + 1 ); @@ -6049,19 +7002,23 @@ void QCPAxis::draw( QCPPainter* painter ) if( mSubTickCount > 0 ) { const int subTickCount = mSubTickVector.size(); - for( int i = 0; i < subTickCount; - ++i ) // no need to check bounds because subticks are always only created inside current mRange + for( int i = 0; i < subTickCount; ++i ) // no need to check bounds because + // subticks are always only created + // inside current mRange subTickPositions.append( coordToPixel( mSubTickVector.at( i ) ) ); } } - // transfer all properties of this axis to QCPAxisPainterPrivate which it needs to draw the axis. - // Note that some axis painter properties are already set by direct feed-through with QCPAxis setters + // transfer all properties of this axis to QCPAxisPainterPrivate which it + // needs to draw the axis. + // Note that some axis painter properties are already set by direct + // feed-through with QCPAxis setters mAxisPainter->type = mAxisType; mAxisPainter->basePen = getBasePen(); mAxisPainter->labelFont = getLabelFont(); mAxisPainter->labelColor = getLabelColor(); mAxisPainter->label = mLabel; - mAxisPainter->substituteExponent = mAutoTickLabels && mNumberBeautifulPowers && mTickLabelType == ltNumber; + mAxisPainter->substituteExponent = + mAutoTickLabels && mNumberBeautifulPowers && mTickLabelType == ltNumber; mAxisPainter->tickPen = getTickPen(); mAxisPainter->subTickPen = getSubTickPen(); mAxisPainter->tickLabelFont = getTickLabelFont(); @@ -6078,19 +7035,28 @@ void QCPAxis::draw( QCPPainter* painter ) /*! \internal - Returns via \a lowIndex and \a highIndex, which ticks in the current tick vector are visible in - the current range. The return values are indices of the tick vector, not the positions of the + Returns via \a lowIndex and \a highIndex, which ticks in the current tick + vector are visible in + the current range. The return values are indices of the tick vector, not the + positions of the ticks themselves. - The actual use of this function is when an external tick vector is provided, since it might - exceed far beyond the currently displayed range, and would cause unnecessary calculations e.g. of + The actual use of this function is when an external tick vector is provided, + since it might + exceed far beyond the currently displayed range, and would cause unnecessary + calculations e.g. of subticks. - If all ticks are outside the axis range, an inverted range is returned, i.e. highIndex will be - smaller than lowIndex. There is one case, where this function returns indices that are not really - visible in the current axis range: When the tick spacing is larger than the axis range size and - one tick is below the axis range and the next tick is already above the axis range. Because in - such cases it is usually desirable to know the tick pair, to draw proper subticks. + If all ticks are outside the axis range, an inverted range is returned, i.e. + highIndex will be + smaller than lowIndex. There is one case, where this function returns indices + that are not really + visible in the current axis range: When the tick spacing is larger than the + axis range size and + one tick is below the axis range and the next tick is already above the axis + range. Because in + such cases it is usually desirable to know the tick pair, to draw proper + subticks. */ void QCPAxis::visibleTickBounds( int& lowIndex, int& highIndex ) const { @@ -6126,8 +7092,10 @@ void QCPAxis::visibleTickBounds( int& lowIndex, int& highIndex ) const /*! \internal - A log function with the base mScaleLogBase, used mostly for coordinate transforms in logarithmic - scales with arbitrary log base. Uses the buffered mScaleLogBaseLogInv for faster calculation. + A log function with the base mScaleLogBase, used mostly for coordinate + transforms in logarithmic + scales with arbitrary log base. Uses the buffered mScaleLogBaseLogInv for + faster calculation. This is set to 1.0/qLn(mScaleLogBase) in \ref setScaleLogBase. \see basePow, setScaleLogBase, setScaleType @@ -6139,7 +7107,8 @@ double QCPAxis::baseLog( double value ) const /*! \internal - A power function with the base mScaleLogBase, used mostly for coordinate transforms in + A power function with the base mScaleLogBase, used mostly for coordinate + transforms in logarithmic scales with arbitrary log base. \see baseLog, setScaleLogBase, setScaleType @@ -6151,7 +7120,8 @@ double QCPAxis::basePow( double value ) const /*! \internal - Returns the pen that is used to draw the axis base line. Depending on the selection state, this + Returns the pen that is used to draw the axis base line. Depending on the + selection state, this is either mSelectedBasePen or mBasePen. */ QPen QCPAxis::getBasePen() const @@ -6161,7 +7131,8 @@ QPen QCPAxis::getBasePen() const /*! \internal - Returns the pen that is used to draw the (major) ticks. Depending on the selection state, this + Returns the pen that is used to draw the (major) ticks. Depending on the + selection state, this is either mSelectedTickPen or mTickPen. */ QPen QCPAxis::getTickPen() const @@ -6171,7 +7142,8 @@ QPen QCPAxis::getTickPen() const /*! \internal - Returns the pen that is used to draw the subticks. Depending on the selection state, this + Returns the pen that is used to draw the subticks. Depending on the selection + state, this is either mSelectedSubTickPen or mSubTickPen. */ QPen QCPAxis::getSubTickPen() const @@ -6181,7 +7153,8 @@ QPen QCPAxis::getSubTickPen() const /*! \internal - Returns the font that is used to draw the tick labels. Depending on the selection state, this + Returns the font that is used to draw the tick labels. Depending on the + selection state, this is either mSelectedTickLabelFont or mTickLabelFont. */ QFont QCPAxis::getTickLabelFont() const @@ -6191,7 +7164,8 @@ QFont QCPAxis::getTickLabelFont() const /*! \internal - Returns the font that is used to draw the axis label. Depending on the selection state, this + Returns the font that is used to draw the axis label. Depending on the + selection state, this is either mSelectedLabelFont or mLabelFont. */ QFont QCPAxis::getLabelFont() const @@ -6201,7 +7175,8 @@ QFont QCPAxis::getLabelFont() const /*! \internal - Returns the color that is used to draw the tick labels. Depending on the selection state, this + Returns the color that is used to draw the tick labels. Depending on the + selection state, this is either mSelectedTickLabelColor or mTickLabelColor. */ QColor QCPAxis::getTickLabelColor() const @@ -6211,7 +7186,8 @@ QColor QCPAxis::getTickLabelColor() const /*! \internal - Returns the color that is used to draw the axis label. Depending on the selection state, this + Returns the color that is used to draw the axis label. Depending on the + selection state, this is either mSelectedLabelColor or mLabelColor. */ QColor QCPAxis::getLabelColor() const @@ -6222,31 +7198,40 @@ QColor QCPAxis::getLabelColor() const /*! \internal Returns the appropriate outward margin for this axis. It is needed if \ref - QCPAxisRect::setAutoMargins is set to true on the parent axis rect. An axis with axis type \ref - atLeft will return an appropriate left margin, \ref atBottom will return an appropriate bottom - margin and so forth. For the calculation, this function goes through similar steps as \ref draw, - so changing one function likely requires the modification of the other one as well. + QCPAxisRect::setAutoMargins is set to true on the parent axis rect. An axis + with axis type \ref + atLeft will return an appropriate left margin, \ref atBottom will return an + appropriate bottom + margin and so forth. For the calculation, this function goes through similar + steps as \ref draw, + so changing one function likely requires the modification of the other one as + well. - The margin consists of the outward tick length, tick label padding, tick label size, label + The margin consists of the outward tick length, tick label padding, tick label + size, label padding, label size, and padding. - The margin is cached internally, so repeated calls while leaving the axis range, fonts, etc. + The margin is cached internally, so repeated calls while leaving the axis + range, fonts, etc. unchanged are very fast. */ int QCPAxis::calculateMargin() { - if( !mVisible ) // if not visible, directly return 0, don't cache 0 because we can't react to setVisible in QCPAxis + if( !mVisible ) // if not visible, directly return 0, don't cache 0 because we + // can't react to setVisible in QCPAxis return 0; if( mCachedMarginValid ) return mCachedMargin; - // run through similar steps as QCPAxis::draw, and caluclate margin needed to fit axis and its labels + // run through similar steps as QCPAxis::draw, and caluclate margin needed to + // fit axis and its labels int margin = 0; int lowTick, highTick; visibleTickBounds( lowTick, highTick ); - QVector tickPositions; // the final coordToPixel transformed vector passed to QCPAxisPainter + QVector tickPositions; // the final coordToPixel transformed vector + // passed to QCPAxisPainter QVector tickLabels; // the final vector passed to QCPAxisPainter tickPositions.reserve( highTick - lowTick + 1 ); tickLabels.reserve( highTick - lowTick + 1 ); @@ -6259,8 +7244,10 @@ int QCPAxis::calculateMargin() tickLabels.append( mTickVectorLabels.at( i ) ); } } - // transfer all properties of this axis to QCPAxisPainterPrivate which it needs to calculate the size. - // Note that some axis painter properties are already set by direct feed-through with QCPAxis setters + // transfer all properties of this axis to QCPAxisPainterPrivate which it + // needs to calculate the size. + // Note that some axis painter properties are already set by direct + // feed-through with QCPAxis setters mAxisPainter->type = mAxisType; mAxisPainter->labelFont = getLabelFont(); mAxisPainter->label = mLabel; @@ -6294,36 +7281,39 @@ QCP::Interaction QCPAxis::selectionCategory() const This is a private class and not part of the public QCustomPlot interface. - It is used by QCPAxis to do the low-level drawing of axis backbone, tick marks, tick labels and - axis label. It also buffers the labels to reduce replot times. The parameters are configured by + It is used by QCPAxis to do the low-level drawing of axis backbone, tick + marks, tick labels and + axis label. It also buffers the labels to reduce replot times. The parameters + are configured by directly accessing the public member variables. */ /*! - Constructs a QCPAxisPainterPrivate instance. Make sure to not create a new instance on every + Constructs a QCPAxisPainterPrivate instance. Make sure to not create a new + instance on every redraw, to utilize the caching mechanisms. */ QCPAxisPainterPrivate::QCPAxisPainterPrivate( QCustomPlot* parentPlot ) - : type( QCPAxis::atLeft ), - basePen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ), - lowerEnding( QCPLineEnding::esNone ), - upperEnding( QCPLineEnding::esNone ), - labelPadding( 0 ), - tickLabelPadding( 0 ), - tickLabelRotation( 0 ), - substituteExponent( true ), - numberMultiplyCross( false ), - tickLengthIn( 5 ), - tickLengthOut( 0 ), - subTickLengthIn( 2 ), - subTickLengthOut( 0 ), - tickPen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ), - subTickPen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ), - offset( 0 ), - abbreviateDecimalPowers( false ), - reversedEndings( false ), - mParentPlot( parentPlot ), - mLabelCache( 16 ) // cache at most 16 (tick) labels + : type( QCPAxis::atLeft ) + , basePen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ) + , lowerEnding( QCPLineEnding::esNone ) + , upperEnding( QCPLineEnding::esNone ) + , labelPadding( 0 ) + , tickLabelPadding( 0 ) + , tickLabelRotation( 0 ) + , substituteExponent( true ) + , numberMultiplyCross( false ) + , tickLengthIn( 5 ) + , tickLengthOut( 0 ) + , subTickLengthIn( 2 ) + , subTickLengthOut( 0 ) + , tickPen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ) + , subTickPen( QPen( Qt::black, 0, Qt::SolidLine, Qt::SquareCap ) ) + , offset( 0 ) + , abbreviateDecimalPowers( false ) + , reversedEndings( false ) + , mParentPlot( parentPlot ) + , mLabelCache( 16 ) // cache at most 16 (tick) labels { } @@ -6335,7 +7325,8 @@ QCPAxisPainterPrivate::~QCPAxisPainterPrivate() Draws the axis with the specified \a painter. - The selection boxes (mAxisSelectionBox, mTickLabelsSelectionBox, mLabelSelectionBox) are set + The selection boxes (mAxisSelectionBox, mTickLabelsSelectionBox, + mLabelSelectionBox) are set here, too. */ void QCPAxisPainterPrivate::draw( QCPPainter* painter ) @@ -6364,8 +7355,8 @@ void QCPAxisPainterPrivate::draw( QCPPainter* painter ) break; } - double xCor = 0, - yCor = 0; // paint system correction, for pixel exact matches (affects baselines and ticks of top/right axes) + double xCor = 0, yCor = 0; // paint system correction, for pixel exact matches (affects + // baselines and ticks of top/right axes) switch( type ) { case QCPAxis::atTop: @@ -6383,12 +7374,15 @@ void QCPAxisPainterPrivate::draw( QCPPainter* painter ) QLineF baseLine; painter->setPen( basePen ); if( QCPAxis::orientation( type ) == Qt::Horizontal ) - baseLine.setPoints( origin + QPointF( xCor, yCor ), origin + QPointF( alignmentRect.width() + xCor, yCor ) ); + baseLine.setPoints( origin + QPointF( xCor, yCor ), + origin + QPointF( alignmentRect.width() + xCor, yCor ) ); else - baseLine.setPoints( origin + QPointF( xCor, yCor ), origin + QPointF( xCor, -alignmentRect.height() + yCor ) ); + baseLine.setPoints( origin + QPointF( xCor, yCor ), + origin + QPointF( xCor, -alignmentRect.height() + yCor ) ); if( reversedEndings ) - baseLine = - QLineF( baseLine.p2(), baseLine.p1() ); // won't make a difference for line itself, but for line endings later + baseLine = QLineF( baseLine.p2(), baseLine.p1() ); // won't make a difference + // for line itself, but for + // line endings later painter->drawLine( baseLine ); // draw ticks: @@ -6397,18 +7391,21 @@ void QCPAxisPainterPrivate::draw( QCPPainter* painter ) painter->setPen( tickPen ); int tickDir = ( type == QCPAxis::atBottom || type == QCPAxis::atRight ) ? -1 - : 1; // direction of ticks ("inward" is right for left axis and left for right axis) + : 1; // direction of ticks ("inward" is right for left + // axis and left for right axis) if( QCPAxis::orientation( type ) == Qt::Horizontal ) { for( int i = 0; i < tickPositions.size(); ++i ) - painter->drawLine( QLineF( tickPositions.at( i ) + xCor, origin.y() - tickLengthOut * tickDir + yCor, - tickPositions.at( i ) + xCor, origin.y() + tickLengthIn * tickDir + yCor ) ); + painter->drawLine( + QLineF( tickPositions.at( i ) + xCor, origin.y() - tickLengthOut * tickDir + yCor, + tickPositions.at( i ) + xCor, origin.y() + tickLengthIn * tickDir + yCor ) ); } else { for( int i = 0; i < tickPositions.size(); ++i ) - painter->drawLine( QLineF( origin.x() - tickLengthOut * tickDir + xCor, tickPositions.at( i ) + yCor, - origin.x() + tickLengthIn * tickDir + xCor, tickPositions.at( i ) + yCor ) ); + painter->drawLine( + QLineF( origin.x() - tickLengthOut * tickDir + xCor, tickPositions.at( i ) + yCor, + origin.x() + tickLengthIn * tickDir + xCor, tickPositions.at( i ) + yCor ) ); } } @@ -6416,37 +7413,41 @@ void QCPAxisPainterPrivate::draw( QCPPainter* painter ) if( !subTickPositions.isEmpty() ) { painter->setPen( subTickPen ); - // direction of ticks ("inward" is right for left axis and left for right axis) + // direction of ticks ("inward" is right for left axis and left for right + // axis) int tickDir = ( type == QCPAxis::atBottom || type == QCPAxis::atRight ) ? -1 : 1; if( QCPAxis::orientation( type ) == Qt::Horizontal ) { for( int i = 0; i < subTickPositions.size(); ++i ) - painter->drawLine( QLineF( subTickPositions.at( i ) + xCor, origin.y() - subTickLengthOut * tickDir + yCor, - subTickPositions.at( i ) + xCor, origin.y() + subTickLengthIn * tickDir + yCor ) ); + painter->drawLine( QLineF( + subTickPositions.at( i ) + xCor, origin.y() - subTickLengthOut * tickDir + yCor, + subTickPositions.at( i ) + xCor, origin.y() + subTickLengthIn * tickDir + yCor ) ); } else { for( int i = 0; i < subTickPositions.size(); ++i ) - painter->drawLine( QLineF( origin.x() - subTickLengthOut * tickDir + xCor, subTickPositions.at( i ) + yCor, - origin.x() + subTickLengthIn * tickDir + xCor, subTickPositions.at( i ) + yCor ) ); + painter->drawLine( QLineF( + origin.x() - subTickLengthOut * tickDir + xCor, subTickPositions.at( i ) + yCor, + origin.x() + subTickLengthIn * tickDir + xCor, subTickPositions.at( i ) + yCor ) ); } } margin += qMax( 0, qMax( tickLengthOut, subTickLengthOut ) ); // draw axis base endings: bool antialiasingBackup = painter->antialiasing(); - painter->setAntialiasing( true ); // always want endings to be antialiased, even if base and ticks themselves aren't + painter->setAntialiasing( true ); // always want endings to be antialiased, even + // if base and ticks themselves aren't painter->setBrush( QBrush( basePen.color() ) ); QVector2D baseLineVector( baseLine.dx(), baseLine.dy() ); if( lowerEnding.style() != QCPLineEnding::esNone ) - lowerEnding.draw( painter, - QVector2D( baseLine.p1() ) - - baseLineVector.normalized() * lowerEnding.realLength() * ( lowerEnding.inverted() ? -1 : 1 ), + lowerEnding.draw( painter, QVector2D( baseLine.p1() ) - + baseLineVector.normalized() * lowerEnding.realLength() * + ( lowerEnding.inverted() ? -1 : 1 ), -baseLineVector ); if( upperEnding.style() != QCPLineEnding::esNone ) - upperEnding.draw( painter, - QVector2D( baseLine.p2() ) + - baseLineVector.normalized() * upperEnding.realLength() * ( upperEnding.inverted() ? -1 : 1 ), + upperEnding.draw( painter, QVector2D( baseLine.p2() ) + + baseLineVector.normalized() * upperEnding.realLength() * + ( upperEnding.inverted() ? -1 : 1 ), baseLineVector ); painter->setAntialiasing( antialiasingBackup ); @@ -6479,25 +7480,27 @@ void QCPAxisPainterPrivate::draw( QCPPainter* painter ) QTransform oldTransform = painter->transform(); painter->translate( ( origin.x() - margin - labelBounds.height() ), origin.y() ); painter->rotate( -90 ); - painter->drawText( 0, 0, alignmentRect.height(), labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, - label ); + painter->drawText( 0, 0, alignmentRect.height(), labelBounds.height(), + Qt::TextDontClip | Qt::AlignCenter, label ); painter->setTransform( oldTransform ); } else if( type == QCPAxis::atRight ) { QTransform oldTransform = painter->transform(); - painter->translate( ( origin.x() + margin + labelBounds.height() ), origin.y() - alignmentRect.height() ); + painter->translate( ( origin.x() + margin + labelBounds.height() ), + origin.y() - alignmentRect.height() ); painter->rotate( 90 ); - painter->drawText( 0, 0, alignmentRect.height(), labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, - label ); + painter->drawText( 0, 0, alignmentRect.height(), labelBounds.height(), + Qt::TextDontClip | Qt::AlignCenter, label ); painter->setTransform( oldTransform ); } else if( type == QCPAxis::atTop ) - painter->drawText( origin.x(), origin.y() - margin - labelBounds.height(), alignmentRect.width(), - labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, label ); - else if( type == QCPAxis::atBottom ) - painter->drawText( origin.x(), origin.y() + margin, alignmentRect.width(), labelBounds.height(), + painter->drawText( origin.x(), origin.y() - margin - labelBounds.height(), + alignmentRect.width(), labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, label ); + else if( type == QCPAxis::atBottom ) + painter->drawText( origin.x(), origin.y() + margin, alignmentRect.width(), + labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, label ); } // set selection boxes: @@ -6509,54 +7512,61 @@ void QCPAxisPainterPrivate::draw( QCPPainter* painter ) int selAxisOutSize = qMax( qMax( tickLengthOut, subTickLengthOut ), selectionTolerance ); int selAxisInSize = selectionTolerance; int selTickLabelSize = - ( QCPAxis::orientation( type ) == Qt::Horizontal ? tickLabelsSize.height() : tickLabelsSize.width() ); + ( QCPAxis::orientation( type ) == Qt::Horizontal ? tickLabelsSize.height() + : tickLabelsSize.width() ); int selTickLabelOffset = qMax( tickLengthOut, subTickLengthOut ) + tickLabelPadding; int selLabelSize = labelBounds.height(); int selLabelOffset = selTickLabelOffset + selTickLabelSize + labelPadding; if( type == QCPAxis::atLeft ) { - mAxisSelectionBox.setCoords( origin.x() - selAxisOutSize, alignmentRect.top(), origin.x() + selAxisInSize, - alignmentRect.bottom() ); - mTickLabelsSelectionBox.setCoords( origin.x() - selTickLabelOffset - selTickLabelSize, alignmentRect.top(), - origin.x() - selTickLabelOffset, alignmentRect.bottom() ); + mAxisSelectionBox.setCoords( origin.x() - selAxisOutSize, alignmentRect.top(), + origin.x() + selAxisInSize, alignmentRect.bottom() ); + mTickLabelsSelectionBox.setCoords( origin.x() - selTickLabelOffset - selTickLabelSize, + alignmentRect.top(), origin.x() - selTickLabelOffset, + alignmentRect.bottom() ); mLabelSelectionBox.setCoords( origin.x() - selLabelOffset - selLabelSize, alignmentRect.top(), origin.x() - selLabelOffset, alignmentRect.bottom() ); } else if( type == QCPAxis::atRight ) { - mAxisSelectionBox.setCoords( origin.x() - selAxisInSize, alignmentRect.top(), origin.x() + selAxisOutSize, - alignmentRect.bottom() ); - mTickLabelsSelectionBox.setCoords( origin.x() + selTickLabelOffset + selTickLabelSize, alignmentRect.top(), - origin.x() + selTickLabelOffset, alignmentRect.bottom() ); + mAxisSelectionBox.setCoords( origin.x() - selAxisInSize, alignmentRect.top(), + origin.x() + selAxisOutSize, alignmentRect.bottom() ); + mTickLabelsSelectionBox.setCoords( origin.x() + selTickLabelOffset + selTickLabelSize, + alignmentRect.top(), origin.x() + selTickLabelOffset, + alignmentRect.bottom() ); mLabelSelectionBox.setCoords( origin.x() + selLabelOffset + selLabelSize, alignmentRect.top(), origin.x() + selLabelOffset, alignmentRect.bottom() ); } else if( type == QCPAxis::atTop ) { - mAxisSelectionBox.setCoords( alignmentRect.left(), origin.y() - selAxisOutSize, alignmentRect.right(), - origin.y() + selAxisInSize ); - mTickLabelsSelectionBox.setCoords( alignmentRect.left(), origin.y() - selTickLabelOffset - selTickLabelSize, + mAxisSelectionBox.setCoords( alignmentRect.left(), origin.y() - selAxisOutSize, + alignmentRect.right(), origin.y() + selAxisInSize ); + mTickLabelsSelectionBox.setCoords( alignmentRect.left(), + origin.y() - selTickLabelOffset - selTickLabelSize, alignmentRect.right(), origin.y() - selTickLabelOffset ); mLabelSelectionBox.setCoords( alignmentRect.left(), origin.y() - selLabelOffset - selLabelSize, alignmentRect.right(), origin.y() - selLabelOffset ); } else if( type == QCPAxis::atBottom ) { - mAxisSelectionBox.setCoords( alignmentRect.left(), origin.y() - selAxisInSize, alignmentRect.right(), - origin.y() + selAxisOutSize ); - mTickLabelsSelectionBox.setCoords( alignmentRect.left(), origin.y() + selTickLabelOffset + selTickLabelSize, + mAxisSelectionBox.setCoords( alignmentRect.left(), origin.y() - selAxisInSize, + alignmentRect.right(), origin.y() + selAxisOutSize ); + mTickLabelsSelectionBox.setCoords( alignmentRect.left(), + origin.y() + selTickLabelOffset + selTickLabelSize, alignmentRect.right(), origin.y() + selTickLabelOffset ); mLabelSelectionBox.setCoords( alignmentRect.left(), origin.y() + selLabelOffset + selLabelSize, alignmentRect.right(), origin.y() + selLabelOffset ); } // draw hitboxes for debug purposes: // painter->setBrush(Qt::NoBrush); - // painter->drawRects(QVector() << mAxisSelectionBox << mTickLabelsSelectionBox << mLabelSelectionBox); + // painter->drawRects(QVector() << mAxisSelectionBox << + // mTickLabelsSelectionBox << mLabelSelectionBox); } /*! \internal - Returns the size ("margin" in QCPAxisRect context, so measured perpendicular to the axis backbone + Returns the size ("margin" in QCPAxisRect context, so measured perpendicular + to the axis backbone direction) needed to fit the axis. */ int QCPAxisPainterPrivate::size() const @@ -6573,16 +7583,19 @@ int QCPAxisPainterPrivate::size() const { for( int i = 0; i < tickLabels.size(); ++i ) getMaxTickLabelSize( tickLabelFont, tickLabels.at( i ), &tickLabelsSize ); - result += QCPAxis::orientation( type ) == Qt::Horizontal ? tickLabelsSize.height() : tickLabelsSize.width(); + result += QCPAxis::orientation( type ) == Qt::Horizontal ? tickLabelsSize.height() + : tickLabelsSize.width(); result += tickLabelPadding; } - // calculate size of axis label (only height needed, because left/right labels are rotated by 90 degrees): + // calculate size of axis label (only height needed, because left/right labels + // are rotated by 90 degrees): if( !label.isEmpty() ) { QFontMetrics fontMetrics( labelFont ); QRect bounds; - bounds = fontMetrics.boundingRect( 0, 0, 0, 0, Qt::TextDontClip | Qt::AlignHCenter | Qt::AlignVCenter, label ); + bounds = fontMetrics.boundingRect( + 0, 0, 0, 0, Qt::TextDontClip | Qt::AlignHCenter | Qt::AlignVCenter, label ); result += bounds.height() + labelPadding; } @@ -6591,8 +7604,10 @@ int QCPAxisPainterPrivate::size() const /*! \internal - Clears the internal label cache. Upon the next \ref draw, all labels will be created new. This - method is called automatically in \ref draw, if any parameters have changed that invalidate the + Clears the internal label cache. Upon the next \ref draw, all labels will be + created new. This + method is called automatically in \ref draw, if any parameters have changed + that invalidate the cached labels, such as font, color, etc. */ void QCPAxisPainterPrivate::clearCache() @@ -6602,9 +7617,12 @@ void QCPAxisPainterPrivate::clearCache() /*! \internal - Returns a hash that allows uniquely identifying whether the label parameters have changed such - that the cached labels must be refreshed (\ref clearCache). It is used in \ref draw. If the - return value of this method hasn't changed since the last redraw, the respective label parameters + Returns a hash that allows uniquely identifying whether the label parameters + have changed such + that the cached labels must be refreshed (\ref clearCache). It is used in \ref + draw. If the + return value of this method hasn't changed since the last redraw, the + respective label parameters haven't changed and cached labels may be used. */ QByteArray QCPAxisPainterPrivate::generateLabelParameterHash() const @@ -6620,21 +7638,32 @@ QByteArray QCPAxisPainterPrivate::generateLabelParameterHash() const /*! \internal - Draws a single tick label with the provided \a painter, utilizing the internal label cache to - significantly speed up drawing of labels that were drawn in previous calls. The tick label is - always bound to an axis, the distance to the axis is controllable via \a distanceToAxis in - pixels. The pixel position in the axis direction is passed in the \a position parameter. Hence - for the bottom axis, \a position would indicate the horizontal pixel position (not coordinate), + Draws a single tick label with the provided \a painter, utilizing the internal + label cache to + significantly speed up drawing of labels that were drawn in previous calls. + The tick label is + always bound to an axis, the distance to the axis is controllable via \a + distanceToAxis in + pixels. The pixel position in the axis direction is passed in the \a position + parameter. Hence + for the bottom axis, \a position would indicate the horizontal pixel position + (not coordinate), at which the label should be drawn. - In order to later draw the axis label in a place that doesn't overlap with the tick labels, the - largest tick label size is needed. This is acquired by passing a \a tickLabelsSize to the \ref - drawTickLabel calls during the process of drawing all tick labels of one axis. In every call, \a - tickLabelsSize is expanded, if the drawn label exceeds the value \a tickLabelsSize currently + In order to later draw the axis label in a place that doesn't overlap with the + tick labels, the + largest tick label size is needed. This is acquired by passing a \a + tickLabelsSize to the \ref + drawTickLabel calls during the process of drawing all tick labels of one axis. + In every call, \a + tickLabelsSize is expanded, if the drawn label exceeds the value \a + tickLabelsSize currently holds. - The label is drawn with the font and pen that are currently set on the \a painter. To draw - superscripted powers, the font is temporarily made smaller by a fixed factor (see \ref + The label is drawn with the font and pen that are currently set on the \a + painter. To draw + superscripted powers, the font is temporarily made smaller by a fixed factor + (see \ref getTickLabelData). */ void QCPAxisPainterPrivate::placeTickLabel( QCPPainter* painter, @@ -6643,7 +7672,8 @@ void QCPAxisPainterPrivate::placeTickLabel( QCPPainter* painter, const QString& text, QSize* tickLabelsSize ) { - // warning: if you change anything here, also adapt getMaxTickLabelSize() accordingly! + // warning: if you change anything here, also adapt getMaxTickLabelSize() + // accordingly! if( text.isEmpty() ) return; QSize finalSize; @@ -6682,16 +7712,19 @@ void QCPAxisPainterPrivate::placeTickLabel( QCPPainter* painter, } // draw cached label: const CachedLabel* cachedLabel = mLabelCache.object( text ); - // if label would be partly clipped by widget border on sides, don't draw it: + // if label would be partly clipped by widget border on sides, don't draw + // it: if( QCPAxis::orientation( type ) == Qt::Horizontal ) { - if( labelAnchor.x() + cachedLabel->offset.x() + cachedLabel->pixmap.width() > viewportRect.right() || + if( labelAnchor.x() + cachedLabel->offset.x() + cachedLabel->pixmap.width() > + viewportRect.right() || labelAnchor.x() + cachedLabel->offset.x() < viewportRect.left() ) return; } else { - if( labelAnchor.y() + cachedLabel->offset.y() + cachedLabel->pixmap.height() > viewportRect.bottom() || + if( labelAnchor.y() + cachedLabel->offset.y() + cachedLabel->pixmap.height() > + viewportRect.bottom() || labelAnchor.y() + cachedLabel->offset.y() < viewportRect.top() ) return; } @@ -6702,17 +7735,20 @@ void QCPAxisPainterPrivate::placeTickLabel( QCPPainter* painter, { TickLabelData labelData = getTickLabelData( painter->font(), text ); QPointF finalPosition = labelAnchor + getTickLabelDrawOffset( labelData ); - // if label would be partly clipped by widget border on sides, don't draw it: + // if label would be partly clipped by widget border on sides, don't draw + // it: if( QCPAxis::orientation( type ) == Qt::Horizontal ) { - if( finalPosition.x() + ( labelData.rotatedTotalBounds.width() + labelData.rotatedTotalBounds.left() ) > + if( finalPosition.x() + + ( labelData.rotatedTotalBounds.width() + labelData.rotatedTotalBounds.left() ) > viewportRect.right() || finalPosition.x() + labelData.rotatedTotalBounds.left() < viewportRect.left() ) return; } else { - if( finalPosition.y() + ( labelData.rotatedTotalBounds.height() + labelData.rotatedTotalBounds.top() ) > + if( finalPosition.y() + + ( labelData.rotatedTotalBounds.height() + labelData.rotatedTotalBounds.top() ) > viewportRect.bottom() || finalPosition.y() + labelData.rotatedTotalBounds.top() < viewportRect.top() ) return; @@ -6732,9 +7768,12 @@ void QCPAxisPainterPrivate::placeTickLabel( QCPPainter* painter, This is a \ref placeTickLabel helper function. - Draws the tick label specified in \a labelData with \a painter at the pixel positions \a x and \a - y. This function is used by \ref placeTickLabel to create new tick labels for the cache, or to - directly draw the labels on the QCustomPlot surface when label caching is disabled, i.e. when + Draws the tick label specified in \a labelData with \a painter at the pixel + positions \a x and \a + y. This function is used by \ref placeTickLabel to create new tick labels for + the cache, or to + directly draw the labels on the QCustomPlot surface when label caching is + disabled, i.e. when QCP::phCacheLabels plotting hint is not set. */ void QCPAxisPainterPrivate::drawTickLabel( QCPPainter* painter, @@ -6757,8 +7796,8 @@ void QCPAxisPainterPrivate::drawTickLabel( QCPPainter* painter, painter->setFont( labelData.baseFont ); painter->drawText( 0, 0, 0, 0, Qt::TextDontClip, labelData.basePart ); painter->setFont( labelData.expFont ); - painter->drawText( labelData.baseBounds.width() + 1, 0, labelData.expBounds.width(), labelData.expBounds.height(), - Qt::TextDontClip, labelData.expPart ); + painter->drawText( labelData.baseBounds.width() + 1, 0, labelData.expBounds.width(), + labelData.expBounds.height(), Qt::TextDontClip, labelData.expPart ); } else { @@ -6776,12 +7815,16 @@ void QCPAxisPainterPrivate::drawTickLabel( QCPPainter* painter, This is a \ref placeTickLabel helper function. - Transforms the passed \a text and \a font to a tickLabelData structure that can then be further - processed by \ref getTickLabelDrawOffset and \ref drawTickLabel. It splits the text into base and - exponent if necessary (member substituteExponent) and calculates appropriate bounding boxes. + Transforms the passed \a text and \a font to a tickLabelData structure that + can then be further + processed by \ref getTickLabelDrawOffset and \ref drawTickLabel. It splits the + text into base and + exponent if necessary (member substituteExponent) and calculates appropriate + bounding boxes. */ -QCPAxisPainterPrivate::TickLabelData QCPAxisPainterPrivate::getTickLabelData( const QFont& font, - const QString& text ) const +QCPAxisPainterPrivate::TickLabelData QCPAxisPainterPrivate::getTickLabelData( + const QFont& font, + const QString& text ) const { TickLabelData result; @@ -6795,26 +7838,33 @@ QCPAxisPainterPrivate::TickLabelData QCPAxisPainterPrivate::getTickLabelData( co useBeautifulPowers = true; } - // calculate text bounding rects and do string preparation for beautiful decimal powers: + // calculate text bounding rects and do string preparation for beautiful + // decimal powers: result.baseFont = font; - if( result.baseFont.pointSizeF() > 0 ) // On some rare systems, this sometimes is initialized with -1 (Qt bug?), so - // we check here before possibly setting a negative value in the next line - result.baseFont.setPointSizeF( result.baseFont.pointSizeF() + 0.05 ); // QFontMetrics.boundingRect has a bug for - // exact point sizes that make the results - // oscillate due to internal rounding + if( result.baseFont.pointSizeF() > 0 ) // On some rare systems, this sometimes + // is initialized with -1 (Qt bug?), so + // we check here before possibly setting a negative value in the next line + result.baseFont.setPointSizeF( result.baseFont.pointSizeF() + + 0.05 ); // QFontMetrics.boundingRect has a bug for + // exact point sizes that make the results + // oscillate due to internal rounding if( useBeautifulPowers ) { - // split text into parts of number/symbol that will be drawn normally and part that will be drawn as exponent: + // split text into parts of number/symbol that will be drawn normally and + // part that will be drawn as exponent: result.basePart = text.left( ePos ); - // in log scaling, we want to turn "1*10^n" into "10^n", else add multiplication sign and decimal base: + // in log scaling, we want to turn "1*10^n" into "10^n", else add + // multiplication sign and decimal base: if( abbreviateDecimalPowers && result.basePart == "1" ) result.basePart = "10"; else - result.basePart += ( numberMultiplyCross ? QString( QChar( 215 ) ) : QString( QChar( 183 ) ) ) + "10"; + result.basePart += + ( numberMultiplyCross ? QString( QChar( 215 ) ) : QString( QChar( 183 ) ) ) + "10"; result.expPart = text.mid( ePos + 1 ); // clip "+" and leading zeros off expPart: while( result.expPart.length() > 2 && - result.expPart.at( 1 ) == '0' ) // length > 2 so we leave one zero when numberFormatChar is 'e' + result.expPart.at( 1 ) == + '0' ) // length > 2 so we leave one zero when numberFormatChar is 'e' result.expPart.remove( 1, 1 ); if( !result.expPart.isEmpty() && result.expPart.at( 0 ) == '+' ) result.expPart.remove( 0, 1 ); @@ -6822,20 +7872,25 @@ QCPAxisPainterPrivate::TickLabelData QCPAxisPainterPrivate::getTickLabelData( co result.expFont = font; result.expFont.setPointSize( result.expFont.pointSize() * 0.75 ); // calculate bounding rects of base part, exponent part and total one: - result.baseBounds = QFontMetrics( result.baseFont ).boundingRect( 0, 0, 0, 0, Qt::TextDontClip, result.basePart ); - result.expBounds = QFontMetrics( result.expFont ).boundingRect( 0, 0, 0, 0, Qt::TextDontClip, result.expPart ); + result.baseBounds = QFontMetrics( result.baseFont ) + .boundingRect( 0, 0, 0, 0, Qt::TextDontClip, result.basePart ); + result.expBounds = + QFontMetrics( result.expFont ).boundingRect( 0, 0, 0, 0, Qt::TextDontClip, result.expPart ); result.totalBounds = result.baseBounds.adjusted( - 0, 0, result.expBounds.width() + 2, 0 ); // +2 consists of the 1 pixel spacing between base and exponent (see - // drawTickLabel) and an extra pixel to include AA + 0, 0, result.expBounds.width() + 2, + 0 ); // +2 consists of the 1 pixel spacing between base and exponent (see + // drawTickLabel) and an extra pixel to include AA } else // useBeautifulPowers == false { result.basePart = text; - result.totalBounds = QFontMetrics( result.baseFont ) - .boundingRect( 0, 0, 0, 0, Qt::TextDontClip | Qt::AlignHCenter, result.basePart ); + result.totalBounds = + QFontMetrics( result.baseFont ) + .boundingRect( 0, 0, 0, 0, Qt::TextDontClip | Qt::AlignHCenter, result.basePart ); } - result.totalBounds.moveTopLeft( QPoint( 0, 0 ) ); // want bounding box aligned top left at origin, independent of how - // it was created, to make further processing simpler + result.totalBounds.moveTopLeft( + QPoint( 0, 0 ) ); // want bounding box aligned top left at origin, independent of how + // it was created, to make further processing simpler // calculate possibly different bounding rect after rotation: result.rotatedTotalBounds = result.totalBounds; @@ -6853,27 +7908,37 @@ QCPAxisPainterPrivate::TickLabelData QCPAxisPainterPrivate::getTickLabelData( co This is a \ref placeTickLabel helper function. - Calculates the offset at which the top left corner of the specified tick label shall be drawn. + Calculates the offset at which the top left corner of the specified tick label + shall be drawn. The offset is relative to a point right next to the tick the label belongs to. - This function is thus responsible for e.g. centering tick labels under ticks and positioning them + This function is thus responsible for e.g. centering tick labels under ticks + and positioning them appropriately when they are rotated. */ QPointF QCPAxisPainterPrivate::getTickLabelDrawOffset( const TickLabelData& labelData ) const { /* - calculate label offset from base point at tick (non-trivial, for best visual appearance): short - explanation for bottom axis: The anchor, i.e. the point in the label that is placed - horizontally under the corresponding tick is always on the label side that is closer to the - axis (e.g. the left side of the text when we're rotating clockwise). On that side, the height - is halved and the resulting point is defined the anchor. This way, a 90 degree rotated text - will be centered under the tick (i.e. displaced horizontally by half its height). At the same - time, a 45 degree rotated text will "point toward" its tick, as is typical for rotated tick + calculate label offset from base point at tick (non-trivial, for best visual + appearance): short + explanation for bottom axis: The anchor, i.e. the point in the label that is + placed + horizontally under the corresponding tick is always on the label side that + is closer to the + axis (e.g. the left side of the text when we're rotating clockwise). On that + side, the height + is halved and the resulting point is defined the anchor. This way, a 90 + degree rotated text + will be centered under the tick (i.e. displaced horizontally by half its + height). At the same + time, a 45 degree rotated text will "point toward" its tick, as is typical + for rotated tick labels. */ bool doRotation = !qFuzzyIsNull( tickLabelRotation ); - bool flip = qFuzzyCompare( qAbs( tickLabelRotation ), - 90.0 ); // perfect +/-90 degree flip. Indicates vertical label centering on vertical axes. + bool flip = + qFuzzyCompare( qAbs( tickLabelRotation ), 90.0 ); // perfect +/-90 degree flip. Indicates + // vertical label centering on vertical axes. double radians = tickLabelRotation / 180.0 * M_PI; int x = 0, y = 0; if( type == QCPAxis::atLeft ) @@ -6889,7 +7954,8 @@ QPointF QCPAxisPainterPrivate::getTickLabelDrawOffset( const TickLabelData& labe } else { - x = -qCos( -radians ) * labelData.totalBounds.width() - qSin( -radians ) * labelData.totalBounds.height(); + x = -qCos( -radians ) * labelData.totalBounds.width() - + qSin( -radians ) * labelData.totalBounds.height(); y = flip ? +labelData.totalBounds.width() / 2.0 : +qSin( -radians ) * labelData.totalBounds.width() - qCos( -radians ) * labelData.totalBounds.height() / 2.0; @@ -6908,12 +7974,14 @@ QPointF QCPAxisPainterPrivate::getTickLabelDrawOffset( const TickLabelData& labe if( tickLabelRotation > 0 ) { x = +qSin( radians ) * labelData.totalBounds.height(); - y = flip ? -labelData.totalBounds.width() / 2.0 : -qCos( radians ) * labelData.totalBounds.height() / 2.0; + y = flip ? -labelData.totalBounds.width() / 2.0 + : -qCos( radians ) * labelData.totalBounds.height() / 2.0; } else { x = 0; - y = flip ? +labelData.totalBounds.width() / 2.0 : -qCos( -radians ) * labelData.totalBounds.height() / 2.0; + y = flip ? +labelData.totalBounds.width() / 2.0 + : -qCos( -radians ) * labelData.totalBounds.height() / 2.0; } } else @@ -6928,8 +7996,10 @@ QPointF QCPAxisPainterPrivate::getTickLabelDrawOffset( const TickLabelData& labe { if( tickLabelRotation > 0 ) { - x = -qCos( radians ) * labelData.totalBounds.width() + qSin( radians ) * labelData.totalBounds.height() / 2.0; - y = -qSin( radians ) * labelData.totalBounds.width() - qCos( radians ) * labelData.totalBounds.height(); + x = -qCos( radians ) * labelData.totalBounds.width() + + qSin( radians ) * labelData.totalBounds.height() / 2.0; + y = -qSin( radians ) * labelData.totalBounds.width() - + qCos( radians ) * labelData.totalBounds.height(); } else { @@ -6954,7 +8024,8 @@ QPointF QCPAxisPainterPrivate::getTickLabelDrawOffset( const TickLabelData& labe } else { - x = -qCos( -radians ) * labelData.totalBounds.width() - qSin( -radians ) * labelData.totalBounds.height() / 2.0; + x = -qCos( -radians ) * labelData.totalBounds.width() - + qSin( -radians ) * labelData.totalBounds.height() / 2.0; y = +qSin( -radians ) * labelData.totalBounds.width(); } } @@ -6970,14 +8041,20 @@ QPointF QCPAxisPainterPrivate::getTickLabelDrawOffset( const TickLabelData& labe /*! \internal - Simulates the steps done by \ref placeTickLabel by calculating bounding boxes of the text label - to be drawn, depending on number format etc. Since only the largest tick label is wanted for the - margin calculation, the passed \a tickLabelsSize is only expanded, if it's currently set to a + Simulates the steps done by \ref placeTickLabel by calculating bounding boxes + of the text label + to be drawn, depending on number format etc. Since only the largest tick label + is wanted for the + margin calculation, the passed \a tickLabelsSize is only expanded, if it's + currently set to a smaller width/height. */ -void QCPAxisPainterPrivate::getMaxTickLabelSize( const QFont& font, const QString& text, QSize* tickLabelsSize ) const +void QCPAxisPainterPrivate::getMaxTickLabelSize( const QFont& font, + const QString& text, + QSize* tickLabelsSize ) const { - // note: this function must return the same tick label sizes as the placeTickLabel function. + // note: this function must return the same tick label sizes as the + // placeTickLabel function. QSize finalSize; if( mParentPlot->plottingHints().testFlag( QCP::phCacheLabels ) && mLabelCache.contains( text ) ) // label caching enabled and have cached label @@ -7005,12 +8082,15 @@ void QCPAxisPainterPrivate::getMaxTickLabelSize( const QFont& font, const QStrin /*! \class QCPAbstractPlottable \brief The abstract base class for all data representing objects in a plot. - It defines a very basic interface like name, pen, brush, visibility etc. Since this class is - abstract, it can't be instantiated. Use one of the subclasses or create a subclass yourself to + It defines a very basic interface like name, pen, brush, visibility etc. Since + this class is + abstract, it can't be instantiated. Use one of the subclasses or create a + subclass yourself to create new ways of displaying data (see "Creating own plottables" below). All further specifics are in the subclasses, for example: - \li A normal graph with possibly a line, scatter points and error bars is displayed by \ref QCPGraph + \li A normal graph with possibly a line, scatter points and error bars is + displayed by \ref QCPGraph (typically created with \ref QCustomPlot::addGraph). \li A parametric curve can be displayed with \ref QCPCurve. \li A stackable bar chart can be achieved with \ref QCPBars. @@ -7018,7 +8098,8 @@ void QCPAxisPainterPrivate::getMaxTickLabelSize( const QFont& font, const QStrin \section plottables-subclassing Creating own plottables - To create an own plottable, you implement a subclass of QCPAbstractPlottable. These are the pure + To create an own plottable, you implement a subclass of QCPAbstractPlottable. + These are the pure virtual functions, you must implement: \li \ref clearData \li \ref selectTest @@ -7029,44 +8110,57 @@ void QCPAxisPainterPrivate::getMaxTickLabelSize( const QFont& font, const QStrin See the documentation of those functions for what they need to do. - For drawing your plot, you can use the \ref coordsToPixels functions to translate a point in plot - coordinates to pixel coordinates. This function is quite convenient, because it takes the - orientation of the key and value axes into account for you (x and y are swapped when the key axis - is vertical and the value axis horizontal). If you are worried about performance (i.e. you need + For drawing your plot, you can use the \ref coordsToPixels functions to + translate a point in plot + coordinates to pixel coordinates. This function is quite convenient, because + it takes the + orientation of the key and value axes into account for you (x and y are + swapped when the key axis + is vertical and the value axis horizontal). If you are worried about + performance (i.e. you need to translate many points in a loop like QCPGraph), you can directly use \ref - QCPAxis::coordToPixel. However, you must then take care about the orientation of the axis + QCPAxis::coordToPixel. However, you must then take care about the orientation + of the axis yourself. Here are some important members you inherit from QCPAbstractPlottable: - - - - + - - @@ -7081,42 +8175,60 @@ void QCPAxisPainterPrivate::getMaxTickLabelSize( const QFont& font, const QStrin Clears all data in the plottable. */ -/*! \fn void QCPAbstractPlottable::drawLegendIcon(QCPPainter *painter, const QRect &rect) const = 0 +/*! \fn void QCPAbstractPlottable::drawLegendIcon(QCPPainter *painter, const + QRect &rect) const = 0 \internal - called by QCPLegend::draw (via QCPPlottableLegendItem::draw) to create a graphical representation + called by QCPLegend::draw (via QCPPlottableLegendItem::draw) to create a + graphical representation of this plottable inside \a rect, next to the plottable name. */ -/*! \fn QCPRange QCPAbstractPlottable::getKeyRange(bool &foundRange, SignDomain inSignDomain) const = 0 +/*! \fn QCPRange QCPAbstractPlottable::getKeyRange(bool &foundRange, SignDomain + inSignDomain) const = 0 \internal - called by rescaleAxes functions to get the full data key bounds. For logarithmic plots, one can - set \a inSignDomain to either \ref sdNegative or \ref sdPositive in order to restrict the - returned range to that sign domain. E.g. when only negative range is wanted, set \a inSignDomain - to \ref sdNegative and all positive points will be ignored for range calculation. For no - restriction, just set \a inSignDomain to \ref sdBoth (default). \a foundRange is an output - parameter that indicates whether a range could be found or not. If this is false, you shouldn't + called by rescaleAxes functions to get the full data key bounds. For + logarithmic plots, one can + set \a inSignDomain to either \ref sdNegative or \ref sdPositive in order to + restrict the + returned range to that sign domain. E.g. when only negative range is wanted, + set \a inSignDomain + to \ref sdNegative and all positive points will be ignored for range + calculation. For no + restriction, just set \a inSignDomain to \ref sdBoth (default). \a foundRange + is an output + parameter that indicates whether a range could be found or not. If this is + false, you shouldn't use the returned range (e.g. no points in data). - Note that \a foundRange is not the same as \ref QCPRange::validRange, since the range returned by + Note that \a foundRange is not the same as \ref QCPRange::validRange, since + the range returned by this function may have size zero, which wouldn't count as a valid range. \see rescaleAxes, getValueRange */ -/*! \fn QCPRange QCPAbstractPlottable::getValueRange(bool &foundRange, SignDomain inSignDomain) const = 0 +/*! \fn QCPRange QCPAbstractPlottable::getValueRange(bool &foundRange, + SignDomain inSignDomain) const = 0 \internal - called by rescaleAxes functions to get the full data value bounds. For logarithmic plots, one can - set \a inSignDomain to either \ref sdNegative or \ref sdPositive in order to restrict the - returned range to that sign domain. E.g. when only negative range is wanted, set \a inSignDomain - to \ref sdNegative and all positive points will be ignored for range calculation. For no - restriction, just set \a inSignDomain to \ref sdBoth (default). \a foundRange is an output - parameter that indicates whether a range could be found or not. If this is false, you shouldn't + called by rescaleAxes functions to get the full data value bounds. For + logarithmic plots, one can + set \a inSignDomain to either \ref sdNegative or \ref sdPositive in order to + restrict the + returned range to that sign domain. E.g. when only negative range is wanted, + set \a inSignDomain + to \ref sdNegative and all positive points will be ignored for range + calculation. For no + restriction, just set \a inSignDomain to \ref sdBoth (default). \a foundRange + is an output + parameter that indicates whether a range could be found or not. If this is + false, you shouldn't use the returned range (e.g. no points in data). - Note that \a foundRange is not the same as \ref QCPRange::validRange, since the range returned by + Note that \a foundRange is not the same as \ref QCPRange::validRange, since + the range returned by this function may have size zero, which wouldn't count as a valid range. \see rescaleAxes, getKeyRange @@ -7127,7 +8239,8 @@ void QCPAxisPainterPrivate::getMaxTickLabelSize( const QFont& font, const QStrin /*! \fn void QCPAbstractPlottable::selectionChanged(bool selected) - This signal is emitted when the selection state of this plottable has changed, either by user + This signal is emitted when the selection state of this plottable has changed, + either by user interaction or by a direct call to \ref setSelected. */ @@ -7141,30 +8254,36 @@ void QCPAxisPainterPrivate::getMaxTickLabelSize( const QFont& font, const QStrin /* end of documentation of signals */ /*! - Constructs an abstract plottable which uses \a keyAxis as its key axis ("x") and \a valueAxis as - its value axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance - and have perpendicular orientations. If either of these restrictions is violated, a corresponding - message is printed to the debug output (qDebug), the construction is not aborted, though. + Constructs an abstract plottable which uses \a keyAxis as its key axis ("x") + and \a valueAxis as + its value axis ("y"). \a keyAxis and \a valueAxis must reside in the same + QCustomPlot instance + and have perpendicular orientations. If either of these restrictions is + violated, a corresponding + message is printed to the debug output (qDebug), the construction is not + aborted, though. - Since QCPAbstractPlottable is an abstract class that defines the basic interface to plottables, + Since QCPAbstractPlottable is an abstract class that defines the basic + interface to plottables, it can't be directly instantiated. - You probably want one of the subclasses like \ref QCPGraph or \ref QCPCurve instead. + You probably want one of the subclasses like \ref QCPGraph or \ref QCPCurve + instead. */ QCPAbstractPlottable::QCPAbstractPlottable( QCPAxis* keyAxis, QCPAxis* valueAxis ) - : QCPLayerable( keyAxis->parentPlot(), "", keyAxis->axisRect() ), - mName( "" ), - mAntialiasedFill( true ), - mAntialiasedScatters( true ), - mAntialiasedErrorBars( false ), - mPen( Qt::black ), - mSelectedPen( Qt::black ), - mBrush( Qt::NoBrush ), - mSelectedBrush( Qt::NoBrush ), - mKeyAxis( keyAxis ), - mValueAxis( valueAxis ), - mSelectable( true ), - mSelected( false ) + : QCPLayerable( keyAxis->parentPlot(), "", keyAxis->axisRect() ) + , mName( "" ) + , mAntialiasedFill( true ) + , mAntialiasedScatters( true ) + , mAntialiasedErrorBars( false ) + , mPen( Qt::black ) + , mSelectedPen( Qt::black ) + , mBrush( Qt::NoBrush ) + , mSelectedBrush( Qt::NoBrush ) + , mKeyAxis( keyAxis ) + , mValueAxis( valueAxis ) + , mSelectable( true ) + , mSelected( false ) { if( keyAxis->parentPlot() != valueAxis->parentPlot() ) qDebug() << Q_FUNC_INFO << "Parent plot of keyAxis is not the same as that of valueAxis."; @@ -7173,7 +8292,8 @@ QCPAbstractPlottable::QCPAbstractPlottable( QCPAxis* keyAxis, QCPAxis* valueAxis } /*! - The name is the textual representation of this plottable as it is displayed in the legend + The name is the textual representation of this plottable as it is displayed + in the legend (\ref QCPLegend). It may contain any UTF-8 characters, including newlines. */ void QCPAbstractPlottable::setName( const QString& name ) @@ -7184,7 +8304,8 @@ void QCPAbstractPlottable::setName( const QString& name ) /*! Sets whether fills of this plottable is drawn antialiased or not. - Note that this setting may be overridden by \ref QCustomPlot::setAntialiasedElements and \ref + Note that this setting may be overridden by \ref + QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. */ void QCPAbstractPlottable::setAntialiasedFill( bool enabled ) @@ -7193,9 +8314,11 @@ void QCPAbstractPlottable::setAntialiasedFill( bool enabled ) } /*! - Sets whether the scatter symbols of this plottable are drawn antialiased or not. + Sets whether the scatter symbols of this plottable are drawn antialiased or + not. - Note that this setting may be overridden by \ref QCustomPlot::setAntialiasedElements and \ref + Note that this setting may be overridden by \ref + QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. */ void QCPAbstractPlottable::setAntialiasedScatters( bool enabled ) @@ -7206,7 +8329,8 @@ void QCPAbstractPlottable::setAntialiasedScatters( bool enabled ) /*! Sets whether the error bars of this plottable are drawn antialiased or not. - Note that this setting may be overridden by \ref QCustomPlot::setAntialiasedElements and \ref + Note that this setting may be overridden by \ref + QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. */ void QCPAbstractPlottable::setAntialiasedErrorBars( bool enabled ) @@ -7215,10 +8339,12 @@ void QCPAbstractPlottable::setAntialiasedErrorBars( bool enabled ) } /*! - The pen is used to draw basic lines that make up the plottable representation in the + The pen is used to draw basic lines that make up the plottable representation + in the plot. - For example, the \ref QCPGraph subclass draws its graph lines and scatter points + For example, the \ref QCPGraph subclass draws its graph lines and scatter + points with this pen. \see setBrush @@ -7229,7 +8355,8 @@ void QCPAbstractPlottable::setPen( const QPen& pen ) } /*! - When the plottable is selected, this pen is used to draw basic lines instead of the normal + When the plottable is selected, this pen is used to draw basic lines instead + of the normal pen set via \ref setPen. \see setSelected, setSelectable, setSelectedBrush, selectTest @@ -7243,7 +8370,8 @@ void QCPAbstractPlottable::setSelectedPen( const QPen& pen ) The brush is used to draw basic fills of the plottable representation in the plot. The Fill can be a color, gradient or texture, see the usage of QBrush. - For example, the \ref QCPGraph subclass draws the fill under the graph with this brush, when + For example, the \ref QCPGraph subclass draws the fill under the graph with + this brush, when it's not set to Qt::NoBrush. \see setPen @@ -7254,7 +8382,8 @@ void QCPAbstractPlottable::setBrush( const QBrush& brush ) } /*! - When the plottable is selected, this brush is used to draw fills instead of the normal + When the plottable is selected, this brush is used to draw fills instead of + the normal brush set via \ref setBrush. \see setSelected, setSelectable, setSelectedPen, selectTest @@ -7265,13 +8394,18 @@ void QCPAbstractPlottable::setSelectedBrush( const QBrush& brush ) } /*! - The key axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal - to the plottable's value axis. This function performs no checks to make sure this is the case. - The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and the + The key axis of a plottable can be set to any axis of a QCustomPlot, as long + as it is orthogonal + to the plottable's value axis. This function performs no checks to make sure + this is the case. + The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as + key axis and the y-axis (QCustomPlot::yAxis) as value axis. - Normally, the key and value axes are set in the constructor of the plottable (or \ref - QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface). + Normally, the key and value axes are set in the constructor of the plottable + (or \ref + QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph + interface). \see setValueAxis */ @@ -7281,13 +8415,18 @@ void QCPAbstractPlottable::setKeyAxis( QCPAxis* axis ) } /*! - The value axis of a plottable can be set to any axis of a QCustomPlot, as long as it is - orthogonal to the plottable's key axis. This function performs no checks to make sure this is the - case. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and + The value axis of a plottable can be set to any axis of a QCustomPlot, as long + as it is + orthogonal to the plottable's key axis. This function performs no checks to + make sure this is the + case. The typical mathematical choice is to use the x-axis + (QCustomPlot::xAxis) as key axis and the y-axis (QCustomPlot::yAxis) as value axis. - Normally, the key and value axes are set in the constructor of the plottable (or \ref - QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface). + Normally, the key and value axes are set in the constructor of the plottable + (or \ref + QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph + interface). \see setKeyAxis */ @@ -7297,10 +8436,12 @@ void QCPAbstractPlottable::setValueAxis( QCPAxis* axis ) } /*! - Sets whether the user can (de-)select this plottable by clicking on the QCustomPlot surface. + Sets whether the user can (de-)select this plottable by clicking on the + QCustomPlot surface. (When \ref QCustomPlot::setInteractions contains iSelectPlottables.) - However, even when \a selectable was set to false, it is possible to set the selection manually, + However, even when \a selectable was set to false, it is possible to set the + selection manually, by calling \ref setSelected directly. \see setSelected @@ -7315,16 +8456,22 @@ void QCPAbstractPlottable::setSelectable( bool selectable ) } /*! - Sets whether this plottable is selected or not. When selected, it uses a different pen and brush - to draw its lines and fills, see \ref setSelectedPen and \ref setSelectedBrush. + Sets whether this plottable is selected or not. When selected, it uses a + different pen and brush + to draw its lines and fills, see \ref setSelectedPen and \ref + setSelectedBrush. - The entire selection mechanism for plottables is handled automatically when \ref - QCustomPlot::setInteractions contains iSelectPlottables. You only need to call this function when + The entire selection mechanism for plottables is handled automatically when + \ref + QCustomPlot::setInteractions contains iSelectPlottables. You only need to call + this function when you wish to change the selection state manually. - This function can change the selection state even when \ref setSelectable was set to false. + This function can change the selection state even when \ref setSelectable was + set to false. - emits the \ref selectionChanged signal when \a selected is different from the previous selection state. + emits the \ref selectionChanged signal when \a selected is different from the + previous selection state. \see setSelectable, selectTest */ @@ -7338,17 +8485,24 @@ void QCPAbstractPlottable::setSelected( bool selected ) } /*! - Rescales the key and value axes associated with this plottable to contain all displayed data, so - the whole plottable is visible. If the scaling of an axis is logarithmic, rescaleAxes will make - sure not to rescale to an illegal range i.e. a range containing different signs and/or zero. - Instead it will stay in the current sign domain and ignore all parts of the plottable that lie + Rescales the key and value axes associated with this plottable to contain all + displayed data, so + the whole plottable is visible. If the scaling of an axis is logarithmic, + rescaleAxes will make + sure not to rescale to an illegal range i.e. a range containing different + signs and/or zero. + Instead it will stay in the current sign domain and ignore all parts of the + plottable that lie outside of that domain. - \a onlyEnlarge makes sure the ranges are only expanded, never reduced. So it's possible to show - multiple plottables in their entirety by multiple calls to rescaleAxes where the first call has + \a onlyEnlarge makes sure the ranges are only expanded, never reduced. So it's + possible to show + multiple plottables in their entirety by multiple calls to rescaleAxes where + the first call has \a onlyEnlarge set to false (the default), and all subsequent set to true. - \see rescaleKeyAxis, rescaleValueAxis, QCustomPlot::rescaleAxes, QCPAxis::rescale + \see rescaleKeyAxis, rescaleValueAxis, QCustomPlot::rescaleAxes, + QCPAxis::rescale */ void QCPAbstractPlottable::rescaleAxes( bool onlyEnlarge ) const { @@ -7380,12 +8534,15 @@ void QCPAbstractPlottable::rescaleKeyAxis( bool onlyEnlarge ) const { if( onlyEnlarge ) newRange.expand( keyAxis->range() ); - if( !QCPRange::validRange( newRange ) ) // likely due to range being zero (plottable has only constant data in this - // axis dimension), shift current range to at least center the plottable + if( !QCPRange::validRange( newRange ) ) // likely due to range being zero + // (plottable has only constant data in + // this + // axis dimension), shift current range to at least center the plottable { - double center = ( newRange.lower + newRange.upper ) * 0.5; // upper and lower should be equal anyway, but just to - // make sure, incase validRange returned false for - // other reason + double center = ( newRange.lower + newRange.upper ) * + 0.5; // upper and lower should be equal anyway, but just to + // make sure, incase validRange returned false for + // other reason if( keyAxis->scaleType() == QCPAxis::stLinear ) { newRange.lower = center - keyAxis->range().size() / 2.0; @@ -7404,7 +8561,8 @@ void QCPAbstractPlottable::rescaleKeyAxis( bool onlyEnlarge ) const /*! Rescales the value axis of the plottable so the whole plottable is visible. - Returns true if the axis was actually scaled. This might not be the case if this plottable has an + Returns true if the axis was actually scaled. This might not be the case if + this plottable has an invalid range, e.g. because it has no data points. See \ref rescaleAxes for detailed behaviour. @@ -7428,12 +8586,15 @@ void QCPAbstractPlottable::rescaleValueAxis( bool onlyEnlarge ) const { if( onlyEnlarge ) newRange.expand( valueAxis->range() ); - if( !QCPRange::validRange( newRange ) ) // likely due to range being zero (plottable has only constant data in this - // axis dimension), shift current range to at least center the plottable + if( !QCPRange::validRange( newRange ) ) // likely due to range being zero + // (plottable has only constant data in + // this + // axis dimension), shift current range to at least center the plottable { - double center = ( newRange.lower + newRange.upper ) * 0.5; // upper and lower should be equal anyway, but just to - // make sure, incase validRange returned false for - // other reason + double center = ( newRange.lower + newRange.upper ) * + 0.5; // upper and lower should be equal anyway, but just to + // make sure, incase validRange returned false for + // other reason if( valueAxis->scaleType() == QCPAxis::stLinear ) { newRange.lower = center - valueAxis->range().size() / 2.0; @@ -7450,13 +8611,17 @@ void QCPAbstractPlottable::rescaleValueAxis( bool onlyEnlarge ) const } /*! - Adds this plottable to the legend of the parent QCustomPlot (QCustomPlot::legend). + Adds this plottable to the legend of the parent QCustomPlot + (QCustomPlot::legend). - Normally, a QCPPlottableLegendItem is created and inserted into the legend. If the plottable - needs a more specialized representation in the legend, this function will take this into account + Normally, a QCPPlottableLegendItem is created and inserted into the legend. If + the plottable + needs a more specialized representation in the legend, this function will take + this into account and instead create the specialized subclass of QCPAbstractLegendItem. - Returns true on success, i.e. when the legend exists and a legend item associated with this plottable isn't already in + Returns true on success, i.e. when the legend exists and a legend item + associated with this plottable isn't already in the legend. \see removeFromLegend, QCPLegend::addItem @@ -7476,11 +8641,14 @@ bool QCPAbstractPlottable::addToLegend() } /*! - Removes the plottable from the legend of the parent QCustomPlot. This means the - QCPAbstractLegendItem (usually a QCPPlottableLegendItem) that is associated with this plottable + Removes the plottable from the legend of the parent QCustomPlot. This means + the + QCPAbstractLegendItem (usually a QCPPlottableLegendItem) that is associated + with this plottable is removed. - Returns true on success, i.e. if the legend exists and a legend item associated with this + Returns true on success, i.e. if the legend exists and a legend item + associated with this plottable was found and removed. \see addToLegend, QCPLegend::removeItem @@ -7513,11 +8681,14 @@ QCP::Interaction QCPAbstractPlottable::selectionCategory() const /*! \internal - Convenience function for transforming a key/value pair to pixels on the QCustomPlot surface, - taking the orientations of the axes associated with this plottable into account (e.g. whether key + Convenience function for transforming a key/value pair to pixels on the + QCustomPlot surface, + taking the orientations of the axes associated with this plottable into + account (e.g. whether key represents x or y). - \a key and \a value are transformed to the coodinates in pixels and are written to \a x and \a y. + \a key and \a value are transformed to the coodinates in pixels and are + written to \a x and \a y. \see pixelsToCoords, QCPAxis::coordToPixel */ @@ -7566,11 +8737,14 @@ const QPointF QCPAbstractPlottable::coordsToPixels( double key, double value ) c /*! \internal - Convenience function for transforming a x/y pixel pair on the QCustomPlot surface to plot coordinates, - taking the orientations of the axes associated with this plottable into account (e.g. whether key + Convenience function for transforming a x/y pixel pair on the QCustomPlot + surface to plot coordinates, + taking the orientations of the axes associated with this plottable into + account (e.g. whether key represents x or y). - \a x and \a y are transformed to the plot coodinates and are written to \a key and \a value. + \a x and \a y are transformed to the plot coodinates and are written to \a key + and \a value. \see coordsToPixels, QCPAxis::coordToPixel */ @@ -7601,14 +8775,17 @@ void QCPAbstractPlottable::pixelsToCoords( double x, double y, double& key, doub Returns the pixel input \a pixelPos as plot coordinates \a key and \a value. */ -void QCPAbstractPlottable::pixelsToCoords( const QPointF& pixelPos, double& key, double& value ) const +void QCPAbstractPlottable::pixelsToCoords( const QPointF& pixelPos, + double& key, + double& value ) const { pixelsToCoords( pixelPos.x(), pixelPos.y(), key, value ); } /*! \internal - Returns the pen that should be used for drawing lines of the plottable. Returns mPen when the + Returns the pen that should be used for drawing lines of the plottable. + Returns mPen when the graph is not selected and mSelectedPen when it is. */ QPen QCPAbstractPlottable::mainPen() const @@ -7618,7 +8795,8 @@ QPen QCPAbstractPlottable::mainPen() const /*! \internal - Returns the brush that should be used for drawing fills of the plottable. Returns mBrush when the + Returns the brush that should be used for drawing fills of the plottable. + Returns mBrush when the graph is not selected and mSelectedBrush when it is. */ QBrush QCPAbstractPlottable::mainBrush() const @@ -7628,16 +8806,20 @@ QBrush QCPAbstractPlottable::mainBrush() const /*! \internal - A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter + A convenience function to easily set the QPainter::Antialiased hint on the + provided \a painter before drawing plottable lines. - This is the antialiasing state the painter passed to the \ref draw method is in by default. + This is the antialiasing state the painter passed to the \ref draw method is + in by default. - This function takes into account the local setting of the antialiasing flag as well as the + This function takes into account the local setting of the antialiasing flag as + well as the overrides set with \ref QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. - \see setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint + \see setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, + applyErrorBarsAntialiasingHint */ void QCPAbstractPlottable::applyDefaultAntialiasingHint( QCPPainter* painter ) const { @@ -7646,14 +8828,17 @@ void QCPAbstractPlottable::applyDefaultAntialiasingHint( QCPPainter* painter ) c /*! \internal - A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter + A convenience function to easily set the QPainter::Antialiased hint on the + provided \a painter before drawing plottable fills. - This function takes into account the local setting of the antialiasing flag as well as the + This function takes into account the local setting of the antialiasing flag as + well as the overrides set with \ref QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. - \see setAntialiased, applyDefaultAntialiasingHint, applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint + \see setAntialiased, applyDefaultAntialiasingHint, + applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint */ void QCPAbstractPlottable::applyFillAntialiasingHint( QCPPainter* painter ) const { @@ -7662,14 +8847,17 @@ void QCPAbstractPlottable::applyFillAntialiasingHint( QCPPainter* painter ) cons /*! \internal - A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter + A convenience function to easily set the QPainter::Antialiased hint on the + provided \a painter before drawing plottable scatter points. - This function takes into account the local setting of the antialiasing flag as well as the + This function takes into account the local setting of the antialiasing flag as + well as the overrides set with \ref QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. - \see setAntialiased, applyFillAntialiasingHint, applyDefaultAntialiasingHint, applyErrorBarsAntialiasingHint + \see setAntialiased, applyFillAntialiasingHint, applyDefaultAntialiasingHint, + applyErrorBarsAntialiasingHint */ void QCPAbstractPlottable::applyScattersAntialiasingHint( QCPPainter* painter ) const { @@ -7678,14 +8866,17 @@ void QCPAbstractPlottable::applyScattersAntialiasingHint( QCPPainter* painter ) /*! \internal - A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter + A convenience function to easily set the QPainter::Antialiased hint on the + provided \a painter before drawing plottable error bars. - This function takes into account the local setting of the antialiasing flag as well as the + This function takes into account the local setting of the antialiasing flag as + well as the overrides set with \ref QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. - \see setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, applyDefaultAntialiasingHint + \see setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, + applyDefaultAntialiasingHint */ void QCPAbstractPlottable::applyErrorBarsAntialiasingHint( QCPPainter* painter ) const { @@ -7694,15 +8885,19 @@ void QCPAbstractPlottable::applyErrorBarsAntialiasingHint( QCPPainter* painter ) /*! \internal - Finds the shortest squared distance of \a point to the line segment defined by \a start and \a + Finds the shortest squared distance of \a point to the line segment defined by + \a start and \a end. - This function may be used to help with the implementation of the \ref selectTest function for + This function may be used to help with the implementation of the \ref + selectTest function for specific plottables. \note This function is identical to QCPAbstractItem::distSqrToLine */ -double QCPAbstractPlottable::distSqrToLine( const QPointF& start, const QPointF& end, const QPointF& point ) const +double QCPAbstractPlottable::distSqrToLine( const QPointF& start, + const QPointF& end, + const QPointF& point ) const { QVector2D a( start ); QVector2D b( end ); @@ -7760,21 +8955,30 @@ void QCPAbstractPlottable::deselectEvent( bool* selectionStateChanged ) /*! \class QCPItemAnchor \brief An anchor of an item to which positions can be attached to. - An item (QCPAbstractItem) may have one or more anchors. Unlike QCPItemPosition, an anchor doesn't - control anything on its item, but provides a way to tie other items via their positions to the + An item (QCPAbstractItem) may have one or more anchors. Unlike + QCPItemPosition, an anchor doesn't + control anything on its item, but provides a way to tie other items via their + positions to the anchor. - For example, a QCPItemRect is defined by its positions \a topLeft and \a bottomRight. - Additionally it has various anchors like \a top, \a topRight or \a bottomLeft etc. So you can - attach the \a start (which is a QCPItemPosition) of a QCPItemLine to one of the anchors by - calling QCPItemPosition::setParentAnchor on \a start, passing the wanted anchor of the - QCPItemRect. This way the start of the line will now always follow the respective anchor location + For example, a QCPItemRect is defined by its positions \a topLeft and \a + bottomRight. + Additionally it has various anchors like \a top, \a topRight or \a bottomLeft + etc. So you can + attach the \a start (which is a QCPItemPosition) of a QCPItemLine to one of + the anchors by + calling QCPItemPosition::setParentAnchor on \a start, passing the wanted + anchor of the + QCPItemRect. This way the start of the line will now always follow the + respective anchor location on the rect item. - Note that QCPItemPosition derives from QCPItemAnchor, so every position can also serve as an + Note that QCPItemPosition derives from QCPItemAnchor, so every position can + also serve as an anchor to other positions. - To learn how to provide anchors in your own item subclasses, see the subclassing section of the + To learn how to provide anchors in your own item subclasses, see the + subclassing section of the QCPAbstractItem documentation. */ @@ -7782,22 +8986,30 @@ void QCPAbstractPlottable::deselectEvent( bool* selectionStateChanged ) /*! \fn virtual QCPItemPosition *QCPItemAnchor::toQCPItemPosition() - Returns 0 if this instance is merely a QCPItemAnchor, and a valid pointer of type QCPItemPosition* if + Returns 0 if this instance is merely a QCPItemAnchor, and a valid pointer of + type QCPItemPosition* if it actually is a QCPItemPosition (which is a subclass of QCPItemAnchor). - This safe downcast functionality could also be achieved with a dynamic_cast. However, QCustomPlot avoids - dynamic_cast to work with projects that don't have RTTI support enabled (e.g. -fno-rtti flag with + This safe downcast functionality could also be achieved with a dynamic_cast. + However, QCustomPlot avoids + dynamic_cast to work with projects that don't have RTTI support enabled (e.g. + -fno-rtti flag with gcc compiler). */ /* end documentation of inline functions */ /*! - Creates a new QCPItemAnchor. You shouldn't create QCPItemAnchor instances directly, even if - you want to make a new item subclass. Use \ref QCPAbstractItem::createAnchor instead, as + Creates a new QCPItemAnchor. You shouldn't create QCPItemAnchor instances + directly, even if + you want to make a new item subclass. Use \ref QCPAbstractItem::createAnchor + instead, as explained in the subclassing section of the QCPAbstractItem documentation. */ -QCPItemAnchor::QCPItemAnchor( QCustomPlot* parentPlot, QCPAbstractItem* parentItem, const QString name, int anchorId ) +QCPItemAnchor::QCPItemAnchor( QCustomPlot* parentPlot, + QCPAbstractItem* parentItem, + const QString name, + int anchorId ) : mName( name ), mParentPlot( parentPlot ), mParentItem( parentItem ), mAnchorId( anchorId ) { } @@ -7807,14 +9019,17 @@ QCPItemAnchor::~QCPItemAnchor() // unregister as parent at children: QList currentChildren( mChildren.toList() ); for( int i = 0; i < currentChildren.size(); ++i ) - currentChildren.at( i )->setParentAnchor( - 0 ); // this acts back on this anchor and child removes itself from mChildren + currentChildren.at( i )->setParentAnchor( 0 ); // this acts back on this anchor + // and child removes itself from + // mChildren } /*! - Returns the final absolute pixel position of the QCPItemAnchor on the QCustomPlot surface. + Returns the final absolute pixel position of the QCPItemAnchor on the + QCustomPlot surface. - The pixel information is internally retrieved via QCPAbstractItem::anchorPixelPosition of the + The pixel information is internally retrieved via + QCPAbstractItem::anchorPixelPosition of the parent item, QCPItemAnchor is just an intermediary. */ QPointF QCPItemAnchor::pixelPoint() const @@ -7840,7 +9055,8 @@ QPointF QCPItemAnchor::pixelPoint() const /*! \internal - Adds \a pos to the child list of this anchor. This is necessary to notify the children prior to + Adds \a pos to the child list of this anchor. This is necessary to notify the + children prior to destruction of the anchor. Note that this function does not change the parent setting in \a pos. @@ -7872,92 +9088,127 @@ void QCPItemAnchor::removeChild( QCPItemPosition* pos ) /*! \class QCPItemPosition \brief Manages the position of an item. - Every item has at least one public QCPItemPosition member pointer which provides ways to position the - item on the QCustomPlot surface. Some items have multiple positions, for example QCPItemRect has two: + Every item has at least one public QCPItemPosition member pointer which + provides ways to position the + item on the QCustomPlot surface. Some items have multiple positions, for + example QCPItemRect has two: \a topLeft and \a bottomRight. - QCPItemPosition has a type (\ref PositionType) that can be set with \ref setType. This type defines - how coordinates passed to \ref setCoords are to be interpreted, e.g. as absolute pixel coordinates, as + QCPItemPosition has a type (\ref PositionType) that can be set with \ref + setType. This type defines + how coordinates passed to \ref setCoords are to be interpreted, e.g. as + absolute pixel coordinates, as plot coordinates of certain axes, etc. - Further, QCPItemPosition may have a parent QCPItemAnchor, see \ref setParentAnchor. (Note that every - QCPItemPosition inherits from QCPItemAnchor and thus can itself be used as parent anchor for other - positions.) This way you can tie multiple items together. If the QCPItemPosition has a parent, the - coordinates set with \ref setCoords are considered to be absolute values in the reference frame of the - parent anchor, where (0, 0) means directly ontop of the parent anchor. For example, You could attach - the \a start position of a QCPItemLine to the \a bottom anchor of a QCPItemText to make the starting - point of the line always be centered under the text label, no matter where the text is moved to, or is + Further, QCPItemPosition may have a parent QCPItemAnchor, see \ref + setParentAnchor. (Note that every + QCPItemPosition inherits from QCPItemAnchor and thus can itself be used as + parent anchor for other + positions.) This way you can tie multiple items together. If the + QCPItemPosition has a parent, the + coordinates set with \ref setCoords are considered to be absolute values in + the reference frame of the + parent anchor, where (0, 0) means directly ontop of the parent anchor. For + example, You could attach + the \a start position of a QCPItemLine to the \a bottom anchor of a + QCPItemText to make the starting + point of the line always be centered under the text label, no matter where the + text is moved to, or is itself tied to. - To set the apparent pixel position on the QCustomPlot surface directly, use \ref setPixelPoint. This - works no matter what type this QCPItemPosition is or what parent-child situation it is in, as \ref - setPixelPoint transforms the coordinates appropriately, to make the position appear at the specified + To set the apparent pixel position on the QCustomPlot surface directly, use + \ref setPixelPoint. This + works no matter what type this QCPItemPosition is or what parent-child + situation it is in, as \ref + setPixelPoint transforms the coordinates appropriately, to make the position + appear at the specified pixel values. */ /*! - Creates a new QCPItemPosition. You shouldn't create QCPItemPosition instances directly, even if - you want to make a new item subclass. Use \ref QCPAbstractItem::createPosition instead, as + Creates a new QCPItemPosition. You shouldn't create QCPItemPosition instances + directly, even if + you want to make a new item subclass. Use \ref QCPAbstractItem::createPosition + instead, as explained in the subclassing section of the QCPAbstractItem documentation. */ -QCPItemPosition::QCPItemPosition( QCustomPlot* parentPlot, QCPAbstractItem* parentItem, const QString name ) - : QCPItemAnchor( parentPlot, parentItem, name ), - mPositionType( ptAbsolute ), - mKey( 0 ), - mValue( 0 ), - mParentAnchor( 0 ) +QCPItemPosition::QCPItemPosition( QCustomPlot* parentPlot, + QCPAbstractItem* parentItem, + const QString name ) + : QCPItemAnchor( parentPlot, parentItem, name ) + , mPositionType( ptAbsolute ) + , mKey( 0 ) + , mValue( 0 ) + , mParentAnchor( 0 ) { } QCPItemPosition::~QCPItemPosition() { // unregister as parent at children: - // Note: this is done in ~QCPItemAnchor again, but it's important QCPItemPosition does it itself, because only then - // the setParentAnchor(0) call the correct QCPItemPosition::pixelPoint function instead of + // Note: this is done in ~QCPItemAnchor again, but it's important + // QCPItemPosition does it itself, because only then + // the setParentAnchor(0) call the correct QCPItemPosition::pixelPoint + // function instead of // QCPItemAnchor::pixelPoint QList currentChildren( mChildren.toList() ); for( int i = 0; i < currentChildren.size(); ++i ) - currentChildren.at( i )->setParentAnchor( - 0 ); // this acts back on this anchor and child removes itself from mChildren + currentChildren.at( i )->setParentAnchor( 0 ); // this acts back on this anchor + // and child removes itself from + // mChildren // unregister as child in parent: if( mParentAnchor ) mParentAnchor->removeChild( this ); } -/* can't make this a header inline function, because QPointer breaks with forward declared types, see QTBUG-29588 */ +/* can't make this a header inline function, because QPointer breaks with + * forward declared types, see QTBUG-29588 */ QCPAxisRect* QCPItemPosition::axisRect() const { return mAxisRect.data(); } /*! - Sets the type of the position. The type defines how the coordinates passed to \ref setCoords + Sets the type of the position. The type defines how the coordinates passed to + \ref setCoords should be handled and how the QCPItemPosition should behave in the plot. The possible values for \a type can be separated in two main categories: - \li The position is regarded as a point in plot coordinates. This corresponds to \ref ptPlotCoords - and requires two axes that define the plot coordinate system. They can be specified with \ref setAxes. + \li The position is regarded as a point in plot coordinates. This corresponds + to \ref ptPlotCoords + and requires two axes that define the plot coordinate system. They can be + specified with \ref setAxes. By default, the QCustomPlot's x- and yAxis are used. - \li The position is fixed on the QCustomPlot surface, i.e. independent of axis ranges. This - corresponds to all other types, i.e. \ref ptAbsolute, \ref ptViewportRatio and \ref - ptAxisRectRatio. They differ only in the way the absolute position is described, see the - documentation of \ref PositionType for details. For \ref ptAxisRectRatio, note that you can specify - the axis rect with \ref setAxisRect. By default this is set to the main axis rect. + \li The position is fixed on the QCustomPlot surface, i.e. independent of axis + ranges. This + corresponds to all other types, i.e. \ref ptAbsolute, \ref ptViewportRatio and + \ref + ptAxisRectRatio. They differ only in the way the absolute position is + described, see the + documentation of \ref PositionType for details. For \ref ptAxisRectRatio, note + that you can specify + the axis rect with \ref setAxisRect. By default this is set to the main axis + rect. - Note that the position type \ref ptPlotCoords is only available (and sensible) when the position + Note that the position type \ref ptPlotCoords is only available (and sensible) + when the position has no parent anchor (\ref setParentAnchor). - If the type is changed, the apparent pixel position on the plot is preserved. This means - the coordinates as retrieved with coords() and set with \ref setCoords may change in the process. + If the type is changed, the apparent pixel position on the plot is preserved. + This means + the coordinates as retrieved with coords() and set with \ref setCoords may + change in the process. */ void QCPItemPosition::setType( QCPItemPosition::PositionType type ) { if( mPositionType != type ) { - // if switching from or to coordinate type that isn't valid (e.g. because axes or axis rect - // were deleted), don't try to recover the pixelPoint() because it would output a qDebug warning. + // if switching from or to coordinate type that isn't valid (e.g. because + // axes or axis rect + // were deleted), don't try to recover the pixelPoint() because it would + // output a qDebug warning. bool recoverPixelPosition = true; if( ( mPositionType == ptPlotCoords || type == ptPlotCoords ) && ( !mKeyAxis || !mValueAxis ) ) recoverPixelPosition = false; @@ -7976,18 +9227,25 @@ void QCPItemPosition::setType( QCPItemPosition::PositionType type ) } /*! - Sets the parent of this QCPItemPosition to \a parentAnchor. This means the position will now - follow any position changes of the anchor. The local coordinate system of positions with a parent - anchor always is absolute with (0, 0) being exactly on top of the parent anchor. (Hence the type + Sets the parent of this QCPItemPosition to \a parentAnchor. This means the + position will now + follow any position changes of the anchor. The local coordinate system of + positions with a parent + anchor always is absolute with (0, 0) being exactly on top of the parent + anchor. (Hence the type shouldn't be \ref ptPlotCoords for positions with parent anchors.) - if \a keepPixelPosition is true, the current pixel position of the QCPItemPosition is preserved - during reparenting. If it's set to false, the coordinates are set to (0, 0), i.e. the position + if \a keepPixelPosition is true, the current pixel position of the + QCPItemPosition is preserved + during reparenting. If it's set to false, the coordinates are set to (0, 0), + i.e. the position will be exactly on top of the parent anchor. - To remove this QCPItemPosition from any parent anchor, set \a parentAnchor to 0. + To remove this QCPItemPosition from any parent anchor, set \a parentAnchor to + 0. - If the QCPItemPosition previously had no parent and the type is \ref ptPlotCoords, the type is + If the QCPItemPosition previously had no parent and the type is \ref + ptPlotCoords, the type is set to \ref ptAbsolute, to keep the position in a valid state. */ bool QCPItemPosition::setParentAnchor( QCPItemAnchor* parentAnchor, bool keepPixelPosition ) @@ -7995,7 +9253,8 @@ bool QCPItemPosition::setParentAnchor( QCPItemAnchor* parentAnchor, bool keepPix // make sure self is not assigned as parent: if( parentAnchor == this ) { - qDebug() << Q_FUNC_INFO << "can't set self as parent anchor" << reinterpret_cast( parentAnchor ); + qDebug() << Q_FUNC_INFO << "can't set self as parent anchor" + << reinterpret_cast( parentAnchor ); return false; } // make sure no recursive parent-child-relationships are created: @@ -8015,12 +9274,15 @@ bool QCPItemPosition::setParentAnchor( QCPItemAnchor* parentAnchor, bool keepPix } else { - // is a QCPItemAnchor, can't have further parent. Now make sure the parent items aren't the - // same, to prevent a position being child of an anchor which itself depends on the position, + // is a QCPItemAnchor, can't have further parent. Now make sure the parent + // items aren't the + // same, to prevent a position being child of an anchor which itself + // depends on the position, // because they're both on the same item: if( currentParent->mParentItem == mParentItem ) { - qDebug() << Q_FUNC_INFO << "can't set parent to be an anchor which itself depends on this position" + qDebug() << Q_FUNC_INFO << "can't set parent to be an anchor which " + "itself depends on this position" << reinterpret_cast( parentAnchor ); return false; } @@ -8028,7 +9290,8 @@ bool QCPItemPosition::setParentAnchor( QCPItemAnchor* parentAnchor, bool keepPix } } - // if previously no parent set and PosType is still ptPlotCoords, set to ptAbsolute: + // if previously no parent set and PosType is still ptPlotCoords, set to + // ptAbsolute: if( !mParentAnchor && mPositionType == ptPlotCoords ) setType( ptAbsolute ); @@ -8052,14 +9315,20 @@ bool QCPItemPosition::setParentAnchor( QCPItemAnchor* parentAnchor, bool keepPix } /*! - Sets the coordinates of this QCPItemPosition. What the coordinates mean, is defined by the type + Sets the coordinates of this QCPItemPosition. What the coordinates mean, is + defined by the type (\ref setType). - For example, if the type is \ref ptAbsolute, \a key and \a value mean the x and y pixel position - on the QCustomPlot surface. In that case the origin (0, 0) is in the top left corner of the - QCustomPlot viewport. If the type is \ref ptPlotCoords, \a key and \a value mean a point in the - plot coordinate system defined by the axes set by \ref setAxes. By default those are the - QCustomPlot's xAxis and yAxis. See the documentation of \ref setType for other available + For example, if the type is \ref ptAbsolute, \a key and \a value mean the x + and y pixel position + on the QCustomPlot surface. In that case the origin (0, 0) is in the top left + corner of the + QCustomPlot viewport. If the type is \ref ptPlotCoords, \a key and \a value + mean a point in the + plot coordinate system defined by the axes set by \ref setAxes. By default + those are the + QCustomPlot's xAxis and yAxis. See the documentation of \ref setType for other + available coordinate types and their meaning. \see setPixelPoint @@ -8072,7 +9341,8 @@ void QCPItemPosition::setCoords( double key, double value ) /*! \overload - Sets the coordinates as a QPointF \a pos where pos.x has the meaning of \a key and pos.y the + Sets the coordinates as a QPointF \a pos where pos.x has the meaning of \a key + and pos.y the meaning of \a value of the \ref setCoords(double key, double value) method. */ void QCPItemPosition::setCoords( const QPointF& pos ) @@ -8081,8 +9351,10 @@ void QCPItemPosition::setCoords( const QPointF& pos ) } /*! - Returns the final absolute pixel position of the QCPItemPosition on the QCustomPlot surface. It - includes all effects of type (\ref setType) and possible parent anchors (\ref setParentAnchor). + Returns the final absolute pixel position of the QCPItemPosition on the + QCustomPlot surface. It + includes all effects of type (\ref setType) and possible parent anchors (\ref + setParentAnchor). \see setPixelPoint */ @@ -8102,12 +9374,14 @@ QPointF QCPItemPosition::pixelPoint() const { if( mParentAnchor ) { - return QPointF( mKey * mParentPlot->viewport().width(), mValue * mParentPlot->viewport().height() ) + + return QPointF( mKey * mParentPlot->viewport().width(), + mValue * mParentPlot->viewport().height() ) + mParentAnchor->pixelPoint(); } else { - return QPointF( mKey * mParentPlot->viewport().width(), mValue * mParentPlot->viewport().height() ) + + return QPointF( mKey * mParentPlot->viewport().width(), + mValue * mParentPlot->viewport().height() ) + mParentPlot->viewport().topLeft(); } } @@ -8139,7 +9413,8 @@ QPointF QCPItemPosition::pixelPoint() const double x, y; if( mKeyAxis && mValueAxis ) { - // both key and value axis are given, translate key/value to x/y coordinates: + // both key and value axis are given, translate key/value to x/y + // coordinates: if( mKeyAxis.data()->orientation() == Qt::Horizontal ) { x = mKeyAxis.data()->coordToPixel( mKey ); @@ -8153,7 +9428,8 @@ QPointF QCPItemPosition::pixelPoint() const } else if( mKeyAxis ) { - // only key axis is given, depending on orientation only transform x or y to key coordinate, other stays pixel: + // only key axis is given, depending on orientation only transform x or y + // to key coordinate, other stays pixel: if( mKeyAxis.data()->orientation() == Qt::Horizontal ) { x = mKeyAxis.data()->coordToPixel( mKey ); @@ -8167,7 +9443,8 @@ QPointF QCPItemPosition::pixelPoint() const } else if( mValueAxis ) { - // only value axis is given, depending on orientation only transform x or y to value coordinate, other stays + // only value axis is given, depending on orientation only transform x or + // y to value coordinate, other stays // pixel: if( mValueAxis.data()->orientation() == Qt::Horizontal ) { @@ -8194,8 +9471,10 @@ QPointF QCPItemPosition::pixelPoint() const } /*! - When \ref setType is \ref ptPlotCoords, this function may be used to specify the axes the - coordinates set with \ref setCoords relate to. By default they are set to the initial xAxis and + When \ref setType is \ref ptPlotCoords, this function may be used to specify + the axes the + coordinates set with \ref setCoords relate to. By default they are set to the + initial xAxis and yAxis of the QCustomPlot. */ void QCPItemPosition::setAxes( QCPAxis* keyAxis, QCPAxis* valueAxis ) @@ -8205,8 +9484,10 @@ void QCPItemPosition::setAxes( QCPAxis* keyAxis, QCPAxis* valueAxis ) } /*! - When \ref setType is \ref ptAxisRectRatio, this function may be used to specify the axis rect the - coordinates set with \ref setCoords relate to. By default this is set to the main axis rect of + When \ref setType is \ref ptAxisRectRatio, this function may be used to + specify the axis rect the + coordinates set with \ref setCoords relate to. By default this is set to the + main axis rect of the QCustomPlot. */ void QCPItemPosition::setAxisRect( QCPAxisRect* axisRect ) @@ -8215,11 +9496,15 @@ void QCPItemPosition::setAxisRect( QCPAxisRect* axisRect ) } /*! - Sets the apparent pixel position. This works no matter what type (\ref setType) this - QCPItemPosition is or what parent-child situation it is in, as coordinates are transformed - appropriately, to make the position finally appear at the specified pixel values. + Sets the apparent pixel position. This works no matter what type (\ref + setType) this + QCPItemPosition is or what parent-child situation it is in, as coordinates are + transformed + appropriately, to make the position finally appear at the specified pixel + values. - Only if the type is \ref ptAbsolute and no parent anchor is set, this function's effect is + Only if the type is \ref ptAbsolute and no parent anchor is set, this + function's effect is identical to that of \ref setCoords. \see pixelPoint, setCoords @@ -8288,7 +9573,8 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) double newKey, newValue; if( mKeyAxis && mValueAxis ) { - // both key and value axis are given, translate point to key/value coordinates: + // both key and value axis are given, translate point to key/value + // coordinates: if( mKeyAxis.data()->orientation() == Qt::Horizontal ) { newKey = mKeyAxis.data()->pixelToCoord( pixelPoint.x() ); @@ -8302,7 +9588,8 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) } else if( mKeyAxis ) { - // only key axis is given, depending on orientation only transform x or y to key coordinate, other stays pixel: + // only key axis is given, depending on orientation only transform x or y + // to key coordinate, other stays pixel: if( mKeyAxis.data()->orientation() == Qt::Horizontal ) { newKey = mKeyAxis.data()->pixelToCoord( pixelPoint.x() ); @@ -8316,7 +9603,8 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) } else if( mValueAxis ) { - // only value axis is given, depending on orientation only transform x or y to value coordinate, other stays + // only value axis is given, depending on orientation only transform x or + // y to value coordinate, other stays // pixel: if( mValueAxis.data()->orientation() == Qt::Horizontal ) { @@ -8349,35 +9637,48 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) /*! \class QCPAbstractItem \brief The abstract base class for all items in a plot. - In QCustomPlot, items are supplemental graphical elements that are neither plottables - (QCPAbstractPlottable) nor axes (QCPAxis). While plottables are always tied to two axes and thus - plot coordinates, items can also be placed in absolute coordinates independent of any axes. Each - specific item has at least one QCPItemPosition member which controls the positioning. Some items - are defined by more than one coordinate and thus have two or more QCPItemPosition members (For + In QCustomPlot, items are supplemental graphical elements that are neither + plottables + (QCPAbstractPlottable) nor axes (QCPAxis). While plottables are always tied to + two axes and thus + plot coordinates, items can also be placed in absolute coordinates independent + of any axes. Each + specific item has at least one QCPItemPosition member which controls the + positioning. Some items + are defined by more than one coordinate and thus have two or more + QCPItemPosition members (For example, QCPItemRect has \a topLeft and \a bottomRight). - This abstract base class defines a very basic interface like visibility and clipping. Since this - class is abstract, it can't be instantiated. Use one of the subclasses or create a subclass + This abstract base class defines a very basic interface like visibility and + clipping. Since this + class is abstract, it can't be instantiated. Use one of the subclasses or + create a subclass yourself to create new items. The built-in items are:
    QCustomPlot *\b mParentPlotA pointer to the parent QCustomPlot instance. The parent plot is inferred from the axes that are passed in the + A pointer to the parent QCustomPlot instance. The parent plot is + inferred from the axes that are passed in the constructor.
    QString \b mName The name of the plottable.
    QPen \b mPenThe generic pen of the plottable. You should use this pen for the most prominent data representing lines in the + The generic pen of the plottable. You should use this pen for the most + prominent data representing lines in the plottable (e.g QCPGraph uses this pen for its graph lines and scatters)
    QPen \b mSelectedPenThe generic pen that should be used when the plottable is selected (hint: \ref mainPen gives you the right pen, + The generic pen that should be used when the plottable is selected + (hint: \ref mainPen gives you the right pen, depending on selection state).
    QBrush \b mBrushThe generic brush of the plottable. You should use this brush for the most prominent fillable structures in the - plottable (e.g. QCPGraph uses this brush to control filling under the graph)The generic brush of the plottable. You should use this brush for the + most prominent fillable structures in the + plottable (e.g. QCPGraph uses this brush to control filling under the + graph)
    QBrush \b mSelectedBrushThe generic brush that should be used when the plottable is selected (hint: \ref mainBrush gives you the right + The generic brush that should be used when the plottable is selected + (hint: \ref mainBrush gives you the right brush, depending on selection state).
    QPointer\b mKeyAxis, \b mValueAxisThe key and value axes this plottable is attached to. Call their QCPAxis::coordToPixel functions to translate + The key and value axes this plottable is attached to. Call their + QCPAxis::coordToPixel functions to translate coordinates to pixels in either the key or value dimension. - Make sure to check whether the pointer is null before using it. If one of the axes is null, don't draw the + Make sure to check whether the pointer is null before using it. If one + of the axes is null, don't draw the plottable.
    bool \b mSelected
    - - - - - +
    QCPItemLineA line defined by a start and an end point. May have different ending styles on each side +
    QCPItemLineA line defined by a start and an end point. May + have different ending styles on each side (e.g. arrows).
    QCPItemStraightLineA straight line defined by a start and a direction point. Unlike QCPItemLine, the +
    QCPItemStraightLineA straight line defined by a start and a + direction point. Unlike QCPItemLine, the straight line is infinitely long and has no endings.
    QCPItemCurveA curve defined by start, end and two intermediate control points. May have different +
    QCPItemCurveA curve defined by start, end and two + intermediate control points. May have different ending styles on each side (e.g. arrows).
    QCPItemRectA rectangle
    QCPItemEllipseAn ellipse
    QCPItemPixmapAn arbitrary pixmap
    QCPItemTextA text label
    QCPItemBracketA bracket which may be used to reference/highlight certain parts in the plot.
    QCPItemTracerAn item that can be attached to a QCPGraph and sticks to its data points, given a key +
    QCPItemBracketA bracket which may be used to + reference/highlight certain parts in the plot.
    QCPItemTracerAn item that can be attached to a QCPGraph and + sticks to its data points, given a key coordinate.
    - Items are by default clipped to the main axis rect. To make an item visible outside that axis + Items are by default clipped to the main axis rect. To make an item visible + outside that axis rect, disable clipping via \ref setClipToAxisRect. \section items-using Using items @@ -8387,14 +9688,17 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) QCPItemLine *line = new QCPItemLine(customPlot); customPlot->addItem(line); \endcode - by default, the positions of the item are bound to the x- and y-Axis of the plot. So we can just + by default, the positions of the item are bound to the x- and y-Axis of the + plot. So we can just set the plot coordinates where the line should start/end: \code line->start->setCoords(-0.1, 0.8); line->end->setCoords(1.1, 0.2); \endcode - If we don't want the line to be positioned in plot coordinates but a different coordinate system, - e.g. absolute pixel positions on the QCustomPlot surface, we need to change the position type like this: + If we don't want the line to be positioned in plot coordinates but a different + coordinate system, + e.g. absolute pixel positions on the QCustomPlot surface, we need to change + the position type like this: \code line->start->setType(QCPItemPosition::ptAbsolute); line->end->setType(QCPItemPosition::ptAbsolute); @@ -8407,7 +9711,8 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) \section items-subclassing Creating own items - To create an own item, you implement a subclass of QCPAbstractItem. These are the pure + To create an own item, you implement a subclass of QCPAbstractItem. These are + the pure virtual functions, you must implement: \li \ref selectTest \li \ref draw @@ -8416,17 +9721,23 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) \subsection items-positioning Allowing the item to be positioned - As mentioned, item positions are represented by QCPItemPosition members. Let's assume the new item shall - have only one point as its position (as opposed to two like a rect or multiple like a polygon). You then add + As mentioned, item positions are represented by QCPItemPosition members. Let's + assume the new item shall + have only one point as its position (as opposed to two like a rect or multiple + like a polygon). You then add a public member of type QCPItemPosition like so: \code QCPItemPosition * const myPosition;\endcode - the const makes sure the pointer itself can't be modified from the user of your new item (the QCPItemPosition + the const makes sure the pointer itself can't be modified from the user of + your new item (the QCPItemPosition instance it points to, can be modified, of course). - The initialization of this pointer is made easy with the \ref createPosition function. Just assign - the return value of this function to each QCPItemPosition in the constructor of your item. \ref createPosition - takes a string which is the name of the position, typically this is identical to the variable name. + The initialization of this pointer is made easy with the \ref createPosition + function. Just assign + the return value of this function to each QCPItemPosition in the constructor + of your item. \ref createPosition + takes a string which is the name of the position, typically this is identical + to the variable name. For example, the constructor of QCPItemExample could look like this: \code @@ -8440,35 +9751,48 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) \subsection items-drawing The draw function - To give your item a visual representation, reimplement the \ref draw function and use the passed - QCPPainter to draw the item. You can retrieve the item position in pixel coordinates from the + To give your item a visual representation, reimplement the \ref draw function + and use the passed + QCPPainter to draw the item. You can retrieve the item position in pixel + coordinates from the position member(s) via \ref QCPItemPosition::pixelPoint. - To optimize performance you should calculate a bounding rect first (don't forget to take the pen - width into account), check whether it intersects the \ref clipRect, and only draw the item at all + To optimize performance you should calculate a bounding rect first (don't + forget to take the pen + width into account), check whether it intersects the \ref clipRect, and only + draw the item at all if this is the case. \subsection items-selection The selectTest function - Your implementation of the \ref selectTest function may use the helpers \ref distSqrToLine and - \ref rectSelectTest. With these, the implementation of the selection test becomes significantly - simpler for most items. See the documentation of \ref selectTest for what the function parameters + Your implementation of the \ref selectTest function may use the helpers \ref + distSqrToLine and + \ref rectSelectTest. With these, the implementation of the selection test + becomes significantly + simpler for most items. See the documentation of \ref selectTest for what the + function parameters mean and what the function should return. \subsection anchors Providing anchors - Providing anchors (QCPItemAnchor) starts off like adding a position. First you create a public + Providing anchors (QCPItemAnchor) starts off like adding a position. First you + create a public member, e.g. \code QCPItemAnchor * const bottom;\endcode - and create it in the constructor with the \ref createAnchor function, assigning it a name and an - anchor id (an integer enumerating all anchors on the item, you may create an own enum for this). - Since anchors can be placed anywhere, relative to the item's position(s), your item needs to - provide the position of every anchor with the reimplementation of the \ref anchorPixelPoint(int + and create it in the constructor with the \ref createAnchor function, + assigning it a name and an + anchor id (an integer enumerating all anchors on the item, you may create an + own enum for this). + Since anchors can be placed anywhere, relative to the item's position(s), your + item needs to + provide the position of every anchor with the reimplementation of the \ref + anchorPixelPoint(int anchorId) function. - In essence the QCPItemAnchor is merely an intermediary that itself asks your item for the pixel + In essence the QCPItemAnchor is merely an intermediary that itself asks your + item for the pixel position when anything attached to the anchor needs to know the coordinates. */ @@ -8483,7 +9807,8 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) /*! \fn QList QCPAbstractItem::anchors() const - Returns all anchors of the item in a list. Note that since a position (QCPItemPosition) is always + Returns all anchors of the item in a list. Note that since a position + (QCPItemPosition) is always also an anchor, the list will also contain the positions of this item. \see positions, anchor @@ -8497,8 +9822,10 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) Draws this item with the provided \a painter. - The cliprect of the provided painter is set to the rect returned by \ref clipRect before this - function is called. The clipRect depends on the clipping settings defined by \ref + The cliprect of the provided painter is set to the rect returned by \ref + clipRect before this + function is called. The clipRect depends on the clipping settings defined by + \ref setClipToAxisRect and \ref setClipAxisRect. */ @@ -8506,7 +9833,8 @@ void QCPItemPosition::setPixelPoint( const QPointF& pixelPoint ) /* start documentation of signals */ /*! \fn void QCPAbstractItem::selectionChanged(bool selected) - This signal is emitted when the selection state of this item has changed, either by user interaction + This signal is emitted when the selection state of this item has changed, + either by user interaction or by a direct call to \ref setSelected. */ @@ -8528,18 +9856,21 @@ QCPAbstractItem::QCPAbstractItem( QCustomPlot* parentPlot ) QCPAbstractItem::~QCPAbstractItem() { - // don't delete mPositions because every position is also an anchor and thus in mAnchors + // don't delete mPositions because every position is also an anchor and thus + // in mAnchors qDeleteAll( mAnchors ); } -/* can't make this a header inline function, because QPointer breaks with forward declared types, see QTBUG-29588 */ +/* can't make this a header inline function, because QPointer breaks with + * forward declared types, see QTBUG-29588 */ QCPAxisRect* QCPAbstractItem::clipAxisRect() const { return mClipAxisRect.data(); } /*! - Sets whether the item shall be clipped to an axis rect or whether it shall be visible on the + Sets whether the item shall be clipped to an axis rect or whether it shall be + visible on the entire QCustomPlot. The axis rect can be set with \ref setClipAxisRect. \see setClipAxisRect @@ -8552,7 +9883,8 @@ void QCPAbstractItem::setClipToAxisRect( bool clip ) } /*! - Sets the clip axis rect. It defines the rect that will be used to clip the item when \ref + Sets the clip axis rect. It defines the rect that will be used to clip the + item when \ref setClipToAxisRect is set to true. \see setClipToAxisRect @@ -8565,10 +9897,12 @@ void QCPAbstractItem::setClipAxisRect( QCPAxisRect* rect ) } /*! - Sets whether the user can (de-)select this item by clicking on the QCustomPlot surface. + Sets whether the user can (de-)select this item by clicking on the QCustomPlot + surface. (When \ref QCustomPlot::setInteractions contains QCustomPlot::iSelectItems.) - However, even when \a selectable was set to false, it is possible to set the selection manually, + However, even when \a selectable was set to false, it is possible to set the + selection manually, by calling \ref setSelected. \see QCustomPlot::setInteractions, setSelected @@ -8583,16 +9917,20 @@ void QCPAbstractItem::setSelectable( bool selectable ) } /*! - Sets whether this item is selected or not. When selected, it might use a different visual + Sets whether this item is selected or not. When selected, it might use a + different visual appearance (e.g. pen and brush), this depends on the specific item though. The entire selection mechanism for items is handled automatically when \ref - QCustomPlot::setInteractions contains QCustomPlot::iSelectItems. You only need to call this + QCustomPlot::setInteractions contains QCustomPlot::iSelectItems. You only need + to call this function when you wish to change the selection state manually. - This function can change the selection state even when \ref setSelectable was set to false. + This function can change the selection state even when \ref setSelectable was + set to false. - emits the \ref selectionChanged signal when \a selected is different from the previous selection state. + emits the \ref selectionChanged signal when \a selected is different from the + previous selection state. \see setSelectable, selectTest */ @@ -8606,11 +9944,14 @@ void QCPAbstractItem::setSelected( bool selected ) } /*! - Returns the QCPItemPosition with the specified \a name. If this item doesn't have a position by + Returns the QCPItemPosition with the specified \a name. If this item doesn't + have a position by that name, returns 0. - This function provides an alternative way to access item positions. Normally, you access - positions direcly by their member pointers (which typically have the same variable name as \a + This function provides an alternative way to access item positions. Normally, + you access + positions direcly by their member pointers (which typically have the same + variable name as \a name). \see positions, anchor @@ -8627,11 +9968,14 @@ QCPItemPosition* QCPAbstractItem::position( const QString& name ) const } /*! - Returns the QCPItemAnchor with the specified \a name. If this item doesn't have an anchor by + Returns the QCPItemAnchor with the specified \a name. If this item doesn't + have an anchor by that name, returns 0. - This function provides an alternative way to access item anchors. Normally, you access - anchors direcly by their member pointers (which typically have the same variable name as \a + This function provides an alternative way to access item anchors. Normally, + you access + anchors direcly by their member pointers (which typically have the same + variable name as \a name). \see anchors, position @@ -8650,7 +9994,8 @@ QCPItemAnchor* QCPAbstractItem::anchor( const QString& name ) const /*! Returns whether this item has an anchor with the specified \a name. - Note that you can check for positions with this function, too. This is because every position is + Note that you can check for positions with this function, too. This is because + every position is also an anchor (QCPItemPosition inherits from QCPItemAnchor). \see anchor, position @@ -8667,10 +10012,13 @@ bool QCPAbstractItem::hasAnchor( const QString& name ) const /*! \internal - Returns the rect the visual representation of this item is clipped to. This depends on the - current setting of \ref setClipToAxisRect as well as the axis rect set with \ref setClipAxisRect. + Returns the rect the visual representation of this item is clipped to. This + depends on the + current setting of \ref setClipToAxisRect as well as the axis rect set with + \ref setClipAxisRect. - If the item is not clipped to an axis rect, the \ref QCustomPlot::viewport rect is returned. + If the item is not clipped to an axis rect, the \ref QCustomPlot::viewport + rect is returned. \see draw */ @@ -8684,12 +10032,15 @@ QRect QCPAbstractItem::clipRect() const /*! \internal - A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter + A convenience function to easily set the QPainter::Antialiased hint on the + provided \a painter before drawing item lines. - This is the antialiasing state the painter passed to the \ref draw method is in by default. + This is the antialiasing state the painter passed to the \ref draw method is + in by default. - This function takes into account the local setting of the antialiasing flag as well as the + This function takes into account the local setting of the antialiasing flag as + well as the overrides set with \ref QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. @@ -8702,17 +10053,21 @@ void QCPAbstractItem::applyDefaultAntialiasingHint( QCPPainter* painter ) const /*! \internal - Finds the shortest squared distance of \a point to the line segment defined by \a start and \a + Finds the shortest squared distance of \a point to the line segment defined by + \a start and \a end. - This function may be used to help with the implementation of the \ref selectTest function for + This function may be used to help with the implementation of the \ref + selectTest function for specific items. \note This function is identical to QCPAbstractPlottable::distSqrToLine \see rectSelectTest */ -double QCPAbstractItem::distSqrToLine( const QPointF& start, const QPointF& end, const QPointF& point ) const +double QCPAbstractItem::distSqrToLine( const QPointF& start, + const QPointF& end, + const QPointF& point ) const { QVector2D a( start ); QVector2D b( end ); @@ -8736,29 +10091,40 @@ double QCPAbstractItem::distSqrToLine( const QPointF& start, const QPointF& end, /*! \internal - A convenience function which returns the selectTest value for a specified \a rect and a specified - click position \a pos. \a filledRect defines whether a click inside the rect should also be + A convenience function which returns the selectTest value for a specified \a + rect and a specified + click position \a pos. \a filledRect defines whether a click inside the rect + should also be considered a hit or whether only the rect border is sensitive to hits. - This function may be used to help with the implementation of the \ref selectTest function for + This function may be used to help with the implementation of the \ref + selectTest function for specific items. - For example, if your item consists of four rects, call this function four times, once for each - rect, in your \ref selectTest reimplementation. Finally, return the minimum of all four returned - values which were greater or equal to zero. (Because this function may return -1.0 when \a pos - doesn't hit \a rect at all). If all calls returned -1.0, return -1.0, too, because your item + For example, if your item consists of four rects, call this function four + times, once for each + rect, in your \ref selectTest reimplementation. Finally, return the minimum of + all four returned + values which were greater or equal to zero. (Because this function may return + -1.0 when \a pos + doesn't hit \a rect at all). If all calls returned -1.0, return -1.0, too, + because your item wasn't hit. \see distSqrToLine */ -double QCPAbstractItem::rectSelectTest( const QRectF& rect, const QPointF& pos, bool filledRect ) const +double QCPAbstractItem::rectSelectTest( const QRectF& rect, + const QPointF& pos, + bool filledRect ) const { double result = -1; // distance to border: QList lines; - lines << QLineF( rect.topLeft(), rect.topRight() ) << QLineF( rect.bottomLeft(), rect.bottomRight() ) - << QLineF( rect.topLeft(), rect.bottomLeft() ) << QLineF( rect.topRight(), rect.bottomRight() ); + lines << QLineF( rect.topLeft(), rect.topRight() ) + << QLineF( rect.bottomLeft(), rect.bottomRight() ) + << QLineF( rect.topLeft(), rect.bottomLeft() ) + << QLineF( rect.topRight(), rect.bottomRight() ); double minDistSqr = std::numeric_limits::max(); for( int i = 0; i < lines.size(); ++i ) { @@ -8779,31 +10145,40 @@ double QCPAbstractItem::rectSelectTest( const QRectF& rect, const QPointF& pos, /*! \internal - Returns the pixel position of the anchor with Id \a anchorId. This function must be reimplemented in + Returns the pixel position of the anchor with Id \a anchorId. This function + must be reimplemented in item subclasses if they want to provide anchors (QCPItemAnchor). - For example, if the item has two anchors with id 0 and 1, this function takes one of these anchor + For example, if the item has two anchors with id 0 and 1, this function takes + one of these anchor ids and returns the respective pixel points of the specified anchor. \see createAnchor */ QPointF QCPAbstractItem::anchorPixelPoint( int anchorId ) const { - qDebug() << Q_FUNC_INFO << "called on item which shouldn't have any anchors (this method not reimplemented). anchorId" + qDebug() << Q_FUNC_INFO << "called on item which shouldn't have any anchors " + "(this method not reimplemented). anchorId" << anchorId; return QPointF(); } /*! \internal - Creates a QCPItemPosition, registers it with this item and returns a pointer to it. The specified - \a name must be a unique string that is usually identical to the variable name of the position - member (This is needed to provide the name-based \ref position access to positions). + Creates a QCPItemPosition, registers it with this item and returns a pointer + to it. The specified + \a name must be a unique string that is usually identical to the variable name + of the position + member (This is needed to provide the name-based \ref position access to + positions). - Don't delete positions created by this function manually, as the item will take care of it. + Don't delete positions created by this function manually, as the item will + take care of it. - Use this function in the constructor (initialization list) of the specific item subclass to - create each position member. Don't create QCPItemPositions with \b new yourself, because they + Use this function in the constructor (initialization list) of the specific + item subclass to + create each position member. Don't create QCPItemPositions with \b new + yourself, because they won't be registered with the item properly. \see createAnchor @@ -8825,19 +10200,28 @@ QCPItemPosition* QCPAbstractItem::createPosition( const QString& name ) /*! \internal - Creates a QCPItemAnchor, registers it with this item and returns a pointer to it. The specified - \a name must be a unique string that is usually identical to the variable name of the anchor - member (This is needed to provide the name based \ref anchor access to anchors). + Creates a QCPItemAnchor, registers it with this item and returns a pointer to + it. The specified + \a name must be a unique string that is usually identical to the variable name + of the anchor + member (This is needed to provide the name based \ref anchor access to + anchors). - The \a anchorId must be a number identifying the created anchor. It is recommended to create an - enum (e.g. "AnchorIndex") for this on each item that uses anchors. This id is used by the anchor - to identify itself when it calls QCPAbstractItem::anchorPixelPoint. That function then returns + The \a anchorId must be a number identifying the created anchor. It is + recommended to create an + enum (e.g. "AnchorIndex") for this on each item that uses anchors. This id is + used by the anchor + to identify itself when it calls QCPAbstractItem::anchorPixelPoint. That + function then returns the correct pixel coordinates for the passed anchor id. - Don't delete anchors created by this function manually, as the item will take care of it. + Don't delete anchors created by this function manually, as the item will take + care of it. - Use this function in the constructor (initialization list) of the specific item subclass to - create each anchor member. Don't create QCPItemAnchors with \b new yourself, because then they + Use this function in the constructor (initialization list) of the specific + item subclass to + create each anchor member. Don't create QCPItemAnchors with \b new yourself, + because then they won't be registered with the item properly. \see createPosition @@ -8892,89 +10276,130 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const \image html qcp-doc-logo.png - Below is a brief overview of and guide to the classes and their relations. If you are new to - QCustomPlot and just want to start using it, it's recommended to look at the tutorials and + Below is a brief overview of and guide to the classes and their relations. If + you are new to + QCustomPlot and just want to start using it, it's recommended to look at the + tutorials and examples at http://www.qcustomplot.com/ - This documentation is especially helpful as a reference, when you're familiar with the basic - concept of how to use %QCustomPlot and you wish to learn more about specific functionality. - See the \ref classoverview "class overview" for diagrams explaining the relationships between + This documentation is especially helpful as a reference, when you're familiar + with the basic + concept of how to use %QCustomPlot and you wish to learn more about specific + functionality. + See the \ref classoverview "class overview" for diagrams explaining the + relationships between the most important classes of the QCustomPlot library. - The central widget which displays the plottables and axes on its surface is QCustomPlot. Every - QCustomPlot contains four axes by default. They can be accessed via the members \ref - QCustomPlot::xAxis "xAxis", \ref QCustomPlot::yAxis "yAxis", \ref QCustomPlot::xAxis2 "xAxis2" - and \ref QCustomPlot::yAxis2 "yAxis2", and are of type QCPAxis. QCustomPlot supports an arbitrary - number of axes and axis rects, see the documentation of QCPAxisRect for details. + The central widget which displays the plottables and axes on its surface is + QCustomPlot. Every + QCustomPlot contains four axes by default. They can be accessed via the + members \ref + QCustomPlot::xAxis "xAxis", \ref QCustomPlot::yAxis "yAxis", \ref + QCustomPlot::xAxis2 "xAxis2" + and \ref QCustomPlot::yAxis2 "yAxis2", and are of type QCPAxis. QCustomPlot + supports an arbitrary + number of axes and axis rects, see the documentation of QCPAxisRect for + details. \section mainpage-plottables Plottables - \a Plottables are classes that display any kind of data inside the QCustomPlot. They all derive - from QCPAbstractPlottable. For example, the QCPGraph class is a plottable that displays a graph + \a Plottables are classes that display any kind of data inside the + QCustomPlot. They all derive + from QCPAbstractPlottable. For example, the QCPGraph class is a plottable that + displays a graph inside the plot with different line styles, scatter styles, filling etc. - Since plotting graphs is such a dominant use case, QCustomPlot has a special interface for working + Since plotting graphs is such a dominant use case, QCustomPlot has a special + interface for working with QCPGraph plottables, that makes it very easy to handle them:\n - You create a new graph with QCustomPlot::addGraph and access them with QCustomPlot::graph. + You create a new graph with QCustomPlot::addGraph and access them with + QCustomPlot::graph. For all other plottables, you need to use the normal plottable interface:\n First, you create an instance of the plottable you want, e.g. \code - QCPCurve *newCurve = new QCPCurve(customPlot->xAxis, customPlot->yAxis);\endcode + QCPCurve *newCurve = new QCPCurve(customPlot->xAxis, + customPlot->yAxis);\endcode add it to the customPlot: \code customPlot->addPlottable(newCurve);\endcode - and then modify the properties of the newly created plottable via the newCurve pointer. + and then modify the properties of the newly created plottable via the + newCurve pointer. - Plottables (including graphs) can be retrieved via QCustomPlot::plottable. Since the return type - of that function is the abstract base class of all plottables, QCPAbstractPlottable, you will - probably want to qobject_cast the returned pointer to the respective plottable subclass. (As - usual, if the cast returns zero, the plottable wasn't of that specific subclass.) + Plottables (including graphs) can be retrieved via QCustomPlot::plottable. + Since the return type + of that function is the abstract base class of all plottables, + QCPAbstractPlottable, you will + probably want to qobject_cast the returned pointer to the respective plottable + subclass. (As + usual, if the cast returns zero, the plottable wasn't of that specific + subclass.) - All further interfacing with plottables (e.g how to set data) is specific to the plottable type. - See the documentations of the subclasses: QCPGraph, QCPCurve, QCPBars, QCPStatisticalBox, + All further interfacing with plottables (e.g how to set data) is specific to + the plottable type. + See the documentations of the subclasses: QCPGraph, QCPCurve, QCPBars, + QCPStatisticalBox, QCPColorMap. \section mainpage-axes Controlling the Axes - As mentioned, QCustomPlot has four axes by default: \a xAxis (bottom), \a yAxis (left), \a xAxis2 + As mentioned, QCustomPlot has four axes by default: \a xAxis (bottom), \a + yAxis (left), \a xAxis2 (top), \a yAxis2 (right). - Their range is handled by the simple QCPRange class. You can set the range with the - QCPAxis::setRange function. By default, the axes represent a linear scale. To set a logarithmic - scale, set \ref QCPAxis::setScaleType to \ref QCPAxis::stLogarithmic. The logarithm base can be set freely + Their range is handled by the simple QCPRange class. You can set the range + with the + QCPAxis::setRange function. By default, the axes represent a linear scale. To + set a logarithmic + scale, set \ref QCPAxis::setScaleType to \ref QCPAxis::stLogarithmic. The + logarithm base can be set freely with \ref QCPAxis::setScaleLogBase. - By default, an axis automatically creates and labels ticks in a sensible manner. See the - following functions for tick manipulation:\n QCPAxis::setTicks, QCPAxis::setAutoTicks, + By default, an axis automatically creates and labels ticks in a sensible + manner. See the + following functions for tick manipulation:\n QCPAxis::setTicks, + QCPAxis::setAutoTicks, QCPAxis::setAutoTickCount, QCPAxis::setAutoTickStep, QCPAxis::setTickLabels, - QCPAxis::setTickLabelType, QCPAxis::setTickLabelRotation, QCPAxis::setTickStep, + QCPAxis::setTickLabelType, QCPAxis::setTickLabelRotation, + QCPAxis::setTickStep, QCPAxis::setTickLength,... - Each axis can be given an axis label (e.g. "Voltage (mV)") with QCPAxis::setLabel. + Each axis can be given an axis label (e.g. "Voltage (mV)") with + QCPAxis::setLabel. - The distance of an axis backbone to the respective viewport border is called its margin. + The distance of an axis backbone to the respective viewport border is called + its margin. Normally, the margins are calculated automatically. To change this, set - \ref QCPAxisRect::setAutoMargins to exclude the respective margin sides, set the margins manually with - \ref QCPAxisRect::setMargins. The main axis rect can be reached with \ref QCustomPlot::axisRect(). + \ref QCPAxisRect::setAutoMargins to exclude the respective margin sides, set + the margins manually with + \ref QCPAxisRect::setMargins. The main axis rect can be reached with \ref + QCustomPlot::axisRect(). \section mainpage-legend Plot Legend - Every QCustomPlot has one QCPLegend (as \ref QCustomPlot::legend) by default. A legend is a small - layout element inside the plot which lists the plottables with an icon of the plottable - line/symbol and a name (QCPAbstractPlottable::setName). Plottables can be added and removed from + Every QCustomPlot has one QCPLegend (as \ref QCustomPlot::legend) by default. + A legend is a small + layout element inside the plot which lists the plottables with an icon of the + plottable + line/symbol and a name (QCPAbstractPlottable::setName). Plottables can be + added and removed from the main legend via \ref QCPAbstractPlottable::addToLegend and \ref - QCPAbstractPlottable::removeFromLegend. By default, adding a plottable to QCustomPlot - automatically adds it to the legend, too. This behaviour can be modified with the + QCPAbstractPlottable::removeFromLegend. By default, adding a plottable to + QCustomPlot + automatically adds it to the legend, too. This behaviour can be modified with + the QCustomPlot::setAutoAddPlottableToLegend property. - The QCPLegend provides an interface to access, add and remove legend items directly, too. See - QCPLegend::item, QCPLegend::itemWithPlottable, QCPLegend::addItem, QCPLegend::removeItem for + The QCPLegend provides an interface to access, add and remove legend items + directly, too. See + QCPLegend::item, QCPLegend::itemWithPlottable, QCPLegend::addItem, + QCPLegend::removeItem for example. - Multiple legends are supported via the \link thelayoutsystem layout system\endlink (as a + Multiple legends are supported via the \link thelayoutsystem layout + system\endlink (as a QCPLegend simply is a normal layout element). \section mainpage-userinteraction User Interactions @@ -8983,84 +10408,129 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const QCPAxisRect::setRangeDrag), zooming axis ranges with the mouse wheel (\ref QCPAxisRect::setRangeZoom) and a complete selection mechanism. - The availability of these interactions is controlled with \ref QCustomPlot::setInteractions. For + The availability of these interactions is controlled with \ref + QCustomPlot::setInteractions. For details about the interaction system, see the documentation there. - Further, QCustomPlot always emits corresponding signals, when objects are clicked or - doubleClicked. See \ref QCustomPlot::plottableClick, \ref QCustomPlot::plottableDoubleClick + Further, QCustomPlot always emits corresponding signals, when objects are + clicked or + doubleClicked. See \ref QCustomPlot::plottableClick, \ref + QCustomPlot::plottableDoubleClick and \ref QCustomPlot::axisClick for example. \section mainpage-items Items - Apart from plottables there is another category of plot objects that are important: Items. The - base class of all items is QCPAbstractItem. An item sets itself apart from plottables in that - it's not necessarily bound to any axes. This means it may also be positioned in absolute pixel - coordinates or placed at a relative position on an axis rect. Further, it usually doesn't + Apart from plottables there is another category of plot objects that are + important: Items. The + base class of all items is QCPAbstractItem. An item sets itself apart from + plottables in that + it's not necessarily bound to any axes. This means it may also be positioned + in absolute pixel + coordinates or placed at a relative position on an axis rect. Further, it + usually doesn't represent data directly, but acts as decoration, emphasis, description etc. - Multiple items can be arranged in a parent-child-hierarchy allowing for dynamical behaviour. For - example, you could place the head of an arrow at a fixed plot coordinate, so it always points to - some important area in the plot. The tail of the arrow can be anchored to a text item which - always resides in the top center of the axis rect, independent of where the user drags the axis - ranges. This way the arrow stretches and turns so it always points from the label to the + Multiple items can be arranged in a parent-child-hierarchy allowing for + dynamical behaviour. For + example, you could place the head of an arrow at a fixed plot coordinate, so + it always points to + some important area in the plot. The tail of the arrow can be anchored to a + text item which + always resides in the top center of the axis rect, independent of where the + user drags the axis + ranges. This way the arrow stretches and turns so it always points from the + label to the specified plot coordinate, without any further code necessary. - For a more detailed introduction, see the QCPAbstractItem documentation, and from there the + For a more detailed introduction, see the QCPAbstractItem documentation, and + from there the documentations of the individual built-in items, to find out how to use them. \section mainpage-layoutelements Layout elements and layouts - QCustomPlot uses an internal layout system to provide dynamic sizing and positioning of objects like - the axis rect(s), legends and the plot title. They are all based on \ref QCPLayoutElement and are arranged by + QCustomPlot uses an internal layout system to provide dynamic sizing and + positioning of objects like + the axis rect(s), legends and the plot title. They are all based on \ref + QCPLayoutElement and are arranged by placing them inside a \ref QCPLayout. - Details on this topic are given on the dedicated page about \link thelayoutsystem the layout system\endlink. + Details on this topic are given on the dedicated page about \link + thelayoutsystem the layout system\endlink. \section mainpage-performancetweaks Performance Tweaks - Although QCustomPlot is quite fast, some features like translucent fills, antialiasing and thick - lines can cause a significant slow down. If you notice this in your application, here are some - thoughts on how to increase performance. By far the most time is spent in the drawing functions, - specifically the drawing of graphs. For maximum performance, consider the following (most + Although QCustomPlot is quite fast, some features like translucent fills, + antialiasing and thick + lines can cause a significant slow down. If you notice this in your + application, here are some + thoughts on how to increase performance. By far the most time is spent in the + drawing functions, + specifically the drawing of graphs. For maximum performance, consider the + following (most recommended/effective measures first): - \li use Qt 4.8.0 and up. Performance has doubled or tripled with respect to Qt 4.7.4. However - QPainter was broken and drawing pixel precise things, e.g. scatters, isn't possible with Qt >= - 4.8.0. So it's a performance vs. plot quality tradeoff when switching to Qt 4.8. - \li To increase responsiveness during dragging, consider setting \ref QCustomPlot::setNoAntialiasingOnDrag to true. - \li On X11 (GNU/Linux), avoid the slow native drawing system, use raster by supplying - "-graphicssystem raster" as command line argument or calling QApplication::setGraphicsSystem("raster") - before creating the QApplication object. (Only available for Qt versions before 5.0) - \li On all operating systems, use OpenGL hardware acceleration by supplying "-graphicssystem - opengl" as command line argument or calling QApplication::setGraphicsSystem("opengl") (Only - available for Qt versions before 5.0). If OpenGL is available, this will slightly decrease the - quality of antialiasing, but extremely increase performance especially with alpha - (semi-transparent) fills, much antialiasing and a large QCustomPlot drawing surface. Note - however, that the maximum frame rate might be constrained by the vertical sync frequency of your - monitor (VSync can be disabled in the graphics card driver configuration). So for simple plots - (where the potential framerate is far above 60 frames per second), OpenGL acceleration might - achieve numerically lower frame rates than the other graphics systems, because they are not + \li use Qt 4.8.0 and up. Performance has doubled or tripled with respect to Qt + 4.7.4. However + QPainter was broken and drawing pixel precise things, e.g. scatters, isn't + possible with Qt >= + 4.8.0. So it's a performance vs. plot quality tradeoff when switching to Qt + 4.8. + \li To increase responsiveness during dragging, consider setting \ref + QCustomPlot::setNoAntialiasingOnDrag to true. + \li On X11 (GNU/Linux), avoid the slow native drawing system, use raster by + supplying + "-graphicssystem raster" as command line argument or calling + QApplication::setGraphicsSystem("raster") + before creating the QApplication object. (Only available for Qt versions + before 5.0) + \li On all operating systems, use OpenGL hardware acceleration by supplying + "-graphicssystem + opengl" as command line argument or calling + QApplication::setGraphicsSystem("opengl") (Only + available for Qt versions before 5.0). If OpenGL is available, this will + slightly decrease the + quality of antialiasing, but extremely increase performance especially with + alpha + (semi-transparent) fills, much antialiasing and a large QCustomPlot drawing + surface. Note + however, that the maximum frame rate might be constrained by the vertical sync + frequency of your + monitor (VSync can be disabled in the graphics card driver configuration). So + for simple plots + (where the potential framerate is far above 60 frames per second), OpenGL + acceleration might + achieve numerically lower frame rates than the other graphics systems, because + they are not capped at the VSync frequency. \li Avoid any kind of alpha (transparency), especially in fills \li Avoid lines with a pen width greater than one - \li Avoid any kind of antialiasing, especially in graph lines (see \ref QCustomPlot::setNotAntialiasedElements) - \li Avoid repeatedly setting the complete data set with \ref QCPGraph::setData. Use \ref QCPGraph::addData instead, if + \li Avoid any kind of antialiasing, especially in graph lines (see \ref + QCustomPlot::setNotAntialiasedElements) + \li Avoid repeatedly setting the complete data set with \ref + QCPGraph::setData. Use \ref QCPGraph::addData instead, if most data points stay unchanged, e.g. in a running measurement. - \li Set the \a copy parameter of the setData functions to false, so only pointers get - transferred. (Relevant only if preparing data maps with a large number of points, i.e. over 10000) + \li Set the \a copy parameter of the setData functions to false, so only + pointers get + transferred. (Relevant only if preparing data maps with a large number of + points, i.e. over 10000) \section mainpage-flags Preprocessor Define Flags - QCustomPlot understands some preprocessor defines that are useful for debugging and compilation: + QCustomPlot understands some preprocessor defines that are useful for + debugging and compilation:
    \c QCUSTOMPLOT_COMPILE_LIBRARY -
    Define this flag when you compile QCustomPlot as a shared library (.so/.dll) +
    Define this flag when you compile QCustomPlot as a shared library + (.so/.dll)
    \c QCUSTOMPLOT_USE_LIBRARY -
    Define this flag before including the header, when using QCustomPlot as a shared library +
    Define this flag before including the header, when using QCustomPlot as a + shared library
    \c QCUSTOMPLOT_CHECK_DATA -
    If this flag is defined, the QCustomPlot plottables will perform data validity checks on every redraw. - This means they will give qDebug output when you plot \e inf or \e nan values, they will not +
    If this flag is defined, the QCustomPlot plottables will perform data + validity checks on every redraw. + This means they will give qDebug output when you plot \e inf or \e nan + values, they will not fix your data.
    @@ -9068,13 +10538,17 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const /*! \page classoverview Class Overview - The following diagrams may help to gain a deeper understanding of the relationships between classes that make up - the QCustomPlot library. The diagrams are not exhaustive, so only the classes deemed most relevant are shown. + The following diagrams may help to gain a deeper understanding of the + relationships between classes that make up + the QCustomPlot library. The diagrams are not exhaustive, so only the classes + deemed most relevant are shown. \section classoverview-relations Class Relationship Diagram - \image html RelationOverview.png "Overview of most important classes and their relations" + \image html RelationOverview.png "Overview of most important classes and their + relations" \section classoverview-inheritance Class Inheritance Tree - \image html InheritanceOverview.png "Inheritance tree of most important classes" + \image html InheritanceOverview.png "Inheritance tree of most important + classes" */ @@ -9084,7 +10558,8 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const /*! \class QCustomPlot - \brief The central class of the library. This is the QWidget which displays the plot and + \brief The central class of the library. This is the QWidget which displays + the plot and interacts with the user. For tutorials on how to use QCustomPlot, see the website\n @@ -9095,22 +10570,30 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const /*! \fn QRect QCustomPlot::viewport() const - Returns the viewport rect of this QCustomPlot instance. The viewport is the area the plot is - drawn in, all mechanisms, e.g. margin caluclation take the viewport to be the outer border of the - plot. The viewport normally is the rect() of the QCustomPlot widget, i.e. a rect with top left + Returns the viewport rect of this QCustomPlot instance. The viewport is the + area the plot is + drawn in, all mechanisms, e.g. margin caluclation take the viewport to be the + outer border of the + plot. The viewport normally is the rect() of the QCustomPlot widget, i.e. a + rect with top left (0, 0) and size of the QCustomPlot widget. - Don't confuse the viewport with the axis rect (QCustomPlot::axisRect). An axis rect is typically - an area enclosed by four axes, where the graphs/plottables are drawn in. The viewport is larger - and contains also the axes themselves, their tick numbers, their labels, the plot title etc. + Don't confuse the viewport with the axis rect (QCustomPlot::axisRect). An axis + rect is typically + an area enclosed by four axes, where the graphs/plottables are drawn in. The + viewport is larger + and contains also the axes themselves, their tick numbers, their labels, the + plot title etc. - Only when saving to a file (see \ref savePng, savePdf etc.) the viewport is temporarily modified + Only when saving to a file (see \ref savePng, savePdf etc.) the viewport is + temporarily modified to allow saving plots with sizes independent of the current widget size. */ /*! \fn QCPLayoutGrid *QCustomPlot::plotLayout() const - Returns the top level layout of this QCustomPlot instance. It is a \ref QCPLayoutGrid, initially containing just + Returns the top level layout of this QCustomPlot instance. It is a \ref + QCPLayoutGrid, initially containing just one cell with the main QCPAxisRect inside. */ @@ -9119,15 +10602,18 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const /*! \fn void QCustomPlot::mouseDoubleClick(QMouseEvent *event) - This signal is emitted when the QCustomPlot receives a mouse double click event. + This signal is emitted when the QCustomPlot receives a mouse double click + event. */ /*! \fn void QCustomPlot::mousePress(QMouseEvent *event) This signal is emitted when the QCustomPlot receives a mouse press event. - It is emitted before QCustomPlot handles any other mechanism like range dragging. So a slot - connected to this signal can still influence the behaviour e.g. with \ref QCPAxisRect::setRangeDrag or \ref + It is emitted before QCustomPlot handles any other mechanism like range + dragging. So a slot + connected to this signal can still influence the behaviour e.g. with \ref + QCPAxisRect::setRangeDrag or \ref QCPAxisRect::setRangeDragAxes. */ @@ -9135,13 +10621,18 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const This signal is emitted when the QCustomPlot receives a mouse move event. - It is emitted before QCustomPlot handles any other mechanism like range dragging. So a slot - connected to this signal can still influence the behaviour e.g. with \ref QCPAxisRect::setRangeDrag or \ref + It is emitted before QCustomPlot handles any other mechanism like range + dragging. So a slot + connected to this signal can still influence the behaviour e.g. with \ref + QCPAxisRect::setRangeDrag or \ref QCPAxisRect::setRangeDragAxes. - \warning It is discouraged to change the drag-axes with \ref QCPAxisRect::setRangeDragAxes here, - because the dragging starting point was saved the moment the mouse was pressed. Thus it only has - a meaning for the range drag axes that were set at that moment. If you want to change the drag + \warning It is discouraged to change the drag-axes with \ref + QCPAxisRect::setRangeDragAxes here, + because the dragging starting point was saved the moment the mouse was + pressed. Thus it only has + a meaning for the range drag axes that were set at that moment. If you want to + change the drag axes, consider doing this in the \ref mousePress signal instead. */ @@ -9149,8 +10640,10 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const This signal is emitted when the QCustomPlot receives a mouse release event. - It is emitted before QCustomPlot handles any other mechanisms like object selection. So a - slot connected to this signal can still influence the behaviour e.g. with \ref setInteractions or + It is emitted before QCustomPlot handles any other mechanisms like object + selection. So a + slot connected to this signal can still influence the behaviour e.g. with \ref + setInteractions or \ref QCPAbstractPlottable::setSelectable. */ @@ -9158,26 +10651,32 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const This signal is emitted when the QCustomPlot receives a mouse wheel event. - It is emitted before QCustomPlot handles any other mechanisms like range zooming. So a slot - connected to this signal can still influence the behaviour e.g. with \ref QCPAxisRect::setRangeZoom, \ref + It is emitted before QCustomPlot handles any other mechanisms like range + zooming. So a slot + connected to this signal can still influence the behaviour e.g. with \ref + QCPAxisRect::setRangeZoom, \ref QCPAxisRect::setRangeZoomAxes or \ref QCPAxisRect::setRangeZoomFactor. */ -/*! \fn void QCustomPlot::plottableClick(QCPAbstractPlottable *plottable, QMouseEvent *event) +/*! \fn void QCustomPlot::plottableClick(QCPAbstractPlottable *plottable, + QMouseEvent *event) This signal is emitted when a plottable is clicked. - \a event is the mouse event that caused the click and \a plottable is the plottable that received + \a event is the mouse event that caused the click and \a plottable is the + plottable that received the click. \see plottableDoubleClick */ -/*! \fn void QCustomPlot::plottableDoubleClick(QCPAbstractPlottable *plottable, QMouseEvent *event) +/*! \fn void QCustomPlot::plottableDoubleClick(QCPAbstractPlottable *plottable, + QMouseEvent *event) This signal is emitted when a plottable is double clicked. - \a event is the mouse event that caused the click and \a plottable is the plottable that received + \a event is the mouse event that caused the click and \a plottable is the + plottable that received the click. \see plottableClick @@ -9187,61 +10686,76 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const This signal is emitted when an item is clicked. - \a event is the mouse event that caused the click and \a item is the item that received the + \a event is the mouse event that caused the click and \a item is the item that + received the click. \see itemDoubleClick */ -/*! \fn void QCustomPlot::itemDoubleClick(QCPAbstractItem *item, QMouseEvent *event) +/*! \fn void QCustomPlot::itemDoubleClick(QCPAbstractItem *item, QMouseEvent + *event) This signal is emitted when an item is double clicked. - \a event is the mouse event that caused the click and \a item is the item that received the + \a event is the mouse event that caused the click and \a item is the item that + received the click. \see itemClick */ -/*! \fn void QCustomPlot::axisClick(QCPAxis *axis, QCPAxis::SelectablePart part, QMouseEvent *event) +/*! \fn void QCustomPlot::axisClick(QCPAxis *axis, QCPAxis::SelectablePart part, + QMouseEvent *event) This signal is emitted when an axis is clicked. - \a event is the mouse event that caused the click, \a axis is the axis that received the click and + \a event is the mouse event that caused the click, \a axis is the axis that + received the click and \a part indicates the part of the axis that was clicked. \see axisDoubleClick */ -/*! \fn void QCustomPlot::axisDoubleClick(QCPAxis *axis, QCPAxis::SelectablePart part, QMouseEvent *event) +/*! \fn void QCustomPlot::axisDoubleClick(QCPAxis *axis, QCPAxis::SelectablePart + part, QMouseEvent *event) This signal is emitted when an axis is double clicked. - \a event is the mouse event that caused the click, \a axis is the axis that received the click and + \a event is the mouse event that caused the click, \a axis is the axis that + received the click and \a part indicates the part of the axis that was clicked. \see axisClick */ -/*! \fn void QCustomPlot::legendClick(QCPLegend *legend, QCPAbstractLegendItem *item, QMouseEvent *event) +/*! \fn void QCustomPlot::legendClick(QCPLegend *legend, QCPAbstractLegendItem + *item, QMouseEvent *event) This signal is emitted when a legend (item) is clicked. - \a event is the mouse event that caused the click, \a legend is the legend that received the - click and \a item is the legend item that received the click. If only the legend and no item is - clicked, \a item is 0. This happens for a click inside the legend padding or the space between + \a event is the mouse event that caused the click, \a legend is the legend + that received the + click and \a item is the legend item that received the click. If only the + legend and no item is + clicked, \a item is 0. This happens for a click inside the legend padding or + the space between two items. \see legendDoubleClick */ -/*! \fn void QCustomPlot::legendDoubleClick(QCPLegend *legend, QCPAbstractLegendItem *item, QMouseEvent *event) +/*! \fn void QCustomPlot::legendDoubleClick(QCPLegend *legend, + QCPAbstractLegendItem *item, QMouseEvent *event) This signal is emitted when a legend (item) is double clicked. - \a event is the mouse event that caused the click, \a legend is the legend that received the - click and \a item is the legend item that received the click. If only the legend and no item is - clicked, \a item is 0. This happens for a click inside the legend padding or the space between + \a event is the mouse event that caused the click, \a legend is the legend + that received the + click and \a item is the legend item that received the click. If only the + legend and no item is + clicked, \a item is 0. This happens for a click inside the legend padding or + the space between two items. \see legendClick @@ -9251,17 +10765,20 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const This signal is emitted when a plot title is clicked. - \a event is the mouse event that caused the click and \a title is the plot title that received + \a event is the mouse event that caused the click and \a title is the plot + title that received the click. \see titleDoubleClick */ -/*! \fn void QCustomPlot::titleDoubleClick(QMouseEvent *event, QCPPlotTitle *title) +/*! \fn void QCustomPlot::titleDoubleClick(QMouseEvent *event, QCPPlotTitle + *title) This signal is emitted when a plot title is double clicked. - \a event is the mouse event that caused the click and \a title is the plot title that received + \a event is the mouse event that caused the click and \a title is the plot + title that received the click. \see titleClick @@ -9269,25 +10786,33 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const /*! \fn void QCustomPlot::selectionChangedByUser() - This signal is emitted after the user has changed the selection in the QCustomPlot, e.g. by - clicking. It is not emitted when the selection state of an object has changed programmatically by + This signal is emitted after the user has changed the selection in the + QCustomPlot, e.g. by + clicking. It is not emitted when the selection state of an object has changed + programmatically by a direct call to setSelected() on an object or by calling \ref deselectAll. - In addition to this signal, selectable objects also provide individual signals, for example - QCPAxis::selectionChanged or QCPAbstractPlottable::selectionChanged. Note that those signals are + In addition to this signal, selectable objects also provide individual + signals, for example + QCPAxis::selectionChanged or QCPAbstractPlottable::selectionChanged. Note that + those signals are emitted even if the selection state is changed programmatically. - See the documentation of \ref setInteractions for details about the selection mechanism. + See the documentation of \ref setInteractions for details about the selection + mechanism. - \see selectedPlottables, selectedGraphs, selectedItems, selectedAxes, selectedLegends + \see selectedPlottables, selectedGraphs, selectedItems, selectedAxes, + selectedLegends */ /*! \fn void QCustomPlot::beforeReplot() - This signal is emitted immediately before a replot takes place (caused by a call to the slot \ref + This signal is emitted immediately before a replot takes place (caused by a + call to the slot \ref replot). - It is safe to mutually connect the replot slot with this signal on two QCustomPlots to make them + It is safe to mutually connect the replot slot with this signal on two + QCustomPlots to make them replot synchronously, it won't cause an infinite recursion. \see replot, afterReplot @@ -9295,10 +10820,12 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const /*! \fn void QCustomPlot::afterReplot() - This signal is emitted immediately after a replot has taken place (caused by a call to the slot \ref + This signal is emitted immediately after a replot has taken place (caused by a + call to the slot \ref replot). - It is safe to mutually connect the replot slot with this signal on two QCustomPlots to make them + It is safe to mutually connect the replot slot with this signal on two + QCustomPlots to make them replot synchronously, it won't cause an infinite recursion. \see replot, beforeReplot @@ -9311,12 +10838,18 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const A pointer to the primary x Axis (bottom) of the main axis rect of the plot. - QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, \ref xAxis2, \ref - yAxis2) and the \ref legend. They make it very easy working with plots that only have a single - axis rect and at most one axis at each axis rect side. If you use \link thelayoutsystem the - layout system\endlink to add multiple axis rects or multiple axes to one side, use the \ref - QCPAxisRect::axis interface to access the new axes. If one of the four default axes or the - default legend is removed due to manipulation of the layout system (e.g. by removing the main + QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, + \ref xAxis2, \ref + yAxis2) and the \ref legend. They make it very easy working with plots that + only have a single + axis rect and at most one axis at each axis rect side. If you use \link + thelayoutsystem the + layout system\endlink to add multiple axis rects or multiple axes to one side, + use the \ref + QCPAxisRect::axis interface to access the new axes. If one of the four default + axes or the + default legend is removed due to manipulation of the layout system (e.g. by + removing the main axis rect), the corresponding pointers become 0. */ @@ -9324,57 +10857,85 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const A pointer to the primary y Axis (left) of the main axis rect of the plot. - QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, \ref xAxis2, \ref - yAxis2) and the \ref legend. They make it very easy working with plots that only have a single - axis rect and at most one axis at each axis rect side. If you use \link thelayoutsystem the - layout system\endlink to add multiple axis rects or multiple axes to one side, use the \ref - QCPAxisRect::axis interface to access the new axes. If one of the four default axes or the - default legend is removed due to manipulation of the layout system (e.g. by removing the main + QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, + \ref xAxis2, \ref + yAxis2) and the \ref legend. They make it very easy working with plots that + only have a single + axis rect and at most one axis at each axis rect side. If you use \link + thelayoutsystem the + layout system\endlink to add multiple axis rects or multiple axes to one side, + use the \ref + QCPAxisRect::axis interface to access the new axes. If one of the four default + axes or the + default legend is removed due to manipulation of the layout system (e.g. by + removing the main axis rect), the corresponding pointers become 0. */ /*! \var QCPAxis *QCustomPlot::xAxis2 - A pointer to the secondary x Axis (top) of the main axis rect of the plot. Secondary axes are + A pointer to the secondary x Axis (top) of the main axis rect of the plot. + Secondary axes are invisible by default. Use QCPAxis::setVisible to change this (or use \ref QCPAxisRect::setupFullAxesBox). - QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, \ref xAxis2, \ref - yAxis2) and the \ref legend. They make it very easy working with plots that only have a single - axis rect and at most one axis at each axis rect side. If you use \link thelayoutsystem the - layout system\endlink to add multiple axis rects or multiple axes to one side, use the \ref - QCPAxisRect::axis interface to access the new axes. If one of the four default axes or the - default legend is removed due to manipulation of the layout system (e.g. by removing the main + QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, + \ref xAxis2, \ref + yAxis2) and the \ref legend. They make it very easy working with plots that + only have a single + axis rect and at most one axis at each axis rect side. If you use \link + thelayoutsystem the + layout system\endlink to add multiple axis rects or multiple axes to one side, + use the \ref + QCPAxisRect::axis interface to access the new axes. If one of the four default + axes or the + default legend is removed due to manipulation of the layout system (e.g. by + removing the main axis rect), the corresponding pointers become 0. */ /*! \var QCPAxis *QCustomPlot::yAxis2 - A pointer to the secondary y Axis (right) of the main axis rect of the plot. Secondary axes are + A pointer to the secondary y Axis (right) of the main axis rect of the plot. + Secondary axes are invisible by default. Use QCPAxis::setVisible to change this (or use \ref QCPAxisRect::setupFullAxesBox). - QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, \ref xAxis2, \ref - yAxis2) and the \ref legend. They make it very easy working with plots that only have a single - axis rect and at most one axis at each axis rect side. If you use \link thelayoutsystem the - layout system\endlink to add multiple axis rects or multiple axes to one side, use the \ref - QCPAxisRect::axis interface to access the new axes. If one of the four default axes or the - default legend is removed due to manipulation of the layout system (e.g. by removing the main + QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, + \ref xAxis2, \ref + yAxis2) and the \ref legend. They make it very easy working with plots that + only have a single + axis rect and at most one axis at each axis rect side. If you use \link + thelayoutsystem the + layout system\endlink to add multiple axis rects or multiple axes to one side, + use the \ref + QCPAxisRect::axis interface to access the new axes. If one of the four default + axes or the + default legend is removed due to manipulation of the layout system (e.g. by + removing the main axis rect), the corresponding pointers become 0. */ /*! \var QCPLegend *QCustomPlot::legend - A pointer to the default legend of the main axis rect. The legend is invisible by default. Use + A pointer to the default legend of the main axis rect. The legend is invisible + by default. Use QCPLegend::setVisible to change this. - QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, \ref xAxis2, \ref - yAxis2) and the \ref legend. They make it very easy working with plots that only have a single - axis rect and at most one axis at each axis rect side. If you use \link thelayoutsystem the - layout system\endlink to add multiple legends to the plot, use the layout system interface to - access the new legend. For example, legends can be placed inside an axis rect's \ref - QCPAxisRect::insetLayout "inset layout", and must then also be accessed via the inset layout. If - the default legend is removed due to manipulation of the layout system (e.g. by removing the main + QCustomPlot offers convenient pointers to the axes (\ref xAxis, \ref yAxis, + \ref xAxis2, \ref + yAxis2) and the \ref legend. They make it very easy working with plots that + only have a single + axis rect and at most one axis at each axis rect side. If you use \link + thelayoutsystem the + layout system\endlink to add multiple legends to the plot, use the layout + system interface to + access the new legend. For example, legends can be placed inside an axis + rect's \ref + QCPAxisRect::insetLayout "inset layout", and must then also be accessed via + the inset layout. If + the default legend is removed due to manipulation of the layout system (e.g. + by removing the main axis rect), the corresponding pointer becomes 0. */ @@ -9384,28 +10945,28 @@ QCP::Interaction QCPAbstractItem::selectionCategory() const Constructs a QCustomPlot and sets reasonable default values. */ QCustomPlot::QCustomPlot( QWidget* parent ) - : QWidget( parent ), - xAxis( 0 ), - yAxis( 0 ), - xAxis2( 0 ), - yAxis2( 0 ), - legend( 0 ), - mPlotLayout( 0 ), - mAutoAddPlottableToLegend( true ), - mAntialiasedElements( QCP::aeNone ), - mNotAntialiasedElements( QCP::aeNone ), - mInteractions( 0 ), - mSelectionTolerance( 8 ), - mNoAntialiasingOnDrag( false ), - mBackgroundBrush( Qt::white, Qt::SolidPattern ), - mBackgroundScaled( true ), - mBackgroundScaledMode( Qt::KeepAspectRatioByExpanding ), - mCurrentLayer( 0 ), - mPlottingHints( QCP::phCacheLabels | QCP::phForceRepaint ), - mMultiSelectModifier( Qt::ControlModifier ), - mPaintBuffer( size() ), - mMouseEventElement( 0 ), - mReplotting( false ) + : QWidget( parent ) + , xAxis( 0 ) + , yAxis( 0 ) + , xAxis2( 0 ) + , yAxis2( 0 ) + , legend( 0 ) + , mPlotLayout( 0 ) + , mAutoAddPlottableToLegend( true ) + , mAntialiasedElements( QCP::aeNone ) + , mNotAntialiasedElements( QCP::aeNone ) + , mInteractions( 0 ) + , mSelectionTolerance( 8 ) + , mNoAntialiasingOnDrag( false ) + , mBackgroundBrush( Qt::white, Qt::SolidPattern ) + , mBackgroundScaled( true ) + , mBackgroundScaledMode( Qt::KeepAspectRatioByExpanding ) + , mCurrentLayer( 0 ) + , mPlottingHints( QCP::phCacheLabels | QCP::phForceRepaint ) + , mMultiSelectModifier( Qt::ControlModifier ) + , mPaintBuffer( size() ) + , mMouseEventElement( 0 ) + , mReplotting( false ) { setAttribute( Qt::WA_NoMousePropagation ); setAttribute( Qt::WA_OpaquePaintEvent ); @@ -9426,7 +10987,8 @@ QCustomPlot::QCustomPlot( QWidget* parent ) // create initial layout, axis rect and legend: mPlotLayout = new QCPLayoutGrid; mPlotLayout->initializeParentPlot( this ); - mPlotLayout->setParent( this ); // important because if parent is QWidget, QCPLayout::sizeConstraintsChanged will + mPlotLayout->setParent( this ); // important because if parent is QWidget, + // QCPLayout::sizeConstraintsChanged will // call QWidget::updateGeometry mPlotLayout->setLayer( "main" ); QCPAxisRect* defaultAxisRect = new QCPAxisRect( this, true ); @@ -9468,23 +11030,31 @@ QCustomPlot::~QCustomPlot() } mCurrentLayer = 0; - qDeleteAll( mLayers ); // don't use removeLayer, because it would prevent the last layer to be removed + qDeleteAll( mLayers ); // don't use removeLayer, because it would prevent the + // last layer to be removed mLayers.clear(); } /*! - Sets which elements are forcibly drawn antialiased as an \a or combination of QCP::AntialiasedElement. + Sets which elements are forcibly drawn antialiased as an \a or combination of + QCP::AntialiasedElement. - This overrides the antialiasing settings for whole element groups, normally controlled with the - \a setAntialiasing function on the individual elements. If an element is neither specified in - \ref setAntialiasedElements nor in \ref setNotAntialiasedElements, the antialiasing setting on + This overrides the antialiasing settings for whole element groups, normally + controlled with the + \a setAntialiasing function on the individual elements. If an element is + neither specified in + \ref setAntialiasedElements nor in \ref setNotAntialiasedElements, the + antialiasing setting on each individual element instance is used. - For example, if \a antialiasedElements contains \ref QCP::aePlottables, all plottables will be - drawn antialiased, no matter what the specific QCPAbstractPlottable::setAntialiased value was set + For example, if \a antialiasedElements contains \ref QCP::aePlottables, all + plottables will be + drawn antialiased, no matter what the specific + QCPAbstractPlottable::setAntialiased value was set to. - if an element in \a antialiasedElements is already set in \ref setNotAntialiasedElements, it is + if an element in \a antialiasedElements is already set in \ref + setNotAntialiasedElements, it is removed from there. \see setNotAntialiasedElements @@ -9493,13 +11063,15 @@ void QCustomPlot::setAntialiasedElements( const QCP::AntialiasedElements& antial { mAntialiasedElements = antialiasedElements; - // make sure elements aren't in mNotAntialiasedElements and mAntialiasedElements simultaneously: + // make sure elements aren't in mNotAntialiasedElements and + // mAntialiasedElements simultaneously: if( ( mNotAntialiasedElements & mAntialiasedElements ) != 0 ) mNotAntialiasedElements |= ~mAntialiasedElements; } /*! - Sets whether the specified \a antialiasedElement is forcibly drawn antialiased. + Sets whether the specified \a antialiasedElement is forcibly drawn + antialiased. See \ref setAntialiasedElements for details. @@ -9512,59 +11084,73 @@ void QCustomPlot::setAntialiasedElement( QCP::AntialiasedElement antialiasedElem else if( enabled && !mAntialiasedElements.testFlag( antialiasedElement ) ) mAntialiasedElements |= antialiasedElement; - // make sure elements aren't in mNotAntialiasedElements and mAntialiasedElements simultaneously: + // make sure elements aren't in mNotAntialiasedElements and + // mAntialiasedElements simultaneously: if( ( mNotAntialiasedElements & mAntialiasedElements ) != 0 ) mNotAntialiasedElements |= ~mAntialiasedElements; } /*! - Sets which elements are forcibly drawn not antialiased as an \a or combination of + Sets which elements are forcibly drawn not antialiased as an \a or combination + of QCP::AntialiasedElement. - This overrides the antialiasing settings for whole element groups, normally controlled with the - \a setAntialiasing function on the individual elements. If an element is neither specified in - \ref setAntialiasedElements nor in \ref setNotAntialiasedElements, the antialiasing setting on + This overrides the antialiasing settings for whole element groups, normally + controlled with the + \a setAntialiasing function on the individual elements. If an element is + neither specified in + \ref setAntialiasedElements nor in \ref setNotAntialiasedElements, the + antialiasing setting on each individual element instance is used. - For example, if \a notAntialiasedElements contains \ref QCP::aePlottables, no plottables will be - drawn antialiased, no matter what the specific QCPAbstractPlottable::setAntialiased value was set + For example, if \a notAntialiasedElements contains \ref QCP::aePlottables, no + plottables will be + drawn antialiased, no matter what the specific + QCPAbstractPlottable::setAntialiased value was set to. - if an element in \a notAntialiasedElements is already set in \ref setAntialiasedElements, it is + if an element in \a notAntialiasedElements is already set in \ref + setAntialiasedElements, it is removed from there. \see setAntialiasedElements */ -void QCustomPlot::setNotAntialiasedElements( const QCP::AntialiasedElements& notAntialiasedElements ) +void QCustomPlot::setNotAntialiasedElements( + const QCP::AntialiasedElements& notAntialiasedElements ) { mNotAntialiasedElements = notAntialiasedElements; - // make sure elements aren't in mNotAntialiasedElements and mAntialiasedElements simultaneously: + // make sure elements aren't in mNotAntialiasedElements and + // mAntialiasedElements simultaneously: if( ( mNotAntialiasedElements & mAntialiasedElements ) != 0 ) mAntialiasedElements |= ~mNotAntialiasedElements; } /*! - Sets whether the specified \a notAntialiasedElement is forcibly drawn not antialiased. + Sets whether the specified \a notAntialiasedElement is forcibly drawn not + antialiased. See \ref setNotAntialiasedElements for details. \see setAntialiasedElement */ -void QCustomPlot::setNotAntialiasedElement( QCP::AntialiasedElement notAntialiasedElement, bool enabled ) +void QCustomPlot::setNotAntialiasedElement( QCP::AntialiasedElement notAntialiasedElement, + bool enabled ) { if( !enabled && mNotAntialiasedElements.testFlag( notAntialiasedElement ) ) mNotAntialiasedElements &= ~notAntialiasedElement; else if( enabled && !mNotAntialiasedElements.testFlag( notAntialiasedElement ) ) mNotAntialiasedElements |= notAntialiasedElement; - // make sure elements aren't in mNotAntialiasedElements and mAntialiasedElements simultaneously: + // make sure elements aren't in mNotAntialiasedElements and + // mAntialiasedElements simultaneously: if( ( mNotAntialiasedElements & mAntialiasedElements ) != 0 ) mAntialiasedElements |= ~mNotAntialiasedElements; } /*! - If set to true, adding a plottable (e.g. a graph) to the QCustomPlot automatically also adds the + If set to true, adding a plottable (e.g. a graph) to the QCustomPlot + automatically also adds the plottable to the legend (QCustomPlot::legend). \see addPlottable, addGraph, QCPLegend::addItem @@ -9575,55 +11161,86 @@ void QCustomPlot::setAutoAddPlottableToLegend( bool on ) } /*! - Sets the possible interactions of this QCustomPlot as an or-combination of \ref QCP::Interaction + Sets the possible interactions of this QCustomPlot as an or-combination of + \ref QCP::Interaction enums. There are the following types of interactions: - Axis range manipulation is controlled via \ref QCP::iRangeDrag and \ref QCP::iRangeZoom. When the - respective interaction is enabled, the user may drag axes ranges and zoom with the mouse wheel. - For details how to control which axes the user may drag/zoom and in what orientations, see \ref - QCPAxisRect::setRangeDrag, \ref QCPAxisRect::setRangeZoom, \ref QCPAxisRect::setRangeDragAxes, + Axis range manipulation is controlled via \ref QCP::iRangeDrag and \ref + QCP::iRangeZoom. When the + respective interaction is enabled, the user may drag axes ranges and zoom with + the mouse wheel. + For details how to control which axes the user may drag/zoom and in what + orientations, see \ref + QCPAxisRect::setRangeDrag, \ref QCPAxisRect::setRangeZoom, \ref + QCPAxisRect::setRangeDragAxes, \ref QCPAxisRect::setRangeZoomAxes. - Plottable selection is controlled by \ref QCP::iSelectPlottables. If \ref QCP::iSelectPlottables is - set, the user may select plottables (graphs, curves, bars,...) by clicking on them or in their - vicinity (\ref setSelectionTolerance). Whether the user can actually select a plottable can - further be restricted with the \ref QCPAbstractPlottable::setSelectable function on the specific + Plottable selection is controlled by \ref QCP::iSelectPlottables. If + \ref QCP::iSelectPlottables is + set, the user may select plottables (graphs, curves, bars,...) by clicking on + them or in their + vicinity (\ref setSelectionTolerance). Whether the user can actually select a + plottable can + further be restricted with the \ref QCPAbstractPlottable::setSelectable + function on the specific plottable. To find out whether a specific plottable is selected, call - QCPAbstractPlottable::selected(). To retrieve a list of all currently selected plottables, call - \ref selectedPlottables. If you're only interested in QCPGraphs, you may use the convenience + QCPAbstractPlottable::selected(). To retrieve a list of all currently selected + plottables, call + \ref selectedPlottables. If you're only interested in QCPGraphs, you may use + the convenience function \ref selectedGraphs. - Item selection is controlled by \ref QCP::iSelectItems. If \ref QCP::iSelectItems is set, the user - may select items (QCPItemLine, QCPItemText,...) by clicking on them or in their vicinity. To find - out whether a specific item is selected, call QCPAbstractItem::selected(). To retrieve a list of + Item selection is controlled by \ref QCP::iSelectItems. If \ref + QCP::iSelectItems is set, the user + may select items (QCPItemLine, QCPItemText,...) by clicking on them or in + their vicinity. To find + out whether a specific item is selected, call QCPAbstractItem::selected(). To + retrieve a list of all currently selected items, call \ref selectedItems. - Axis selection is controlled with \ref QCP::iSelectAxes. If \ref QCP::iSelectAxes is set, the user - may select parts of the axes by clicking on them. What parts exactly (e.g. Axis base line, tick - labels, axis label) are selectable can be controlled via \ref QCPAxis::setSelectableParts for - each axis. To retrieve a list of all axes that currently contain selected parts, call \ref - selectedAxes. Which parts of an axis are selected, can be retrieved with QCPAxis::selectedParts(). + Axis selection is controlled with \ref QCP::iSelectAxes. If \ref + QCP::iSelectAxes is set, the user + may select parts of the axes by clicking on them. What parts exactly (e.g. + Axis base line, tick + labels, axis label) are selectable can be controlled via \ref + QCPAxis::setSelectableParts for + each axis. To retrieve a list of all axes that currently contain selected + parts, call \ref + selectedAxes. Which parts of an axis are selected, can be retrieved with + QCPAxis::selectedParts(). - Legend selection is controlled with \ref QCP::iSelectLegend. If this is set, the user may - select the legend itself or individual items by clicking on them. What parts exactly are - selectable can be controlled via \ref QCPLegend::setSelectableParts. To find out whether the - legend or any of its child items are selected, check the value of QCPLegend::selectedParts. To + Legend selection is controlled with \ref QCP::iSelectLegend. If this is + set, the user may + select the legend itself or individual items by clicking on them. What parts + exactly are + selectable can be controlled via \ref QCPLegend::setSelectableParts. To find + out whether the + legend or any of its child items are selected, check the value of + QCPLegend::selectedParts. To find out which child items are selected, call \ref QCPLegend::selectedItems. - All other selectable elements The selection of all other selectable objects (e.g. - QCPPlotTitle, or your own layerable subclasses) is controlled with \ref QCP::iSelectOther. If set, the - user may select those objects by clicking on them. To find out which are currently selected, you + All other selectable elements The selection of all other selectable + objects (e.g. + QCPPlotTitle, or your own layerable subclasses) is controlled with \ref + QCP::iSelectOther. If set, the + user may select those objects by clicking on them. To find out which are + currently selected, you need to check their selected state explicitly. - If the selection state has changed by user interaction, the \ref selectionChangedByUser signal is - emitted. Each selectable object additionally emits an individual selectionChanged signal whenever + If the selection state has changed by user interaction, the \ref + selectionChangedByUser signal is + emitted. Each selectable object additionally emits an individual + selectionChanged signal whenever their selection state has changed, i.e. not only by user interaction. - To allow multiple objects to be selected by holding the selection modifier (\ref + To allow multiple objects to be selected by holding the selection modifier + (\ref setMultiSelectModifier), set the flag \ref QCP::iMultiSelect. - \note In addition to the selection mechanism presented here, QCustomPlot always emits - corresponding signals, when an object is clicked or double clicked. see \ref plottableClick and + \note In addition to the selection mechanism presented here, QCustomPlot + always emits + corresponding signals, when an object is clicked or double clicked. see \ref + plottableClick and \ref plottableDoubleClick for example. \see setInteraction, setSelectionTolerance @@ -9649,14 +11266,20 @@ void QCustomPlot::setInteraction( const QCP::Interaction& interaction, bool enab } /*! - Sets the tolerance that is used to decide whether a click selects an object (e.g. a plottable) or + Sets the tolerance that is used to decide whether a click selects an object + (e.g. a plottable) or not. - If the user clicks in the vicinity of the line of e.g. a QCPGraph, it's only regarded as a - potential selection when the minimum distance between the click position and the graph line is - smaller than \a pixels. Objects that are defined by an area (e.g. QCPBars) only react to clicks - directly inside the area and ignore this selection tolerance. In other words, it only has meaning - for parts of objects that are too thin to exactly hit with a click and thus need such a + If the user clicks in the vicinity of the line of e.g. a QCPGraph, it's only + regarded as a + potential selection when the minimum distance between the click position and + the graph line is + smaller than \a pixels. Objects that are defined by an area (e.g. QCPBars) + only react to clicks + directly inside the area and ignore this selection tolerance. In other words, + it only has meaning + for parts of objects that are too thin to exactly hit with a click and thus + need such a tolerance. \see setInteractions, QCPLayerable::selectTest @@ -9667,10 +11290,14 @@ void QCustomPlot::setSelectionTolerance( int pixels ) } /*! - Sets whether antialiasing is disabled for this QCustomPlot while the user is dragging axes - ranges. If many objects, especially plottables, are drawn antialiased, this greatly improves - performance during dragging. Thus it creates a more responsive user experience. As soon as the - user stops dragging, the last replot is done with normal antialiasing, to restore high image + Sets whether antialiasing is disabled for this QCustomPlot while the user is + dragging axes + ranges. If many objects, especially plottables, are drawn antialiased, this + greatly improves + performance during dragging. Thus it creates a more responsive user + experience. As soon as the + user stops dragging, the last replot is done with normal antialiasing, to + restore high image quality. \see setAntialiasedElements, setNotAntialiasedElements @@ -9681,7 +11308,8 @@ void QCustomPlot::setNoAntialiasingOnDrag( bool enabled ) } /*! - Sets the plotting hints for this QCustomPlot instance as an \a or combination of QCP::PlottingHint. + Sets the plotting hints for this QCustomPlot instance as an \a or combination + of QCP::PlottingHint. \see setPlottingHint */ @@ -9710,7 +11338,8 @@ void QCustomPlot::setPlottingHint( QCP::PlottingHint hint, bool enabled ) /*! Sets the keyboard modifier that will be recognized as multi-select-modifier. - If \ref QCP::iMultiSelect is specified in \ref setInteractions, the user may select multiple objects + If \ref QCP::iMultiSelect is specified in \ref setInteractions, the user may + select multiple objects by clicking on them one after the other while holding down \a modifier. By default the multi-select-modifier is set to Qt::ControlModifier. @@ -9723,10 +11352,13 @@ void QCustomPlot::setMultiSelectModifier( Qt::KeyboardModifier modifier ) } /*! - Sets the viewport of this QCustomPlot. The Viewport is the area that the top level layout - (QCustomPlot::plotLayout()) uses as its rect. Normally, the viewport is the entire widget rect. + Sets the viewport of this QCustomPlot. The Viewport is the area that the top + level layout + (QCustomPlot::plotLayout()) uses as its rect. Normally, the viewport is the + entire widget rect. - This function is used to allow arbitrary size exports with \ref toPixmap, \ref savePng, \ref + This function is used to allow arbitrary size exports with \ref toPixmap, \ref + savePng, \ref savePdf, etc. by temporarily changing the viewport size. */ void QCustomPlot::setViewport( const QRect& rect ) @@ -9737,16 +11369,22 @@ void QCustomPlot::setViewport( const QRect& rect ) } /*! - Sets \a pm as the viewport background pixmap (see \ref setViewport). The pixmap is always drawn + Sets \a pm as the viewport background pixmap (see \ref setViewport). The + pixmap is always drawn below all other objects in the plot. - For cases where the provided pixmap doesn't have the same size as the viewport, scaling can be - enabled with \ref setBackgroundScaled and the scaling mode (whether and how the aspect ratio is - preserved) can be set with \ref setBackgroundScaledMode. To set all these options in one call, + For cases where the provided pixmap doesn't have the same size as the + viewport, scaling can be + enabled with \ref setBackgroundScaled and the scaling mode (whether and how + the aspect ratio is + preserved) can be set with \ref setBackgroundScaledMode. To set all these + options in one call, consider using the overloaded version of this function. - If a background brush was set with \ref setBackground(const QBrush &brush), the viewport will - first be filled with that brush, before drawing the background pixmap. This can be useful for + If a background brush was set with \ref setBackground(const QBrush &brush), + the viewport will + first be filled with that brush, before drawing the background pixmap. This + can be useful for background pixmaps with translucent areas. \see setBackgroundScaled, setBackgroundScaledMode @@ -9760,13 +11398,18 @@ void QCustomPlot::setBackground( const QPixmap& pm ) /*! Sets the background brush of the viewport (see \ref setViewport). - Before drawing everything else, the background is filled with \a brush. If a background pixmap - was set with \ref setBackground(const QPixmap &pm), this brush will be used to fill the viewport - before the background pixmap is drawn. This can be useful for background pixmaps with translucent + Before drawing everything else, the background is filled with \a brush. If a + background pixmap + was set with \ref setBackground(const QPixmap &pm), this brush will be used to + fill the viewport + before the background pixmap is drawn. This can be useful for background + pixmaps with translucent areas. - Set \a brush to Qt::NoBrush or Qt::Transparent to leave background transparent. This can be - useful for exporting to image formats which support transparency, e.g. \ref savePng. + Set \a brush to Qt::NoBrush or Qt::Transparent to leave background + transparent. This can be + useful for exporting to image formats which support transparency, e.g. \ref + savePng. \see setBackgroundScaled, setBackgroundScaledMode */ @@ -9777,10 +11420,12 @@ void QCustomPlot::setBackground( const QBrush& brush ) /*! \overload - Allows setting the background pixmap of the viewport, whether it shall be scaled and how it + Allows setting the background pixmap of the viewport, whether it shall be + scaled and how it shall be scaled in one call. - \see setBackground(const QPixmap &pm), setBackgroundScaled, setBackgroundScaledMode + \see setBackground(const QPixmap &pm), setBackgroundScaled, + setBackgroundScaledMode */ void QCustomPlot::setBackground( const QPixmap& pm, bool scaled, Qt::AspectRatioMode mode ) { @@ -9791,12 +11436,16 @@ void QCustomPlot::setBackground( const QPixmap& pm, bool scaled, Qt::AspectRatio } /*! - Sets whether the viewport background pixmap shall be scaled to fit the viewport. If \a scaled is - set to true, control whether and how the aspect ratio of the original pixmap is preserved with + Sets whether the viewport background pixmap shall be scaled to fit the + viewport. If \a scaled is + set to true, control whether and how the aspect ratio of the original pixmap + is preserved with \ref setBackgroundScaledMode. - Note that the scaled version of the original pixmap is buffered, so there is no performance - penalty on replots. (Except when the viewport dimensions are changed continuously.) + Note that the scaled version of the original pixmap is buffered, so there is + no performance + penalty on replots. (Except when the viewport dimensions are changed + continuously.) \see setBackground, setBackgroundScaledMode */ @@ -9806,8 +11455,10 @@ void QCustomPlot::setBackgroundScaled( bool scaled ) } /*! - If scaling of the viewport background pixmap is enabled (\ref setBackgroundScaled), use this - function to define whether and how the aspect ratio of the original pixmap is preserved. + If scaling of the viewport background pixmap is enabled (\ref + setBackgroundScaled), use this + function to define whether and how the aspect ratio of the original pixmap is + preserved. \see setBackground, setBackgroundScaled */ @@ -9819,7 +11470,8 @@ void QCustomPlot::setBackgroundScaledMode( Qt::AspectRatioMode mode ) /*! Returns the plottable with \a index. If the index is invalid, returns 0. - There is an overloaded version of this function with no parameter which returns the last added + There is an overloaded version of this function with no parameter which + returns the last added plottable, see QCustomPlot::plottable() \see plottableCount, addPlottable @@ -9839,7 +11491,8 @@ QCPAbstractPlottable* QCustomPlot::plottable( int index ) /*! \overload - Returns the last plottable that was added with \ref addPlottable. If there are no plottables in + Returns the last plottable that was added with \ref addPlottable. If there are + no plottables in the plot, returns 0. \see plottableCount, addPlottable @@ -9855,11 +11508,15 @@ QCPAbstractPlottable* QCustomPlot::plottable() } /*! - Adds the specified plottable to the plot and, if \ref setAutoAddPlottableToLegend is enabled, to - the legend (QCustomPlot::legend). QCustomPlot takes ownership of the plottable. + Adds the specified plottable to the plot and, if \ref + setAutoAddPlottableToLegend is enabled, to + the legend (QCustomPlot::legend). QCustomPlot takes ownership of the + plottable. - Returns true on success, i.e. when \a plottable isn't already in the plot and the parent plot of - \a plottable is this QCustomPlot (the latter is controlled by what axes were passed in the + Returns true on success, i.e. when \a plottable isn't already in the plot and + the parent plot of + \a plottable is this QCustomPlot (the latter is controlled by what axes were + passed in the plottable's constructor). \see plottable, plottableCount, removePlottable, clearPlottables @@ -9868,14 +11525,14 @@ bool QCustomPlot::addPlottable( QCPAbstractPlottable* plottable ) { if( mPlottables.contains( plottable ) ) { - qDebug() << Q_FUNC_INFO - << "plottable already added to this QCustomPlot:" << reinterpret_cast( plottable ); + qDebug() << Q_FUNC_INFO << "plottable already added to this QCustomPlot:" + << reinterpret_cast( plottable ); return false; } if( plottable->parentPlot() != this ) { - qDebug() << Q_FUNC_INFO - << "plottable not created with this QCustomPlot as parent:" << reinterpret_cast( plottable ); + qDebug() << Q_FUNC_INFO << "plottable not created with this QCustomPlot as parent:" + << reinterpret_cast( plottable ); return false; } @@ -9886,14 +11543,16 @@ bool QCustomPlot::addPlottable( QCPAbstractPlottable* plottable ) // special handling for QCPGraphs to maintain the simple graph interface: if( QCPGraph* graph = qobject_cast( plottable ) ) mGraphs.append( graph ); - if( !plottable->layer() ) // usually the layer is already set in the constructor of the plottable (via QCPLayerable + if( !plottable->layer() ) // usually the layer is already set in the + // constructor of the plottable (via QCPLayerable // constructor) plottable->setLayer( currentLayer() ); return true; } /*! - Removes the specified plottable from the plot and, if necessary, from the legend (QCustomPlot::legend). + Removes the specified plottable from the plot and, if necessary, from the + legend (QCustomPlot::legend). Returns true on success. @@ -9934,7 +11593,8 @@ bool QCustomPlot::removePlottable( int index ) } /*! - Removes all plottables from the plot (and the QCustomPlot::legend, if necessary). + Removes all plottables from the plot (and the QCustomPlot::legend, if + necessary). Returns the number of plottables removed. @@ -9959,11 +11619,14 @@ int QCustomPlot::plottableCount() const } /*! - Returns a list of the selected plottables. If no plottables are currently selected, the list is empty. + Returns a list of the selected plottables. If no plottables are currently + selected, the list is empty. - There is a convenience function if you're only interested in selected graphs, see \ref selectedGraphs. + There is a convenience function if you're only interested in selected graphs, + see \ref selectedGraphs. - \see setInteractions, QCPAbstractPlottable::setSelectable, QCPAbstractPlottable::setSelected + \see setInteractions, QCPAbstractPlottable::setSelectable, + QCPAbstractPlottable::setSelected */ QList QCustomPlot::selectedPlottables() const { @@ -9977,8 +11640,10 @@ QList QCustomPlot::selectedPlottables() const } /*! - Returns the plottable at the pixel position \a pos. Plottables that only consist of single lines - (like graphs) have a tolerance band around them, see \ref setSelectionTolerance. If multiple + Returns the plottable at the pixel position \a pos. Plottables that only + consist of single lines + (like graphs) have a tolerance band around them, see \ref + setSelectionTolerance. If multiple plottables come into consideration, the one closest to \a pos is returned. If \a onlySelectable is true, only plottables that are selectable @@ -9991,17 +11656,22 @@ QList QCustomPlot::selectedPlottables() const QCPAbstractPlottable* QCustomPlot::plottableAt( const QPointF& pos, bool onlySelectable ) const { QCPAbstractPlottable* resultPlottable = 0; - double resultDistance = mSelectionTolerance; // only regard clicks with distances smaller than mSelectionTolerance as - // selections, so initialize with that value + double resultDistance = mSelectionTolerance; // only regard clicks with + // distances smaller than + // mSelectionTolerance as + // selections, so initialize with that value foreach( QCPAbstractPlottable* plottable, mPlottables ) { - if( onlySelectable && !plottable->selectable() ) // we could have also passed onlySelectable to the selectTest - // function, but checking here is faster, because we have access - // to QCPabstractPlottable::selectable + if( onlySelectable && !plottable->selectable() ) // we could have also passed + // onlySelectable to the + // selectTest + // function, but checking here is faster, because we have access + // to QCPabstractPlottable::selectable continue; if( ( plottable->keyAxis()->axisRect()->rect() & plottable->valueAxis()->axisRect()->rect() ) - .contains( pos.toPoint() ) ) // only consider clicks inside the rect that is spanned by the plottable's + .contains( pos.toPoint() ) ) // only consider clicks inside the rect + // that is spanned by the plottable's // key/value axes { double currentDistance = plottable->selectTest( pos, false ); @@ -10029,7 +11699,8 @@ bool QCustomPlot::hasPlottable( QCPAbstractPlottable* plottable ) const /*! Returns the graph with \a index. If the index is invalid, returns 0. - There is an overloaded version of this function with no parameter which returns the last created + There is an overloaded version of this function with no parameter which + returns the last created graph, see QCustomPlot::graph() \see graphCount, addGraph @@ -10049,7 +11720,8 @@ QCPGraph* QCustomPlot::graph( int index ) const /*! \overload - Returns the last graph, that was created with \ref addGraph. If there are no graphs in the plot, + Returns the last graph, that was created with \ref addGraph. If there are no + graphs in the plot, returns 0. \see graphCount, addGraph @@ -10065,11 +11737,14 @@ QCPGraph* QCustomPlot::graph() const } /*! - Creates a new graph inside the plot. If \a keyAxis and \a valueAxis are left unspecified (0), the - bottom (xAxis) is used as key and the left (yAxis) is used as value axis. If specified, \a + Creates a new graph inside the plot. If \a keyAxis and \a valueAxis are left + unspecified (0), the + bottom (xAxis) is used as key and the left (yAxis) is used as value axis. If + specified, \a keyAxis and \a valueAxis must reside in this QCustomPlot. - \a keyAxis will be used as key axis (typically "x") and \a valueAxis as value axis (typically + \a keyAxis will be used as key axis (typically "x") and \a valueAxis as value + axis (typically "y") for the graph. Returns a pointer to the newly created graph, or 0 if adding the graph failed. @@ -10084,13 +11759,15 @@ QCPGraph* QCustomPlot::addGraph( QCPAxis* keyAxis, QCPAxis* valueAxis ) valueAxis = yAxis; if( !keyAxis || !valueAxis ) { - qDebug() << Q_FUNC_INFO - << "can't use default QCustomPlot xAxis or yAxis, because at least one is invalid (has been deleted)"; + qDebug() << Q_FUNC_INFO << "can't use default QCustomPlot xAxis or yAxis, " + "because at least one is invalid (has been " + "deleted)"; return 0; } if( keyAxis->parentPlot() != this || valueAxis->parentPlot() != this ) { - qDebug() << Q_FUNC_INFO << "passed keyAxis or valueAxis doesn't have this QCustomPlot as parent"; + qDebug() << Q_FUNC_INFO << "passed keyAxis or valueAxis doesn't have this " + "QCustomPlot as parent"; return 0; } @@ -10108,8 +11785,10 @@ QCPGraph* QCustomPlot::addGraph( QCPAxis* keyAxis, QCPAxis* valueAxis ) } /*! - Removes the specified \a graph from the plot and, if necessary, from the QCustomPlot::legend. If - any other graphs in the plot have a channel fill set towards the removed graph, the channel fill + Removes the specified \a graph from the plot and, if necessary, from the + QCustomPlot::legend. If + any other graphs in the plot have a channel fill set towards the removed + graph, the channel fill property of those graphs is reset to zero (no channel fill). Returns true on success. @@ -10159,12 +11838,15 @@ int QCustomPlot::graphCount() const } /*! - Returns a list of the selected graphs. If no graphs are currently selected, the list is empty. + Returns a list of the selected graphs. If no graphs are currently selected, + the list is empty. - If you are not only interested in selected graphs but other plottables like QCPCurve, QCPBars, + If you are not only interested in selected graphs but other plottables like + QCPCurve, QCPBars, etc., use \ref selectedPlottables. - \see setInteractions, selectedPlottables, QCPAbstractPlottable::setSelectable, QCPAbstractPlottable::setSelected + \see setInteractions, selectedPlottables, QCPAbstractPlottable::setSelectable, + QCPAbstractPlottable::setSelected */ QList QCustomPlot::selectedGraphs() const { @@ -10180,7 +11862,8 @@ QList QCustomPlot::selectedGraphs() const /*! Returns the item with \a index. If the index is invalid, returns 0. - There is an overloaded version of this function with no parameter which returns the last added + There is an overloaded version of this function with no parameter which + returns the last added item, see QCustomPlot::item() \see itemCount, addItem @@ -10200,7 +11883,8 @@ QCPAbstractItem* QCustomPlot::item( int index ) const /*! \overload - Returns the last item, that was added with \ref addItem. If there are no items in the plot, + Returns the last item, that was added with \ref addItem. If there are no items + in the plot, returns 0. \see itemCount, addItem @@ -10218,7 +11902,8 @@ QCPAbstractItem* QCustomPlot::item() const /*! Adds the specified item to the plot. QCustomPlot takes ownership of the item. - Returns true on success, i.e. when \a item wasn't already in the plot and the parent plot of \a + Returns true on success, i.e. when \a item wasn't already in the plot and the + parent plot of \a item is this QCustomPlot. \see item, itemCount, removeItem, clearItems @@ -10232,7 +11917,8 @@ bool QCustomPlot::addItem( QCPAbstractItem* item ) } else { - qDebug() << Q_FUNC_INFO << "item either already in list or not created with this QCustomPlot as parent:" + qDebug() << Q_FUNC_INFO << "item either already in list or not created " + "with this QCustomPlot as parent:" << reinterpret_cast( item ); return false; } @@ -10301,9 +11987,11 @@ int QCustomPlot::itemCount() const } /*! - Returns a list of the selected items. If no items are currently selected, the list is empty. + Returns a list of the selected items. If no items are currently selected, the + list is empty. - \see setInteractions, QCPAbstractItem::setSelectable, QCPAbstractItem::setSelected + \see setInteractions, QCPAbstractItem::setSelectable, + QCPAbstractItem::setSelected */ QList QCustomPlot::selectedItems() const { @@ -10317,12 +12005,15 @@ QList QCustomPlot::selectedItems() const } /*! - Returns the item at the pixel position \a pos. Items that only consist of single lines (e.g. \ref + Returns the item at the pixel position \a pos. Items that only consist of + single lines (e.g. \ref QCPItemLine or \ref QCPItemCurve) have a tolerance band around them, see \ref - setSelectionTolerance. If multiple items come into consideration, the one closest to \a pos is + setSelectionTolerance. If multiple items come into consideration, the one + closest to \a pos is returned. - If \a onlySelectable is true, only items that are selectable (QCPAbstractItem::setSelectable) are + If \a onlySelectable is true, only items that are selectable + (QCPAbstractItem::setSelectable) are considered. If there is no item at \a pos, the return value is 0. @@ -10332,18 +12023,23 @@ QList QCustomPlot::selectedItems() const QCPAbstractItem* QCustomPlot::itemAt( const QPointF& pos, bool onlySelectable ) const { QCPAbstractItem* resultItem = 0; - double resultDistance = mSelectionTolerance; // only regard clicks with distances smaller than mSelectionTolerance as - // selections, so initialize with that value + double resultDistance = mSelectionTolerance; // only regard clicks with + // distances smaller than + // mSelectionTolerance as + // selections, so initialize with that value foreach( QCPAbstractItem* item, mItems ) { - if( onlySelectable && !item->selectable() ) // we could have also passed onlySelectable to the selectTest function, - // but checking here is faster, because we have access to - // QCPAbstractItem::selectable + if( onlySelectable && !item->selectable() ) // we could have also passed + // onlySelectable to the + // selectTest function, + // but checking here is faster, because we have access to + // QCPAbstractItem::selectable continue; if( !item->clipToAxisRect() || - item->clipRect().contains( - pos.toPoint() ) ) // only consider clicks inside axis cliprect of the item if actually clipped to it + item->clipRect().contains( pos.toPoint() ) ) // only consider clicks inside + // axis cliprect of the item + // if actually clipped to it { double currentDistance = item->selectTest( pos, false ); if( currentDistance >= 0 && currentDistance < resultDistance ) @@ -10368,7 +12064,8 @@ bool QCustomPlot::hasItem( QCPAbstractItem* item ) const } /*! - Returns the layer with the specified \a name. If there is no layer with the specified name, 0 is + Returns the layer with the specified \a name. If there is no layer with the + specified name, 0 is returned. Layer names are case-sensitive. @@ -10413,10 +12110,12 @@ QCPLayer* QCustomPlot::currentLayer() const } /*! - Sets the layer with the specified \a name to be the current layer. All layerables (\ref + Sets the layer with the specified \a name to be the current layer. All + layerables (\ref QCPLayerable), e.g. plottables and items, are created on the current layer. - Returns true on success, i.e. if there is a layer with the specified \a name in the QCustomPlot. + Returns true on success, i.e. if there is a layer with the specified \a name + in the QCustomPlot. Layer names are case-sensitive. @@ -10439,7 +12138,8 @@ bool QCustomPlot::setCurrentLayer( const QString& name ) Sets the provided \a layer to be the current layer. - Returns true on success, i.e. when \a layer is a valid layer in the QCustomPlot. + Returns true on success, i.e. when \a layer is a valid layer in the + QCustomPlot. \see addLayer, moveLayer, removeLayer */ @@ -10447,7 +12147,8 @@ bool QCustomPlot::setCurrentLayer( QCPLayer* layer ) { if( !mLayers.contains( layer ) ) { - qDebug() << Q_FUNC_INFO << "layer not a layer of this QCustomPlot:" << reinterpret_cast( layer ); + qDebug() << Q_FUNC_INFO + << "layer not a layer of this QCustomPlot:" << reinterpret_cast( layer ); return false; } @@ -10466,26 +12167,32 @@ int QCustomPlot::layerCount() const } /*! - Adds a new layer to this QCustomPlot instance. The new layer will have the name \a name, which - must be unique. Depending on \a insertMode, it is positioned either below or above \a otherLayer. + Adds a new layer to this QCustomPlot instance. The new layer will have the + name \a name, which + must be unique. Depending on \a insertMode, it is positioned either below or + above \a otherLayer. - Returns true on success, i.e. if there is no other layer named \a name and \a otherLayer is a + Returns true on success, i.e. if there is no other layer named \a name and \a + otherLayer is a valid layer inside this QCustomPlot. If \a otherLayer is 0, the highest layer in the QCustomPlot will be used. - For an explanation of what layers are in QCustomPlot, see the documentation of \ref QCPLayer. + For an explanation of what layers are in QCustomPlot, see the documentation of + \ref QCPLayer. \see layer, moveLayer, removeLayer */ -bool QCustomPlot::addLayer( const QString& name, QCPLayer* otherLayer, QCustomPlot::LayerInsertMode insertMode ) +bool QCustomPlot::addLayer( const QString& name, + QCPLayer* otherLayer, + QCustomPlot::LayerInsertMode insertMode ) { if( !otherLayer ) otherLayer = mLayers.last(); if( !mLayers.contains( otherLayer ) ) { - qDebug() << Q_FUNC_INFO - << "otherLayer not a layer of this QCustomPlot:" << reinterpret_cast( otherLayer ); + qDebug() << Q_FUNC_INFO << "otherLayer not a layer of this QCustomPlot:" + << reinterpret_cast( otherLayer ); return false; } if( layer( name ) ) @@ -10503,11 +12210,15 @@ bool QCustomPlot::addLayer( const QString& name, QCPLayer* otherLayer, QCustomPl /*! Removes the specified \a layer and returns true on success. - All layerables (e.g. plottables and items) on the removed layer will be moved to the layer below - \a layer. If \a layer is the bottom layer, the layerables are moved to the layer above. In both - cases, the total rendering order of all layerables in the QCustomPlot is preserved. + All layerables (e.g. plottables and items) on the removed layer will be moved + to the layer below + \a layer. If \a layer is the bottom layer, the layerables are moved to the + layer above. In both + cases, the total rendering order of all layerables in the QCustomPlot is + preserved. - If \a layer is the current layer (\ref setCurrentLayer), the layer below (or above, if bottom + If \a layer is the current layer (\ref setCurrentLayer), the layer below (or + above, if bottom layer) becomes the new current layer. It is not possible to remove the last layer of the plot. @@ -10518,7 +12229,8 @@ bool QCustomPlot::removeLayer( QCPLayer* layer ) { if( !mLayers.contains( layer ) ) { - qDebug() << Q_FUNC_INFO << "layer not a layer of this QCustomPlot:" << reinterpret_cast( layer ); + qDebug() << Q_FUNC_INFO + << "layer not a layer of this QCustomPlot:" << reinterpret_cast( layer ); return false; } if( mLayers.size() < 2 ) @@ -10527,12 +12239,15 @@ bool QCustomPlot::removeLayer( QCPLayer* layer ) return false; } - // append all children of this layer to layer below (if this is lowest layer, prepend to layer above) + // append all children of this layer to layer below (if this is lowest layer, + // prepend to layer above) int removedIndex = layer->index(); bool isFirstLayer = removedIndex == 0; - QCPLayer* targetLayer = isFirstLayer ? mLayers.at( removedIndex + 1 ) : mLayers.at( removedIndex - 1 ); + QCPLayer* targetLayer = + isFirstLayer ? mLayers.at( removedIndex + 1 ) : mLayers.at( removedIndex - 1 ); QList children = layer->children(); - if( isFirstLayer ) // prepend in reverse order (so order relative to each other stays the same) + if( isFirstLayer ) // prepend in reverse order (so order relative to each other + // stays the same) { for( int i = children.size() - 1; i >= 0; --i ) children.at( i )->moveToLayer( targetLayer, true ); @@ -10542,7 +12257,8 @@ bool QCustomPlot::removeLayer( QCPLayer* layer ) for( int i = 0; i < children.size(); ++i ) children.at( i )->moveToLayer( targetLayer, false ); } - // if removed layer is current layer, change current layer to layer below/above: + // if removed layer is current layer, change current layer to layer + // below/above: if( layer == mCurrentLayer ) setCurrentLayer( targetLayer ); // remove layer: @@ -10553,25 +12269,30 @@ bool QCustomPlot::removeLayer( QCPLayer* layer ) } /*! - Moves the specified \a layer either above or below \a otherLayer. Whether it's placed above or + Moves the specified \a layer either above or below \a otherLayer. Whether it's + placed above or below is controlled with \a insertMode. - Returns true on success, i.e. when both \a layer and \a otherLayer are valid layers in the + Returns true on success, i.e. when both \a layer and \a otherLayer are valid + layers in the QCustomPlot. \see layer, addLayer, moveLayer */ -bool QCustomPlot::moveLayer( QCPLayer* layer, QCPLayer* otherLayer, QCustomPlot::LayerInsertMode insertMode ) +bool QCustomPlot::moveLayer( QCPLayer* layer, + QCPLayer* otherLayer, + QCustomPlot::LayerInsertMode insertMode ) { if( !mLayers.contains( layer ) ) { - qDebug() << Q_FUNC_INFO << "layer not a layer of this QCustomPlot:" << reinterpret_cast( layer ); + qDebug() << Q_FUNC_INFO + << "layer not a layer of this QCustomPlot:" << reinterpret_cast( layer ); return false; } if( !mLayers.contains( otherLayer ) ) { - qDebug() << Q_FUNC_INFO - << "otherLayer not a layer of this QCustomPlot:" << reinterpret_cast( otherLayer ); + qDebug() << Q_FUNC_INFO << "otherLayer not a layer of this QCustomPlot:" + << reinterpret_cast( otherLayer ); return false; } @@ -10597,9 +12318,12 @@ int QCustomPlot::axisRectCount() const /*! Returns the axis rect with \a index. - Initially, only one axis rect (with index 0) exists in the plot. If multiple axis rects were - added, all of them may be accessed with this function in a linear fashion (even when they are - nested in a layout hierarchy or inside other axis rects via QCPAxisRect::insetLayout). + Initially, only one axis rect (with index 0) exists in the plot. If multiple + axis rects were + added, all of them may be accessed with this function in a linear fashion + (even when they are + nested in a layout hierarchy or inside other axis rects via + QCPAxisRect::insetLayout). \see axisRectCount, axisRects */ @@ -10646,10 +12370,12 @@ QList QCustomPlot::axisRects() const } /*! - Returns the layout element at pixel position \a pos. If there is no element at that position, + Returns the layout element at pixel position \a pos. If there is no element at + that position, returns 0. - Only visible elements are used. If \ref QCPLayoutElement::setVisible on the element itself or on + Only visible elements are used. If \ref QCPLayoutElement::setVisible on the + element itself or on any of its parent elements is set to false, it will not be considered. \see itemAt, plottableAt @@ -10675,10 +12401,12 @@ QCPLayoutElement* QCustomPlot::layoutElementAt( const QPointF& pos ) const } /*! - Returns the axes that currently have selected parts, i.e. whose selection state is not \ref + Returns the axes that currently have selected parts, i.e. whose selection + state is not \ref QCPAxis::spNone. - \see selectedPlottables, selectedLegends, setInteractions, QCPAxis::setSelectedParts, + \see selectedPlottables, selectedLegends, setInteractions, + QCPAxis::setSelectedParts, QCPAxis::setSelectableParts */ QList QCustomPlot::selectedAxes() const @@ -10697,10 +12425,12 @@ QList QCustomPlot::selectedAxes() const } /*! - Returns the legends that currently have selected parts, i.e. whose selection state is not \ref + Returns the legends that currently have selected parts, i.e. whose selection + state is not \ref QCPLegend::spNone. - \see selectedPlottables, selectedAxes, setInteractions, QCPLegend::setSelectedParts, + \see selectedPlottables, selectedAxes, setInteractions, + QCPLegend::setSelectedParts, QCPLegend::setSelectableParts, QCPLegend::selectedItems */ QList QCustomPlot::selectedLegends() const @@ -10731,13 +12461,17 @@ QList QCustomPlot::selectedLegends() const } /*! - Deselects all layerables (plottables, items, axes, legends,...) of the QCustomPlot. + Deselects all layerables (plottables, items, axes, legends,...) of the + QCustomPlot. - Since calling this function is not a user interaction, this does not emit the \ref - selectionChangedByUser signal. The individual selectionChanged signals are emitted though, if the + Since calling this function is not a user interaction, this does not emit the + \ref + selectionChangedByUser signal. The individual selectionChanged signals are + emitted though, if the objects were previously selected. - \see setInteractions, selectedPlottables, selectedItems, selectedAxes, selectedLegends + \see setInteractions, selectedPlottables, selectedItems, selectedAxes, + selectedLegends */ void QCustomPlot::deselectAll() { @@ -10749,16 +12483,23 @@ void QCustomPlot::deselectAll() } /*! - Causes a complete replot into the internal buffer. Finally, update() is called, to redraw the - buffer on the QCustomPlot widget surface. This is the method that must be called to make changes, + Causes a complete replot into the internal buffer. Finally, update() is + called, to redraw the + buffer on the QCustomPlot widget surface. This is the method that must be + called to make changes, for example on the axis ranges or data points of graphs, visible. - Under a few circumstances, QCustomPlot causes a replot by itself. Those are resize events of the - QCustomPlot widget and user interactions (object selection and range dragging/zooming). + Under a few circumstances, QCustomPlot causes a replot by itself. Those are + resize events of the + QCustomPlot widget and user interactions (object selection and range + dragging/zooming). - Before the replot happens, the signal \ref beforeReplot is emitted. After the replot, \ref - afterReplot is emitted. It is safe to mutually connect the replot slot with any of those two - signals on two QCustomPlots to make them replot synchronously, it won't cause an infinite + Before the replot happens, the signal \ref beforeReplot is emitted. After the + replot, \ref + afterReplot is emitted. It is safe to mutually connect the replot slot with + any of those two + signals on two QCustomPlots to make them replot synchronously, it won't cause + an infinite recursion. */ void QCustomPlot::replot( QCustomPlot::RefreshPriority refreshPriority ) @@ -10768,13 +12509,15 @@ void QCustomPlot::replot( QCustomPlot::RefreshPriority refreshPriority ) mReplotting = true; emit beforeReplot(); - mPaintBuffer.fill( mBackgroundBrush.style() == Qt::SolidPattern ? mBackgroundBrush.color() : Qt::transparent ); + mPaintBuffer.fill( mBackgroundBrush.style() == Qt::SolidPattern ? mBackgroundBrush.color() + : Qt::transparent ); QCPPainter painter; painter.begin( &mPaintBuffer ); if( painter.isActive() ) { painter.setRenderHint( - QPainter::HighQualityAntialiasing ); // to make Antialiasing look good if using the OpenGL graphicssystem + QPainter::HighQualityAntialiasing ); // to make Antialiasing look good if + // using the OpenGL graphicssystem if( mBackgroundBrush.style() != Qt::SolidPattern && mBackgroundBrush.style() != Qt::NoBrush ) painter.fillRect( mViewport, mBackgroundBrush ); draw( &painter ); @@ -10793,9 +12536,11 @@ void QCustomPlot::replot( QCustomPlot::RefreshPriority refreshPriority ) } /*! - Rescales the axes such that all plottables (like graphs) in the plot are fully visible. + Rescales the axes such that all plottables (like graphs) in the plot are fully + visible. - if \a onlyVisiblePlottables is set to true, only the plottables that have their visibility set to true + if \a onlyVisiblePlottables is set to true, only the plottables that have + their visibility set to true (QCPLayerable::setVisible), will be used to rescale the axes. \see QCPAbstractPlottable::rescaleAxes, QCPAxis::rescale @@ -10811,39 +12556,59 @@ void QCustomPlot::rescaleAxes( bool onlyVisiblePlottables ) } /*! - Saves a PDF with the vectorized plot to the file \a fileName. The axis ratio as well as the scale - of texts and lines will be derived from the specified \a width and \a height. This means, the - output will look like the normal on-screen output of a QCustomPlot widget with the corresponding - pixel width and height. If either \a width or \a height is zero, the exported image will have the + Saves a PDF with the vectorized plot to the file \a fileName. The axis ratio + as well as the scale + of texts and lines will be derived from the specified \a width and \a height. + This means, the + output will look like the normal on-screen output of a QCustomPlot widget with + the corresponding + pixel width and height. If either \a width or \a height is zero, the exported + image will have the same dimensions as the QCustomPlot widget currently has. - \a noCosmeticPen disables the use of cosmetic pens when drawing to the PDF file. Cosmetic pens - are pens with numerical width 0, which are always drawn as a one pixel wide line, no matter what - zoom factor is set in the PDF-Viewer. For more information about cosmetic pens, see the QPainter + \a noCosmeticPen disables the use of cosmetic pens when drawing to the PDF + file. Cosmetic pens + are pens with numerical width 0, which are always drawn as a one pixel wide + line, no matter what + zoom factor is set in the PDF-Viewer. For more information about cosmetic + pens, see the QPainter and QPen documentation. - The objects of the plot will appear in the current selection state. If you don't want any - selected objects to be painted in their selected look, deselect everything with \ref deselectAll + The objects of the plot will appear in the current selection state. If you + don't want any + selected objects to be painted in their selected look, deselect everything + with \ref deselectAll before calling this function. Returns true on success. \warning - \li If you plan on editing the exported PDF file with a vector graphics editor like - Inkscape, it is advised to set \a noCosmeticPen to true to avoid losing those cosmetic lines - (which might be quite many, because cosmetic pens are the default for e.g. axes and tick marks). - \li If calling this function inside the constructor of the parent of the QCustomPlot widget - (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), always provide - explicit non-zero widths and heights. If you leave \a width or \a height as 0 (default), this - function uses the current width and height of the QCustomPlot widget. However, in Qt, these - aren't defined yet inside the constructor, so you would get an image that has strange + \li If you plan on editing the exported PDF file with a vector graphics editor + like + Inkscape, it is advised to set \a noCosmeticPen to true to avoid losing those + cosmetic lines + (which might be quite many, because cosmetic pens are the default for e.g. + axes and tick marks). + \li If calling this function inside the constructor of the parent of the + QCustomPlot widget + (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), + always provide + explicit non-zero widths and heights. If you leave \a width or \a height as 0 + (default), this + function uses the current width and height of the QCustomPlot widget. However, + in Qt, these + aren't defined yet inside the constructor, so you would get an image that has + strange widths/heights. - \a pdfCreator and \a pdfTitle may be used to set the according metadata fields in the resulting + \a pdfCreator and \a pdfTitle may be used to set the according metadata fields + in the resulting PDF file. - \note On Android systems, this method does nothing and issues an according qDebug warning - message. This is also the case if for other reasons the define flag QT_NO_PRINTER is set. + \note On Android systems, this method does nothing and issues an according + qDebug warning + message. This is also the case if for other reasons the define flag + QT_NO_PRINTER is set. \see savePng, saveBmp, saveJpg, saveRastered */ @@ -10860,7 +12625,8 @@ bool QCustomPlot::savePdf( const QString& fileName, Q_UNUSED( noCosmeticPen ) Q_UNUSED( width ) Q_UNUSED( height ) - qDebug() << Q_FUNC_INFO << "Qt was built without printer support (QT_NO_PRINTER). PDF not created."; + qDebug() << Q_FUNC_INFO << "Qt was built without printer support " + "(QT_NO_PRINTER). PDF not created."; #else int newWidth, newHeight; if( width == 0 || height == 0 ) @@ -10893,7 +12659,8 @@ bool QCustomPlot::savePdf( const QString& fileName, printpainter.setWindow( mViewport ); if( mBackgroundBrush.style() != Qt::NoBrush && mBackgroundBrush.color() != Qt::white && mBackgroundBrush.color() != Qt::transparent && - mBackgroundBrush.color().alpha() > 0 ) // draw pdf background color if not white/transparent + mBackgroundBrush.color().alpha() > + 0 ) // draw pdf background color if not white/transparent printpainter.fillRect( viewport(), mBackgroundBrush ); draw( &printpainter ); printpainter.end(); @@ -10905,113 +12672,176 @@ bool QCustomPlot::savePdf( const QString& fileName, } /*! - Saves a PNG image file to \a fileName on disc. The output plot will have the dimensions \a width - and \a height in pixels. If either \a width or \a height is zero, the exported image will have - the same dimensions as the QCustomPlot widget currently has. Line widths and texts etc. are not - scaled up when larger widths/heights are used. If you want that effect, use the \a scale parameter. + Saves a PNG image file to \a fileName on disc. The output plot will have the + dimensions \a width + and \a height in pixels. If either \a width or \a height is zero, the exported + image will have + the same dimensions as the QCustomPlot widget currently has. Line widths and + texts etc. are not + scaled up when larger widths/heights are used. If you want that effect, use + the \a scale parameter. - For example, if you set both \a width and \a height to 100 and \a scale to 2, you will end up with an - image file of size 200*200 in which all graphical elements are scaled up by factor 2 (line widths, - texts, etc.). This scaling is not done by stretching a 100*100 image, the result will have full + For example, if you set both \a width and \a height to 100 and \a scale to 2, + you will end up with an + image file of size 200*200 in which all graphical elements are scaled up by + factor 2 (line widths, + texts, etc.). This scaling is not done by stretching a 100*100 image, the + result will have full 200*200 pixel resolution. - If you use a high scaling factor, it is recommended to enable antialiasing for all elements via - temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref QCP::aeAll as this allows + If you use a high scaling factor, it is recommended to enable antialiasing for + all elements via + temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref + QCP::aeAll as this allows QCustomPlot to place objects with sub-pixel accuracy. - \warning If calling this function inside the constructor of the parent of the QCustomPlot widget - (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), always provide - explicit non-zero widths and heights. If you leave \a width or \a height as 0 (default), this - function uses the current width and height of the QCustomPlot widget. However, in Qt, these - aren't defined yet inside the constructor, so you would get an image that has strange + \warning If calling this function inside the constructor of the parent of the + QCustomPlot widget + (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), + always provide + explicit non-zero widths and heights. If you leave \a width or \a height as 0 + (default), this + function uses the current width and height of the QCustomPlot widget. However, + in Qt, these + aren't defined yet inside the constructor, so you would get an image that has + strange widths/heights. - The objects of the plot will appear in the current selection state. If you don't want any selected - objects to be painted in their selected look, deselect everything with \ref deselectAll before calling + The objects of the plot will appear in the current selection state. If you + don't want any selected + objects to be painted in their selected look, deselect everything with \ref + deselectAll before calling this function. - If you want the PNG to have a transparent background, call \ref setBackground(const QBrush - &brush) with no brush (Qt::NoBrush) or a transparent color (Qt::transparent), before saving. + If you want the PNG to have a transparent background, call \ref + setBackground(const QBrush + &brush) with no brush (Qt::NoBrush) or a transparent color (Qt::transparent), + before saving. - PNG compression can be controlled with the \a quality parameter which must be between 0 and 100 or + PNG compression can be controlled with the \a quality parameter which must be + between 0 and 100 or -1 to use the default setting. - Returns true on success. If this function fails, most likely the PNG format isn't supported by + Returns true on success. If this function fails, most likely the PNG format + isn't supported by the system, see Qt docs about QImageWriter::supportedImageFormats(). \see savePdf, saveBmp, saveJpg, saveRastered */ -bool QCustomPlot::savePng( const QString& fileName, int width, int height, double scale, int quality ) +bool QCustomPlot::savePng( const QString& fileName, + int width, + int height, + double scale, + int quality ) { return saveRastered( fileName, width, height, scale, "PNG", quality ); } /*! - Saves a JPG image file to \a fileName on disc. The output plot will have the dimensions \a width - and \a height in pixels. If either \a width or \a height is zero, the exported image will have - the same dimensions as the QCustomPlot widget currently has. Line widths and texts etc. are not - scaled up when larger widths/heights are used. If you want that effect, use the \a scale parameter. + Saves a JPG image file to \a fileName on disc. The output plot will have the + dimensions \a width + and \a height in pixels. If either \a width or \a height is zero, the exported + image will have + the same dimensions as the QCustomPlot widget currently has. Line widths and + texts etc. are not + scaled up when larger widths/heights are used. If you want that effect, use + the \a scale parameter. - For example, if you set both \a width and \a height to 100 and \a scale to 2, you will end up with an - image file of size 200*200 in which all graphical elements are scaled up by factor 2 (line widths, - texts, etc.). This scaling is not done by stretching a 100*100 image, the result will have full + For example, if you set both \a width and \a height to 100 and \a scale to 2, + you will end up with an + image file of size 200*200 in which all graphical elements are scaled up by + factor 2 (line widths, + texts, etc.). This scaling is not done by stretching a 100*100 image, the + result will have full 200*200 pixel resolution. - If you use a high scaling factor, it is recommended to enable antialiasing for all elements via - temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref QCP::aeAll as this allows + If you use a high scaling factor, it is recommended to enable antialiasing for + all elements via + temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref + QCP::aeAll as this allows QCustomPlot to place objects with sub-pixel accuracy. - \warning If calling this function inside the constructor of the parent of the QCustomPlot widget - (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), always provide - explicit non-zero widths and heights. If you leave \a width or \a height as 0 (default), this - function uses the current width and height of the QCustomPlot widget. However, in Qt, these - aren't defined yet inside the constructor, so you would get an image that has strange + \warning If calling this function inside the constructor of the parent of the + QCustomPlot widget + (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), + always provide + explicit non-zero widths and heights. If you leave \a width or \a height as 0 + (default), this + function uses the current width and height of the QCustomPlot widget. However, + in Qt, these + aren't defined yet inside the constructor, so you would get an image that has + strange widths/heights. - The objects of the plot will appear in the current selection state. If you don't want any selected - objects to be painted in their selected look, deselect everything with \ref deselectAll before calling + The objects of the plot will appear in the current selection state. If you + don't want any selected + objects to be painted in their selected look, deselect everything with \ref + deselectAll before calling this function. - JPG compression can be controlled with the \a quality parameter which must be between 0 and 100 or + JPG compression can be controlled with the \a quality parameter which must be + between 0 and 100 or -1 to use the default setting. - Returns true on success. If this function fails, most likely the JPG format isn't supported by + Returns true on success. If this function fails, most likely the JPG format + isn't supported by the system, see Qt docs about QImageWriter::supportedImageFormats(). \see savePdf, savePng, saveBmp, saveRastered */ -bool QCustomPlot::saveJpg( const QString& fileName, int width, int height, double scale, int quality ) +bool QCustomPlot::saveJpg( const QString& fileName, + int width, + int height, + double scale, + int quality ) { return saveRastered( fileName, width, height, scale, "JPG", quality ); } /*! - Saves a BMP image file to \a fileName on disc. The output plot will have the dimensions \a width - and \a height in pixels. If either \a width or \a height is zero, the exported image will have - the same dimensions as the QCustomPlot widget currently has. Line widths and texts etc. are not - scaled up when larger widths/heights are used. If you want that effect, use the \a scale parameter. + Saves a BMP image file to \a fileName on disc. The output plot will have the + dimensions \a width + and \a height in pixels. If either \a width or \a height is zero, the exported + image will have + the same dimensions as the QCustomPlot widget currently has. Line widths and + texts etc. are not + scaled up when larger widths/heights are used. If you want that effect, use + the \a scale parameter. - For example, if you set both \a width and \a height to 100 and \a scale to 2, you will end up with an - image file of size 200*200 in which all graphical elements are scaled up by factor 2 (line widths, - texts, etc.). This scaling is not done by stretching a 100*100 image, the result will have full + For example, if you set both \a width and \a height to 100 and \a scale to 2, + you will end up with an + image file of size 200*200 in which all graphical elements are scaled up by + factor 2 (line widths, + texts, etc.). This scaling is not done by stretching a 100*100 image, the + result will have full 200*200 pixel resolution. - If you use a high scaling factor, it is recommended to enable antialiasing for all elements via - temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref QCP::aeAll as this allows + If you use a high scaling factor, it is recommended to enable antialiasing for + all elements via + temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref + QCP::aeAll as this allows QCustomPlot to place objects with sub-pixel accuracy. - \warning If calling this function inside the constructor of the parent of the QCustomPlot widget - (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), always provide - explicit non-zero widths and heights. If you leave \a width or \a height as 0 (default), this - function uses the current width and height of the QCustomPlot widget. However, in Qt, these - aren't defined yet inside the constructor, so you would get an image that has strange + \warning If calling this function inside the constructor of the parent of the + QCustomPlot widget + (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), + always provide + explicit non-zero widths and heights. If you leave \a width or \a height as 0 + (default), this + function uses the current width and height of the QCustomPlot widget. However, + in Qt, these + aren't defined yet inside the constructor, so you would get an image that has + strange widths/heights. - The objects of the plot will appear in the current selection state. If you don't want any selected - objects to be painted in their selected look, deselect everything with \ref deselectAll before calling + The objects of the plot will appear in the current selection state. If you + don't want any selected + objects to be painted in their selected look, deselect everything with \ref + deselectAll before calling this function. - Returns true on success. If this function fails, most likely the BMP format isn't supported by + Returns true on success. If this function fails, most likely the BMP format + isn't supported by the system, see Qt docs about QImageWriter::supportedImageFormats(). \see savePdf, savePng, saveJpg, saveRastered @@ -11023,10 +12853,14 @@ bool QCustomPlot::saveBmp( const QString& fileName, int width, int height, doubl /*! \internal - Returns a minimum size hint that corresponds to the minimum size of the top level layout - (\ref plotLayout). To prevent QCustomPlot from being collapsed to size/width zero, set a minimum - size (setMinimumSize) either on the whole QCustomPlot or on any layout elements inside the plot. - This is especially important, when placed in a QLayout where other components try to take in as + Returns a minimum size hint that corresponds to the minimum size of the top + level layout + (\ref plotLayout). To prevent QCustomPlot from being collapsed to size/width + zero, set a minimum + size (setMinimumSize) either on the whole QCustomPlot or on any layout + elements inside the plot. + This is especially important, when placed in a QLayout where other components + try to take in as much space as possible (e.g. QMdiArea). */ QSize QCustomPlot::minimumSizeHint() const @@ -11046,7 +12880,8 @@ QSize QCustomPlot::sizeHint() const /*! \internal - Event handler for when the QCustomPlot widget needs repainting. This does not cause a \ref replot, but + Event handler for when the QCustomPlot widget needs repainting. This does not + cause a \ref replot, but draws the internal buffer on the widget surface. */ void QCustomPlot::paintEvent( QPaintEvent* event ) @@ -11058,8 +12893,10 @@ void QCustomPlot::paintEvent( QPaintEvent* event ) /*! \internal - Event handler for a resize of the QCustomPlot widget. Causes the internal buffer to be resized to - the new size. The viewport (which becomes the outer rect of mPlotLayout) is resized + Event handler for a resize of the QCustomPlot widget. Causes the internal + buffer to be resized to + the new size. The viewport (which becomes the outer rect of mPlotLayout) is + resized appropriately. Finally a \ref replot is performed. */ void QCustomPlot::resizeEvent( QResizeEvent* event ) @@ -11067,14 +12904,18 @@ void QCustomPlot::resizeEvent( QResizeEvent* event ) // resize and repaint the buffer: mPaintBuffer = QPixmap( event->size() ); setViewport( rect() ); - replot( rpQueued ); // queued update is important here, to prevent painting issues in some contexts + replot( rpQueued ); // queued update is important here, to prevent painting + // issues in some contexts } /*! \internal - Event handler for when a double click occurs. Emits the \ref mouseDoubleClick signal, then emits - the specialized signals when certain objecs are clicked (e.g. \ref plottableDoubleClick, \ref - axisDoubleClick, etc.). Finally determines the affected layout element and forwards the event to + Event handler for when a double click occurs. Emits the \ref mouseDoubleClick + signal, then emits + the specialized signals when certain objecs are clicked (e.g. \ref + plottableDoubleClick, \ref + axisDoubleClick, etc.). Finally determines the affected layout element and + forwards the event to it. \see mousePressEvent, mouseReleaseEvent @@ -11104,7 +12945,8 @@ void QCustomPlot::mouseDoubleClickEvent( QMouseEvent* event ) if( QCPLayoutElement* el = layoutElementAt( event->pos() ) ) el->mouseDoubleClickEvent( event ); - // call release event of affected layout element (as in mouseReleaseEvent, since the mouseDoubleClick replaces the + // call release event of affected layout element (as in mouseReleaseEvent, + // since the mouseDoubleClick replaces the // second release event in double click case): if( mMouseEventElement ) { @@ -11112,13 +12954,15 @@ void QCustomPlot::mouseDoubleClickEvent( QMouseEvent* event ) mMouseEventElement = 0; } - // QWidget::mouseDoubleClickEvent(event); don't call base class implementation because it would just cause a + // QWidget::mouseDoubleClickEvent(event); don't call base class implementation + // because it would just cause a // mousePress/ReleaseEvent, which we don't want. } /*! \internal - Event handler for when a mouse button is pressed. Emits the mousePress signal. Then determines + Event handler for when a mouse button is pressed. Emits the mousePress signal. + Then determines the affected layout element and forwards the event to it. \see mouseMoveEvent, mouseReleaseEvent @@ -11126,7 +12970,8 @@ void QCustomPlot::mouseDoubleClickEvent( QMouseEvent* event ) void QCustomPlot::mousePressEvent( QMouseEvent* event ) { emit mousePress( event ); - mMousePressPos = event->pos(); // need this to determine in releaseEvent whether it was a click (no position change + mMousePressPos = event->pos(); // need this to determine in releaseEvent + // whether it was a click (no position change // between press and release) // call event of affected layout element: @@ -11141,7 +12986,8 @@ void QCustomPlot::mousePressEvent( QMouseEvent* event ) Event handler for when the cursor is moved. Emits the \ref mouseMove signal. - If a layout element has mouse capture focus (a mousePressEvent happened on top of the layout + If a layout element has mouse capture focus (a mousePressEvent happened on top + of the layout element before), the mouseMoveEvent is forwarded to that element. \see mousePressEvent, mouseReleaseEvent @@ -11159,14 +13005,19 @@ void QCustomPlot::mouseMoveEvent( QMouseEvent* event ) /*! \internal - Event handler for when a mouse button is released. Emits the \ref mouseRelease signal. + Event handler for when a mouse button is released. Emits the \ref mouseRelease + signal. - If the mouse was moved less than a certain threshold in any direction since the \ref - mousePressEvent, it is considered a click which causes the selection mechanism (if activated via - \ref setInteractions) to possibly change selection states accordingly. Further, specialized mouse + If the mouse was moved less than a certain threshold in any direction since + the \ref + mousePressEvent, it is considered a click which causes the selection mechanism + (if activated via + \ref setInteractions) to possibly change selection states accordingly. + Further, specialized mouse click signals are emitted (e.g. \ref plottableClick, \ref axisClick, etc.) - If a layout element has mouse capture focus (a \ref mousePressEvent happened on top of the layout + If a layout element has mouse capture focus (a \ref mousePressEvent happened + on top of the layout element before), the \ref mouseReleaseEvent is forwarded to that element. \see mousePressEvent, mouseMoveEvent @@ -11176,7 +13027,8 @@ void QCustomPlot::mouseReleaseEvent( QMouseEvent* event ) emit mouseRelease( event ); bool doReplot = false; - if( ( mMousePressPos - event->pos() ).manhattanLength() < 5 ) // determine whether it was a click operation + if( ( mMousePressPos - event->pos() ).manhattanLength() < + 5 ) // determine whether it was a click operation { if( event->button() == Qt::LeftButton ) { @@ -11184,8 +13036,8 @@ void QCustomPlot::mouseReleaseEvent( QMouseEvent* event ) QVariant details; QCPLayerable* clickedLayerable = layerableAt( event->pos(), true, &details ); bool selectionStateChanged = false; - bool additive = - mInteractions.testFlag( QCP::iMultiSelect ) && event->modifiers().testFlag( mMultiSelectModifier ); + bool additive = mInteractions.testFlag( QCP::iMultiSelect ) && + event->modifiers().testFlag( mMultiSelectModifier ); // deselect all other layerables if not additive selection: if( !additive ) { @@ -11193,7 +13045,8 @@ void QCustomPlot::mouseReleaseEvent( QMouseEvent* event ) { foreach( QCPLayerable* layerable, layer->children() ) { - if( layerable != clickedLayerable && mInteractions.testFlag( layerable->selectionCategory() ) ) + if( layerable != clickedLayerable && + mInteractions.testFlag( layerable->selectionCategory() ) ) { bool selChanged = false; layerable->deselectEvent( &selChanged ); @@ -11217,8 +13070,9 @@ void QCustomPlot::mouseReleaseEvent( QMouseEvent* event ) // emit specialized object click signals: QVariant details; QCPLayerable* clickedLayerable = - layerableAt( event->pos(), false, &details ); // for these signals, selectability is ignored, that's why we - // call this again with onlySelectable set to false + layerableAt( event->pos(), false, + &details ); // for these signals, selectability is ignored, that's why we + // call this again with onlySelectable set to false if( QCPAbstractPlottable* ap = qobject_cast( clickedLayerable ) ) emit plottableClick( ap, event ); else if( QCPAxis* ax = qobject_cast( clickedLayerable ) ) @@ -11248,7 +13102,8 @@ void QCustomPlot::mouseReleaseEvent( QMouseEvent* event ) /*! \internal - Event handler for mouse wheel events. First, the \ref mouseWheel signal is emitted. Then + Event handler for mouse wheel events. First, the \ref mouseWheel signal is + emitted. Then determines the affected layout element and forwards the event to it. */ @@ -11265,10 +13120,14 @@ void QCustomPlot::wheelEvent( QWheelEvent* event ) /*! \internal - This is the main draw function. It draws the entire plot, including background pixmap, with the - specified \a painter. Note that it does not fill the background with the background brush (as the - user may specify with \ref setBackground(const QBrush &brush)), this is up to the respective - functions calling this method (e.g. \ref replot, \ref toPixmap and \ref toPainter). + This is the main draw function. It draws the entire plot, including background + pixmap, with the + specified \a painter. Note that it does not fill the background with the + background brush (as the + user may specify with \ref setBackground(const QBrush &brush)), this is up to + the respective + functions calling this method (e.g. \ref replot, \ref toPixmap and \ref + toPainter). */ void QCustomPlot::draw( QCPPainter* painter ) { @@ -11312,15 +13171,21 @@ void QCustomPlot::draw( QCPPainter* painter ) Draws the viewport background pixmap of the plot. - If a pixmap was provided via \ref setBackground, this function buffers the scaled version - depending on \ref setBackgroundScaled and \ref setBackgroundScaledMode and then draws it inside + If a pixmap was provided via \ref setBackground, this function buffers the + scaled version + depending on \ref setBackgroundScaled and \ref setBackgroundScaledMode and + then draws it inside the viewport with the provided \a painter. The scaled version is buffered in - mScaledBackgroundPixmap to prevent expensive rescaling at every redraw. It is only updated, when - the axis rect has changed in a way that requires a rescale of the background pixmap (this is - dependent on the \ref setBackgroundScaledMode), or when a differend axis background pixmap was + mScaledBackgroundPixmap to prevent expensive rescaling at every redraw. It is + only updated, when + the axis rect has changed in a way that requires a rescale of the background + pixmap (this is + dependent on the \ref setBackgroundScaledMode), or when a differend axis + background pixmap was set. - Note that this function does not draw a fill with the background brush (\ref setBackground(const + Note that this function does not draw a fill with the background brush (\ref + setBackground(const QBrush &brush)) beneath the pixmap. \see setBackground, setBackgroundScaled, setBackgroundScaledMode @@ -11338,10 +13203,11 @@ void QCustomPlot::drawBackground( QCPPainter* painter ) QSize scaledSize( mBackgroundPixmap.size() ); scaledSize.scale( mViewport.size(), mBackgroundScaledMode ); if( mScaledBackgroundPixmap.size() != scaledSize ) - mScaledBackgroundPixmap = - mBackgroundPixmap.scaled( mViewport.size(), mBackgroundScaledMode, Qt::SmoothTransformation ); - painter->drawPixmap( mViewport.topLeft(), mScaledBackgroundPixmap, - QRect( 0, 0, mViewport.width(), mViewport.height() ) & mScaledBackgroundPixmap.rect() ); + mScaledBackgroundPixmap = mBackgroundPixmap.scaled( mViewport.size(), mBackgroundScaledMode, + Qt::SmoothTransformation ); + painter->drawPixmap( + mViewport.topLeft(), mScaledBackgroundPixmap, + QRect( 0, 0, mViewport.width(), mViewport.height() ) & mScaledBackgroundPixmap.rect() ); } else { @@ -11353,8 +13219,10 @@ void QCustomPlot::drawBackground( QCPPainter* painter ) /*! \internal - This method is used by \ref QCPAxisRect::removeAxis to report removed axes to the QCustomPlot - so it may clear its QCustomPlot::xAxis, yAxis, xAxis2 and yAxis2 members accordingly. + This method is used by \ref QCPAxisRect::removeAxis to report removed axes to + the QCustomPlot + so it may clear its QCustomPlot::xAxis, yAxis, xAxis2 and yAxis2 members + accordingly. */ void QCustomPlot::axisRemoved( QCPAxis* axis ) { @@ -11367,12 +13235,14 @@ void QCustomPlot::axisRemoved( QCPAxis* axis ) if( yAxis2 == axis ) yAxis2 = 0; - // Note: No need to take care of range drag axes and range zoom axes, because they are stored in smart pointers + // Note: No need to take care of range drag axes and range zoom axes, because + // they are stored in smart pointers } /*! \internal - This method is used by the QCPLegend destructor to report legend removal to the QCustomPlot so + This method is used by the QCPLegend destructor to report legend removal to + the QCustomPlot so it may clear its QCustomPlot::legend member accordingly. */ void QCustomPlot::legendRemoved( QCPLegend* legend ) @@ -11383,8 +13253,10 @@ void QCustomPlot::legendRemoved( QCPLegend* legend ) /*! \internal - Assigns all layers their index (QCPLayer::mIndex) in the mLayers list. This method is thus called - after every operation that changes the layer indices, like layer removal, layer creation, layer + Assigns all layers their index (QCPLayer::mIndex) in the mLayers list. This + method is thus called + after every operation that changes the layer indices, like layer removal, + layer creation, layer moving. */ void QCustomPlot::updateLayerIndices() const @@ -11395,17 +13267,25 @@ void QCustomPlot::updateLayerIndices() const /*! \internal - Returns the layerable at pixel position \a pos. If \a onlySelectable is set to true, only those - layerables that are selectable will be considered. (Layerable subclasses communicate their + Returns the layerable at pixel position \a pos. If \a onlySelectable is set to + true, only those + layerables that are selectable will be considered. (Layerable subclasses + communicate their selectability via the QCPLayerable::selectTest method, by returning -1.) - \a selectionDetails is an output parameter that contains selection specifics of the affected - layerable. This is useful if the respective layerable shall be given a subsequent - QCPLayerable::selectEvent (like in \ref mouseReleaseEvent). \a selectionDetails usually contains - information about which part of the layerable was hit, in multi-part layerables (e.g. + \a selectionDetails is an output parameter that contains selection specifics + of the affected + layerable. This is useful if the respective layerable shall be given a + subsequent + QCPLayerable::selectEvent (like in \ref mouseReleaseEvent). \a + selectionDetails usually contains + information about which part of the layerable was hit, in multi-part + layerables (e.g. QCPAxis::SelectablePart). */ -QCPLayerable* QCustomPlot::layerableAt( const QPointF& pos, bool onlySelectable, QVariant* selectionDetails ) const +QCPLayerable* QCustomPlot::layerableAt( const QPointF& pos, + bool onlySelectable, + QVariant* selectionDetails ) const { for( int layerIndex = mLayers.size() - 1; layerIndex >= 0; --layerIndex ) { @@ -11433,12 +13313,16 @@ QCPLayerable* QCustomPlot::layerableAt( const QPointF& pos, bool onlySelectable, } /*! - Saves the plot to a rastered image file \a fileName in the image format \a format. The plot is - sized to \a width and \a height in pixels and scaled with \a scale. (width 100 and scale 2.0 lead - to a full resolution file with width 200.) If the \a format supports compression, \a quality may + Saves the plot to a rastered image file \a fileName in the image format \a + format. The plot is + sized to \a width and \a height in pixels and scaled with \a scale. (width 100 + and scale 2.0 lead + to a full resolution file with width 200.) If the \a format supports + compression, \a quality may be between 0 and 100 to control it. - Returns true on success. If this function fails, most likely the given \a format isn't supported + Returns true on success. If this function fails, most likely the given \a + format isn't supported by the system, see Qt docs about QImageWriter::supportedImageFormats(). \see saveBmp, saveJpg, savePng, savePdf @@ -11460,14 +13344,16 @@ bool QCustomPlot::saveRastered( const QString& fileName, /*! Renders the plot to a pixmap and returns it. - The plot is sized to \a width and \a height in pixels and scaled with \a scale. (width 100 and + The plot is sized to \a width and \a height in pixels and scaled with \a + scale. (width 100 and scale 2.0 lead to a full resolution pixmap with width 200.) \see toPainter, saveRastered, saveBmp, savePng, saveJpg, savePdf */ QPixmap QCustomPlot::toPixmap( int width, int height, double scale ) { - // this method is somewhat similar to toPainter. Change something here, and a change in toPainter might be necessary, + // this method is somewhat similar to toPainter. Change something here, and a + // change in toPainter might be necessary, // too. int newWidth, newHeight; if( width == 0 || height == 0 ) @@ -11484,10 +13370,11 @@ QPixmap QCustomPlot::toPixmap( int width, int height, double scale ) int scaledHeight = qRound( scale * newHeight ); QPixmap result( scaledWidth, scaledHeight ); - result.fill( - mBackgroundBrush.style() == Qt::SolidPattern - ? mBackgroundBrush.color() - : Qt::transparent ); // if using non-solid pattern, make transparent now and draw brush pattern later + result.fill( mBackgroundBrush.style() == Qt::SolidPattern + ? mBackgroundBrush.color() + : Qt::transparent ); // if using non-solid pattern, make + // transparent now and draw brush pattern + // later QCPPainter painter; painter.begin( &result ); if( painter.isActive() ) @@ -11497,7 +13384,8 @@ QPixmap QCustomPlot::toPixmap( int width, int height, double scale ) painter.setMode( QCPPainter::pmNoCaching ); if( !qFuzzyCompare( scale, 1.0 ) ) { - if( scale > 1.0 ) // for scale < 1 we always want cosmetic pens where possible, because else lines might + if( scale > 1.0 ) // for scale < 1 we always want cosmetic pens where + // possible, because else lines might // disappear for very small scales painter.setMode( QCPPainter::pmNonCosmetic ); painter.scale( scale, scale ); @@ -11519,19 +13407,24 @@ QPixmap QCustomPlot::toPixmap( int width, int height, double scale ) /*! Renders the plot using the passed \a painter. - The plot is sized to \a width and \a height in pixels. If the \a painter's scale is not 1.0, the resulting plot will + The plot is sized to \a width and \a height in pixels. If the \a painter's + scale is not 1.0, the resulting plot will appear scaled accordingly. - \note If you are restricted to using a QPainter (instead of QCPPainter), create a temporary QPicture and open a + \note If you are restricted to using a QPainter (instead of QCPPainter), + create a temporary QPicture and open a QCPPainter - on it. Then call \ref toPainter with this QCPPainter. After ending the paint operation on the picture, draw it with - the QPainter. This will reproduce the painter actions the QCPPainter took, with a QPainter. + on it. Then call \ref toPainter with this QCPPainter. After ending the paint + operation on the picture, draw it with + the QPainter. This will reproduce the painter actions the QCPPainter took, + with a QPainter. \see toPixmap */ void QCustomPlot::toPainter( QCPPainter* painter, int width, int height ) { - // this method is somewhat similar to toPixmap. Change something here, and a change in toPixmap might be necessary, + // this method is somewhat similar to toPixmap. Change something here, and a + // change in toPixmap might be necessary, // too. int newWidth, newHeight; if( width == 0 || height == 0 ) @@ -11550,7 +13443,8 @@ void QCustomPlot::toPainter( QCPPainter* painter, int width, int height ) QRect oldViewport = viewport(); setViewport( QRect( 0, 0, newWidth, newHeight ) ); painter->setMode( QCPPainter::pmNoCaching ); - // warning: the following is different in toPixmap, because a solid background color is applied there via + // warning: the following is different in toPixmap, because a solid + // background color is applied there via // QPixmap::fill // here, we need to do this via QPainter::fillRect. if( mBackgroundBrush.style() != Qt::NoBrush ) @@ -11569,37 +13463,51 @@ void QCustomPlot::toPainter( QCPPainter* painter, int width, int height ) /*! \class QCPColorGradient \brief Defines a color gradient for use with e.g. \ref QCPColorMap - This class describes a color gradient which can be used to encode data with color. For example, - QCPColorMap and QCPColorScale have a \ref QCPColorMap::setGradient "setGradient" method which - takes an instance of this class. Colors are set with \ref setColorStopAt(double position, const QColor &color) + This class describes a color gradient which can be used to encode data with + color. For example, + QCPColorMap and QCPColorScale have a \ref QCPColorMap::setGradient + "setGradient" method which + takes an instance of this class. Colors are set with \ref + setColorStopAt(double position, const QColor &color) with a \a position from 0 to 1. In between these defined color positions, the - color will be interpolated linearly either in RGB or HSV space, see \ref setColorInterpolation. + color will be interpolated linearly either in RGB or HSV space, see \ref + setColorInterpolation. - Alternatively, load one of the preset color gradients shown in the image below, with \ref + Alternatively, load one of the preset color gradients shown in the image + below, with \ref loadPreset, or by directly specifying the preset in the constructor. \image html QCPColorGradient.png - The fact that the \ref QCPColorGradient(GradientPreset preset) constructor allows directly - converting a \ref GradientPreset to a QCPColorGradient, you can also directly pass \ref + The fact that the \ref QCPColorGradient(GradientPreset preset) constructor + allows directly + converting a \ref GradientPreset to a QCPColorGradient, you can also directly + pass \ref GradientPreset to all the \a setGradient methods, e.g.: \code colorMap->setGradient(QCPColorGradient::gpHot); \endcode - The total number of levels used in the gradient can be set with \ref setLevelCount. Whether the - color gradient shall be applied periodically (wrapping around) to data values that lie outside - the data range specified on the plottable instance can be controlled with \ref setPeriodic. + The total number of levels used in the gradient can be set with \ref + setLevelCount. Whether the + color gradient shall be applied periodically (wrapping around) to data values + that lie outside + the data range specified on the plottable instance can be controlled with \ref + setPeriodic. */ /*! - Constructs a new QCPColorGradient initialized with the colors and color interpolation according + Constructs a new QCPColorGradient initialized with the colors and color + interpolation according to \a preset. The color level count is initialized to 350. */ QCPColorGradient::QCPColorGradient( GradientPreset preset ) - : mLevelCount( 350 ), mColorInterpolation( ciRGB ), mPeriodic( false ), mColorBufferInvalidated( true ) + : mLevelCount( 350 ) + , mColorInterpolation( ciRGB ) + , mPeriodic( false ) + , mColorBufferInvalidated( true ) { mColorBuffer.fill( qRgb( 0, 0, 0 ), mLevelCount ); loadPreset( preset ); @@ -11608,12 +13516,14 @@ QCPColorGradient::QCPColorGradient( GradientPreset preset ) /* undocumented operator */ bool QCPColorGradient::operator==( const QCPColorGradient& other ) const { - return ( ( other.mLevelCount == this->mLevelCount ) && ( other.mColorInterpolation == this->mColorInterpolation ) && + return ( ( other.mLevelCount == this->mLevelCount ) && + ( other.mColorInterpolation == this->mColorInterpolation ) && ( other.mPeriodic == this->mPeriodic ) && ( other.mColorStops == this->mColorStops ) ); } /*! - Sets the number of discretization levels of the color gradient to \a n. The default is 350 which + Sets the number of discretization levels of the color gradient to \a n. The + default is 350 which is typically enough to create a smooth appearance. \image html QCPColorGradient-levelcount.png @@ -11633,11 +13543,14 @@ void QCPColorGradient::setLevelCount( int n ) } /*! - Sets at which positions from 0 to 1 which color shall occur. The positions are the keys, the - colors are the values of the passed QMap \a colorStops. In between these color stops, the color + Sets at which positions from 0 to 1 which color shall occur. The positions are + the keys, the + colors are the values of the passed QMap \a colorStops. In between these color + stops, the color is interpolated according to \ref setColorInterpolation. - A more convenient way to create a custom gradient may be to clear all color stops with \ref + A more convenient way to create a custom gradient may be to clear all color + stops with \ref clearColorStops and then adding them one by one with \ref setColorStopAt. \see clearColorStops @@ -11649,8 +13562,10 @@ void QCPColorGradient::setColorStops( const QMap& colorStops ) } /*! - Sets the \a color the gradient will have at the specified \a position (from 0 to 1). In between - these color stops, the color is interpolated according to \ref setColorInterpolation. + Sets the \a color the gradient will have at the specified \a position (from 0 + to 1). In between + these color stops, the color is interpolated according to \ref + setColorInterpolation. \see setColorStops, clearColorStops */ @@ -11661,10 +13576,12 @@ void QCPColorGradient::setColorStopAt( double position, const QColor& color ) } /*! - Sets whether the colors in between the configured color stops (see \ref setColorStopAt) shall be + Sets whether the colors in between the configured color stops (see \ref + setColorStopAt) shall be interpolated linearly in RGB or in HSV color space. - For example, a sweep in RGB space from red to green will have a muddy brown intermediate color, + For example, a sweep in RGB space from red to green will have a muddy brown + intermediate color, whereas in HSV space the intermediate color is yellow. */ void QCPColorGradient::setColorInterpolation( QCPColorGradient::ColorInterpolation interpolation ) @@ -11678,17 +13595,23 @@ void QCPColorGradient::setColorInterpolation( QCPColorGradient::ColorInterpolati /*! Sets whether data points that are outside the configured data range (e.g. \ref - QCPColorMap::setDataRange) are colored by periodically repeating the color gradient or whether - they all have the same color, corresponding to the respective gradient boundary color. + QCPColorMap::setDataRange) are colored by periodically repeating the color + gradient or whether + they all have the same color, corresponding to the respective gradient + boundary color. \image html QCPColorGradient-periodic.png - As shown in the image above, gradients that have the same start and end color are especially - suitable for a periodic gradient mapping, since they produce smooth color transitions throughout + As shown in the image above, gradients that have the same start and end color + are especially + suitable for a periodic gradient mapping, since they produce smooth color + transitions throughout the color map. A preset that has this property is \ref gpHues. - In practice, using periodic color gradients makes sense when the data corresponds to a periodic - dimension, such as an angle or a phase. If this is not the case, the color encoding might become + In practice, using periodic color gradients makes sense when the data + corresponds to a periodic + dimension, such as an angle or a phase. If this is not the case, the color + encoding might become ambiguous, because multiple different data values are shown as the same color. */ void QCPColorGradient::setPeriodic( bool enabled ) @@ -11697,15 +13620,22 @@ void QCPColorGradient::setPeriodic( bool enabled ) } /*! - This method is used to quickly convert a \a data array to colors. The colors will be output in - the array \a scanLine. Both \a data and \a scanLine must have the length \a n when passed to this - function. The data range that shall be used for mapping the data value to the gradient is passed - in \a range. \a logarithmic indicates whether the data values shall be mapped to colors + This method is used to quickly convert a \a data array to colors. The colors + will be output in + the array \a scanLine. Both \a data and \a scanLine must have the length \a n + when passed to this + function. The data range that shall be used for mapping the data value to the + gradient is passed + in \a range. \a logarithmic indicates whether the data values shall be mapped + to colors logarithmically. - if \a data actually contains 2D-data linearized via [row*columnCount + column], you can - set \a dataIndexFactor to columnCount to convert a column instead of a row of the data - array, in \a scanLine. \a scanLine will remain a regular (1D) array. This works because \a data + if \a data actually contains 2D-data linearized via [row*columnCount + + column], you can + set \a dataIndexFactor to columnCount to convert a column instead of + a row of the data + array, in \a scanLine. \a scanLine will remain a regular (1D) array. This + works because \a data is addressed data[i*dataIndexFactor]. */ void QCPColorGradient::colorize( const double* data, @@ -11736,7 +13666,8 @@ void QCPColorGradient::colorize( const double* data, { for( int i = 0; i < n; ++i ) { - int index = (int)( ( data[dataIndexFactor * i] - range.lower ) * posToIndexFactor ) % mLevelCount; + int index = + (int)( ( data[dataIndexFactor * i] - range.lower ) * posToIndexFactor ) % mLevelCount; if( index < 0 ) index += mLevelCount; scanLine[i] = mColorBuffer.at( index ); @@ -11761,9 +13692,9 @@ void QCPColorGradient::colorize( const double* data, { for( int i = 0; i < n; ++i ) { - int index = - (int)( qLn( data[dataIndexFactor * i] / range.lower ) / qLn( range.upper / range.lower ) * mLevelCount ) % - mLevelCount; + int index = (int)( qLn( data[dataIndexFactor * i] / range.lower ) / + qLn( range.upper / range.lower ) * mLevelCount ) % + mLevelCount; if( index < 0 ) index += mLevelCount; scanLine[i] = mColorBuffer.at( index ); @@ -11773,7 +13704,8 @@ void QCPColorGradient::colorize( const double* data, { for( int i = 0; i < n; ++i ) { - int index = qLn( data[dataIndexFactor * i] / range.lower ) / qLn( range.upper / range.lower ) * mLevelCount; + int index = qLn( data[dataIndexFactor * i] / range.lower ) / + qLn( range.upper / range.lower ) * mLevelCount; if( index < 0 ) index = 0; else if( index >= mLevelCount ) @@ -11786,11 +13718,15 @@ void QCPColorGradient::colorize( const double* data, /*! \internal - This method is used to colorize a single data value given in \a position, to colors. The data - range that shall be used for mapping the data value to the gradient is passed in \a range. \a - logarithmic indicates whether the data value shall be mapped to a color logarithmically. + This method is used to colorize a single data value given in \a position, to + colors. The data + range that shall be used for mapping the data value to the gradient is passed + in \a range. \a + logarithmic indicates whether the data value shall be mapped to a color + logarithmically. - If an entire array of data values shall be converted, rather use \ref colorize, for better + If an entire array of data values shall be converted, rather use \ref + colorize, for better performance. */ QRgb QCPColorGradient::color( double position, const QCPRange& range, bool logarithmic ) @@ -11820,7 +13756,8 @@ QRgb QCPColorGradient::color( double position, const QCPRange& range, bool logar } /*! - Clears the current color stops and loads the specified \a preset. A preset consists of predefined + Clears the current color stops and loads the specified \a preset. A preset + consists of predefined color stops and the corresponding color interpolation method. The available presets are: @@ -11942,7 +13879,8 @@ void QCPColorGradient::clearColorStops() } /*! - Returns an inverted gradient. The inverted gradient has all properties as this \ref + Returns an inverted gradient. The inverted gradient has all properties as this + \ref QCPColorGradient, but the order of the color stops is inverted. \see setColorStops, setColorStopAt @@ -11951,15 +13889,18 @@ QCPColorGradient QCPColorGradient::inverted() const { QCPColorGradient result( *this ); result.clearColorStops(); - for( QMap::const_iterator it = mColorStops.constBegin(); it != mColorStops.constEnd(); ++it ) + for( QMap::const_iterator it = mColorStops.constBegin(); + it != mColorStops.constEnd(); ++it ) result.setColorStopAt( 1.0 - it.key(), it.value() ); return result; } /*! \internal - Updates the internal color buffer which will be used by \ref colorize and \ref color, to quickly - convert positions to colors. This is where the interpolation between color stops is calculated. + Updates the internal color buffer which will be used by \ref colorize and \ref + color, to quickly + convert positions to colors. This is where the interpolation between color + stops is calculated. */ void QCPColorGradient::updateColorBuffer() { @@ -11972,19 +13913,24 @@ void QCPColorGradient::updateColorBuffer() { double position = i * indexToPosFactor; QMap::const_iterator it = mColorStops.lowerBound( position ); - if( it == mColorStops.constEnd() ) // position is on or after last stop, use color of last stop + if( it == mColorStops.constEnd() ) // position is on or after last stop, + // use color of last stop { mColorBuffer[i] = ( it - 1 ).value().rgb(); } - else if( it == mColorStops.constBegin() ) // position is on or before first stop, use color of first stop + else if( it == mColorStops.constBegin() ) // position is on or before + // first stop, use color of + // first stop { mColorBuffer[i] = it.value().rgb(); } - else // position is in between stops (or on an intermediate stop), interpolate color + else // position is in between stops (or on an intermediate stop), + // interpolate color { QMap::const_iterator high = it; QMap::const_iterator low = it - 1; - double t = ( position - low.key() ) / ( high.key() - low.key() ); // interpolation factor 0..1 + double t = + ( position - low.key() ) / ( high.key() - low.key() ); // interpolation factor 0..1 switch( mColorInterpolation ) { case ciRGB: @@ -12010,9 +13956,10 @@ void QCPColorGradient::updateColorBuffer() hue += 1.0; else if( hue >= 1.0 ) hue -= 1.0; - mColorBuffer[i] = QColor::fromHsvF( hue, ( 1 - t ) * lowHsv.saturationF() + t * highHsv.saturationF(), - ( 1 - t ) * lowHsv.valueF() + t * highHsv.valueF() ) - .rgb(); + mColorBuffer[i] = + QColor::fromHsvF( hue, ( 1 - t ) * lowHsv.saturationF() + t * highHsv.saturationF(), + ( 1 - t ) * lowHsv.valueF() + t * highHsv.valueF() ) + .rgb(); break; } } @@ -12037,37 +13984,55 @@ void QCPColorGradient::updateColorBuffer() /*! \class QCPAxisRect \brief Holds multiple axes and arranges them in a rectangular shape. - This class represents an axis rect, a rectangular area that is bounded on all sides with an + This class represents an axis rect, a rectangular area that is bounded on all + sides with an arbitrary number of axes. - Initially QCustomPlot has one axis rect, accessible via QCustomPlot::axisRect(). However, the - layout system allows to have multiple axis rects, e.g. arranged in a grid layout + Initially QCustomPlot has one axis rect, accessible via + QCustomPlot::axisRect(). However, the + layout system allows to have multiple axis rects, e.g. arranged in a grid + layout (QCustomPlot::plotLayout). - By default, QCPAxisRect comes with four axes, at bottom, top, left and right. They can be - accessed via \ref axis by providing the respective axis type (\ref QCPAxis::AxisType) and index. - If you need all axes in the axis rect, use \ref axes. The top and right axes are set to be - invisible initially (QCPAxis::setVisible). To add more axes to a side, use \ref addAxis or \ref + By default, QCPAxisRect comes with four axes, at bottom, top, left and right. + They can be + accessed via \ref axis by providing the respective axis type (\ref + QCPAxis::AxisType) and index. + If you need all axes in the axis rect, use \ref axes. The top and right axes + are set to be + invisible initially (QCPAxis::setVisible). To add more axes to a side, use + \ref addAxis or \ref addAxes. To remove an axis, use \ref removeAxis. - The axis rect layerable itself only draws a background pixmap or color, if specified (\ref - setBackground). It is placed on the "background" layer initially (see \ref QCPLayer for an - explanation of the QCustomPlot layer system). The axes that are held by the axis rect can be + The axis rect layerable itself only draws a background pixmap or color, if + specified (\ref + setBackground). It is placed on the "background" layer initially (see \ref + QCPLayer for an + explanation of the QCustomPlot layer system). The axes that are held by the + axis rect can be placed on other layers, independently of the axis rect. - Every axis rect has a child layout of type \ref QCPLayoutInset. It is accessible via \ref - insetLayout and can be used to have other layout elements (or even other layouts with multiple + Every axis rect has a child layout of type \ref QCPLayoutInset. It is + accessible via \ref + insetLayout and can be used to have other layout elements (or even other + layouts with multiple elements) hovering inside the axis rect. - If an axis rect is clicked and dragged, it processes this by moving certain axis ranges. The - behaviour can be controlled with \ref setRangeDrag and \ref setRangeDragAxes. If the mouse wheel - is scrolled while the cursor is on the axis rect, certain axes are scaled. This is controllable - via \ref setRangeZoom, \ref setRangeZoomAxes and \ref setRangeZoomFactor. These interactions are - only enabled if \ref QCustomPlot::setInteractions contains \ref QCP::iRangeDrag and \ref + If an axis rect is clicked and dragged, it processes this by moving certain + axis ranges. The + behaviour can be controlled with \ref setRangeDrag and \ref setRangeDragAxes. + If the mouse wheel + is scrolled while the cursor is on the axis rect, certain axes are scaled. + This is controllable + via \ref setRangeZoom, \ref setRangeZoomAxes and \ref setRangeZoomFactor. + These interactions are + only enabled if \ref QCustomPlot::setInteractions contains \ref + QCP::iRangeDrag and \ref QCP::iRangeZoom. \image html AxisRectSpacingOverview.png -
    Overview of the spacings and paddings that define the geometry of an axis. The dashed +
    Overview of the spacings and paddings that define the geometry of an + axis. The dashed line on the far left indicates the viewport/widget border.
    */ @@ -12075,7 +14040,8 @@ void QCPColorGradient::updateColorBuffer() /*! \fn QCPLayoutInset *QCPAxisRect::insetLayout() const - Returns the inset layout of this axis rect. It can be used to place other layout elements (or + Returns the inset layout of this axis rect. It can be used to place other + layout elements (or even layouts with multiple other elements) inside/on top of an axis rect. \see QCPLayoutInset @@ -12083,93 +14049,106 @@ void QCPColorGradient::updateColorBuffer() /*! \fn int QCPAxisRect::left() const - Returns the pixel position of the left border of this axis rect. Margins are not taken into + Returns the pixel position of the left border of this axis rect. Margins are + not taken into account here, so the returned value is with respect to the inner \ref rect. */ /*! \fn int QCPAxisRect::right() const - Returns the pixel position of the right border of this axis rect. Margins are not taken into + Returns the pixel position of the right border of this axis rect. Margins are + not taken into account here, so the returned value is with respect to the inner \ref rect. */ /*! \fn int QCPAxisRect::top() const - Returns the pixel position of the top border of this axis rect. Margins are not taken into + Returns the pixel position of the top border of this axis rect. Margins are + not taken into account here, so the returned value is with respect to the inner \ref rect. */ /*! \fn int QCPAxisRect::bottom() const - Returns the pixel position of the bottom border of this axis rect. Margins are not taken into + Returns the pixel position of the bottom border of this axis rect. Margins are + not taken into account here, so the returned value is with respect to the inner \ref rect. */ /*! \fn int QCPAxisRect::width() const - Returns the pixel width of this axis rect. Margins are not taken into account here, so the + Returns the pixel width of this axis rect. Margins are not taken into account + here, so the returned value is with respect to the inner \ref rect. */ /*! \fn int QCPAxisRect::height() const - Returns the pixel height of this axis rect. Margins are not taken into account here, so the + Returns the pixel height of this axis rect. Margins are not taken into account + here, so the returned value is with respect to the inner \ref rect. */ /*! \fn QSize QCPAxisRect::size() const - Returns the pixel size of this axis rect. Margins are not taken into account here, so the + Returns the pixel size of this axis rect. Margins are not taken into account + here, so the returned value is with respect to the inner \ref rect. */ /*! \fn QPoint QCPAxisRect::topLeft() const - Returns the top left corner of this axis rect in pixels. Margins are not taken into account here, + Returns the top left corner of this axis rect in pixels. Margins are not taken + into account here, so the returned value is with respect to the inner \ref rect. */ /*! \fn QPoint QCPAxisRect::topRight() const - Returns the top right corner of this axis rect in pixels. Margins are not taken into account + Returns the top right corner of this axis rect in pixels. Margins are not + taken into account here, so the returned value is with respect to the inner \ref rect. */ /*! \fn QPoint QCPAxisRect::bottomLeft() const - Returns the bottom left corner of this axis rect in pixels. Margins are not taken into account + Returns the bottom left corner of this axis rect in pixels. Margins are not + taken into account here, so the returned value is with respect to the inner \ref rect. */ /*! \fn QPoint QCPAxisRect::bottomRight() const - Returns the bottom right corner of this axis rect in pixels. Margins are not taken into account + Returns the bottom right corner of this axis rect in pixels. Margins are not + taken into account here, so the returned value is with respect to the inner \ref rect. */ /*! \fn QPoint QCPAxisRect::center() const - Returns the center of this axis rect in pixels. Margins are not taken into account here, so the + Returns the center of this axis rect in pixels. Margins are not taken into + account here, so the returned value is with respect to the inner \ref rect. */ /* end documentation of inline functions */ /*! - Creates a QCPAxisRect instance and sets default values. An axis is added for each of the four + Creates a QCPAxisRect instance and sets default values. An axis is added for + each of the four sides, the top and right axes are set invisible initially. */ QCPAxisRect::QCPAxisRect( QCustomPlot* parentPlot, bool setupDefaultAxes ) - : QCPLayoutElement( parentPlot ), - mBackgroundBrush( Qt::NoBrush ), - mBackgroundScaled( true ), - mBackgroundScaledMode( Qt::KeepAspectRatioByExpanding ), - mInsetLayout( new QCPLayoutInset ), - mRangeDrag( Qt::Horizontal | Qt::Vertical ), - mRangeZoom( Qt::Horizontal | Qt::Vertical ), - mRangeZoomFactorHorz( 0.85 ), - mRangeZoomFactorVert( 0.85 ), - mDragging( false ) + : QCPLayoutElement( parentPlot ) + , mBackgroundBrush( Qt::NoBrush ) + , mBackgroundScaled( true ) + , mBackgroundScaledMode( Qt::KeepAspectRatioByExpanding ) + , mInsetLayout( new QCPLayoutInset ) + , mRangeDrag( Qt::Horizontal | Qt::Vertical ) + , mRangeZoom( Qt::Horizontal | Qt::Vertical ) + , mRangeZoomFactorHorz( 0.85 ) + , mRangeZoomFactorVert( 0.85 ) + , mDragging( false ) { mInsetLayout->initializeParentPlot( mParentPlot ); mInsetLayout->setParentLayerable( this ); @@ -12224,7 +14203,8 @@ int QCPAxisRect::axisCount( QCPAxis::AxisType type ) const } /*! - Returns the axis with the given \a index on the axis rect side specified with \a type. + Returns the axis with the given \a index on the axis rect side specified with + \a type. \see axisCount, axes */ @@ -12245,7 +14225,8 @@ QCPAxis* QCPAxisRect::axis( QCPAxis::AxisType type, int index ) const /*! Returns all axes on the axis rect sides specified with \a types. - \a types may be a single \ref QCPAxis::AxisType or an or-combination, to get the axes of + \a types may be a single \ref QCPAxis::AxisType or an or-combination, + to get the axes of multiple sides. \see axis @@ -12271,7 +14252,7 @@ QList QCPAxisRect::axes( QCPAxis::AxisTypes types ) const QList QCPAxisRect::axes() const { QList result; - QHashIterator > it( mAxes ); + QHashIterator> it( mAxes ); while( it.hasNext() ) { it.next(); @@ -12283,8 +14264,10 @@ QList QCPAxisRect::axes() const /*! Adds a new axis to the axis rect side specified with \a type, and returns it. - If an axis rect side already contains one or more axes, the lower and upper endings of the new - axis (\ref QCPAxis::setLowerEnding, \ref QCPAxis::setUpperEnding) are initialized to \ref + If an axis rect side already contains one or more axes, the lower and upper + endings of the new + axis (\ref QCPAxis::setLowerEnding, \ref QCPAxis::setUpperEnding) are + initialized to \ref QCPLineEnding::esHalfBar. \see addAxes, setupFullAxesBox @@ -12292,7 +14275,8 @@ QList QCPAxisRect::axes() const QCPAxis* QCPAxisRect::addAxis( QCPAxis::AxisType type ) { QCPAxis* newAxis = new QCPAxis( this, type ); - if( mAxes[type].size() > 0 ) // multiple axes on one side, add half-bar axis ending to additional axes with offset + if( mAxes[type].size() > 0 ) // multiple axes on one side, add half-bar axis + // ending to additional axes with offset { bool invert = ( type == QCPAxis::atRight ) || ( type == QCPAxis::atBottom ); newAxis->setLowerEnding( QCPLineEnding( QCPLineEnding::esHalfBar, 6, 10, !invert ) ); @@ -12303,8 +14287,10 @@ QCPAxis* QCPAxisRect::addAxis( QCPAxis::AxisType type ) } /*! - Adds a new axis with \ref addAxis to each axis rect side specified in \a types. This may be an - or-combination of QCPAxis::AxisType, so axes can be added to multiple sides at once. + Adds a new axis with \ref addAxis to each axis rect side specified in \a + types. This may be an + or-combination of QCPAxis::AxisType, so axes can be added to multiple + sides at once. Returns a list of the added axes. @@ -12333,18 +14319,21 @@ QList QCPAxisRect::addAxes( QCPAxis::AxisTypes types ) */ bool QCPAxisRect::removeAxis( QCPAxis* axis ) { - // don't access axis->axisType() to provide safety when axis is an invalid pointer, rather go through all axis + // don't access axis->axisType() to provide safety when axis is an invalid + // pointer, rather go through all axis // containers: - QHashIterator > it( mAxes ); + QHashIterator> it( mAxes ); while( it.hasNext() ) { it.next(); if( it.value().contains( axis ) ) { mAxes[it.key()].removeOne( axis ); - if( qobject_cast( parentPlot() ) ) // make sure this isn't called from QObject dtor when - // QCustomPlot is already destructed (happens when the axis rect - // is not in any layout and thus QObject-child of QCustomPlot) + if( qobject_cast( parentPlot() ) ) // make sure this isn't + // called from QObject dtor + // when + // QCustomPlot is already destructed (happens when the axis rect + // is not in any layout and thus QObject-child of QCustomPlot) parentPlot()->axisRemoved( axis ); delete axis; return true; @@ -12355,8 +14344,10 @@ bool QCPAxisRect::removeAxis( QCPAxis* axis ) } /*! - Convenience function to create an axis on each side that doesn't have any axes yet and set their - visibility to true. Further, the top/right axes are assigned the following properties of the + Convenience function to create an axis on each side that doesn't have any axes + yet and set their + visibility to true. Further, the top/right axes are assigned the following + properties of the bottom/left axes: \li range (\ref QCPAxis::setRange) @@ -12375,10 +14366,13 @@ bool QCPAxisRect::removeAxis( QCPAxis* axis ) \li date time format (\ref QCPAxis::setDateTimeFormat) \li date time spec (\ref QCPAxis::setDateTimeSpec) - Tick labels (\ref QCPAxis::setTickLabels) of the right and top axes are set to false. + Tick labels (\ref QCPAxis::setTickLabels) of the right and top axes are set to + false. - If \a connectRanges is true, the \ref QCPAxis::rangeChanged "rangeChanged" signals of the bottom - and left axes are connected to the \ref QCPAxis::setRange slots of the top and right axes. + If \a connectRanges is true, the \ref QCPAxis::rangeChanged "rangeChanged" + signals of the bottom + and left axes are connected to the \ref QCPAxis::setRange slots of the top and + right axes. */ void QCPAxisRect::setupFullAxesBox( bool connectRanges ) { @@ -12452,14 +14446,16 @@ void QCPAxisRect::setupFullAxesBox( bool connectRanges ) /*! Returns a list of all the plottables that are associated with this axis rect. - A plottable is considered associated with an axis rect if its key or value axis (or both) is in + A plottable is considered associated with an axis rect if its key or value + axis (or both) is in this axis rect. \see graphs, items */ QList QCPAxisRect::plottables() const { - // Note: don't append all QCPAxis::plottables() into a list, because we might get duplicate entries + // Note: don't append all QCPAxis::plottables() into a list, because we might + // get duplicate entries QList result; for( int i = 0; i < mParentPlot->mPlottables.size(); ++i ) { @@ -12473,14 +14469,16 @@ QList QCPAxisRect::plottables() const /*! Returns a list of all the graphs that are associated with this axis rect. - A graph is considered associated with an axis rect if its key or value axis (or both) is in + A graph is considered associated with an axis rect if its key or value axis + (or both) is in this axis rect. \see plottables, items */ QList QCPAxisRect::graphs() const { - // Note: don't append all QCPAxis::graphs() into a list, because we might get duplicate entries + // Note: don't append all QCPAxis::graphs() into a list, because we might get + // duplicate entries QList result; for( int i = 0; i < mParentPlot->mGraphs.size(); ++i ) { @@ -12494,16 +14492,19 @@ QList QCPAxisRect::graphs() const /*! Returns a list of all the items that are associated with this axis rect. - An item is considered associated with an axis rect if any of its positions has key or value axis + An item is considered associated with an axis rect if any of its positions has + key or value axis set to an axis that is in this axis rect, or if any of its positions has \ref - QCPItemPosition::setAxisRect set to the axis rect, or if the clip axis rect (\ref + QCPItemPosition::setAxisRect set to the axis rect, or if the clip axis rect + (\ref QCPAbstractItem::setClipAxisRect) is set to this axis rect. \see plottables, graphs */ QList QCPAxisRect::items() const { - // Note: don't just append all QCPAxis::items() into a list, because we might get duplicate entries + // Note: don't just append all QCPAxis::items() into a list, because we might + // get duplicate entries // and miss those items that have this axis rect as clipAxisRect. QList result; for( int itemId = 0; itemId < mParentPlot->mItems.size(); ++itemId ) @@ -12516,7 +14517,8 @@ QList QCPAxisRect::items() const QList positions = mParentPlot->mItems.at( itemId )->positions(); for( int posId = 0; posId < positions.size(); ++posId ) { - if( positions.at( posId )->axisRect() == this || positions.at( posId )->keyAxis()->axisRect() == this || + if( positions.at( posId )->axisRect() == this || + positions.at( posId )->keyAxis()->axisRect() == this || positions.at( posId )->valueAxis()->axisRect() == this ) { result.append( mParentPlot->mItems.at( itemId ) ); @@ -12528,11 +14530,14 @@ QList QCPAxisRect::items() const } /*! - This method is called automatically upon replot and doesn't need to be called by users of + This method is called automatically upon replot and doesn't need to be called + by users of QCPAxisRect. - Calls the base class implementation to update the margins (see \ref QCPLayoutElement::update), - and finally passes the \ref rect to the inset layout (\ref insetLayout) and calls its + Calls the base class implementation to update the margins (see \ref + QCPLayoutElement::update), + and finally passes the \ref rect to the inset layout (\ref insetLayout) and + calls its QCPInsetLayout::update function. */ void QCPAxisRect::update( UpdatePhase phase ) @@ -12557,7 +14562,8 @@ void QCPAxisRect::update( UpdatePhase phase ) break; } - // pass update call on to inset layout (doesn't happen automatically, because QCPAxisRect doesn't derive from + // pass update call on to inset layout (doesn't happen automatically, because + // QCPAxisRect doesn't derive from // QCPLayout): mInsetLayout->update( phase ); } @@ -12588,19 +14594,26 @@ void QCPAxisRect::draw( QCPPainter* painter ) } /*! - Sets \a pm as the axis background pixmap. The axis background pixmap will be drawn inside the - axis rect. Since axis rects place themselves on the "background" layer by default, the axis rect + Sets \a pm as the axis background pixmap. The axis background pixmap will be + drawn inside the + axis rect. Since axis rects place themselves on the "background" layer by + default, the axis rect backgrounds are usually drawn below everything else. - For cases where the provided pixmap doesn't have the same size as the axis rect, scaling can be - enabled with \ref setBackgroundScaled and the scaling mode (i.e. whether and how the aspect ratio - is preserved) can be set with \ref setBackgroundScaledMode. To set all these options in one call, + For cases where the provided pixmap doesn't have the same size as the axis + rect, scaling can be + enabled with \ref setBackgroundScaled and the scaling mode (i.e. whether and + how the aspect ratio + is preserved) can be set with \ref setBackgroundScaledMode. To set all these + options in one call, consider using the overloaded version of this function. - Below the pixmap, the axis rect may be optionally filled with a brush, if specified with \ref + Below the pixmap, the axis rect may be optionally filled with a brush, if + specified with \ref setBackground(const QBrush &brush). - \see setBackgroundScaled, setBackgroundScaledMode, setBackground(const QBrush &brush) + \see setBackgroundScaled, setBackgroundScaledMode, setBackground(const QBrush + &brush) */ void QCPAxisRect::setBackground( const QPixmap& pm ) { @@ -12610,11 +14623,14 @@ void QCPAxisRect::setBackground( const QPixmap& pm ) /*! \overload - Sets \a brush as the background brush. The axis rect background will be filled with this brush. - Since axis rects place themselves on the "background" layer by default, the axis rect backgrounds + Sets \a brush as the background brush. The axis rect background will be filled + with this brush. + Since axis rects place themselves on the "background" layer by default, the + axis rect backgrounds are usually drawn below everything else. - The brush will be drawn before (under) any background pixmap, which may be specified with \ref + The brush will be drawn before (under) any background pixmap, which may be + specified with \ref setBackground(const QPixmap &pm). To disable drawing of a background brush, set \a brush to Qt::NoBrush. @@ -12628,10 +14644,12 @@ void QCPAxisRect::setBackground( const QBrush& brush ) /*! \overload - Allows setting the background pixmap of the axis rect, whether it shall be scaled and how it + Allows setting the background pixmap of the axis rect, whether it shall be + scaled and how it shall be scaled in one call. - \see setBackground(const QPixmap &pm), setBackgroundScaled, setBackgroundScaledMode + \see setBackground(const QPixmap &pm), setBackgroundScaled, + setBackgroundScaledMode */ void QCPAxisRect::setBackground( const QPixmap& pm, bool scaled, Qt::AspectRatioMode mode ) { @@ -12642,12 +14660,16 @@ void QCPAxisRect::setBackground( const QPixmap& pm, bool scaled, Qt::AspectRatio } /*! - Sets whether the axis background pixmap shall be scaled to fit the axis rect or not. If \a scaled - is set to true, you may control whether and how the aspect ratio of the original pixmap is + Sets whether the axis background pixmap shall be scaled to fit the axis rect + or not. If \a scaled + is set to true, you may control whether and how the aspect ratio of the + original pixmap is preserved with \ref setBackgroundScaledMode. - Note that the scaled version of the original pixmap is buffered, so there is no performance - penalty on replots. (Except when the axis rect dimensions are changed continuously.) + Note that the scaled version of the original pixmap is buffered, so there is + no performance + penalty on replots. (Except when the axis rect dimensions are changed + continuously.) \see setBackground, setBackgroundScaledMode */ @@ -12657,8 +14679,10 @@ void QCPAxisRect::setBackgroundScaled( bool scaled ) } /*! - If scaling of the axis background pixmap is enabled (\ref setBackgroundScaled), use this function to - define whether and how the aspect ratio of the original pixmap passed to \ref setBackground is preserved. + If scaling of the axis background pixmap is enabled (\ref + setBackgroundScaled), use this function to + define whether and how the aspect ratio of the original pixmap passed to \ref + setBackground is preserved. \see setBackground, setBackgroundScaled */ void QCPAxisRect::setBackgroundScaledMode( Qt::AspectRatioMode mode ) @@ -12697,17 +14721,21 @@ double QCPAxisRect::rangeZoomFactor( Qt::Orientation orientation ) } /*! - Sets which axis orientation may be range dragged by the user with mouse interaction. + Sets which axis orientation may be range dragged by the user with mouse + interaction. What orientation corresponds to which specific axis can be set with \ref setRangeDragAxes(QCPAxis *horizontal, QCPAxis *vertical). By default, the horizontal axis is the bottom axis (xAxis) and the vertical axis is the left axis (yAxis). - To disable range dragging entirely, pass 0 as \a orientations or remove \ref QCP::iRangeDrag from \ref - QCustomPlot::setInteractions. To enable range dragging for both directions, pass Qt::Horizontal | + To disable range dragging entirely, pass 0 as \a orientations or remove \ref + QCP::iRangeDrag from \ref + QCustomPlot::setInteractions. To enable range dragging for both directions, + pass Qt::Horizontal | Qt::Vertical as \a orientations. - In addition to setting \a orientations to a non-zero value, make sure \ref QCustomPlot::setInteractions + In addition to setting \a orientations to a non-zero value, make sure \ref + QCustomPlot::setInteractions contains \ref QCP::iRangeDrag to enable the range dragging interaction. \see setRangeZoom, setRangeDragAxes, setNoAntialiasingOnDrag @@ -12718,16 +14746,22 @@ void QCPAxisRect::setRangeDrag( Qt::Orientations orientations ) } /*! - Sets which axis orientation may be zoomed by the user with the mouse wheel. What orientation - corresponds to which specific axis can be set with \ref setRangeZoomAxes(QCPAxis *horizontal, - QCPAxis *vertical). By default, the horizontal axis is the bottom axis (xAxis) and the vertical + Sets which axis orientation may be zoomed by the user with the mouse wheel. + What orientation + corresponds to which specific axis can be set with \ref + setRangeZoomAxes(QCPAxis *horizontal, + QCPAxis *vertical). By default, the horizontal axis is the bottom axis (xAxis) + and the vertical axis is the left axis (yAxis). - To disable range zooming entirely, pass 0 as \a orientations or remove \ref QCP::iRangeZoom from \ref - QCustomPlot::setInteractions. To enable range zooming for both directions, pass Qt::Horizontal | + To disable range zooming entirely, pass 0 as \a orientations or remove \ref + QCP::iRangeZoom from \ref + QCustomPlot::setInteractions. To enable range zooming for both directions, + pass Qt::Horizontal | Qt::Vertical as \a orientations. - In addition to setting \a orientations to a non-zero value, make sure \ref QCustomPlot::setInteractions + In addition to setting \a orientations to a non-zero value, make sure \ref + QCustomPlot::setInteractions contains \ref QCP::iRangeZoom to enable the range zooming interaction. \see setRangeZoomFactor, setRangeZoomAxes, setRangeDrag @@ -12738,7 +14772,8 @@ void QCPAxisRect::setRangeZoom( Qt::Orientations orientations ) } /*! - Sets the axes whose range will be dragged when \ref setRangeDrag enables mouse range dragging + Sets the axes whose range will be dragged when \ref setRangeDrag enables mouse + range dragging on the QCustomPlot widget. \see setRangeZoomAxes @@ -12750,9 +14785,12 @@ void QCPAxisRect::setRangeDragAxes( QCPAxis* horizontal, QCPAxis* vertical ) } /*! - Sets the axes whose range will be zoomed when \ref setRangeZoom enables mouse wheel zooming on the - QCustomPlot widget. The two axes can be zoomed with different strengths, when different factors - are passed to \ref setRangeZoomFactor(double horizontalFactor, double verticalFactor). + Sets the axes whose range will be zoomed when \ref setRangeZoom enables mouse + wheel zooming on the + QCustomPlot widget. The two axes can be zoomed with different strengths, when + different factors + are passed to \ref setRangeZoomFactor(double horizontalFactor, double + verticalFactor). \see setRangeDragAxes */ @@ -12763,13 +14801,18 @@ void QCPAxisRect::setRangeZoomAxes( QCPAxis* horizontal, QCPAxis* vertical ) } /*! - Sets how strong one rotation step of the mouse wheel zooms, when range zoom was activated with - \ref setRangeZoom. The two parameters \a horizontalFactor and \a verticalFactor provide a way to - let the horizontal axis zoom at different rates than the vertical axis. Which axis is horizontal + Sets how strong one rotation step of the mouse wheel zooms, when range zoom + was activated with + \ref setRangeZoom. The two parameters \a horizontalFactor and \a + verticalFactor provide a way to + let the horizontal axis zoom at different rates than the vertical axis. Which + axis is horizontal and which is vertical, can be set with \ref setRangeZoomAxes. - When the zoom factor is greater than one, scrolling the mouse wheel backwards (towards the user) - will zoom in (make the currently visible range smaller). For zoom factors smaller than one, the + When the zoom factor is greater than one, scrolling the mouse wheel backwards + (towards the user) + will zoom in (make the currently visible range smaller). For zoom factors + smaller than one, the same scrolling direction will zoom out. */ void QCPAxisRect::setRangeZoomFactor( double horizontalFactor, double verticalFactor ) @@ -12790,18 +14833,25 @@ void QCPAxisRect::setRangeZoomFactor( double factor ) /*! \internal - Draws the background of this axis rect. It may consist of a background fill (a QBrush) and a + Draws the background of this axis rect. It may consist of a background fill (a + QBrush) and a pixmap. - If a brush was given via \ref setBackground(const QBrush &brush), this function first draws an + If a brush was given via \ref setBackground(const QBrush &brush), this + function first draws an according filling inside the axis rect with the provided \a painter. - Then, if a pixmap was provided via \ref setBackground, this function buffers the scaled version - depending on \ref setBackgroundScaled and \ref setBackgroundScaledMode and then draws it inside + Then, if a pixmap was provided via \ref setBackground, this function buffers + the scaled version + depending on \ref setBackgroundScaled and \ref setBackgroundScaledMode and + then draws it inside the axis rect with the provided \a painter. The scaled version is buffered in - mScaledBackgroundPixmap to prevent expensive rescaling at every redraw. It is only updated, when - the axis rect has changed in a way that requires a rescale of the background pixmap (this is - dependant on the \ref setBackgroundScaledMode), or when a differend axis backgroud pixmap was + mScaledBackgroundPixmap to prevent expensive rescaling at every redraw. It is + only updated, when + the axis rect has changed in a way that requires a rescale of the background + pixmap (this is + dependant on the \ref setBackgroundScaledMode), or when a differend axis + backgroud pixmap was set. \see setBackground, setBackgroundScaled, setBackgroundScaledMode @@ -12821,24 +14871,29 @@ void QCPAxisRect::drawBackground( QCPPainter* painter ) QSize scaledSize( mBackgroundPixmap.size() ); scaledSize.scale( mRect.size(), mBackgroundScaledMode ); if( mScaledBackgroundPixmap.size() != scaledSize ) - mScaledBackgroundPixmap = - mBackgroundPixmap.scaled( mRect.size(), mBackgroundScaledMode, Qt::SmoothTransformation ); - painter->drawPixmap( mRect.topLeft(), mScaledBackgroundPixmap, - QRect( 0, 0, mRect.width(), mRect.height() ) & mScaledBackgroundPixmap.rect() ); + mScaledBackgroundPixmap = mBackgroundPixmap.scaled( mRect.size(), mBackgroundScaledMode, + Qt::SmoothTransformation ); + painter->drawPixmap( + mRect.topLeft(), mScaledBackgroundPixmap, + QRect( 0, 0, mRect.width(), mRect.height() ) & mScaledBackgroundPixmap.rect() ); } else { - painter->drawPixmap( mRect.topLeft(), mBackgroundPixmap, QRect( 0, 0, mRect.width(), mRect.height() ) ); + painter->drawPixmap( mRect.topLeft(), mBackgroundPixmap, + QRect( 0, 0, mRect.width(), mRect.height() ) ); } } } /*! \internal - This function makes sure multiple axes on the side specified with \a type don't collide, but are - distributed according to their respective space requirement (QCPAxis::calculateMargin). + This function makes sure multiple axes on the side specified with \a type + don't collide, but are + distributed according to their respective space requirement + (QCPAxis::calculateMargin). - It does this by setting an appropriate offset (\ref QCPAxis::setOffset) on all axes except the + It does this by setting an appropriate offset (\ref QCPAxis::setOffset) on all + axes except the one with index zero. This function is called by \ref calculateAutoMargin. @@ -12849,14 +14904,17 @@ void QCPAxisRect::updateAxesOffset( QCPAxis::AxisType type ) if( axesList.isEmpty() ) return; - bool isFirstVisible = !axesList.first()->visible(); // if the first axis is visible, the second axis (which is where - // the loop starts) isn't the first visible axis, so initialize - // with false + bool isFirstVisible = !axesList.first()->visible(); // if the first axis is + // visible, the second + // axis (which is where + // the loop starts) isn't the first visible axis, so initialize + // with false for( int i = 1; i < axesList.size(); ++i ) { int offset = axesList.at( i - 1 )->offset() + axesList.at( i - 1 )->calculateMargin(); - if( axesList.at( i )->visible() ) // only add inner tick length to offset if this axis is visible and it's not the - // first visible one (might happen if true first axis is invisible) + if( axesList.at( i )->visible() ) // only add inner tick length to offset if + // this axis is visible and it's not the + // first visible one (might happen if true first axis is invisible) { if( !isFirstVisible ) offset += axesList.at( i )->tickLengthIn(); @@ -12874,7 +14932,8 @@ int QCPAxisRect::calculateAutoMargin( QCP::MarginSide side ) updateAxesOffset( QCPAxis::marginSideToAxisType( side ) ); - // note: only need to look at the last (outer most) axis to determine the total margin, due to updateAxisOffset call + // note: only need to look at the last (outer most) axis to determine the + // total margin, due to updateAxisOffset call const QList axesList = mAxes.value( QCPAxis::marginSideToAxisType( side ) ); if( axesList.size() > 0 ) return axesList.last()->offset() + axesList.last()->calculateMargin(); @@ -12884,19 +14943,23 @@ int QCPAxisRect::calculateAutoMargin( QCP::MarginSide side ) /*! \internal - Event handler for when a mouse button is pressed on the axis rect. If the left mouse button is - pressed, the range dragging interaction is initialized (the actual range manipulation happens in + Event handler for when a mouse button is pressed on the axis rect. If the left + mouse button is + pressed, the range dragging interaction is initialized (the actual range + manipulation happens in the \ref mouseMoveEvent). - The mDragging flag is set to true and some anchor points are set that are needed to determine the + The mDragging flag is set to true and some anchor points are set that are + needed to determine the distance the mouse was dragged in the mouse move/release events later. \see mouseMoveEvent, mouseReleaseEvent */ void QCPAxisRect::mousePressEvent( QMouseEvent* event ) { - mDragStart = event->pos(); // need this even when not LeftButton is pressed, to determine in releaseEvent whether it - // was a full click (no position change between press and release) + mDragStart = event->pos(); // need this even when not LeftButton is pressed, + // to determine in releaseEvent whether it + // was a full click (no position change between press and release) if( event->buttons() & Qt::LeftButton ) { mDragging = true; @@ -12919,7 +14982,8 @@ void QCPAxisRect::mousePressEvent( QMouseEvent* event ) /*! \internal - Event handler for when the mouse is moved on the axis rect. If range dragging was activated in a + Event handler for when the mouse is moved on the axis rect. If range dragging + was activated in a preceding \ref mousePressEvent, the range is moved accordingly. \see mousePressEvent, mouseReleaseEvent @@ -12935,15 +14999,17 @@ void QCPAxisRect::mouseMoveEvent( QMouseEvent* event ) { if( rangeDragHorzAxis->mScaleType == QCPAxis::stLinear ) { - double diff = - rangeDragHorzAxis->pixelToCoord( mDragStart.x() ) - rangeDragHorzAxis->pixelToCoord( event->pos().x() ); - rangeDragHorzAxis->setRange( mDragStartHorzRange.lower + diff, mDragStartHorzRange.upper + diff ); + double diff = rangeDragHorzAxis->pixelToCoord( mDragStart.x() ) - + rangeDragHorzAxis->pixelToCoord( event->pos().x() ); + rangeDragHorzAxis->setRange( mDragStartHorzRange.lower + diff, + mDragStartHorzRange.upper + diff ); } else if( rangeDragHorzAxis->mScaleType == QCPAxis::stLogarithmic ) { - double diff = - rangeDragHorzAxis->pixelToCoord( mDragStart.x() ) / rangeDragHorzAxis->pixelToCoord( event->pos().x() ); - rangeDragHorzAxis->setRange( mDragStartHorzRange.lower * diff, mDragStartHorzRange.upper * diff ); + double diff = rangeDragHorzAxis->pixelToCoord( mDragStart.x() ) / + rangeDragHorzAxis->pixelToCoord( event->pos().x() ); + rangeDragHorzAxis->setRange( mDragStartHorzRange.lower * diff, + mDragStartHorzRange.upper * diff ); } } } @@ -12953,15 +15019,17 @@ void QCPAxisRect::mouseMoveEvent( QMouseEvent* event ) { if( rangeDragVertAxis->mScaleType == QCPAxis::stLinear ) { - double diff = - rangeDragVertAxis->pixelToCoord( mDragStart.y() ) - rangeDragVertAxis->pixelToCoord( event->pos().y() ); - rangeDragVertAxis->setRange( mDragStartVertRange.lower + diff, mDragStartVertRange.upper + diff ); + double diff = rangeDragVertAxis->pixelToCoord( mDragStart.y() ) - + rangeDragVertAxis->pixelToCoord( event->pos().y() ); + rangeDragVertAxis->setRange( mDragStartVertRange.lower + diff, + mDragStartVertRange.upper + diff ); } else if( rangeDragVertAxis->mScaleType == QCPAxis::stLogarithmic ) { - double diff = - rangeDragVertAxis->pixelToCoord( mDragStart.y() ) / rangeDragVertAxis->pixelToCoord( event->pos().y() ); - rangeDragVertAxis->setRange( mDragStartVertRange.lower * diff, mDragStartVertRange.upper * diff ); + double diff = rangeDragVertAxis->pixelToCoord( mDragStart.y() ) / + rangeDragVertAxis->pixelToCoord( event->pos().y() ); + rangeDragVertAxis->setRange( mDragStartVertRange.lower * diff, + mDragStartVertRange.upper * diff ); } } } @@ -12988,16 +15056,25 @@ void QCPAxisRect::mouseReleaseEvent( QMouseEvent* event ) /*! \internal - Event handler for mouse wheel events. If rangeZoom is Qt::Horizontal, Qt::Vertical or both, the - ranges of the axes defined as rangeZoomHorzAxis and rangeZoomVertAxis are scaled. The center of - the scaling operation is the current cursor position inside the axis rect. The scaling factor is - dependant on the mouse wheel delta (which direction the wheel was rotated) to provide a natural - zooming feel. The Strength of the zoom can be controlled via \ref setRangeZoomFactor. + Event handler for mouse wheel events. If rangeZoom is Qt::Horizontal, + Qt::Vertical or both, the + ranges of the axes defined as rangeZoomHorzAxis and rangeZoomVertAxis are + scaled. The center of + the scaling operation is the current cursor position inside the axis rect. The + scaling factor is + dependant on the mouse wheel delta (which direction the wheel was rotated) to + provide a natural + zooming feel. The Strength of the zoom can be controlled via \ref + setRangeZoomFactor. - Note, that event->delta() is usually +/-120 for single rotation steps. However, if the mouse - wheel is turned rapidly, many steps may bunch up to one event, so the event->delta() may then be - multiples of 120. This is taken into account here, by calculating \a wheelSteps and using it as - exponent of the range zoom factor. This takes care of the wheel direction automatically, by + Note, that event->delta() is usually +/-120 for single rotation steps. + However, if the mouse + wheel is turned rapidly, many steps may bunch up to one event, so the + event->delta() may then be + multiples of 120. This is taken into account here, by calculating \a + wheelSteps and using it as + exponent of the range zoom factor. This takes care of the wheel direction + automatically, by inverting the factor, when the wheel step is negative (f^-1 = 1/f). */ void QCPAxisRect::wheelEvent( QWheelEvent* event ) @@ -13013,13 +15090,15 @@ void QCPAxisRect::wheelEvent( QWheelEvent* event ) { factor = pow( mRangeZoomFactorHorz, wheelSteps ); if( mRangeZoomHorzAxis.data() ) - mRangeZoomHorzAxis.data()->scaleRange( factor, mRangeZoomHorzAxis.data()->pixelToCoord( event->pos().x() ) ); + mRangeZoomHorzAxis.data()->scaleRange( + factor, mRangeZoomHorzAxis.data()->pixelToCoord( event->pos().x() ) ); } if( mRangeZoom.testFlag( Qt::Vertical ) ) { factor = pow( mRangeZoomFactorVert, wheelSteps ); if( mRangeZoomVertAxis.data() ) - mRangeZoomVertAxis.data()->scaleRange( factor, mRangeZoomVertAxis.data()->pixelToCoord( event->pos().y() ) ); + mRangeZoomVertAxis.data()->scaleRange( + factor, mRangeZoomVertAxis.data()->pixelToCoord( event->pos().y() ) ); } mParentPlot->replot(); } @@ -13033,10 +15112,12 @@ void QCPAxisRect::wheelEvent( QWheelEvent* event ) /*! \class QCPAbstractLegendItem \brief The abstract base class for all entries in a QCPLegend. - It defines a very basic interface for entries in a QCPLegend. For representing plottables in the + It defines a very basic interface for entries in a QCPLegend. For representing + plottables in the legend, the subclass \ref QCPPlottableLegendItem is more suitable. - Only derive directly from this class when you need absolute freedom (e.g. a custom legend entry + Only derive directly from this class when you need absolute freedom (e.g. a + custom legend entry that's not even associated with a plottable). You must implement the following pure virtual functions: @@ -13049,7 +15130,8 @@ void QCPAxisRect::wheelEvent( QWheelEvent* event ) A pointer to the parent QCPLegend. QFont \b mFont - The generic font of the item. You should use this font for all or at least the most prominent text of the + The generic font of the item. You should use this font for all or at + least the most prominent text of the item. @@ -13059,25 +15141,28 @@ void QCPAxisRect::wheelEvent( QWheelEvent* event ) /*! \fn void QCPAbstractLegendItem::selectionChanged(bool selected) - This signal is emitted when the selection state of this legend item has changed, either by user + This signal is emitted when the selection state of this legend item has + changed, either by user interaction or by a direct call to \ref setSelected. */ /* end of documentation of signals */ /*! - Constructs a QCPAbstractLegendItem and associates it with the QCPLegend \a parent. This does not - cause the item to be added to \a parent, so \ref QCPLegend::addItem must be called separately. + Constructs a QCPAbstractLegendItem and associates it with the QCPLegend \a + parent. This does not + cause the item to be added to \a parent, so \ref QCPLegend::addItem must be + called separately. */ QCPAbstractLegendItem::QCPAbstractLegendItem( QCPLegend* parent ) - : QCPLayoutElement( parent->parentPlot() ), - mParentLegend( parent ), - mFont( parent->font() ), - mTextColor( parent->textColor() ), - mSelectedFont( parent->selectedFont() ), - mSelectedTextColor( parent->selectedTextColor() ), - mSelectable( true ), - mSelected( false ) + : QCPLayoutElement( parent->parentPlot() ) + , mParentLegend( parent ) + , mFont( parent->font() ) + , mTextColor( parent->textColor() ) + , mSelectedFont( parent->selectedFont() ) + , mSelectedTextColor( parent->selectedTextColor() ) + , mSelectable( true ) + , mSelected( false ) { setLayer( "legend" ); setMargins( QMargins( 8, 2, 8, 2 ) ); @@ -13104,7 +15189,8 @@ void QCPAbstractLegendItem::setTextColor( const QColor& color ) } /*! - When this legend item is selected, \a font is used to draw generic text, instead of the normal + When this legend item is selected, \a font is used to draw generic text, + instead of the normal font set with \ref setFont. \see setFont, QCPLegend::setSelectedFont @@ -13115,7 +15201,8 @@ void QCPAbstractLegendItem::setSelectedFont( const QFont& font ) } /*! - When this legend item is selected, \a color is used to draw generic text, instead of the normal + When this legend item is selected, \a color is used to draw generic text, + instead of the normal color set with \ref setTextColor. \see setTextColor, QCPLegend::setSelectedTextColor @@ -13142,7 +15229,8 @@ void QCPAbstractLegendItem::setSelectable( bool selectable ) /*! Sets whether this specific legend item is selected. - It is possible to set the selection state of this item by calling this function directly, even if + It is possible to set the selection state of this item by calling this + function directly, even if setSelectable is set to false. \see setSelectableParts, QCustomPlot::setInteractions @@ -13157,12 +15245,15 @@ void QCPAbstractLegendItem::setSelected( bool selected ) } /* inherits documentation from base class */ -double QCPAbstractLegendItem::selectTest( const QPointF& pos, bool onlySelectable, QVariant* details ) const +double QCPAbstractLegendItem::selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details ) const { Q_UNUSED( details ) if( !mParentPlot ) return -1; - if( onlySelectable && ( !mSelectable || !mParentLegend->selectableParts().testFlag( QCPLegend::spItems ) ) ) + if( onlySelectable && + ( !mSelectable || !mParentLegend->selectableParts().testFlag( QCPLegend::spItems ) ) ) return -1; if( mRect.contains( pos.toPoint() ) ) @@ -13217,27 +15308,40 @@ void QCPAbstractLegendItem::deselectEvent( bool* selectionStateChanged ) //////////////////////////////////////////////////////////////////////////////////////////////////// /*! \class QCPPlottableLegendItem - \brief A legend item representing a plottable with an icon and the plottable name. + \brief A legend item representing a plottable with an icon and the plottable + name. - This is the standard legend item for plottables. It displays an icon of the plottable next to the + This is the standard legend item for plottables. It displays an icon of the + plottable next to the plottable name. The icon is drawn by the respective plottable itself (\ref - QCPAbstractPlottable::drawLegendIcon), and tries to give an intuitive symbol for the plottable. - For example, the QCPGraph draws a centered horizontal line and/or a single scatter point in the + QCPAbstractPlottable::drawLegendIcon), and tries to give an intuitive symbol + for the plottable. + For example, the QCPGraph draws a centered horizontal line and/or a single + scatter point in the middle. - Legend items of this type are always associated with one plottable (retrievable via the - plottable() function and settable with the constructor). You may change the font of the plottable - name with \ref setFont. Icon padding and border pen is taken from the parent QCPLegend, see \ref + Legend items of this type are always associated with one plottable + (retrievable via the + plottable() function and settable with the constructor). You may change the + font of the plottable + name with \ref setFont. Icon padding and border pen is taken from the parent + QCPLegend, see \ref QCPLegend::setIconBorderPen and \ref QCPLegend::setIconTextPadding. - The function \ref QCPAbstractPlottable::addToLegend/\ref QCPAbstractPlottable::removeFromLegend - creates/removes legend items of this type in the default implementation. However, these functions - may be reimplemented such that a different kind of legend item (e.g a direct subclass of + The function \ref QCPAbstractPlottable::addToLegend/\ref + QCPAbstractPlottable::removeFromLegend + creates/removes legend items of this type in the default implementation. + However, these functions + may be reimplemented such that a different kind of legend item (e.g a direct + subclass of QCPAbstractLegendItem) is used for that plottable. - Since QCPLegend is based on QCPLayoutGrid, a legend item itself is just a subclass of - QCPLayoutElement. While it could be added to a legend (or any other layout) via the normal layout - interface, QCPLegend has specialized functions for handling legend items conveniently, see the + Since QCPLegend is based on QCPLayoutGrid, a legend item itself is just a + subclass of + QCPLayoutElement. While it could be added to a legend (or any other layout) + via the normal layout + interface, QCPLegend has specialized functions for handling legend items + conveniently, see the documentation of \ref QCPLegend. */ @@ -13246,8 +15350,10 @@ void QCPAbstractLegendItem::deselectEvent( bool* selectionStateChanged ) Once it's created, it can be added to the legend via \ref QCPLegend::addItem. - A more convenient way of adding/removing a plottable to/from the legend is via the functions \ref - QCPAbstractPlottable::addToLegend and \ref QCPAbstractPlottable::removeFromLegend. + A more convenient way of adding/removing a plottable to/from the legend is via + the functions \ref + QCPAbstractPlottable::addToLegend and \ref + QCPAbstractPlottable::removeFromLegend. */ QCPPlottableLegendItem::QCPPlottableLegendItem( QCPLegend* parent, QCPAbstractPlottable* plottable ) : QCPAbstractLegendItem( parent ), mPlottable( plottable ) @@ -13256,7 +15362,8 @@ QCPPlottableLegendItem::QCPPlottableLegendItem( QCPLegend* parent, QCPAbstractPl /*! \internal - Returns the pen that shall be used to draw the icon border, taking into account the selection + Returns the pen that shall be used to draw the icon border, taking into + account the selection state of this item. */ QPen QCPPlottableLegendItem::getIconBorderPen() const @@ -13266,7 +15373,8 @@ QPen QCPPlottableLegendItem::getIconBorderPen() const /*! \internal - Returns the text color that shall be used to draw text, taking into account the selection state + Returns the text color that shall be used to draw text, taking into account + the selection state of this item. */ QColor QCPPlottableLegendItem::getTextColor() const @@ -13276,7 +15384,8 @@ QColor QCPPlottableLegendItem::getTextColor() const /*! \internal - Returns the font that shall be used to draw text, taking into account the selection state of this + Returns the font that shall be used to draw text, taking into account the + selection state of this item. */ QFont QCPPlottableLegendItem::getFont() const @@ -13286,8 +15395,10 @@ QFont QCPPlottableLegendItem::getFont() const /*! \internal - Draws the item with \a painter. The size and position of the drawn legend item is defined by the - parent layout (typically a \ref QCPLegend) and the \ref minimumSizeHint and \ref maximumSizeHint + Draws the item with \a painter. The size and position of the drawn legend item + is defined by the + parent layout (typically a \ref QCPLegend) and the \ref minimumSizeHint and + \ref maximumSizeHint of this legend item. */ void QCPPlottableLegendItem::draw( QCPPainter* painter ) @@ -13297,15 +15408,14 @@ void QCPPlottableLegendItem::draw( QCPPainter* painter ) painter->setFont( getFont() ); painter->setPen( QPen( getTextColor() ) ); QSizeF iconSize = mParentLegend->iconSize(); - QRectF textRect = - painter->fontMetrics().boundingRect( 0, 0, 0, iconSize.height(), Qt::TextDontClip, mPlottable->name() ); + QRectF textRect = painter->fontMetrics().boundingRect( 0, 0, 0, iconSize.height(), + Qt::TextDontClip, mPlottable->name() ); QRectF iconRect( mRect.topLeft(), iconSize ); - int textHeight = qMax( - textRect.height(), - iconSize - .height() ); // if text has smaller height than icon, center text vertically in icon height, else align tops - painter->drawText( mRect.x() + iconSize.width() + mParentLegend->iconTextPadding(), mRect.y(), textRect.width(), - textHeight, Qt::TextDontClip, mPlottable->name() ); + int textHeight = qMax( textRect.height(), iconSize.height() ); // if text has smaller height than + // icon, center text vertically in + // icon height, else align tops + painter->drawText( mRect.x() + iconSize.width() + mParentLegend->iconTextPadding(), mRect.y(), + textRect.width(), textHeight, Qt::TextDontClip, mPlottable->name() ); // draw icon: painter->save(); painter->setClipRect( iconRect, Qt::IntersectClip ); @@ -13322,7 +15432,8 @@ void QCPPlottableLegendItem::draw( QCPPainter* painter ) /*! \internal - Calculates and returns the size of this item. This includes the icon, the text and the padding in + Calculates and returns the size of this item. This includes the icon, the text + and the padding in between. */ QSize QCPPlottableLegendItem::minimumSizeHint() const @@ -13333,10 +15444,12 @@ QSize QCPPlottableLegendItem::minimumSizeHint() const QRect textRect; QFontMetrics fontMetrics( getFont() ); QSize iconSize = mParentLegend->iconSize(); - textRect = fontMetrics.boundingRect( 0, 0, 0, iconSize.height(), Qt::TextDontClip, mPlottable->name() ); - result.setWidth( iconSize.width() + mParentLegend->iconTextPadding() + textRect.width() + mMargins.left() + - mMargins.right() ); - result.setHeight( qMax( textRect.height(), iconSize.height() ) + mMargins.top() + mMargins.bottom() ); + textRect = + fontMetrics.boundingRect( 0, 0, 0, iconSize.height(), Qt::TextDontClip, mPlottable->name() ); + result.setWidth( iconSize.width() + mParentLegend->iconTextPadding() + textRect.width() + + mMargins.left() + mMargins.right() ); + result.setHeight( qMax( textRect.height(), iconSize.height() ) + mMargins.top() + + mMargins.bottom() ); return result; } @@ -13347,25 +15460,39 @@ QSize QCPPlottableLegendItem::minimumSizeHint() const /*! \class QCPLegend \brief Manages a legend inside a QCustomPlot. - A legend is a small box somewhere in the plot which lists plottables with their name and icon. + A legend is a small box somewhere in the plot which lists plottables with + their name and icon. - Normally, the legend is populated by calling \ref QCPAbstractPlottable::addToLegend. The - respective legend item can be removed with \ref QCPAbstractPlottable::removeFromLegend. However, - QCPLegend also offers an interface to add and manipulate legend items directly: \ref item, \ref + Normally, the legend is populated by calling \ref + QCPAbstractPlottable::addToLegend. The + respective legend item can be removed with \ref + QCPAbstractPlottable::removeFromLegend. However, + QCPLegend also offers an interface to add and manipulate legend items + directly: \ref item, \ref itemWithPlottable, \ref itemCount, \ref addItem, \ref removeItem, etc. - The QCPLegend derives from QCPLayoutGrid and as such can be placed in any position a - QCPLayoutElement may be positioned. The legend items are themselves QCPLayoutElements which are - placed in the grid layout of the legend. QCPLegend only adds an interface specialized for - handling child elements of type QCPAbstractLegendItem, as mentioned above. In principle, any - other layout elements may also be added to a legend via the normal \ref QCPLayoutGrid interface. - However, the QCPAbstractLegendItem-Interface will ignore those elements (e.g. \ref itemCount will + The QCPLegend derives from QCPLayoutGrid and as such can be placed in any + position a + QCPLayoutElement may be positioned. The legend items are themselves + QCPLayoutElements which are + placed in the grid layout of the legend. QCPLegend only adds an interface + specialized for + handling child elements of type QCPAbstractLegendItem, as mentioned above. In + principle, any + other layout elements may also be added to a legend via the normal \ref + QCPLayoutGrid interface. + However, the QCPAbstractLegendItem-Interface will ignore those elements (e.g. + \ref itemCount will only return the number of items with QCPAbstractLegendItems type). - By default, every QCustomPlot has one legend (QCustomPlot::legend) which is placed in the inset - layout of the main axis rect (\ref QCPAxisRect::insetLayout). To move the legend to another - position inside the axis rect, use the methods of the \ref QCPLayoutInset. To move the legend - outside of the axis rect, place it anywhere else with the QCPLayout/QCPLayoutElement interface. + By default, every QCustomPlot has one legend (QCustomPlot::legend) which is + placed in the inset + layout of the main axis rect (\ref QCPAxisRect::insetLayout). To move the + legend to another + position inside the axis rect, use the methods of the \ref QCPLayoutInset. To + move the legend + outside of the axis rect, place it anywhere else with the + QCPLayout/QCPLayoutElement interface. */ /* start of documentation of signals */ @@ -13380,9 +15507,11 @@ QSize QCPPlottableLegendItem::minimumSizeHint() const /* end of documentation of signals */ /*! - Constructs a new QCPLegend instance with \a parentPlot as the containing plot and default values. + Constructs a new QCPLegend instance with \a parentPlot as the containing plot + and default values. - Note that by default, QCustomPlot already contains a legend ready to be used as + Note that by default, QCustomPlot already contains a legend ready to be used + as QCustomPlot::legend */ QCPLegend::QCPLegend() @@ -13418,7 +15547,8 @@ QCPLegend::~QCPLegend() /* no doc for getter, see setSelectedParts */ QCPLegend::SelectableParts QCPLegend::selectedParts() const { - // check whether any legend elements selected, if yes, add spItems to return value + // check whether any legend elements selected, if yes, add spItems to return + // value bool hasSelectedItems = false; for( int i = 0; i < itemCount(); ++i ) { @@ -13451,8 +15581,10 @@ void QCPLegend::setBrush( const QBrush& brush ) } /*! - Sets the default font of legend text. Legend items that draw text (e.g. the name of a graph) will - use this font by default. However, a different font can be specified on a per-item-basis by + Sets the default font of legend text. Legend items that draw text (e.g. the + name of a graph) will + use this font by default. However, a different font can be specified on a + per-item-basis by accessing the specific legend item. This function will also set \a font on all already existing legend items. @@ -13470,8 +15602,10 @@ void QCPLegend::setFont( const QFont& font ) } /*! - Sets the default color of legend text. Legend items that draw text (e.g. the name of a graph) - will use this color by default. However, a different colors can be specified on a per-item-basis + Sets the default color of legend text. Legend items that draw text (e.g. the + name of a graph) + will use this color by default. However, a different colors can be specified + on a per-item-basis by accessing the specific legend item. This function will also set \a color on all already existing legend items. @@ -13506,8 +15640,10 @@ void QCPLegend::setIconSize( int width, int height ) } /*! - Sets the horizontal space in pixels between the legend icon and the text next to it. - Legend items that draw an icon (e.g. a visual representation of the graph) and text (e.g. the + Sets the horizontal space in pixels between the legend icon and the text next + to it. + Legend items that draw an icon (e.g. a visual representation of the graph) and + text (e.g. the name of the graph) will use this space by default. */ void QCPLegend::setIconTextPadding( int padding ) @@ -13516,7 +15652,8 @@ void QCPLegend::setIconTextPadding( int padding ) } /*! - Sets the pen used to draw a border around each legend icon. Legend items that draw an + Sets the pen used to draw a border around each legend icon. Legend items that + draw an icon (e.g. a visual representation of the graph) will use this pen by default. If no border is wanted, set this to \a Qt::NoPen. @@ -13527,11 +15664,14 @@ void QCPLegend::setIconBorderPen( const QPen& pen ) } /*! - Sets whether the user can (de-)select the parts in \a selectable by clicking on the QCustomPlot surface. + Sets whether the user can (de-)select the parts in \a selectable by clicking + on the QCustomPlot surface. (When \ref QCustomPlot::setInteractions contains \ref QCP::iSelectLegend.) - However, even when \a selectable is set to a value not allowing the selection of a specific part, - it is still possible to set the selection of this part manually, by calling \ref setSelectedParts + However, even when \a selectable is set to a value not allowing the selection + of a specific part, + it is still possible to set the selection of this part manually, by calling + \ref setSelectedParts directly. \see SelectablePart, setSelectedParts @@ -13546,37 +15686,49 @@ void QCPLegend::setSelectableParts( const SelectableParts& selectable ) } /*! - Sets the selected state of the respective legend parts described by \ref SelectablePart. When a part - is selected, it uses a different pen/font and brush. If some legend items are selected and \a selected + Sets the selected state of the respective legend parts described by \ref + SelectablePart. When a part + is selected, it uses a different pen/font and brush. If some legend items are + selected and \a selected doesn't contain \ref spItems, those items become deselected. - The entire selection mechanism is handled automatically when \ref QCustomPlot::setInteractions - contains iSelectLegend. You only need to call this function when you wish to change the selection + The entire selection mechanism is handled automatically when \ref + QCustomPlot::setInteractions + contains iSelectLegend. You only need to call this function when you wish to + change the selection state manually. - This function can change the selection state of a part even when \ref setSelectableParts was set to a + This function can change the selection state of a part even when \ref + setSelectableParts was set to a value that actually excludes the part. - emits the \ref selectionChanged signal when \a selected is different from the previous selection state. + emits the \ref selectionChanged signal when \a selected is different from the + previous selection state. - Note that it doesn't make sense to set the selected state \ref spItems here when it wasn't set - before, because there's no way to specify which exact items to newly select. Do this by calling - \ref QCPAbstractLegendItem::setSelected directly on the legend item you wish to select. + Note that it doesn't make sense to set the selected state \ref spItems here + when it wasn't set + before, because there's no way to specify which exact items to newly select. + Do this by calling + \ref QCPAbstractLegendItem::setSelected directly on the legend item you wish + to select. - \see SelectablePart, setSelectableParts, selectTest, setSelectedBorderPen, setSelectedIconBorderPen, setSelectedBrush, + \see SelectablePart, setSelectableParts, selectTest, setSelectedBorderPen, + setSelectedIconBorderPen, setSelectedBrush, setSelectedFont */ void QCPLegend::setSelectedParts( const SelectableParts& selected ) { SelectableParts newSelected = selected; - mSelectedParts = this->selectedParts(); // update mSelectedParts in case item selection changed + mSelectedParts = this->selectedParts(); // update mSelectedParts in case item + // selection changed if( mSelectedParts != newSelected ) { if( !mSelectedParts.testFlag( spItems ) && newSelected.testFlag( spItems ) ) // attempt to set spItems flag (can't do that) { - qDebug() << Q_FUNC_INFO << "spItems flag can not be set, it can only be unset with this function"; + qDebug() << Q_FUNC_INFO << "spItems flag can not be set, it can only be " + "unset with this function"; newSelected &= ~spItems; } if( mSelectedParts.testFlag( spItems ) && @@ -13594,7 +15746,8 @@ void QCPLegend::setSelectedParts( const SelectableParts& selected ) } /*! - When the legend box is selected, this pen is used to draw the border instead of the normal pen + When the legend box is selected, this pen is used to draw the border instead + of the normal pen set via \ref setBorderPen. \see setSelectedParts, setSelectableParts, setSelectedBrush @@ -13605,7 +15758,8 @@ void QCPLegend::setSelectedBorderPen( const QPen& pen ) } /*! - Sets the pen legend items will use to draw their icon borders, when they are selected. + Sets the pen legend items will use to draw their icon borders, when they are + selected. \see setSelectedParts, setSelectableParts, setSelectedFont */ @@ -13615,7 +15769,8 @@ void QCPLegend::setSelectedIconBorderPen( const QPen& pen ) } /*! - When the legend box is selected, this brush is used to draw the legend background instead of the normal brush + When the legend box is selected, this brush is used to draw the legend + background instead of the normal brush set via \ref setBrush. \see setSelectedParts, setSelectableParts, setSelectedBorderPen @@ -13643,7 +15798,8 @@ void QCPLegend::setSelectedFont( const QFont& font ) } /*! - Sets the default text color that is used by legend items when they are selected. + Sets the default text color that is used by legend items when they are + selected. This function will also set \a color on all already existing legend items. @@ -13670,7 +15826,8 @@ QCPAbstractLegendItem* QCPLegend::item( int index ) const } /*! - Returns the QCPPlottableLegendItem which is associated with \a plottable (e.g. a \ref QCPGraph*). + Returns the QCPPlottableLegendItem which is associated with \a plottable (e.g. + a \ref QCPGraph*). If such an item isn't in the legend, returns 0. \see hasItemWithPlottable @@ -13711,7 +15868,8 @@ bool QCPLegend::hasItem( QCPAbstractLegendItem* item ) const } /*! - Returns whether the legend contains a QCPPlottableLegendItem which is associated with \a plottable (e.g. a \ref + Returns whether the legend contains a QCPPlottableLegendItem which is + associated with \a plottable (e.g. a \ref QCPGraph*). If such an item isn't in the legend, returns false. @@ -13725,7 +15883,8 @@ bool QCPLegend::hasItemWithPlottable( const QCPAbstractPlottable* plottable ) co /*! Adds \a item to the legend, if it's not present already. - Returns true on sucess, i.e. if the item wasn't in the list already and has been successfuly added. + Returns true on sucess, i.e. if the item wasn't in the list already and has + been successfuly added. The legend takes ownership of the item. */ @@ -13783,7 +15942,8 @@ void QCPLegend::clearItems() } /*! - Returns the legend items that are currently selected. If no items are selected, + Returns the legend items that are currently selected. If no items are + selected, the list is empty. \see QCPAbstractLegendItem::setSelected, setSelectable @@ -13804,12 +15964,15 @@ QList QCPLegend::selectedItems() const /*! \internal - A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter + A convenience function to easily set the QPainter::Antialiased hint on the + provided \a painter before drawing main legend elements. - This is the antialiasing state the painter passed to the \ref draw method is in by default. + This is the antialiasing state the painter passed to the \ref draw method is + in by default. - This function takes into account the local setting of the antialiasing flag as well as the + This function takes into account the local setting of the antialiasing flag as + well as the overrides set with \ref QCustomPlot::setAntialiasedElements and \ref QCustomPlot::setNotAntialiasedElements. @@ -13822,7 +15985,8 @@ void QCPLegend::applyDefaultAntialiasingHint( QCPPainter* painter ) const /*! \internal - Returns the pen used to paint the border of the legend, taking into account the selection state + Returns the pen used to paint the border of the legend, taking into account + the selection state of the legend box. */ QPen QCPLegend::getBorderPen() const @@ -13832,7 +15996,8 @@ QPen QCPLegend::getBorderPen() const /*! \internal - Returns the brush used to paint the background of the legend, taking into account the selection + Returns the brush used to paint the background of the legend, taking into + account the selection state of the legend box. */ QBrush QCPLegend::getBrush() const @@ -13842,7 +16007,8 @@ QBrush QCPLegend::getBrush() const /*! \internal - Draws the legend box with the provided \a painter. The individual legend items are layerables + Draws the legend box with the provided \a painter. The individual legend items + are layerables themselves, thus are drawn independently. */ void QCPLegend::draw( QCPPainter* painter ) @@ -13871,7 +16037,10 @@ double QCPLegend::selectTest( const QPointF& pos, bool onlySelectable, QVariant* } /* inherits documentation from base class */ -void QCPLegend::selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ) +void QCPLegend::selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ) { Q_UNUSED( event ) mSelectedParts = selectedParts(); // in case item selection has changed @@ -13879,9 +16048,12 @@ void QCPLegend::selectEvent( QMouseEvent* event, bool additive, const QVariant& { SelectableParts selBefore = mSelectedParts; setSelectedParts( additive ? mSelectedParts ^ spLegendBox - : mSelectedParts | spLegendBox ); // no need to unset spItems in !additive case, because - // they will be deselected by QCustomPlot (they're - // normal QCPLayerables with own deselectEvent) + : mSelectedParts | spLegendBox ); // no need to + // unset spItems + // in !additive + // case, because + // they will be deselected by QCustomPlot (they're + // normal QCPLayerables with own deselectEvent) if( selectionStateChanged ) *selectionStateChanged = mSelectedParts != selBefore; } @@ -13925,17 +16097,22 @@ void QCPLegend::parentPlotInitialized( QCustomPlot* parentPlot ) /*! \class QCPPlotTitle \brief A layout element displaying a plot title text - The text may be specified with \ref setText, theformatting can be controlled with \ref setFont + The text may be specified with \ref setText, theformatting can be controlled + with \ref setFont and \ref setTextColor. A plot title can be added as follows: \code - customPlot->plotLayout()->insertRow(0); // inserts an empty row above the default axis rect - customPlot->plotLayout()->addElement(0, 0, new QCPPlotTitle(customPlot, "Your Plot Title")); + customPlot->plotLayout()->insertRow(0); // inserts an empty row above the + default axis rect + customPlot->plotLayout()->addElement(0, 0, new QCPPlotTitle(customPlot, "Your + Plot Title")); \endcode - Since a plot title is a common requirement, QCustomPlot offers specialized selection signals for - easy interaction with QCPPlotTitle. If a layout element of type QCPPlotTitle is clicked, the + Since a plot title is a common requirement, QCustomPlot offers specialized + selection signals for + easy interaction with QCPPlotTitle. If a layout element of type QCPPlotTitle + is clicked, the signal \ref QCustomPlot::titleClick is emitted. A double click emits the \ref QCustomPlot::titleDoubleClick signal. */ @@ -13944,7 +16121,8 @@ void QCPLegend::parentPlotInitialized( QCustomPlot* parentPlot ) /*! \fn void QCPPlotTitle::selectionChanged(bool selected) - This signal is emitted when the selection state has changed to \a selected, either by user + This signal is emitted when the selection state has changed to \a selected, + either by user interaction or by a direct call to \ref setSelected. \see setSelected, setSelectable @@ -13953,48 +16131,55 @@ void QCPLegend::parentPlotInitialized( QCustomPlot* parentPlot ) /* end documentation of signals */ /*! - Creates a new QCPPlotTitle instance and sets default values. The initial text is empty (\ref setText). + Creates a new QCPPlotTitle instance and sets default values. The initial text + is empty (\ref setText). - To set the title text in the constructor, rather use \ref QCPPlotTitle(QCustomPlot *parentPlot, const QString &text). + To set the title text in the constructor, rather use \ref + QCPPlotTitle(QCustomPlot *parentPlot, const QString &text). */ QCPPlotTitle::QCPPlotTitle( QCustomPlot* parentPlot ) - : QCPLayoutElement( parentPlot ), - mFont( QFont( "sans serif", 13 * 1.5, QFont::Bold ) ), - mTextColor( Qt::black ), - mSelectedFont( QFont( "sans serif", 13 * 1.6, QFont::Bold ) ), - mSelectedTextColor( Qt::blue ), - mSelectable( false ), - mSelected( false ) + : QCPLayoutElement( parentPlot ) + , mFont( QFont( "sans serif", 13 * 1.5, QFont::Bold ) ) + , mTextColor( Qt::black ) + , mSelectedFont( QFont( "sans serif", 13 * 1.6, QFont::Bold ) ) + , mSelectedTextColor( Qt::blue ) + , mSelectable( false ) + , mSelected( false ) { if( parentPlot ) { setLayer( parentPlot->currentLayer() ); mFont = QFont( parentPlot->font().family(), parentPlot->font().pointSize() * 1.5, QFont::Bold ); - mSelectedFont = QFont( parentPlot->font().family(), parentPlot->font().pointSize() * 1.6, QFont::Bold ); + mSelectedFont = + QFont( parentPlot->font().family(), parentPlot->font().pointSize() * 1.6, QFont::Bold ); } setMargins( QMargins( 5, 5, 5, 0 ) ); } /*! \overload - Creates a new QCPPlotTitle instance and sets default values. The initial text is set to \a text. + Creates a new QCPPlotTitle instance and sets default values. The initial text + is set to \a text. */ QCPPlotTitle::QCPPlotTitle( QCustomPlot* parentPlot, const QString& text ) - : QCPLayoutElement( parentPlot ), - mText( text ), - mFont( QFont( parentPlot->font().family(), parentPlot->font().pointSize() * 1.5, QFont::Bold ) ), - mTextColor( Qt::black ), - mSelectedFont( QFont( parentPlot->font().family(), parentPlot->font().pointSize() * 1.6, QFont::Bold ) ), - mSelectedTextColor( Qt::blue ), - mSelectable( false ), - mSelected( false ) + : QCPLayoutElement( parentPlot ) + , mText( text ) + , mFont( + QFont( parentPlot->font().family(), parentPlot->font().pointSize() * 1.5, QFont::Bold ) ) + , mTextColor( Qt::black ) + , mSelectedFont( + QFont( parentPlot->font().family(), parentPlot->font().pointSize() * 1.6, QFont::Bold ) ) + , mSelectedTextColor( Qt::blue ) + , mSelectable( false ) + , mSelected( false ) { setLayer( "axes" ); setMargins( QMargins( 5, 5, 5, 0 ) ); } /*! - Sets the text that will be displayed to \a text. Multiple lines can be created by insertion of "\n". + Sets the text that will be displayed to \a text. Multiple lines can be created + by insertion of "\n". \see setFont, setTextColor */ @@ -14024,7 +16209,8 @@ void QCPPlotTitle::setTextColor( const QColor& color ) } /*! - Sets the \a font of the title text that will be used if the plot title is selected (\ref setSelected). + Sets the \a font of the title text that will be used if the plot title is + selected (\ref setSelected). \see setFont */ @@ -14034,7 +16220,8 @@ void QCPPlotTitle::setSelectedFont( const QFont& font ) } /*! - Sets the \a color of the title text that will be used if the plot title is selected (\ref setSelected). + Sets the \a color of the title text that will be used if the plot title is + selected (\ref setSelected). \see setTextColor */ @@ -14046,7 +16233,8 @@ void QCPPlotTitle::setSelectedTextColor( const QColor& color ) /*! Sets whether the user may select this plot title to \a selectable. - Note that even when \a selectable is set to false, the selection state may be changed + Note that even when \a selectable is set to false, the selection + state may be changed programmatically via \ref setSelected. */ void QCPPlotTitle::setSelectable( bool selectable ) @@ -14059,10 +16247,12 @@ void QCPPlotTitle::setSelectable( bool selectable ) } /*! - Sets the selection state of this plot title to \a selected. If the selection has changed, \ref + Sets the selection state of this plot title to \a selected. If the selection + has changed, \ref selectionChanged is emitted. - Note that this function can change the selection state independently of the current \ref + Note that this function can change the selection state independently of the + current \ref setSelectable state. */ void QCPPlotTitle::setSelected( bool selected ) @@ -14152,7 +16342,8 @@ double QCPPlotTitle::selectTest( const QPointF& pos, bool onlySelectable, QVaria /*! \internal - Returns the main font to be used. This is mSelectedFont if \ref setSelected is set to + Returns the main font to be used. This is mSelectedFont if \ref setSelected is + set to true, else mFont is returned. */ QFont QCPPlotTitle::mainFont() const @@ -14162,7 +16353,8 @@ QFont QCPPlotTitle::mainFont() const /*! \internal - Returns the main color to be used. This is mSelectedTextColor if \ref setSelected is set to + Returns the main color to be used. This is mSelectedTextColor if \ref + setSelected is set to true, else mTextColor is returned. */ QColor QCPPlotTitle::mainTextColor() const @@ -14177,37 +16369,50 @@ QColor QCPPlotTitle::mainTextColor() const /*! \class QCPColorScale \brief A color scale for use with color coding data such as QCPColorMap - This layout element can be placed on the plot to correlate a color gradient with data values. It - is usually used in combination with one or multiple \ref QCPColorMap "QCPColorMaps". + This layout element can be placed on the plot to correlate a color gradient + with data values. It + is usually used in combination with one or multiple \ref QCPColorMap + "QCPColorMaps". \image html QCPColorScale.png - The color scale can be either horizontal or vertical, as shown in the image above. The - orientation and the side where the numbers appear is controlled with \ref setType. + The color scale can be either horizontal or vertical, as shown in the image + above. The + orientation and the side where the numbers appear is controlled with \ref + setType. - Use \ref QCPColorMap::setColorScale to connect a color map with a color scale. Once they are - connected, they share their gradient, data range and data scale type (\ref setGradient, \ref - setDataRange, \ref setDataScaleType). Multiple color maps may be associated with a single color + Use \ref QCPColorMap::setColorScale to connect a color map with a color scale. + Once they are + connected, they share their gradient, data range and data scale type (\ref + setGradient, \ref + setDataRange, \ref setDataScaleType). Multiple color maps may be associated + with a single color scale, to make them all synchronize these properties. - To have finer control over the number display and axis behaviour, you can directly access the - \ref axis. See the documentation of QCPAxis for details about configuring axes. For example, if + To have finer control over the number display and axis behaviour, you can + directly access the + \ref axis. See the documentation of QCPAxis for details about configuring + axes. For example, if you want to change the number of automatically generated ticks, call \code colorScale->axis()->setAutoTickCount(3); \endcode - Placing a color scale next to the main axis rect works like with any other layout element: + Placing a color scale next to the main axis rect works like with any other + layout element: \code QCPColorScale *colorScale = new QCPColorScale(customPlot); customPlot->plotLayout()->addElement(0, 1, colorScale); colorScale->setLabel("Some Label Text"); \endcode - In this case we have placed it to the right of the default axis rect, so it wasn't necessary to - call \ref setType, since \ref QCPAxis::atRight is already the default. The text next to the color + In this case we have placed it to the right of the default axis rect, so it + wasn't necessary to + call \ref setType, since \ref QCPAxis::atRight is already the default. The + text next to the color scale can be set with \ref setLabel. - For optimum appearance (like in the image above), it may be desirable to line up the axis rect and + For optimum appearance (like in the image above), it may be desirable to line + up the axis rect and the borders of the color scale. Use a \ref QCPMarginGroup to achieve this: \code QCPMarginGroup *group = new QCPMarginGroup(customPlot); @@ -14215,10 +16420,14 @@ QColor QCPPlotTitle::mainTextColor() const customPlot->axisRect()->setMarginGroup(QCP::msTop|QCP::msBottom, group); \endcode - Color scales are initialized with a non-zero minimum top and bottom margin (\ref - setMinimumMargins), because vertical color scales are most common and the minimum top/bottom - margin makes sure it keeps some distance to the top/bottom widget border. So if you change to a - horizontal color scale by setting \ref setType to \ref QCPAxis::atBottom or \ref QCPAxis::atTop, you + Color scales are initialized with a non-zero minimum top and bottom margin + (\ref + setMinimumMargins), because vertical color scales are most common and the + minimum top/bottom + margin makes sure it keeps some distance to the top/bottom widget border. So + if you change to a + horizontal color scale by setting \ref setType to \ref QCPAxis::atBottom or + \ref QCPAxis::atTop, you might want to also change the minimum margins accordingly, e.g. \ref setMinimumMargins(QMargins(6, 0, 6, 0)). */ @@ -14227,15 +16436,22 @@ QColor QCPPlotTitle::mainTextColor() const /*! \fn QCPAxis *QCPColorScale::axis() const - Returns the internal \ref QCPAxis instance of this color scale. You can access it to alter the - appearance and behaviour of the axis. \ref QCPColorScale duplicates some properties in its - interface for convenience. Those are \ref setDataRange (\ref QCPAxis::setRange), \ref - setDataScaleType (\ref QCPAxis::setScaleType), and the method \ref setLabel (\ref - QCPAxis::setLabel). As they each are connected, it does not matter whether you use the method on + Returns the internal \ref QCPAxis instance of this color scale. You can access + it to alter the + appearance and behaviour of the axis. \ref QCPColorScale duplicates some + properties in its + interface for convenience. Those are \ref setDataRange (\ref + QCPAxis::setRange), \ref + setDataScaleType (\ref QCPAxis::setScaleType), and the method \ref setLabel + (\ref + QCPAxis::setLabel). As they each are connected, it does not matter whether you + use the method on the QCPColorScale or on its QCPAxis. - If the type of the color scale is changed with \ref setType, the axis returned by this method - will change, too, to either the left, right, bottom or top axis, depending on which type was set. + If the type of the color scale is changed with \ref setType, the axis returned + by this method + will change, too, to either the left, right, bottom or top axis, depending on + which type was set. */ /* end documentation of signals */ @@ -14268,15 +16484,19 @@ QColor QCPPlotTitle::mainTextColor() const Constructs a new QCPColorScale. */ QCPColorScale::QCPColorScale( QCustomPlot* parentPlot ) - : QCPLayoutElement( parentPlot ), - mType( QCPAxis::atTop ), // set to atTop such that setType(QCPAxis::atRight) below doesn't skip work because it - // thinks it's already atRight - mDataScaleType( QCPAxis::stLinear ), - mBarWidth( 20 ), - mAxisRect( new QCPColorScaleAxisRectPrivate( this ) ) + : QCPLayoutElement( parentPlot ) + , mType( QCPAxis::atTop ) + , // set to atTop such that setType(QCPAxis::atRight) + // below doesn't skip work because it + // thinks it's already atRight + mDataScaleType( QCPAxis::stLinear ) + , mBarWidth( 20 ) + , mAxisRect( new QCPColorScaleAxisRectPrivate( this ) ) { - setMinimumMargins( QMargins( 0, 6, 0, 6 ) ); // for default right color scale types, keep some room at bottom and top - // (important if no margin group is used) + setMinimumMargins( QMargins( 0, 6, 0, 6 ) ); // for default right color scale + // types, keep some room at bottom + // and top + // (important if no margin group is used) setType( QCPAxis::atRight ); setDataRange( QCPRange( 0, 6 ) ); } @@ -14329,10 +16549,13 @@ bool QCPColorScale::rangeZoom() const } /*! - Sets at which side of the color scale the axis is placed, and thus also its orientation. + Sets at which side of the color scale the axis is placed, and thus also its + orientation. - Note that after setting \a type to a different value, the axis returned by \ref axis() will - be a different one. The new axis will adopt the following properties from the previous axis: The + Note that after setting \a type to a different value, the axis returned by + \ref axis() will + be a different one. The new axis will adopt the following properties from the + previous axis: The range, scale type, log base and label. */ void QCPColorScale::setType( QCPAxis::AxisType type ) @@ -14355,12 +16578,14 @@ void QCPColorScale::setType( QCPAxis::AxisType type ) labelTransfer = mColorAxis.data()->label(); logBaseTransfer = mColorAxis.data()->scaleLogBase(); mColorAxis.data()->setLabel( "" ); - disconnect( mColorAxis.data(), SIGNAL( rangeChanged( QCPRange ) ), this, SLOT( setDataRange( QCPRange ) ) ); + disconnect( mColorAxis.data(), SIGNAL( rangeChanged( QCPRange ) ), this, + SLOT( setDataRange( QCPRange ) ) ); disconnect( mColorAxis.data(), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), this, SLOT( setDataScaleType( QCPAxis::ScaleType ) ) ); } - foreach( QCPAxis::AxisType atype, QList() << QCPAxis::atLeft << QCPAxis::atRight - << QCPAxis::atBottom << QCPAxis::atTop ) + foreach( QCPAxis::AxisType atype, QList() + << QCPAxis::atLeft << QCPAxis::atRight + << QCPAxis::atBottom << QCPAxis::atTop ) { mAxisRect.data()->axis( atype )->setTicks( atype == mType ); mAxisRect.data()->axis( atype )->setTickLabels( atype == mType ); @@ -14368,25 +16593,34 @@ void QCPColorScale::setType( QCPAxis::AxisType type ) // set new mColorAxis pointer: mColorAxis = mAxisRect.data()->axis( mType ); // transfer settings to new axis: - mColorAxis.data()->setRange( rangeTransfer ); // transfer range of old axis to new one (necessary if axis changes - // from vertical to horizontal or vice versa) + mColorAxis.data()->setRange( rangeTransfer ); // transfer range of old axis to + // new one (necessary if axis + // changes + // from vertical to horizontal or vice versa) mColorAxis.data()->setLabel( labelTransfer ); - mColorAxis.data()->setScaleLogBase( logBaseTransfer ); // scaleType is synchronized among axes in realtime via - // signals (connected in QCPColorScale ctor), so we only - // need to take care of log base here - connect( mColorAxis.data(), SIGNAL( rangeChanged( QCPRange ) ), this, SLOT( setDataRange( QCPRange ) ) ); + mColorAxis.data()->setScaleLogBase( logBaseTransfer ); // scaleType is + // synchronized among + // axes in realtime via + // signals (connected in QCPColorScale ctor), so we only + // need to take care of log base here + connect( mColorAxis.data(), SIGNAL( rangeChanged( QCPRange ) ), this, + SLOT( setDataRange( QCPRange ) ) ); connect( mColorAxis.data(), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), this, SLOT( setDataScaleType( QCPAxis::ScaleType ) ) ); - mAxisRect.data()->setRangeDragAxes( QCPAxis::orientation( mType ) == Qt::Horizontal ? mColorAxis.data() : 0, - QCPAxis::orientation( mType ) == Qt::Vertical ? mColorAxis.data() : 0 ); + mAxisRect.data()->setRangeDragAxes( + QCPAxis::orientation( mType ) == Qt::Horizontal ? mColorAxis.data() : 0, + QCPAxis::orientation( mType ) == Qt::Vertical ? mColorAxis.data() : 0 ); } } /*! - Sets the range spanned by the color gradient and that is shown by the axis in the color scale. + Sets the range spanned by the color gradient and that is shown by the axis in + the color scale. - It is equivalent to calling QCPColorMap::setDataRange on any of the connected color maps. It is - also equivalent to directly accessing the \ref axis and setting its range with \ref + It is equivalent to calling QCPColorMap::setDataRange on any of the connected + color maps. It is + also equivalent to directly accessing the \ref axis and setting its range with + \ref QCPAxis::setRange. \see setDataScaleType, setGradient, rescaleDataRange @@ -14403,11 +16637,14 @@ void QCPColorScale::setDataRange( const QCPRange& dataRange ) } /*! - Sets the scale type of the color scale, i.e. whether values are linearly associated with colors + Sets the scale type of the color scale, i.e. whether values are linearly + associated with colors or logarithmically. - It is equivalent to calling QCPColorMap::setDataScaleType on any of the connected color maps. It is - also equivalent to directly accessing the \ref axis and setting its scale type with \ref + It is equivalent to calling QCPColorMap::setDataScaleType on any of the + connected color maps. It is + also equivalent to directly accessing the \ref axis and setting its scale type + with \ref QCPAxis::setScaleType. \see setDataRange, setGradient @@ -14428,7 +16665,8 @@ void QCPColorScale::setDataScaleType( QCPAxis::ScaleType scaleType ) /*! Sets the color gradient that will be used to represent data values. - It is equivalent to calling QCPColorMap::setGradient on any of the connected color maps. + It is equivalent to calling QCPColorMap::setGradient on any of the connected + color maps. \see setDataRange, setDataScaleType */ @@ -14444,7 +16682,8 @@ void QCPColorScale::setGradient( const QCPColorGradient& gradient ) } /*! - Sets the axis label of the color scale. This is equivalent to calling \ref QCPAxis::setLabel on + Sets the axis label of the color scale. This is equivalent to calling \ref + QCPAxis::setLabel on the internal \ref axis. */ void QCPColorScale::setLabel( const QString& str ) @@ -14459,7 +16698,8 @@ void QCPColorScale::setLabel( const QString& str ) } /*! - Sets the width (or height, for horizontal color scales) the bar where the gradient is displayed + Sets the width (or height, for horizontal color scales) the bar where the + gradient is displayed will have. */ void QCPColorScale::setBarWidth( int width ) @@ -14488,7 +16728,8 @@ void QCPColorScale::setRangeDrag( bool enabled ) } /*! - Sets whether the user can zoom the data range (\ref setDataRange) by scrolling the mouse wheel. + Sets whether the user can zoom the data range (\ref setDataRange) by scrolling + the mouse wheel. Note that \ref QCP::iRangeZoom must be in the QCustomPlot's interactions (\ref QCustomPlot::setInteractions) to allow range dragging. @@ -14523,7 +16764,8 @@ QList QCPColorScale::colorMaps() const } /*! - Changes the data range such that all color maps associated with this color scale are fully mapped + Changes the data range such that all color maps associated with this color + scale are fully mapped to the gradient in the data dimension. \see setDataRange @@ -14533,7 +16775,8 @@ void QCPColorScale::rescaleDataRange( bool onlyVisibleMaps ) QList maps = colorMaps(); QCPRange newRange; bool haveRange = false; - int sign = 0; // TODO: should change this to QCPAbstractPlottable::SignDomain later (currently is protected, maybe + int sign = 0; // TODO: should change this to QCPAbstractPlottable::SignDomain + // later (currently is protected, maybe // move to QCP namespace) if( mDataScaleType == QCPAxis::stLogarithmic ) sign = ( mDataRange.upper < 0 ? -1 : 1 ); @@ -14572,12 +16815,15 @@ void QCPColorScale::rescaleDataRange( bool onlyVisibleMaps ) } if( haveRange ) { - if( !QCPRange::validRange( newRange ) ) // likely due to range being zero (plottable has only constant data in this - // dimension), shift current range to at least center the data + if( !QCPRange::validRange( newRange ) ) // likely due to range being zero + // (plottable has only constant data in + // this + // dimension), shift current range to at least center the data { - double center = ( newRange.lower + newRange.upper ) * 0.5; // upper and lower should be equal anyway, but just to - // make sure, incase validRange returned false for - // other reason + double center = ( newRange.lower + newRange.upper ) * + 0.5; // upper and lower should be equal anyway, but just to + // make sure, incase validRange returned false for + // other reason if( mDataScaleType == QCPAxis::stLinear ) { newRange.lower = center - mDataRange.size() / 2.0; @@ -14612,18 +16858,21 @@ void QCPColorScale::update( UpdatePhase phase ) if( mType == QCPAxis::atBottom || mType == QCPAxis::atTop ) { setMaximumSize( QWIDGETSIZE_MAX, mBarWidth + mAxisRect.data()->margins().top() + - mAxisRect.data()->margins().bottom() + margins().top() + - margins().bottom() ); - setMinimumSize( 0, mBarWidth + mAxisRect.data()->margins().top() + mAxisRect.data()->margins().bottom() + - margins().top() + margins().bottom() ); + mAxisRect.data()->margins().bottom() + + margins().top() + margins().bottom() ); + setMinimumSize( 0, mBarWidth + mAxisRect.data()->margins().top() + + mAxisRect.data()->margins().bottom() + margins().top() + + margins().bottom() ); } else { - setMaximumSize( mBarWidth + mAxisRect.data()->margins().left() + mAxisRect.data()->margins().right() + - margins().left() + margins().right(), + setMaximumSize( mBarWidth + mAxisRect.data()->margins().left() + + mAxisRect.data()->margins().right() + margins().left() + + margins().right(), QWIDGETSIZE_MAX ); - setMinimumSize( mBarWidth + mAxisRect.data()->margins().left() + mAxisRect.data()->margins().right() + - margins().left() + margins().right(), + setMinimumSize( mBarWidth + mAxisRect.data()->margins().left() + + mAxisRect.data()->margins().right() + margins().left() + + margins().right(), 0 ); } break; @@ -14706,13 +16955,14 @@ void QCPColorScale::wheelEvent( QWheelEvent* event ) Creates a new instance, as a child of \a parentColorScale. */ QCPColorScaleAxisRectPrivate::QCPColorScaleAxisRectPrivate( QCPColorScale* parentColorScale ) - : QCPAxisRect( parentColorScale->parentPlot(), true ), - mParentColorScale( parentColorScale ), - mGradientImageInvalidated( true ) + : QCPAxisRect( parentColorScale->parentPlot(), true ) + , mParentColorScale( parentColorScale ) + , mGradientImageInvalidated( true ) { setParentLayerable( parentColorScale ); setMinimumMargins( QMargins( 0, 0, 0, 0 ) ); - foreach( QCPAxis::AxisType type, QList() << QCPAxis::atBottom << QCPAxis::atTop << QCPAxis::atLeft + foreach( QCPAxis::AxisType type, QList() << QCPAxis::atBottom << QCPAxis::atTop + << QCPAxis::atLeft << QCPAxis::atRight ) { axis( type )->setVisible( true ); @@ -14732,26 +16982,32 @@ QCPColorScaleAxisRectPrivate::QCPColorScaleAxisRectPrivate( QCPColorScale* paren SLOT( setRange( QCPRange ) ) ); connect( axis( QCPAxis::atTop ), SIGNAL( rangeChanged( QCPRange ) ), axis( QCPAxis::atBottom ), SLOT( setRange( QCPRange ) ) ); - connect( axis( QCPAxis::atLeft ), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), axis( QCPAxis::atRight ), - SLOT( setScaleType( QCPAxis::ScaleType ) ) ); - connect( axis( QCPAxis::atRight ), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), axis( QCPAxis::atLeft ), - SLOT( setScaleType( QCPAxis::ScaleType ) ) ); - connect( axis( QCPAxis::atBottom ), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), axis( QCPAxis::atTop ), - SLOT( setScaleType( QCPAxis::ScaleType ) ) ); - connect( axis( QCPAxis::atTop ), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), axis( QCPAxis::atBottom ), - SLOT( setScaleType( QCPAxis::ScaleType ) ) ); + connect( axis( QCPAxis::atLeft ), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), + axis( QCPAxis::atRight ), SLOT( setScaleType( QCPAxis::ScaleType ) ) ); + connect( axis( QCPAxis::atRight ), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), + axis( QCPAxis::atLeft ), SLOT( setScaleType( QCPAxis::ScaleType ) ) ); + connect( axis( QCPAxis::atBottom ), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), + axis( QCPAxis::atTop ), SLOT( setScaleType( QCPAxis::ScaleType ) ) ); + connect( axis( QCPAxis::atTop ), SIGNAL( scaleTypeChanged( QCPAxis::ScaleType ) ), + axis( QCPAxis::atBottom ), SLOT( setScaleType( QCPAxis::ScaleType ) ) ); // make layer transfers of color scale transfer to axis rect and axes - // the axes must be set after axis rect, such that they appear above color gradient drawn by axis rect: - connect( parentColorScale, SIGNAL( layerChanged( QCPLayer* ) ), this, SLOT( setLayer( QCPLayer* ) ) ); - foreach( QCPAxis::AxisType type, QList() << QCPAxis::atBottom << QCPAxis::atTop << QCPAxis::atLeft + // the axes must be set after axis rect, such that they appear above color + // gradient drawn by axis rect: + connect( parentColorScale, SIGNAL( layerChanged( QCPLayer* ) ), this, + SLOT( setLayer( QCPLayer* ) ) ); + foreach( QCPAxis::AxisType type, QList() << QCPAxis::atBottom << QCPAxis::atTop + << QCPAxis::atLeft << QCPAxis::atRight ) - connect( parentColorScale, SIGNAL( layerChanged( QCPLayer* ) ), axis( type ), SLOT( setLayer( QCPLayer* ) ) ); + connect( parentColorScale, SIGNAL( layerChanged( QCPLayer* ) ), axis( type ), + SLOT( setLayer( QCPLayer* ) ) ); } /*! \internal - Updates the color gradient image if necessary, by calling \ref updateGradientImage, then draws - it. Then the axes are drawn by calling the \ref QCPAxisRect::draw base class implementation. + Updates the color gradient image if necessary, by calling \ref + updateGradientImage, then draws + it. Then the axes are drawn by calling the \ref QCPAxisRect::draw base class + implementation. */ void QCPColorScaleAxisRectPrivate::draw( QCPPainter* painter ) { @@ -14763,9 +17019,11 @@ void QCPColorScaleAxisRectPrivate::draw( QCPPainter* painter ) if( mParentColorScale->mColorAxis ) { mirrorHorz = mParentColorScale->mColorAxis.data()->rangeReversed() && - ( mParentColorScale->type() == QCPAxis::atBottom || mParentColorScale->type() == QCPAxis::atTop ); + ( mParentColorScale->type() == QCPAxis::atBottom || + mParentColorScale->type() == QCPAxis::atTop ); mirrorVert = mParentColorScale->mColorAxis.data()->rangeReversed() && - ( mParentColorScale->type() == QCPAxis::atLeft || mParentColorScale->type() == QCPAxis::atRight ); + ( mParentColorScale->type() == QCPAxis::atLeft || + mParentColorScale->type() == QCPAxis::atRight ); } painter->drawImage( rect(), mGradientImage.mirrored( mirrorHorz, mirrorVert ) ); @@ -14774,8 +17032,10 @@ void QCPColorScaleAxisRectPrivate::draw( QCPPainter* painter ) /*! \internal - Uses the current gradient of the parent \ref QCPColorScale (specified in the constructor) to - generate a gradient image. This gradient image will be used in the \ref draw method. + Uses the current gradient of the parent \ref QCPColorScale (specified in the + constructor) to + generate a gradient image. This gradient image will be used in the \ref draw + method. */ void QCPColorScaleAxisRectPrivate::updateGradientImage() { @@ -14795,7 +17055,8 @@ void QCPColorScaleAxisRectPrivate::updateGradientImage() QVector pixels; for( int y = 0; y < h; ++y ) pixels.append( reinterpret_cast( mGradientImage.scanLine( y ) ) ); - mParentColorScale->mGradient.colorize( data.constData(), QCPRange( 0, n - 1 ), pixels.first(), n ); + mParentColorScale->mGradient.colorize( data.constData(), QCPRange( 0, n - 1 ), pixels.first(), + n ); for( int y = 1; y < h; ++y ) memcpy( pixels.at( y ), pixels.first(), n * sizeof( QRgb ) ); } @@ -14807,7 +17068,8 @@ void QCPColorScaleAxisRectPrivate::updateGradientImage() for( int y = 0; y < h; ++y ) { QRgb* pixels = reinterpret_cast( mGradientImage.scanLine( y ) ); - const QRgb lineColor = mParentColorScale->mGradient.color( data[h - 1 - y], QCPRange( 0, n - 1 ) ); + const QRgb lineColor = + mParentColorScale->mGradient.color( data[h - 1 - y], QCPRange( 0, n - 1 ) ); for( int x = 0; x < w; ++x ) pixels[x] = lineColor; } @@ -14817,13 +17079,15 @@ void QCPColorScaleAxisRectPrivate::updateGradientImage() /*! \internal - This slot is connected to the selectionChanged signals of the four axes in the constructor. It + This slot is connected to the selectionChanged signals of the four axes in the + constructor. It synchronizes the selection state of the axes. */ void QCPColorScaleAxisRectPrivate::axisSelectionChanged( QCPAxis::SelectableParts selectedParts ) { // axis bases of four axes shall always (de-)selected synchronously: - foreach( QCPAxis::AxisType type, QList() << QCPAxis::atBottom << QCPAxis::atTop << QCPAxis::atLeft + foreach( QCPAxis::AxisType type, QList() << QCPAxis::atBottom << QCPAxis::atTop + << QCPAxis::atLeft << QCPAxis::atRight ) { if( QCPAxis* senderAxis = qobject_cast( sender() ) ) @@ -14842,13 +17106,15 @@ void QCPColorScaleAxisRectPrivate::axisSelectionChanged( QCPAxis::SelectablePart /*! \internal - This slot is connected to the selectableChanged signals of the four axes in the constructor. It + This slot is connected to the selectableChanged signals of the four axes in + the constructor. It synchronizes the selectability of the axes. */ void QCPColorScaleAxisRectPrivate::axisSelectableChanged( QCPAxis::SelectableParts selectableParts ) { // synchronize axis base selectability: - foreach( QCPAxis::AxisType type, QList() << QCPAxis::atBottom << QCPAxis::atTop << QCPAxis::atLeft + foreach( QCPAxis::AxisType type, QList() << QCPAxis::atBottom << QCPAxis::atTop + << QCPAxis::atLeft << QCPAxis::atRight ) { if( QCPAxis* senderAxis = qobject_cast( sender() ) ) @@ -14889,15 +17155,26 @@ void QCPColorScaleAxisRectPrivate::axisSelectableChanged( QCPAxis::SelectablePar Constructs a data point with key, value and all errors set to zero. */ QCPData::QCPData() - : key( 0 ), value( 0 ), keyErrorPlus( 0 ), keyErrorMinus( 0 ), valueErrorPlus( 0 ), valueErrorMinus( 0 ) + : key( 0 ) + , value( 0 ) + , keyErrorPlus( 0 ) + , keyErrorMinus( 0 ) + , valueErrorPlus( 0 ) + , valueErrorMinus( 0 ) { } /*! - Constructs a data point with the specified \a key and \a value. All errors are set to zero. + Constructs a data point with the specified \a key and \a value. All errors are + set to zero. */ QCPData::QCPData( double key, double value ) - : key( key ), value( value ), keyErrorPlus( 0 ), keyErrorMinus( 0 ), valueErrorPlus( 0 ), valueErrorMinus( 0 ) + : key( key ) + , value( value ) + , keyErrorPlus( 0 ) + , keyErrorMinus( 0 ) + , valueErrorPlus( 0 ) + , valueErrorMinus( 0 ) { } @@ -14910,30 +17187,42 @@ QCPData::QCPData( double key, double value ) \image html QCPGraph.png - Usually QCustomPlot creates graphs internally via QCustomPlot::addGraph and the resulting + Usually QCustomPlot creates graphs internally via QCustomPlot::addGraph and + the resulting instance is accessed via QCustomPlot::graph. - To plot data, assign it with the \ref setData or \ref addData functions. Alternatively, you can - also access and modify the graph's data via the \ref data method, which returns a pointer to the + To plot data, assign it with the \ref setData or \ref addData functions. + Alternatively, you can + also access and modify the graph's data via the \ref data method, which + returns a pointer to the internal \ref QCPDataMap. - Graphs are used to display single-valued data. Single-valued means that there should only be one - data point per unique key coordinate. In other words, the graph can't have \a loops. If you do + Graphs are used to display single-valued data. Single-valued means that there + should only be one + data point per unique key coordinate. In other words, the graph can't have \a + loops. If you do want to plot non-single-valued curves, rather use the QCPCurve plottable. \section appearance Changing the appearance - The appearance of the graph is mainly determined by the line style, scatter style, brush and pen - of the graph (\ref setLineStyle, \ref setScatterStyle, \ref setBrush, \ref setPen). + The appearance of the graph is mainly determined by the line style, scatter + style, brush and pen + of the graph (\ref setLineStyle, \ref setScatterStyle, \ref setBrush, \ref + setPen). \subsection filling Filling under or between graphs - QCPGraph knows two types of fills: Normal graph fills towards the zero-value-line parallel to - the key axis of the graph, and fills between two graphs, called channel fills. To enable a fill, - just set a brush with \ref setBrush which is neither Qt::NoBrush nor fully transparent. + QCPGraph knows two types of fills: Normal graph fills towards the + zero-value-line parallel to + the key axis of the graph, and fills between two graphs, called channel fills. + To enable a fill, + just set a brush with \ref setBrush which is neither Qt::NoBrush nor fully + transparent. - By default, a normal fill towards the zero-value-line will be drawn. To set up a channel fill - between this graph and another one, call \ref setChannelFillGraph with the other graph as + By default, a normal fill towards the zero-value-line will be drawn. To set up + a channel fill + between this graph and another one, call \ref setChannelFillGraph with the + other graph as parameter. \see QCustomPlot::addGraph, QCustomPlot::graph, QCPLegend::addGraph @@ -14943,25 +17232,33 @@ QCPData::QCPData( double key, double value ) /*! \fn QCPDataMap *QCPGraph::data() const - Returns a pointer to the internal data storage of type \ref QCPDataMap. You may use it to - directly manipulate the data, which may be more convenient and faster than using the regular \ref + Returns a pointer to the internal data storage of type \ref QCPDataMap. You + may use it to + directly manipulate the data, which may be more convenient and faster than + using the regular \ref setData or \ref addData methods, in certain situations. */ /* end of documentation of inline functions */ /*! - Constructs a graph which uses \a keyAxis as its key axis ("x") and \a valueAxis as its value - axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance and not have - the same orientation. If either of these restrictions is violated, a corresponding message is + Constructs a graph which uses \a keyAxis as its key axis ("x") and \a + valueAxis as its value + axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot + instance and not have + the same orientation. If either of these restrictions is violated, a + corresponding message is printed to the debug output (qDebug), the construction is not aborted, though. - The constructed QCPGraph can be added to the plot with QCustomPlot::addPlottable, QCustomPlot + The constructed QCPGraph can be added to the plot with + QCustomPlot::addPlottable, QCustomPlot then takes ownership of the graph. - To directly create a graph inside a plot, you can also use the simpler QCustomPlot::addGraph function. + To directly create a graph inside a plot, you can also use the simpler + QCustomPlot::addGraph function. */ -QCPGraph::QCPGraph( QCPAxis* keyAxis, QCPAxis* valueAxis ) : QCPAbstractPlottable( keyAxis, valueAxis ) +QCPGraph::QCPGraph( QCPAxis* keyAxis, QCPAxis* valueAxis ) + : QCPAbstractPlottable( keyAxis, valueAxis ) { mData = new QCPDataMap; @@ -14987,11 +17284,14 @@ QCPGraph::~QCPGraph() /*! Replaces the current data with the provided \a data. - If \a copy is set to true, data points in \a data will only be copied. if false, the graph - takes ownership of the passed data and replaces the internal data pointer with it. This is + If \a copy is set to true, data points in \a data will only be copied. if + false, the graph + takes ownership of the passed data and replaces the internal data pointer with + it. This is significantly faster than copying for large datasets. - Alternatively, you can also access and modify the graph's data via the \ref data method, which + Alternatively, you can also access and modify the graph's data via the \ref + data method, which returns a pointer to the internal \ref QCPDataMap. */ void QCPGraph::setData( QCPDataMap* data, bool copy ) @@ -15009,8 +17309,10 @@ void QCPGraph::setData( QCPDataMap* data, bool copy ) /*! \overload - Replaces the current data with the provided points in \a key and \a value pairs. The provided - vectors should have equal length. Else, the number of added points will be the size of the + Replaces the current data with the provided points in \a key and \a value + pairs. The provided + vectors should have equal length. Else, the number of added points will be the + size of the smallest vector. */ void QCPGraph::setData( const QVector& key, const QVector& value ) @@ -15028,13 +17330,17 @@ void QCPGraph::setData( const QVector& key, const QVector& value } /*! - Replaces the current data with the provided points in \a key and \a value pairs. Additionally the - symmetrical value error of the data points are set to the values in \a valueError. + Replaces the current data with the provided points in \a key and \a value + pairs. Additionally the + symmetrical value error of the data points are set to the values in \a + valueError. For error bars to show appropriately, see \ref setErrorType. - The provided vectors should have equal length. Else, the number of added points will be the size of the + The provided vectors should have equal length. Else, the number of added + points will be the size of the smallest vector. - For asymmetrical errors (plus different from minus), see the overloaded version of this function. + For asymmetrical errors (plus different from minus), see the overloaded + version of this function. */ void QCPGraph::setDataValueError( const QVector& key, const QVector& value, @@ -15057,11 +17363,14 @@ void QCPGraph::setDataValueError( const QVector& key, /*! \overload - Replaces the current data with the provided points in \a key and \a value pairs. Additionally the - negative value error of the data points are set to the values in \a valueErrorMinus, the positive + Replaces the current data with the provided points in \a key and \a value + pairs. Additionally the + negative value error of the data points are set to the values in \a + valueErrorMinus, the positive value error to \a valueErrorPlus. For error bars to show appropriately, see \ref setErrorType. - The provided vectors should have equal length. Else, the number of added points will be the size of the + The provided vectors should have equal length. Else, the number of added + points will be the size of the smallest vector. */ void QCPGraph::setDataValueError( const QVector& key, @@ -15086,13 +17395,16 @@ void QCPGraph::setDataValueError( const QVector& key, } /*! - Replaces the current data with the provided points in \a key and \a value pairs. Additionally the + Replaces the current data with the provided points in \a key and \a value + pairs. Additionally the symmetrical key error of the data points are set to the values in \a keyError. For error bars to show appropriately, see \ref setErrorType. - The provided vectors should have equal length. Else, the number of added points will be the size of the + The provided vectors should have equal length. Else, the number of added + points will be the size of the smallest vector. - For asymmetrical errors (plus different from minus), see the overloaded version of this function. + For asymmetrical errors (plus different from minus), see the overloaded + version of this function. */ void QCPGraph::setDataKeyError( const QVector& key, const QVector& value, @@ -15115,11 +17427,14 @@ void QCPGraph::setDataKeyError( const QVector& key, /*! \overload - Replaces the current data with the provided points in \a key and \a value pairs. Additionally the - negative key error of the data points are set to the values in \a keyErrorMinus, the positive + Replaces the current data with the provided points in \a key and \a value + pairs. Additionally the + negative key error of the data points are set to the values in \a + keyErrorMinus, the positive key error to \a keyErrorPlus. For error bars to show appropriately, see \ref setErrorType. - The provided vectors should have equal length. Else, the number of added points will be the size of the + The provided vectors should have equal length. Else, the number of added + points will be the size of the smallest vector. */ void QCPGraph::setDataKeyError( const QVector& key, @@ -15144,13 +17459,17 @@ void QCPGraph::setDataKeyError( const QVector& key, } /*! - Replaces the current data with the provided points in \a key and \a value pairs. Additionally the - symmetrical key and value errors of the data points are set to the values in \a keyError and \a valueError. + Replaces the current data with the provided points in \a key and \a value + pairs. Additionally the + symmetrical key and value errors of the data points are set to the values in + \a keyError and \a valueError. For error bars to show appropriately, see \ref setErrorType. - The provided vectors should have equal length. Else, the number of added points will be the size of the + The provided vectors should have equal length. Else, the number of added + points will be the size of the smallest vector. - For asymmetrical errors (plus different from minus), see the overloaded version of this function. + For asymmetrical errors (plus different from minus), see the overloaded + version of this function. */ void QCPGraph::setDataBothError( const QVector& key, const QVector& value, @@ -15177,12 +17496,16 @@ void QCPGraph::setDataBothError( const QVector& key, /*! \overload - Replaces the current data with the provided points in \a key and \a value pairs. Additionally the - negative key and value errors of the data points are set to the values in \a keyErrorMinus and \a valueErrorMinus. The + Replaces the current data with the provided points in \a key and \a value + pairs. Additionally the + negative key and value errors of the data points are set to the values in \a + keyErrorMinus and \a valueErrorMinus. The positive - key and value errors are set to the values in \a keyErrorPlus \a valueErrorPlus. + key and value errors are set to the values in \a keyErrorPlus \a + valueErrorPlus. For error bars to show appropriately, see \ref setErrorType. - The provided vectors should have equal length. Else, the number of added points will be the size of the + The provided vectors should have equal length. Else, the number of added + points will be the size of the smallest vector. */ void QCPGraph::setDataBothError( const QVector& key, @@ -15213,7 +17536,8 @@ void QCPGraph::setDataBothError( const QVector& key, } /*! - Sets how the single data points are connected in the plot. For scatter-only plots, set \a ls to + Sets how the single data points are connected in the plot. For scatter-only + plots, set \a ls to \ref lsNone and \ref setScatterStyle to the desired scatter style. \see setScatterStyle @@ -15224,7 +17548,8 @@ void QCPGraph::setLineStyle( LineStyle ls ) } /*! - Sets the visual appearance of single data points in the plot. If set to \ref QCPScatterStyle::ssNone, no scatter + Sets the visual appearance of single data points in the plot. If set to \ref + QCPScatterStyle::ssNone, no scatter points are drawn (e.g. for line-only-plots with appropriate line style). @@ -15236,9 +17561,12 @@ void QCPGraph::setScatterStyle( const QCPScatterStyle& style ) } /*! - Sets which kind of error bars (Key Error, Value Error or both) should be drawn on each data - point. If you set \a errorType to something other than \ref etNone, make sure to actually pass - error data via the specific setData functions along with the data points (e.g. \ref + Sets which kind of error bars (Key Error, Value Error or both) should be drawn + on each data + point. If you set \a errorType to something other than \ref etNone, make sure + to actually pass + error data via the specific setData functions along with the data points (e.g. + \ref setDataValueError, \ref setDataKeyError, \ref setDataBothError). \see ErrorType @@ -15266,12 +17594,15 @@ void QCPGraph::setErrorBarSize( double size ) } /*! - If \a enabled is set to true, the error bar will not be drawn as a solid line under the scatter symbol but + If \a enabled is set to true, the error bar will not be drawn as a solid line + under the scatter symbol but leave some free space around the symbol. - This feature uses the current scatter size (\ref QCPScatterStyle::setSize) to determine the size + This feature uses the current scatter size (\ref QCPScatterStyle::setSize) to + determine the size of the area to leave blank. So when drawing Pixmaps as scatter points (\ref - QCPScatterStyle::ssPixmap), the scatter size must be set manually to a value corresponding to the + QCPScatterStyle::ssPixmap), the scatter size must be set manually to a value + corresponding to the size of the Pixmap, if the error bars should leave gaps to its boundaries. \ref setErrorType, setErrorBarSize, setScatterStyle @@ -15282,10 +17613,12 @@ void QCPGraph::setErrorBarSkipSymbol( bool enabled ) } /*! - Sets the target graph for filling the area between this graph and \a targetGraph with the current + Sets the target graph for filling the area between this graph and \a + targetGraph with the current brush (\ref setBrush). - When \a targetGraph is set to 0, a normal graph fill to the zero-value-line will be shown. To + When \a targetGraph is set to 0, a normal graph fill to the zero-value-line + will be shown. To disable any filling, set the brush to Qt::NoBrush. \see setBrush @@ -15311,34 +17644,54 @@ void QCPGraph::setChannelFillGraph( QCPGraph* targetGraph ) } /*! - Sets whether adaptive sampling shall be used when plotting this graph. QCustomPlot's adaptive - sampling technique can drastically improve the replot performance for graphs with a larger number - of points (e.g. above 10,000), without notably changing the appearance of the graph. + Sets whether adaptive sampling shall be used when plotting this graph. + QCustomPlot's adaptive + sampling technique can drastically improve the replot performance for graphs + with a larger number + of points (e.g. above 10,000), without notably changing the appearance of the + graph. - By default, adaptive sampling is enabled. Even if enabled, QCustomPlot decides whether adaptive - sampling shall actually be used on a per-graph basis. So leaving adaptive sampling enabled has no + By default, adaptive sampling is enabled. Even if enabled, QCustomPlot decides + whether adaptive + sampling shall actually be used on a per-graph basis. So leaving adaptive + sampling enabled has no disadvantage in almost all cases. - \image html adaptive-sampling-line.png "A line plot of 500,000 points without and with adaptive sampling" + \image html adaptive-sampling-line.png "A line plot of 500,000 points without + and with adaptive sampling" - As can be seen, line plots experience no visual degradation from adaptive sampling. Outliers are - reproduced reliably, as well as the overall shape of the data set. The replot time reduces - dramatically though. This allows QCustomPlot to display large amounts of data in realtime. + As can be seen, line plots experience no visual degradation from adaptive + sampling. Outliers are + reproduced reliably, as well as the overall shape of the data set. The replot + time reduces + dramatically though. This allows QCustomPlot to display large amounts of data + in realtime. - \image html adaptive-sampling-scatter.png "A scatter plot of 100,000 points without and with adaptive sampling" + \image html adaptive-sampling-scatter.png "A scatter plot of 100,000 points + without and with adaptive sampling" - Care must be taken when using high-density scatter plots in combination with adaptive sampling. - The adaptive sampling algorithm treats scatter plots more carefully than line plots which still - gives a significant reduction of replot times, but not quite as much as for line plots. This is - because scatter plots inherently need more data points to be preserved in order to still resemble - the original, non-adaptive-sampling plot. As shown above, the results still aren't quite - identical, as banding occurs for the outer data points. This is in fact intentional, such that - the boundaries of the data cloud stay visible to the viewer. How strong the banding appears, + Care must be taken when using high-density scatter plots in combination with + adaptive sampling. + The adaptive sampling algorithm treats scatter plots more carefully than line + plots which still + gives a significant reduction of replot times, but not quite as much as for + line plots. This is + because scatter plots inherently need more data points to be preserved in + order to still resemble + the original, non-adaptive-sampling plot. As shown above, the results still + aren't quite + identical, as banding occurs for the outer data points. This is in fact + intentional, such that + the boundaries of the data cloud stay visible to the viewer. How strong the + banding appears, depends on the point density, i.e. the number of points in the plot. - For some situations with scatter plots it might thus be desirable to manually turn adaptive - sampling off. For example, when saving the plot to disk. This can be achieved by setting \a - enabled to false before issuing a command like \ref QCustomPlot::savePng, and setting \a enabled + For some situations with scatter plots it might thus be desirable to manually + turn adaptive + sampling off. For example, when saving the plot to disk. This can be achieved + by setting \a + enabled to false before issuing a command like \ref QCustomPlot::savePng, and + setting \a enabled back to true afterwards. */ void QCPGraph::setAdaptiveSampling( bool enabled ) @@ -15349,7 +17702,8 @@ void QCPGraph::setAdaptiveSampling( bool enabled ) /*! Adds the provided data points in \a dataMap to the current data. - Alternatively, you can also access and modify the graph's data via the \ref data method, which + Alternatively, you can also access and modify the graph's data via the \ref + data method, which returns a pointer to the internal \ref QCPDataMap. \see removeData @@ -15362,7 +17716,8 @@ void QCPGraph::addData( const QCPDataMap& dataMap ) /*! \overload Adds the provided single data point in \a data to the current data. - Alternatively, you can also access and modify the graph's data via the \ref data method, which + Alternatively, you can also access and modify the graph's data via the \ref + data method, which returns a pointer to the internal \ref QCPDataMap. \see removeData @@ -15373,9 +17728,11 @@ void QCPGraph::addData( const QCPData& data ) } /*! \overload - Adds the provided single data point as \a key and \a value pair to the current data. + Adds the provided single data point as \a key and \a value pair to the current + data. - Alternatively, you can also access and modify the graph's data via the \ref data method, which + Alternatively, you can also access and modify the graph's data via the \ref + data method, which returns a pointer to the internal \ref QCPDataMap. \see removeData @@ -15389,9 +17746,11 @@ void QCPGraph::addData( double key, double value ) } /*! \overload - Adds the provided data points as \a key and \a value pairs to the current data. + Adds the provided data points as \a key and \a value pairs to the current + data. - Alternatively, you can also access and modify the graph's data via the \ref data method, which + Alternatively, you can also access and modify the graph's data via the \ref + data method, which returns a pointer to the internal \ref QCPDataMap. \see removeData @@ -15434,7 +17793,8 @@ void QCPGraph::removeDataAfter( double key ) /*! Removes all data points with keys between \a fromKey and \a toKey. - if \a fromKey is greater or equal to \a toKey, the function does nothing. To remove + if \a fromKey is greater or equal to \a toKey, the function does nothing. To + remove a single data point with known key, use \ref removeData(double key). \see addData, clearData @@ -15451,8 +17811,10 @@ void QCPGraph::removeData( double fromKey, double toKey ) /*! \overload - Removes a single data point at \a key. If the position is not known with absolute precision, - consider using \ref removeData(double fromKey, double toKey) with a small fuzziness interval around + Removes a single data point at \a key. If the position is not known with + absolute precision, + consider using \ref removeData(double fromKey, double toKey) with a small + fuzziness interval around the suspected position, depeding on the precision with which the key is known. \see addData, clearData @@ -15491,10 +17853,12 @@ double QCPGraph::selectTest( const QPointF& pos, bool onlySelectable, QVariant* /*! \overload - Allows to define whether error bars are taken into consideration when determining the new axis + Allows to define whether error bars are taken into consideration when + determining the new axis range. - \see rescaleKeyAxis, rescaleValueAxis, QCPAbstractPlottable::rescaleAxes, QCustomPlot::rescaleAxes + \see rescaleKeyAxis, rescaleValueAxis, QCPAbstractPlottable::rescaleAxes, + QCustomPlot::rescaleAxes */ void QCPGraph::rescaleAxes( bool onlyEnlarge, bool includeErrorBars ) const { @@ -15504,14 +17868,16 @@ void QCPGraph::rescaleAxes( bool onlyEnlarge, bool includeErrorBars ) const /*! \overload - Allows to define whether error bars (of kind \ref QCPGraph::etKey) are taken into consideration + Allows to define whether error bars (of kind \ref QCPGraph::etKey) are taken + into consideration when determining the new axis range. \see rescaleAxes, QCPAbstractPlottable::rescaleKeyAxis */ void QCPGraph::rescaleKeyAxis( bool onlyEnlarge, bool includeErrorBars ) const { - // this code is a copy of QCPAbstractPlottable::rescaleKeyAxis with the only change + // this code is a copy of QCPAbstractPlottable::rescaleKeyAxis with the only + // change // that getKeyRange is passed the includeErrorBars value. if( mData->isEmpty() ) return; @@ -15545,14 +17911,16 @@ void QCPGraph::rescaleKeyAxis( bool onlyEnlarge, bool includeErrorBars ) const /*! \overload - Allows to define whether error bars (of kind \ref QCPGraph::etValue) are taken into consideration + Allows to define whether error bars (of kind \ref QCPGraph::etValue) are taken + into consideration when determining the new axis range. \see rescaleAxes, QCPAbstractPlottable::rescaleValueAxis */ void QCPGraph::rescaleValueAxis( bool onlyEnlarge, bool includeErrorBars ) const { - // this code is a copy of QCPAbstractPlottable::rescaleValueAxis with the only change + // this code is a copy of QCPAbstractPlottable::rescaleValueAxis with the only + // change // is that getValueRange is passed the includeErrorBars value. if( mData->isEmpty() ) return; @@ -15645,17 +18013,19 @@ void QCPGraph::drawLegendIcon( QCPPainter* painter, const QRectF& rect ) const if( mBrush.style() != Qt::NoBrush ) { applyFillAntialiasingHint( painter ); - painter->fillRect( QRectF( rect.left(), rect.top() + rect.height() / 2.0, rect.width(), rect.height() / 3.0 ), - mBrush ); + painter->fillRect( + QRectF( rect.left(), rect.top() + rect.height() / 2.0, rect.width(), rect.height() / 3.0 ), + mBrush ); } // draw line vertically centered: if( mLineStyle != lsNone ) { applyDefaultAntialiasingHint( painter ); painter->setPen( mPen ); - painter->drawLine( - QLineF( rect.left(), rect.top() + rect.height() / 2.0, rect.right() + 5, - rect.top() + rect.height() / 2.0 ) ); // +5 on x2 else last segment is missing from dashed/dotted pens + painter->drawLine( QLineF( rect.left(), rect.top() + rect.height() / 2.0, rect.right() + 5, + rect.top() + rect.height() / 2.0 ) ); // +5 on x2 else last segment + // is missing from + // dashed/dotted pens } // draw scatter symbol: if( !mScatterStyle.isNone() ) @@ -15667,8 +18037,8 @@ void QCPGraph::drawLegendIcon( QCPPainter* painter, const QRectF& rect ) const mScatterStyle.pixmap().size().height() > rect.height() ) ) { QCPScatterStyle scaledStyle( mScatterStyle ); - scaledStyle.setPixmap( - scaledStyle.pixmap().scaled( rect.size().toSize(), Qt::KeepAspectRatio, Qt::SmoothTransformation ) ); + scaledStyle.setPixmap( scaledStyle.pixmap().scaled( rect.size().toSize(), Qt::KeepAspectRatio, + Qt::SmoothTransformation ) ); scaledStyle.applyTo( painter, mPen ); scaledStyle.drawShape( painter, QRectF( rect ).center() ); } @@ -15682,20 +18052,29 @@ void QCPGraph::drawLegendIcon( QCPPainter* painter, const QRectF& rect ) const /*! \internal - This function branches out to the line style specific "get(...)PlotData" functions, according to + This function branches out to the line style specific "get(...)PlotData" + functions, according to the line style of the graph. - \a lineData will be filled with raw points that will be drawn with the according draw functions, - e.g. \ref drawLinePlot and \ref drawImpulsePlot. These aren't necessarily the original data - points, since for step plots for example, additional points are needed for drawing lines that - make up steps. If the line style of the graph is \ref lsNone, the \a lineData vector will be left + \a lineData will be filled with raw points that will be drawn with the + according draw functions, + e.g. \ref drawLinePlot and \ref drawImpulsePlot. These aren't necessarily the + original data + points, since for step plots for example, additional points are needed for + drawing lines that + make up steps. If the line style of the graph is \ref lsNone, the \a lineData + vector will be left untouched. - \a scatterData will be filled with the original data points so \ref drawScatterPlot can draw the - scatter symbols accordingly. If no scatters need to be drawn, i.e. the scatter style's shape is - \ref QCPScatterStyle::ssNone, pass 0 as \a scatterData, and this step will be skipped. + \a scatterData will be filled with the original data points so \ref + drawScatterPlot can draw the + scatter symbols accordingly. If no scatters need to be drawn, i.e. the scatter + style's shape is + \ref QCPScatterStyle::ssNone, pass 0 as \a scatterData, and this step will be + skipped. - \see getScatterPlotData, getLinePlotData, getStepLeftPlotData, getStepRightPlotData, + \see getScatterPlotData, getLinePlotData, getStepLeftPlotData, + getStepRightPlotData, getStepCenterPlotData, getImpulsePlotData */ void QCPGraph::getPlotData( QVector* lineData, QVector* scatterData ) const @@ -15725,12 +18104,16 @@ void QCPGraph::getPlotData( QVector* lineData, QVector* scatte /*! \internal - If line style is \ref lsNone and the scatter style's shape is not \ref QCPScatterStyle::ssNone, - this function serves at providing the visible data points in \a scatterData, so the \ref + If line style is \ref lsNone and the scatter style's shape is not \ref + QCPScatterStyle::ssNone, + this function serves at providing the visible data points in \a scatterData, + so the \ref drawScatterPlot function can draw the scatter points accordingly. - If line style is not \ref lsNone, this function is not called and the data for the scatter points - are (if needed) calculated inside the corresponding other "get(...)PlotData" functions. + If line style is not \ref lsNone, this function is not called and the data for + the scatter points + are (if needed) calculated inside the corresponding other "get(...)PlotData" + functions. \see drawScatterPlot */ @@ -15741,16 +18124,21 @@ void QCPGraph::getScatterPlotData( QVector* scatterData ) const /*! \internal - Places the raw data points needed for a normal linearly connected graph in \a linePixelData. + Places the raw data points needed for a normal linearly connected graph in \a + linePixelData. - As for all plot data retrieval functions, \a scatterData just contains all unaltered data (scatter) - points that are visible for drawing scatter points, if necessary. If drawing scatter points is - disabled (i.e. the scatter style's shape is \ref QCPScatterStyle::ssNone), pass 0 as \a + As for all plot data retrieval functions, \a scatterData just contains all + unaltered data (scatter) + points that are visible for drawing scatter points, if necessary. If drawing + scatter points is + disabled (i.e. the scatter style's shape is \ref QCPScatterStyle::ssNone), + pass 0 as \a scatterData, and the function will skip filling the vector. \see drawLinePlot */ -void QCPGraph::getLinePlotData( QVector* linePixelData, QVector* scatterData ) const +void QCPGraph::getLinePlotData( QVector* linePixelData, + QVector* scatterData ) const { QCPAxis* keyAxis = mKeyAxis.data(); QCPAxis* valueAxis = mValueAxis.data(); @@ -15767,9 +18155,9 @@ void QCPGraph::getLinePlotData( QVector* linePixelData, QVector lineData; getPreparedData( &lineData, scatterData ); - linePixelData->reserve( - lineData.size() + - 2 ); // added 2 to reserve memory for lower/upper fill base points that might be needed for fill + linePixelData->reserve( lineData.size() + 2 ); // added 2 to reserve memory for + // lower/upper fill base points + // that might be needed for fill linePixelData->resize( lineData.size() ); // transform lineData points to pixels: @@ -15793,16 +18181,21 @@ void QCPGraph::getLinePlotData( QVector* linePixelData, QVector* linePixelData, QVector* scatterData ) const +void QCPGraph::getStepLeftPlotData( QVector* linePixelData, + QVector* scatterData ) const { QCPAxis* keyAxis = mKeyAxis.data(); QCPAxis* valueAxis = mValueAxis.data(); @@ -15819,9 +18212,10 @@ void QCPGraph::getStepLeftPlotData( QVector* linePixelData, QVector lineData; getPreparedData( &lineData, scatterData ); - linePixelData->reserve( - lineData.size() * 2 + - 2 ); // added 2 to reserve memory for lower/upper fill base points that might be needed for fill + linePixelData->reserve( lineData.size() * 2 + 2 ); // added 2 to reserve memory + // for lower/upper fill base + // points that might be + // needed for fill linePixelData->resize( lineData.size() * 2 ); // calculate steps from lineData and transform to pixel coordinates: @@ -15857,16 +18251,21 @@ void QCPGraph::getStepLeftPlotData( QVector* linePixelData, QVector* linePixelData, QVector* scatterData ) const +void QCPGraph::getStepRightPlotData( QVector* linePixelData, + QVector* scatterData ) const { QCPAxis* keyAxis = mKeyAxis.data(); QCPAxis* valueAxis = mValueAxis.data(); @@ -15883,9 +18282,10 @@ void QCPGraph::getStepRightPlotData( QVector* linePixelData, QVector lineData; getPreparedData( &lineData, scatterData ); - linePixelData->reserve( - lineData.size() * 2 + - 2 ); // added 2 to reserve memory for lower/upper fill base points that might be needed for fill + linePixelData->reserve( lineData.size() * 2 + 2 ); // added 2 to reserve memory + // for lower/upper fill base + // points that might be + // needed for fill linePixelData->resize( lineData.size() * 2 ); // calculate steps from lineData and transform to pixel coordinates: @@ -15921,16 +18321,21 @@ void QCPGraph::getStepRightPlotData( QVector* linePixelData, QVector* linePixelData, QVector* scatterData ) const +void QCPGraph::getStepCenterPlotData( QVector* linePixelData, + QVector* scatterData ) const { QCPAxis* keyAxis = mKeyAxis.data(); QCPAxis* valueAxis = mValueAxis.data(); @@ -15947,9 +18352,10 @@ void QCPGraph::getStepCenterPlotData( QVector* linePixelData, QVector lineData; getPreparedData( &lineData, scatterData ); - linePixelData->reserve( - lineData.size() * 2 + - 2 ); // added 2 to reserve memory for lower/upper fill base points that might be needed for fill + linePixelData->reserve( lineData.size() * 2 + 2 ); // added 2 to reserve memory + // for lower/upper fill base + // points that might be + // needed for fill linePixelData->resize( lineData.size() * 2 ); // calculate steps from lineData and transform to pixel coordinates: if( keyAxis->orientation() == Qt::Vertical ) @@ -15998,14 +18404,18 @@ void QCPGraph::getStepCenterPlotData( QVector* linePixelData, QVector* linePixelData, QVector* scatterData ) const +void QCPGraph::getImpulsePlotData( QVector* linePixelData, + QVector* scatterData ) const { QCPAxis* keyAxis = mKeyAxis.data(); QCPAxis* valueAxis = mValueAxis.data(); @@ -16022,7 +18432,8 @@ void QCPGraph::getImpulsePlotData( QVector* linePixelData, QVector lineData; getPreparedData( &lineData, scatterData ); - linePixelData->resize( lineData.size() * 2 ); // no need to reserve 2 extra points because impulse plot has no fill + linePixelData->resize( lineData.size() * + 2 ); // no need to reserve 2 extra points because impulse plot has no fill // transform lineData points to pixels: if( keyAxis->orientation() == Qt::Vertical ) @@ -16057,12 +18468,16 @@ void QCPGraph::getImpulsePlotData( QVector* linePixelData, QVector* lineData ) const /*! \internal - Draws scatter symbols at every data point passed in \a scatterData. scatter symbols are independent - of the line style and are always drawn if the scatter style's shape is not \ref - QCPScatterStyle::ssNone. Hence, the \a scatterData vector is outputted by all "get(...)PlotData" + Draws scatter symbols at every data point passed in \a scatterData. scatter + symbols are independent + of the line style and are always drawn if the scatter style's shape is not + \ref + QCPScatterStyle::ssNone. Hence, the \a scatterData vector is outputted by all + "get(...)PlotData" functions, together with the (line style dependent) line data. \see drawLinePlot, drawImpulsePlot @@ -16149,10 +18567,14 @@ void QCPGraph::drawScatterPlot( QCPPainter* painter, QVector* scatterDa /*! \internal - Draws line graphs from the provided data. It connects all points in \a lineData, which was - created by one of the "get(...)PlotData" functions for line styles that require simple line - connections between the point vector they create. These are for example \ref getLinePlotData, - \ref getStepLeftPlotData, \ref getStepRightPlotData and \ref getStepCenterPlotData. + Draws line graphs from the provided data. It connects all points in \a + lineData, which was + created by one of the "get(...)PlotData" functions for line styles that + require simple line + connections between the point vector they create. These are for example \ref + getLinePlotData, + \ref getStepLeftPlotData, \ref getStepRightPlotData and \ref + getStepCenterPlotData. \see drawScatterPlot, drawImpulsePlot */ @@ -16180,8 +18602,10 @@ void QCPGraph::drawLinePlot( QCPPainter* painter, QVector* lineData ) c } */ - // if drawing solid line and not in PDF, use much faster line drawing instead of polyline: - if( mParentPlot->plottingHints().testFlag( QCP::phFastPolylines ) && painter->pen().style() == Qt::SolidLine && + // if drawing solid line and not in PDF, use much faster line drawing + // instead of polyline: + if( mParentPlot->plottingHints().testFlag( QCP::phFastPolylines ) && + painter->pen().style() == Qt::SolidLine && !painter->modes().testFlag( QCPPainter::pmVectorized ) && !painter->modes().testFlag( QCPPainter::pmNoCaching ) ) { @@ -16197,7 +18621,8 @@ void QCPGraph::drawLinePlot( QCPPainter* painter, QVector* lineData ) c /*! \internal - Draws impulses from the provided data, i.e. it connects all line pairs in \a lineData, which was + Draws impulses from the provided data, i.e. it connects all line pairs in \a + lineData, which was created by \ref getImpulsePlotData. \see drawScatterPlot, drawLinePlot @@ -16218,15 +18643,20 @@ void QCPGraph::drawImpulsePlot( QCPPainter* painter, QVector* lineData /*! \internal - Returns the \a lineData and \a scatterData that need to be plotted for this graph taking into - consideration the current axis ranges and, if \ref setAdaptiveSampling is enabled, local point + Returns the \a lineData and \a scatterData that need to be plotted for this + graph taking into + consideration the current axis ranges and, if \ref setAdaptiveSampling is + enabled, local point densities. - 0 may be passed as \a lineData or \a scatterData to indicate that the respective dataset isn't - needed. For example, if the scatter style (\ref setScatterStyle) is \ref QCPScatterStyle::ssNone, \a + 0 may be passed as \a lineData or \a scatterData to indicate that the + respective dataset isn't + needed. For example, if the scatter style (\ref setScatterStyle) is \ref + QCPScatterStyle::ssNone, \a scatterData should be 0 to prevent unnecessary calculations. - This method is used by the various "get(...)PlotData" methods to get the basic working set of data. + This method is used by the various "get(...)PlotData" methods to get the basic + working set of data. */ void QCPGraph::getPreparedData( QVector* lineData, QVector* scatterData ) const { @@ -16239,23 +18669,27 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc } // get visible data range: QCPDataMap::const_iterator lower, - upper; // note that upper is the actual upper point, and not 1 step after the upper point + upper; // note that upper is the actual upper point, and not 1 step after + // the upper point getVisibleDataBounds( lower, upper ); if( lower == mData->constEnd() || upper == mData->constEnd() ) return; - // count points in visible range, taking into account that we only need to count to the limit maxCount if using + // count points in visible range, taking into account that we only need to + // count to the limit maxCount if using // adaptive sampling: int maxCount = std::numeric_limits::max(); if( mAdaptiveSampling ) { - int keyPixelSpan = qAbs( keyAxis->coordToPixel( lower.key() ) - keyAxis->coordToPixel( upper.key() ) ); + int keyPixelSpan = + qAbs( keyAxis->coordToPixel( lower.key() ) - keyAxis->coordToPixel( upper.key() ) ); maxCount = 2 * keyPixelSpan + 2; } int dataCount = countDataInBounds( lower, upper, maxCount ); - if( mAdaptiveSampling && - dataCount >= maxCount ) // use adaptive sampling only if there are at least two points per pixel on average + if( mAdaptiveSampling && dataCount >= maxCount ) // use adaptive sampling only + // if there are at least two + // points per pixel on average { if( lineData ) { @@ -16264,29 +18698,36 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc double minValue = it.value().value; double maxValue = it.value().value; QCPDataMap::const_iterator currentIntervalFirstPoint = it; - int reversedFactor = - keyAxis->rangeReversed() ? -1 : 1; // is used to calculate keyEpsilon pixel into the correct direction - int reversedRound = - keyAxis->rangeReversed() - ? 1 - : 0; // is used to switch between floor (normal) and ceil (reversed) rounding of currentIntervalStartKey + int reversedFactor = keyAxis->rangeReversed() ? -1 : 1; // is used to calculate keyEpsilon + // pixel into the correct direction + int reversedRound = keyAxis->rangeReversed() ? 1 : 0; // is used to switch between floor + // (normal) and ceil (reversed) + // rounding of + // currentIntervalStartKey double currentIntervalStartKey = keyAxis->pixelToCoord( (int)( keyAxis->coordToPixel( lower.key() ) + reversedRound ) ); double lastIntervalEndKey = currentIntervalStartKey; double keyEpsilon = qAbs( currentIntervalStartKey - - keyAxis->pixelToCoord( - keyAxis->coordToPixel( currentIntervalStartKey ) + - 1.0 * reversedFactor ) ); // interval of one pixel on screen when mapped to plot key coordinates - bool keyEpsilonVariable = keyAxis->scaleType() == QCPAxis::stLogarithmic; // indicates whether keyEpsilon needs - // to be updated after every interval - // (for log axes) + keyAxis->pixelToCoord( keyAxis->coordToPixel( currentIntervalStartKey ) + + 1.0 * reversedFactor ) ); // interval of one pixel + // on screen when mapped + // to plot key + // coordinates + bool keyEpsilonVariable = + keyAxis->scaleType() == QCPAxis::stLogarithmic; // indicates whether keyEpsilon needs + // to be updated after every interval + // (for log axes) int intervalDataCount = 1; - ++it; // advance iterator to second data point because adaptive sampling works in 1 point retrospect + ++it; // advance iterator to second data point because adaptive sampling + // works in 1 point retrospect while( it != upperEnd ) { - if( it.key() < currentIntervalStartKey + keyEpsilon ) // data point is still within same pixel, so skip it and - // expand value span of this cluster if necessary + if( it.key() < currentIntervalStartKey + keyEpsilon ) // data point is + // still within + // same pixel, so + // skip it and + // expand value span of this cluster if necessary { if( it.value().value < minValue ) minValue = it.value().value; @@ -16296,47 +18737,57 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc } else // new pixel interval started { - if( intervalDataCount >= 2 ) // last pixel had multiple data points, consolidate them to a cluster + if( intervalDataCount >= 2 ) // last pixel had multiple data points, + // consolidate them to a cluster { - if( lastIntervalEndKey < currentIntervalStartKey - keyEpsilon ) // last point is further away, so first - // point of this cluster must be at a real - // data point - lineData->append( - QCPData( currentIntervalStartKey + keyEpsilon * 0.2, currentIntervalFirstPoint.value().value ) ); + if( lastIntervalEndKey < + currentIntervalStartKey - keyEpsilon ) // last point is further away, so first + // point of this cluster must be at a real + // data point + lineData->append( QCPData( currentIntervalStartKey + keyEpsilon * 0.2, + currentIntervalFirstPoint.value().value ) ); lineData->append( QCPData( currentIntervalStartKey + keyEpsilon * 0.25, minValue ) ); lineData->append( QCPData( currentIntervalStartKey + keyEpsilon * 0.75, maxValue ) ); - if( it.key() > currentIntervalStartKey + keyEpsilon * 2 ) // new pixel started further away from previous - // cluster, so make sure the last point of the - // cluster is at a real data point - lineData->append( QCPData( currentIntervalStartKey + keyEpsilon * 0.8, ( it - 1 ).value().value ) ); + if( it.key() > currentIntervalStartKey + + keyEpsilon * 2 ) // new pixel started further away from previous + // cluster, so make sure the last point of the + // cluster is at a real data point + lineData->append( + QCPData( currentIntervalStartKey + keyEpsilon * 0.8, ( it - 1 ).value().value ) ); } else - lineData->append( QCPData( currentIntervalFirstPoint.key(), currentIntervalFirstPoint.value().value ) ); + lineData->append( QCPData( currentIntervalFirstPoint.key(), + currentIntervalFirstPoint.value().value ) ); lastIntervalEndKey = ( it - 1 ).value().key; minValue = it.value().value; maxValue = it.value().value; currentIntervalFirstPoint = it; - currentIntervalStartKey = keyAxis->pixelToCoord( (int)( keyAxis->coordToPixel( it.key() ) + reversedRound ) ); + currentIntervalStartKey = + keyAxis->pixelToCoord( (int)( keyAxis->coordToPixel( it.key() ) + reversedRound ) ); if( keyEpsilonVariable ) - keyEpsilon = qAbs( - currentIntervalStartKey - - keyAxis->pixelToCoord( keyAxis->coordToPixel( currentIntervalStartKey ) + 1.0 * reversedFactor ) ); + keyEpsilon = + qAbs( currentIntervalStartKey - + keyAxis->pixelToCoord( keyAxis->coordToPixel( currentIntervalStartKey ) + + 1.0 * reversedFactor ) ); intervalDataCount = 1; } ++it; } // handle last interval: - if( intervalDataCount >= 2 ) // last pixel had multiple data points, consolidate them to a cluster + if( intervalDataCount >= 2 ) // last pixel had multiple data points, + // consolidate them to a cluster { - if( lastIntervalEndKey < currentIntervalStartKey - keyEpsilon ) // last point wasn't a cluster, so first point - // of this cluster must be at a real data point - lineData->append( - QCPData( currentIntervalStartKey + keyEpsilon * 0.2, currentIntervalFirstPoint.value().value ) ); + if( lastIntervalEndKey < + currentIntervalStartKey - keyEpsilon ) // last point wasn't a cluster, so first point + // of this cluster must be at a real data point + lineData->append( QCPData( currentIntervalStartKey + keyEpsilon * 0.2, + currentIntervalFirstPoint.value().value ) ); lineData->append( QCPData( currentIntervalStartKey + keyEpsilon * 0.25, minValue ) ); lineData->append( QCPData( currentIntervalStartKey + keyEpsilon * 0.75, maxValue ) ); } else - lineData->append( QCPData( currentIntervalFirstPoint.key(), currentIntervalFirstPoint.value().value ) ); + lineData->append( + QCPData( currentIntervalFirstPoint.key(), currentIntervalFirstPoint.value().value ) ); } if( scatterData ) @@ -16350,35 +18801,44 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc QCPDataMap::const_iterator minValueIt = it; QCPDataMap::const_iterator maxValueIt = it; QCPDataMap::const_iterator currentIntervalStart = it; - int reversedFactor = - keyAxis->rangeReversed() ? -1 : 1; // is used to calculate keyEpsilon pixel into the correct direction - int reversedRound = - keyAxis->rangeReversed() - ? 1 - : 0; // is used to switch between floor (normal) and ceil (reversed) rounding of currentIntervalStartKey + int reversedFactor = keyAxis->rangeReversed() ? -1 : 1; // is used to calculate keyEpsilon + // pixel into the correct direction + int reversedRound = keyAxis->rangeReversed() ? 1 : 0; // is used to switch between floor + // (normal) and ceil (reversed) + // rounding of + // currentIntervalStartKey double currentIntervalStartKey = keyAxis->pixelToCoord( (int)( keyAxis->coordToPixel( lower.key() ) + reversedRound ) ); double keyEpsilon = qAbs( currentIntervalStartKey - - keyAxis->pixelToCoord( - keyAxis->coordToPixel( currentIntervalStartKey ) + - 1.0 * reversedFactor ) ); // interval of one pixel on screen when mapped to plot key coordinates - bool keyEpsilonVariable = keyAxis->scaleType() == QCPAxis::stLogarithmic; // indicates whether keyEpsilon needs - // to be updated after every interval - // (for log axes) + keyAxis->pixelToCoord( keyAxis->coordToPixel( currentIntervalStartKey ) + + 1.0 * reversedFactor ) ); // interval of one pixel + // on screen when mapped + // to plot key + // coordinates + bool keyEpsilonVariable = + keyAxis->scaleType() == QCPAxis::stLogarithmic; // indicates whether keyEpsilon needs + // to be updated after every interval + // (for log axes) int intervalDataCount = 1; - ++it; // advance iterator to second data point because adaptive sampling works in 1 point retrospect + ++it; // advance iterator to second data point because adaptive sampling + // works in 1 point retrospect while( it != upperEnd ) { - if( it.key() < currentIntervalStartKey + keyEpsilon ) // data point is still within same pixel, so skip it and - // expand value span of this pixel if necessary + if( it.key() < currentIntervalStartKey + keyEpsilon ) // data point is + // still within + // same pixel, so + // skip it and + // expand value span of this pixel if necessary { - if( it.value().value < minValue && it.value().value > valueMinRange && it.value().value < valueMaxRange ) + if( it.value().value < minValue && it.value().value > valueMinRange && + it.value().value < valueMaxRange ) { minValue = it.value().value; minValueIt = it; } - else if( it.value().value > maxValue && it.value().value > valueMinRange && it.value().value < valueMaxRange ) + else if( it.value().value > maxValue && it.value().value > valueMinRange && + it.value().value < valueMaxRange ) { maxValue = it.value().value; maxValueIt = it; @@ -16389,19 +18849,23 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc { if( intervalDataCount >= 2 ) // last pixel had multiple data points, consolidate them { - // determine value pixel span and add as many points in interval to maintain certain vertical data density + // determine value pixel span and add as many points in interval to + // maintain certain vertical data density // (this is specific to scatter plot): - double valuePixelSpan = qAbs( valueAxis->coordToPixel( minValue ) - valueAxis->coordToPixel( maxValue ) ); + double valuePixelSpan = + qAbs( valueAxis->coordToPixel( minValue ) - valueAxis->coordToPixel( maxValue ) ); int dataModulo = qMax( 1, - qRound( intervalDataCount / - ( valuePixelSpan / 4.0 ) ) ); // approximately every 4 value pixels one data point on average + qRound( intervalDataCount / ( valuePixelSpan / 4.0 ) ) ); // approximately every 4 + // value pixels one data + // point on average QCPDataMap::const_iterator intervalIt = currentIntervalStart; int c = 0; while( intervalIt != it ) { if( ( c % dataModulo == 0 || intervalIt == minValueIt || intervalIt == maxValueIt ) && - intervalIt.value().value > valueMinRange && intervalIt.value().value < valueMaxRange ) + intervalIt.value().value > valueMinRange && + intervalIt.value().value < valueMaxRange ) scatterData->append( intervalIt.value() ); ++c; ++intervalIt; @@ -16413,11 +18877,13 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc minValue = it.value().value; maxValue = it.value().value; currentIntervalStart = it; - currentIntervalStartKey = keyAxis->pixelToCoord( (int)( keyAxis->coordToPixel( it.key() ) + reversedRound ) ); + currentIntervalStartKey = + keyAxis->pixelToCoord( (int)( keyAxis->coordToPixel( it.key() ) + reversedRound ) ); if( keyEpsilonVariable ) - keyEpsilon = qAbs( - currentIntervalStartKey - - keyAxis->pixelToCoord( keyAxis->coordToPixel( currentIntervalStartKey ) + 1.0 * reversedFactor ) ); + keyEpsilon = + qAbs( currentIntervalStartKey - + keyAxis->pixelToCoord( keyAxis->coordToPixel( currentIntervalStartKey ) + + 1.0 * reversedFactor ) ); intervalDataCount = 1; } ++it; @@ -16425,12 +18891,15 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc // handle last interval: if( intervalDataCount >= 2 ) // last pixel had multiple data points, consolidate them { - // determine value pixel span and add as many points in interval to maintain certain vertical data density (this + // determine value pixel span and add as many points in interval to + // maintain certain vertical data density (this // is specific to scatter plot): - double valuePixelSpan = qAbs( valueAxis->coordToPixel( minValue ) - valueAxis->coordToPixel( maxValue ) ); + double valuePixelSpan = + qAbs( valueAxis->coordToPixel( minValue ) - valueAxis->coordToPixel( maxValue ) ); int dataModulo = qMax( - 1, qRound( intervalDataCount / - ( valuePixelSpan / 4.0 ) ) ); // approximately every 4 value pixels one data point on average + 1, qRound( intervalDataCount / ( valuePixelSpan / 4.0 ) ) ); // approximately every 4 + // value pixels one data + // point on average QCPDataMap::const_iterator intervalIt = currentIntervalStart; int c = 0; while( intervalIt != it ) @@ -16447,7 +18916,8 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc scatterData->append( currentIntervalStart.value() ); } } - else // don't use adaptive sampling algorithm, transfer points one-to-one from the map into the output parameters + else // don't use adaptive sampling algorithm, transfer points one-to-one + // from the map into the output parameters { QVector* dataVector = 0; if( lineData ) @@ -16472,9 +18942,12 @@ void QCPGraph::getPreparedData( QVector* lineData, QVector* sc /*! \internal - called by the scatter drawing function (\ref drawScatterPlot) to draw the error bars on one data - point. \a x and \a y pixel positions of the data point are passed since they are already known in - pixel coordinates in the drawing function, so we save some extra coordToPixel transforms here. \a + called by the scatter drawing function (\ref drawScatterPlot) to draw the + error bars on one data + point. \a x and \a y pixel positions of the data point are passed since they + are already known in + pixel coordinates in the drawing function, so we save some extra coordToPixel + transforms here. \a data is therefore only used for the errors, not key and value. */ void QCPGraph::drawError( QCPPainter* painter, double x, double y, const QCPData& data ) const @@ -16489,7 +18962,9 @@ void QCPGraph::drawError( QCPPainter* painter, double x, double y, const QCPData double a, b; // positions of error bar bounds in pixels double barWidthHalf = mErrorBarSize * 0.5; - double skipSymbolMargin = mScatterStyle.size(); // pixels left blank per side, when mErrorBarSkipSymbol is true + double skipSymbolMargin = mScatterStyle.size(); // pixels left blank per side, + // when mErrorBarSkipSymbol is + // true if( keyAxis->orientation() == Qt::Vertical ) { @@ -16503,7 +18978,8 @@ void QCPGraph::drawError( QCPPainter* painter, double x, double y, const QCPData // draw spine: if( mErrorBarSkipSymbol ) { - if( a - y > skipSymbolMargin ) // don't draw spine if error is so small it's within skipSymbolmargin + if( a - y > skipSymbolMargin ) // don't draw spine if error is so small + // it's within skipSymbolmargin painter->drawLine( QLineF( x, a, x, y + skipSymbolMargin ) ); if( y - b > skipSymbolMargin ) painter->drawLine( QLineF( x, y - skipSymbolMargin, x, b ) ); @@ -16523,7 +18999,8 @@ void QCPGraph::drawError( QCPPainter* painter, double x, double y, const QCPData // draw spine: if( mErrorBarSkipSymbol ) { - if( x - a > skipSymbolMargin ) // don't draw spine if error is so small it's within skipSymbolmargin + if( x - a > skipSymbolMargin ) // don't draw spine if error is so small + // it's within skipSymbolmargin painter->drawLine( QLineF( a, y, x - skipSymbolMargin, y ) ); if( b - x > skipSymbolMargin ) painter->drawLine( QLineF( x + skipSymbolMargin, y, b, y ) ); @@ -16547,7 +19024,8 @@ void QCPGraph::drawError( QCPPainter* painter, double x, double y, const QCPData // draw spine: if( mErrorBarSkipSymbol ) { - if( x - a > skipSymbolMargin ) // don't draw spine if error is so small it's within skipSymbolmargin + if( x - a > skipSymbolMargin ) // don't draw spine if error is so small + // it's within skipSymbolmargin painter->drawLine( QLineF( a, y, x - skipSymbolMargin, y ) ); if( b - x > skipSymbolMargin ) painter->drawLine( QLineF( x + skipSymbolMargin, y, b, y ) ); @@ -16567,7 +19045,8 @@ void QCPGraph::drawError( QCPPainter* painter, double x, double y, const QCPData // draw spine: if( mErrorBarSkipSymbol ) { - if( a - y > skipSymbolMargin ) // don't draw spine if error is so small it's within skipSymbolmargin + if( a - y > skipSymbolMargin ) // don't draw spine if error is so small + // it's within skipSymbolmargin painter->drawLine( QLineF( x, a, x, y + skipSymbolMargin ) ); if( y - b > skipSymbolMargin ) painter->drawLine( QLineF( x, y - skipSymbolMargin, x, b ) ); @@ -16583,19 +19062,24 @@ void QCPGraph::drawError( QCPPainter* painter, double x, double y, const QCPData /*! \internal - called by \ref getPreparedData to determine which data (key) range is visible at the current key + called by \ref getPreparedData to determine which data (key) range is visible + at the current key axis range setting, so only that needs to be processed. - \a lower returns an iterator to the lowest data point that needs to be taken into account when - plotting. Note that in order to get a clean plot all the way to the edge of the axis rect, \a + \a lower returns an iterator to the lowest data point that needs to be taken + into account when + plotting. Note that in order to get a clean plot all the way to the edge of + the axis rect, \a lower may still be just outside the visible range. - \a upper returns an iterator to the highest data point. Same as before, \a upper may also lie + \a upper returns an iterator to the highest data point. Same as before, \a + upper may also lie just outside of the visible range. if the graph contains no data, both \a lower and \a upper point to constEnd. */ -void QCPGraph::getVisibleDataBounds( QCPDataMap::const_iterator& lower, QCPDataMap::const_iterator& upper ) const +void QCPGraph::getVisibleDataBounds( QCPDataMap::const_iterator& lower, + QCPDataMap::const_iterator& upper ) const { if( !mKeyAxis ) { @@ -16612,8 +19096,11 @@ void QCPGraph::getVisibleDataBounds( QCPDataMap::const_iterator& lower, QCPDataM // get visible data range as QMap iterators QCPDataMap::const_iterator lbound = mData->lowerBound( mKeyAxis.data()->range().lower ); QCPDataMap::const_iterator ubound = mData->upperBound( mKeyAxis.data()->range().upper ); - bool lowoutlier = lbound != mData->constBegin(); // indicates whether there exist points below axis range - bool highoutlier = ubound != mData->constEnd(); // indicates whether there exist points above axis range + bool lowoutlier = lbound != mData->constBegin(); // indicates whether there + // exist points below axis + // range + bool highoutlier = + ubound != mData->constEnd(); // indicates whether there exist points above axis range lower = ( lowoutlier ? lbound - 1 : lbound ); // data point range that will be actually drawn upper = ( highoutlier ? ubound : ubound - 1 ); // data point range that will be actually drawn @@ -16621,12 +19108,16 @@ void QCPGraph::getVisibleDataBounds( QCPDataMap::const_iterator& lower, QCPDataM /*! \internal - Counts the number of data points between \a lower and \a upper (including them), up to a maximum + Counts the number of data points between \a lower and \a upper (including + them), up to a maximum of \a maxCount. - This function is used by \ref getPreparedData to determine whether adaptive sampling shall be - used (if enabled via \ref setAdaptiveSampling) or not. This is also why counting of data points - only needs to be done until \a maxCount is reached, which should be set to the number of data + This function is used by \ref getPreparedData to determine whether adaptive + sampling shall be + used (if enabled via \ref setAdaptiveSampling) or not. This is also why + counting of data points + only needs to be done until \a maxCount is reached, which should be set to the + number of data points at which adaptive sampling sets in. */ int QCPGraph::countDataInBounds( const QCPDataMap::const_iterator& lower, @@ -16647,15 +19138,22 @@ int QCPGraph::countDataInBounds( const QCPDataMap::const_iterator& lower, /*! \internal - The line data vector generated by e.g. getLinePlotData contains only the line that connects the - data points. If the graph needs to be filled, two additional points need to be added at the - value-zero-line in the lower and upper key positions of the graph. This function calculates these - points and adds them to the end of \a lineData. Since the fill is typically drawn before the line - stroke, these added points need to be removed again after the fill is done, with the + The line data vector generated by e.g. getLinePlotData contains only the line + that connects the + data points. If the graph needs to be filled, two additional points need to be + added at the + value-zero-line in the lower and upper key positions of the graph. This + function calculates these + points and adds them to the end of \a lineData. Since the fill is typically + drawn before the line + stroke, these added points need to be removed again after the fill is done, + with the removeFillBasePoints function. - The expanding of \a lineData by two points will not cause unnecessary memory reallocations, - because the data vector generation functions (getLinePlotData etc.) reserve two extra points when + The expanding of \a lineData by two points will not cause unnecessary memory + reallocations, + because the data vector generation functions (getLinePlotData etc.) reserve + two extra points when they allocate memory for \a lineData. \see removeFillBasePoints, lowerFillBasePoint, upperFillBasePoint @@ -16683,7 +19181,8 @@ void QCPGraph::addFillBasePoints( QVector* lineData ) const /*! \internal - removes the two points from \a lineData that were added by \ref addFillBasePoints. + removes the two points from \a lineData that were added by \ref + addFillBasePoints. \see addFillBasePoints, lowerFillBasePoint, upperFillBasePoint */ @@ -16694,14 +19193,20 @@ void QCPGraph::removeFillBasePoints( QVector* lineData ) const /*! \internal - called by \ref addFillBasePoints to conveniently assign the point which closes the fill polygon - on the lower side of the zero-value-line parallel to the key axis. The logarithmic axis scale - case is a bit special, since the zero-value-line in pixel coordinates is in positive or negative - infinity. So this case is handled separately by just closing the fill polygon on the axis which + called by \ref addFillBasePoints to conveniently assign the point which closes + the fill polygon + on the lower side of the zero-value-line parallel to the key axis. The + logarithmic axis scale + case is a bit special, since the zero-value-line in pixel coordinates is in + positive or negative + infinity. So this case is handled separately by just closing the fill polygon + on the axis which lies in the direction towards the zero value. - \a lowerKey will be the the key (in pixels) of the returned point. Depending on whether the key - axis is horizontal or vertical, \a lowerKey will end up as the x or y value of the returned + \a lowerKey will be the the key (in pixels) of the returned point. Depending + on whether the key + axis is horizontal or vertical, \a lowerKey will end up as the x or y value of + the returned point, respectively. \see upperFillBasePoint, addFillBasePoints @@ -16742,13 +19247,15 @@ QPointF QCPGraph::lowerFillBasePoint( double lowerKey ) const } else // valueAxis->mScaleType == QCPAxis::stLogarithmic { - // In logarithmic scaling we can't just draw to value zero so we just fill all the way + // In logarithmic scaling we can't just draw to value zero so we just fill + // all the way // to the axis which is in the direction towards zero if( keyAxis->orientation() == Qt::Vertical ) { if( ( valueAxis->range().upper < 0 && !valueAxis->rangeReversed() ) || ( valueAxis->range().upper > 0 && - valueAxis->rangeReversed() ) ) // if range is negative, zero is on opposite side of key axis + valueAxis->rangeReversed() ) ) // if range is negative, zero is on + // opposite side of key axis point.setX( keyAxis->axisRect()->right() ); else point.setX( keyAxis->axisRect()->left() ); @@ -16759,7 +19266,8 @@ QPointF QCPGraph::lowerFillBasePoint( double lowerKey ) const point.setX( lowerKey ); if( ( valueAxis->range().upper < 0 && !valueAxis->rangeReversed() ) || ( valueAxis->range().upper > 0 && - valueAxis->rangeReversed() ) ) // if range is negative, zero is on opposite side of key axis + valueAxis->rangeReversed() ) ) // if range is negative, zero is on + // opposite side of key axis point.setY( keyAxis->axisRect()->top() ); else point.setY( keyAxis->axisRect()->bottom() ); @@ -16770,14 +19278,20 @@ QPointF QCPGraph::lowerFillBasePoint( double lowerKey ) const /*! \internal - called by \ref addFillBasePoints to conveniently assign the point which closes the fill - polygon on the upper side of the zero-value-line parallel to the key axis. The logarithmic axis - scale case is a bit special, since the zero-value-line in pixel coordinates is in positive or - negative infinity. So this case is handled separately by just closing the fill polygon on the + called by \ref addFillBasePoints to conveniently assign the point which closes + the fill + polygon on the upper side of the zero-value-line parallel to the key axis. The + logarithmic axis + scale case is a bit special, since the zero-value-line in pixel coordinates is + in positive or + negative infinity. So this case is handled separately by just closing the fill + polygon on the axis which lies in the direction towards the zero value. - \a upperKey will be the the key (in pixels) of the returned point. Depending on whether the key - axis is horizontal or vertical, \a upperKey will end up as the x or y value of the returned + \a upperKey will be the the key (in pixels) of the returned point. Depending + on whether the key + axis is horizontal or vertical, \a upperKey will end up as the x or y value of + the returned point, respectively. \see lowerFillBasePoint, addFillBasePoints @@ -16818,13 +19332,15 @@ QPointF QCPGraph::upperFillBasePoint( double upperKey ) const } else // valueAxis->mScaleType == QCPAxis::stLogarithmic { - // In logarithmic scaling we can't just draw to value 0 so we just fill all the way + // In logarithmic scaling we can't just draw to value 0 so we just fill all + // the way // to the axis which is in the direction towards 0 if( keyAxis->orientation() == Qt::Vertical ) { if( ( valueAxis->range().upper < 0 && !valueAxis->rangeReversed() ) || ( valueAxis->range().upper > 0 && - valueAxis->rangeReversed() ) ) // if range is negative, zero is on opposite side of key axis + valueAxis->rangeReversed() ) ) // if range is negative, zero is on + // opposite side of key axis point.setX( keyAxis->axisRect()->right() ); else point.setX( keyAxis->axisRect()->left() ); @@ -16835,7 +19351,8 @@ QPointF QCPGraph::upperFillBasePoint( double upperKey ) const point.setX( upperKey ); if( ( valueAxis->range().upper < 0 && !valueAxis->rangeReversed() ) || ( valueAxis->range().upper > 0 && - valueAxis->rangeReversed() ) ) // if range is negative, zero is on opposite side of key axis + valueAxis->rangeReversed() ) ) // if range is negative, zero is on + // opposite side of key axis point.setY( keyAxis->axisRect()->top() ); else point.setY( keyAxis->axisRect()->bottom() ); @@ -16846,11 +19363,16 @@ QPointF QCPGraph::upperFillBasePoint( double upperKey ) const /*! \internal - Generates the polygon needed for drawing channel fills between this graph (data passed via \a - lineData) and the graph specified by mChannelFillGraph (data generated by calling its \ref - getPlotData function). May return an empty polygon if the key ranges have no overlap or fill - target graph and this graph don't have same orientation (i.e. both key axes horizontal or both - key axes vertical). For increased performance (due to implicit sharing), keep the returned + Generates the polygon needed for drawing channel fills between this graph + (data passed via \a + lineData) and the graph specified by mChannelFillGraph (data generated by + calling its \ref + getPlotData function). May return an empty polygon if the key ranges have no + overlap or fill + target graph and this graph don't have same orientation (i.e. both key axes + horizontal or both + key axes vertical). For increased performance (due to implicit sharing), keep + the returned QPolygonF const. */ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineData ) const @@ -16872,7 +19394,8 @@ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineDat } if( mChannelFillGraph.data()->mKeyAxis.data()->orientation() != keyAxis->orientation() ) - return QPolygonF(); // don't have same axis orientation, can't fill that (Note: if keyAxis fits, valueAxis will fit + return QPolygonF(); // don't have same axis orientation, can't fill that + // (Note: if keyAxis fits, valueAxis will fit // too, because it's always orthogonal to keyAxis) if( lineData->isEmpty() ) @@ -16882,20 +19405,27 @@ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineDat if( otherData.isEmpty() ) return QPolygonF(); QVector thisData; - thisData.reserve( lineData->size() + otherData.size() ); // because we will join both vectors at end of this function - for( int i = 0; i < lineData->size(); ++i ) // don't use the vector<<(vector), it squeezes internally, which ruins - // the performance tuning with reserve() + thisData.reserve( lineData->size() + otherData.size() ); // because we will join + // both vectors at end + // of this function + for( int i = 0; i < lineData->size(); ++i ) // don't use the vector<<(vector), + // it squeezes internally, which + // ruins + // the performance tuning with reserve() thisData << lineData->at( i ); - // pointers to be able to swap them, depending which data range needs cropping: + // pointers to be able to swap them, depending which data range needs + // cropping: QVector* staticData = &thisData; QVector* croppedData = &otherData; - // crop both vectors to ranges in which the keys overlap (which coord is key, depends on axisType): + // crop both vectors to ranges in which the keys overlap (which coord is key, + // depends on axisType): if( keyAxis->orientation() == Qt::Horizontal ) { // x is key - // if an axis range is reversed, the data point keys will be descending. Reverse them, since following algorithm + // if an axis range is reversed, the data point keys will be descending. + // Reverse them, since following algorithm // assumes ascending keys: if( staticData->first().x() > staticData->last().x() ) { @@ -16916,7 +19446,8 @@ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineDat if( lowBound == -1 ) return QPolygonF(); // key ranges have no overlap croppedData->remove( 0, lowBound ); - // set lowest point of cropped data to fit exactly key position of first static data + // set lowest point of cropped data to fit exactly key position of first + // static data // point via linear interpolation: if( croppedData->size() < 2 ) return QPolygonF(); // need at least two points for interpolation @@ -16937,7 +19468,8 @@ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineDat if( highBound == -1 ) return QPolygonF(); // key ranges have no overlap croppedData->remove( highBound + 1, croppedData->size() - ( highBound + 1 ) ); - // set highest point of cropped data to fit exactly key position of last static data + // set highest point of cropped data to fit exactly key position of last + // static data // point via linear interpolation: if( croppedData->size() < 2 ) return QPolygonF(); // need at least two points for interpolation @@ -16954,9 +19486,12 @@ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineDat else // mKeyAxis->orientation() == Qt::Vertical { // y is key - // similar to "x is key" but switched x,y. Further, lower/upper meaning is inverted compared to x, - // because in pixel coordinates, y increases from top to bottom, not bottom to top like data coordinate. - // if an axis range is reversed, the data point keys will be descending. Reverse them, since following algorithm + // similar to "x is key" but switched x,y. Further, lower/upper meaning is + // inverted compared to x, + // because in pixel coordinates, y increases from top to bottom, not bottom + // to top like data coordinate. + // if an axis range is reversed, the data point keys will be descending. + // Reverse them, since following algorithm // assumes ascending keys: if( staticData->first().y() < staticData->last().y() ) { @@ -16977,12 +19512,14 @@ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineDat if( lowBound == -1 ) return QPolygonF(); // key ranges have no overlap croppedData->remove( 0, lowBound ); - // set lowest point of cropped data to fit exactly key position of first static data + // set lowest point of cropped data to fit exactly key position of first + // static data // point via linear interpolation: if( croppedData->size() < 2 ) return QPolygonF(); // need at least two points for interpolation double slope; - if( croppedData->at( 1 ).y() - croppedData->at( 0 ).y() != 0 ) // avoid division by zero in step plots + if( croppedData->at( 1 ).y() - croppedData->at( 0 ).y() != + 0 ) // avoid division by zero in step plots slope = ( croppedData->at( 1 ).x() - croppedData->at( 0 ).x() ) / ( croppedData->at( 1 ).y() - croppedData->at( 0 ).y() ); else @@ -16998,12 +19535,14 @@ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineDat if( highBound == -1 ) return QPolygonF(); // key ranges have no overlap croppedData->remove( highBound + 1, croppedData->size() - ( highBound + 1 ) ); - // set highest point of cropped data to fit exactly key position of last static data + // set highest point of cropped data to fit exactly key position of last + // static data // point via linear interpolation: if( croppedData->size() < 2 ) - return QPolygonF(); // need at least two points for interpolation - int li = croppedData->size() - 1; // last index - if( croppedData->at( li ).y() - croppedData->at( li - 1 ).y() != 0 ) // avoid division by zero in step plots + return QPolygonF(); // need at least two points for interpolation + int li = croppedData->size() - 1; // last index + if( croppedData->at( li ).y() - croppedData->at( li - 1 ).y() != + 0 ) // avoid division by zero in step plots slope = ( croppedData->at( li ).x() - croppedData->at( li - 1 ).x() ) / ( croppedData->at( li ).y() - croppedData->at( li - 1 ).y() ); else @@ -17014,15 +19553,18 @@ const QPolygonF QCPGraph::getChannelFillPolygon( const QVector* lineDat } // return joined: - for( int i = otherData.size() - 1; i >= 0; --i ) // insert reversed, otherwise the polygon will be twisted + for( int i = otherData.size() - 1; i >= 0; + --i ) // insert reversed, otherwise the polygon will be twisted thisData << otherData.at( i ); return QPolygonF( thisData ); } /*! \internal - Finds the smallest index of \a data, whose points x value is just above \a x. Assumes x values in - \a data points are ordered ascending, as is the case when plotting with horizontal key axis. + Finds the smallest index of \a data, whose points x value is just above \a x. + Assumes x values in + \a data points are ordered ascending, as is the case when plotting with + horizontal key axis. Used to calculate the channel fill polygon, see \ref getChannelFillPolygon. */ @@ -17043,8 +19585,10 @@ int QCPGraph::findIndexAboveX( const QVector* data, double x ) const /*! \internal - Finds the highest index of \a data, whose points x value is just below \a x. Assumes x values in - \a data points are ordered ascending, as is the case when plotting with horizontal key axis. + Finds the highest index of \a data, whose points x value is just below \a x. + Assumes x values in + \a data points are ordered ascending, as is the case when plotting with + horizontal key axis. Used to calculate the channel fill polygon, see \ref getChannelFillPolygon. */ @@ -17065,8 +19609,10 @@ int QCPGraph::findIndexBelowX( const QVector* data, double x ) const /*! \internal - Finds the smallest index of \a data, whose points y value is just above \a y. Assumes y values in - \a data points are ordered descending, as is the case when plotting with vertical key axis. + Finds the smallest index of \a data, whose points y value is just above \a y. + Assumes y values in + \a data points are ordered descending, as is the case when plotting with + vertical key axis. Used to calculate the channel fill polygon, see \ref getChannelFillPolygon. */ @@ -17087,12 +19633,16 @@ int QCPGraph::findIndexAboveY( const QVector* data, double y ) const /*! \internal - Calculates the (minimum) distance (in pixels) the graph's representation has from the given \a - pixelPoint in pixels. This is used to determine whether the graph was clicked or not, e.g. in + Calculates the (minimum) distance (in pixels) the graph's representation has + from the given \a + pixelPoint in pixels. This is used to determine whether the graph was clicked + or not, e.g. in \ref selectTest. - If either the graph has no data or if the line style is \ref lsNone and the scatter style's shape - is \ref QCPScatterStyle::ssNone (i.e. there is no visual representation of the graph), returns + If either the graph has no data or if the line style is \ref lsNone and the + scatter style's shape + is \ref QCPScatterStyle::ssNone (i.e. there is no visual representation of the + graph), returns 500. */ double QCPGraph::pointDistance( const QPointF& pixelPoint ) const @@ -17104,7 +19654,8 @@ double QCPGraph::pointDistance( const QPointF& pixelPoint ) const } if( mData->size() == 1 ) { - QPointF dataPoint = coordsToPixels( mData->constBegin().key(), mData->constBegin().value().value ); + QPointF dataPoint = + coordsToPixels( mData->constBegin().key(), mData->constBegin().value().value ); return QVector2D( dataPoint - pixelPoint ).length(); } @@ -17119,9 +19670,10 @@ double QCPGraph::pointDistance( const QPointF& pixelPoint ) const getScatterPlotData( scatterData ); double minDistSqr = std::numeric_limits::max(); QPointF ptA; - QPointF ptB = coordsToPixels( - scatterData->at( 0 ).key, - scatterData->at( 0 ).value ); // getScatterPlotData returns in plot coordinates, so transform to pixels + QPointF ptB = coordsToPixels( scatterData->at( 0 ).key, + scatterData->at( 0 ).value ); // getScatterPlotData returns + // in plot coordinates, so + // transform to pixels for( int i = 1; i < scatterData->size(); ++i ) { ptA = ptB; @@ -17141,10 +19693,12 @@ double QCPGraph::pointDistance( const QPointF& pixelPoint ) const double minDistSqr = std::numeric_limits::max(); if( mLineStyle == lsImpulse ) { - // impulse plot differs from other line styles in that the lineData points are only pairwise connected: + // impulse plot differs from other line styles in that the lineData points + // are only pairwise connected: for( int i = 0; i < lineData->size() - 1; i += 2 ) // iterate pairs { - double currentDistSqr = distSqrToLine( lineData->at( i ), lineData->at( i + 1 ), pixelPoint ); + double currentDistSqr = + distSqrToLine( lineData->at( i ), lineData->at( i + 1 ), pixelPoint ); if( currentDistSqr < minDistSqr ) minDistSqr = currentDistSqr; } @@ -17154,7 +19708,8 @@ double QCPGraph::pointDistance( const QPointF& pixelPoint ) const // all other line plots (line and step) connect points directly: for( int i = 0; i < lineData->size() - 1; ++i ) { - double currentDistSqr = distSqrToLine( lineData->at( i ), lineData->at( i + 1 ), pixelPoint ); + double currentDistSqr = + distSqrToLine( lineData->at( i ), lineData->at( i + 1 ), pixelPoint ); if( currentDistSqr < minDistSqr ) minDistSqr = currentDistSqr; } @@ -17166,8 +19721,10 @@ double QCPGraph::pointDistance( const QPointF& pixelPoint ) const /*! \internal - Finds the highest index of \a data, whose points y value is just below \a y. Assumes y values in - \a data points are ordered descending, as is the case when plotting with vertical key axis (since + Finds the highest index of \a data, whose points y value is just below \a y. + Assumes y values in + \a data points are ordered descending, as is the case when plotting with + vertical key axis (since keys are ordered ascending). Used to calculate the channel fill polygon, see \ref getChannelFillPolygon. @@ -17190,26 +19747,33 @@ int QCPGraph::findIndexBelowY( const QVector* data, double y ) const /* inherits documentation from base class */ QCPRange QCPGraph::getKeyRange( bool& foundRange, SignDomain inSignDomain ) const { - // just call the specialized version which takes an additional argument whether error bars - // should also be taken into consideration for range calculation. We set this to true here. + // just call the specialized version which takes an additional argument + // whether error bars + // should also be taken into consideration for range calculation. We set this + // to true here. return getKeyRange( foundRange, inSignDomain, true ); } /* inherits documentation from base class */ QCPRange QCPGraph::getValueRange( bool& foundRange, SignDomain inSignDomain ) const { - // just call the specialized version which takes an additional argument whether error bars - // should also be taken into consideration for range calculation. We set this to true here. + // just call the specialized version which takes an additional argument + // whether error bars + // should also be taken into consideration for range calculation. We set this + // to true here. return getValueRange( foundRange, inSignDomain, true ); } /*! \overload - Allows to specify whether the error bars should be included in the range calculation. + Allows to specify whether the error bars should be included in the range + calculation. \see getKeyRange(bool &foundRange, SignDomain inSignDomain) */ -QCPRange QCPGraph::getKeyRange( bool& foundRange, SignDomain inSignDomain, bool includeErrors ) const +QCPRange QCPGraph::getKeyRange( bool& foundRange, + SignDomain inSignDomain, + bool includeErrors ) const { QCPRange range; bool haveLower = false; @@ -17246,17 +19810,20 @@ QCPRange QCPGraph::getKeyRange( bool& foundRange, SignDomain inSignDomain, bool current = it.value().key; currentErrorMinus = ( includeErrors ? it.value().keyErrorMinus : 0 ); currentErrorPlus = ( includeErrors ? it.value().keyErrorPlus : 0 ); - if( ( current - currentErrorMinus < range.lower || !haveLower ) && current - currentErrorMinus < 0 ) + if( ( current - currentErrorMinus < range.lower || !haveLower ) && + current - currentErrorMinus < 0 ) { range.lower = current - currentErrorMinus; haveLower = true; } - if( ( current + currentErrorPlus > range.upper || !haveUpper ) && current + currentErrorPlus < 0 ) + if( ( current + currentErrorPlus > range.upper || !haveUpper ) && + current + currentErrorPlus < 0 ) { range.upper = current + currentErrorPlus; haveUpper = true; } - if( includeErrors ) // in case point is in valid sign domain but errobars stretch beyond it, we still want to + if( includeErrors ) // in case point is in valid sign domain but errobars + // stretch beyond it, we still want to // geht that point. { if( ( current < range.lower || !haveLower ) && current < 0 ) @@ -17281,17 +19848,20 @@ QCPRange QCPGraph::getKeyRange( bool& foundRange, SignDomain inSignDomain, bool current = it.value().key; currentErrorMinus = ( includeErrors ? it.value().keyErrorMinus : 0 ); currentErrorPlus = ( includeErrors ? it.value().keyErrorPlus : 0 ); - if( ( current - currentErrorMinus < range.lower || !haveLower ) && current - currentErrorMinus > 0 ) + if( ( current - currentErrorMinus < range.lower || !haveLower ) && + current - currentErrorMinus > 0 ) { range.lower = current - currentErrorMinus; haveLower = true; } - if( ( current + currentErrorPlus > range.upper || !haveUpper ) && current + currentErrorPlus > 0 ) + if( ( current + currentErrorPlus > range.upper || !haveUpper ) && + current + currentErrorPlus > 0 ) { range.upper = current + currentErrorPlus; haveUpper = true; } - if( includeErrors ) // in case point is in valid sign domain but errobars stretch beyond it, we still want to get + if( includeErrors ) // in case point is in valid sign domain but errobars + // stretch beyond it, we still want to get // that point. { if( ( current < range.lower || !haveLower ) && current > 0 ) @@ -17315,11 +19885,14 @@ QCPRange QCPGraph::getKeyRange( bool& foundRange, SignDomain inSignDomain, bool /*! \overload - Allows to specify whether the error bars should be included in the range calculation. + Allows to specify whether the error bars should be included in the range + calculation. \see getValueRange(bool &foundRange, SignDomain inSignDomain) */ -QCPRange QCPGraph::getValueRange( bool& foundRange, SignDomain inSignDomain, bool includeErrors ) const +QCPRange QCPGraph::getValueRange( bool& foundRange, + SignDomain inSignDomain, + bool includeErrors ) const { QCPRange range; bool haveLower = false; @@ -17356,17 +19929,20 @@ QCPRange QCPGraph::getValueRange( bool& foundRange, SignDomain inSignDomain, boo current = it.value().value; currentErrorMinus = ( includeErrors ? it.value().valueErrorMinus : 0 ); currentErrorPlus = ( includeErrors ? it.value().valueErrorPlus : 0 ); - if( ( current - currentErrorMinus < range.lower || !haveLower ) && current - currentErrorMinus < 0 ) + if( ( current - currentErrorMinus < range.lower || !haveLower ) && + current - currentErrorMinus < 0 ) { range.lower = current - currentErrorMinus; haveLower = true; } - if( ( current + currentErrorPlus > range.upper || !haveUpper ) && current + currentErrorPlus < 0 ) + if( ( current + currentErrorPlus > range.upper || !haveUpper ) && + current + currentErrorPlus < 0 ) { range.upper = current + currentErrorPlus; haveUpper = true; } - if( includeErrors ) // in case point is in valid sign domain but errobars stretch beyond it, we still want to get + if( includeErrors ) // in case point is in valid sign domain but errobars + // stretch beyond it, we still want to get // that point. { if( ( current < range.lower || !haveLower ) && current < 0 ) @@ -17391,17 +19967,20 @@ QCPRange QCPGraph::getValueRange( bool& foundRange, SignDomain inSignDomain, boo current = it.value().value; currentErrorMinus = ( includeErrors ? it.value().valueErrorMinus : 0 ); currentErrorPlus = ( includeErrors ? it.value().valueErrorPlus : 0 ); - if( ( current - currentErrorMinus < range.lower || !haveLower ) && current - currentErrorMinus > 0 ) + if( ( current - currentErrorMinus < range.lower || !haveLower ) && + current - currentErrorMinus > 0 ) { range.lower = current - currentErrorMinus; haveLower = true; } - if( ( current + currentErrorPlus > range.upper || !haveUpper ) && current + currentErrorPlus > 0 ) + if( ( current + currentErrorPlus > range.upper || !haveUpper ) && + current + currentErrorPlus > 0 ) { range.upper = current + currentErrorPlus; haveUpper = true; } - if( includeErrors ) // in case point is in valid sign domain but errobars stretch beyond it, we still want to + if( includeErrors ) // in case point is in valid sign domain but errobars + // stretch beyond it, we still want to // geht that point. { if( ( current < range.lower || !haveLower ) && current > 0 ) @@ -17433,7 +20012,8 @@ QCPRange QCPGraph::getValueRange( bool& foundRange, SignDomain inSignDomain, boo The container for storing multiple data points is \ref QCPCurveDataMap. The stored data is: - \li \a t: the free parameter of the curve at this curve point (cp. the mathematical vector (x(t), y(t))) + \li \a t: the free parameter of the curve at this curve point (cp. the + mathematical vector (x(t), y(t))) \li \a key: coordinate on the key axis of this curve point \li \a value: coordinate on the value axis of this curve point @@ -17450,7 +20030,8 @@ QCPCurveData::QCPCurveData() : t( 0 ), key( 0 ), value( 0 ) /*! Constructs a curve data point with the specified \a t, \a key and \a value. */ -QCPCurveData::QCPCurveData( double t, double key, double value ) : t( t ), key( key ), value( value ) +QCPCurveData::QCPCurveData( double t, double key, double value ) + : t( t ), key( key ), value( value ) { } @@ -17463,25 +20044,32 @@ QCPCurveData::QCPCurveData( double t, double key, double value ) : t( t ), key( \image html QCPCurve.png - Unlike QCPGraph, plottables of this type may have multiple points with the same key coordinate, - so their visual representation can have \a loops. This is realized by introducing a third - coordinate \a t, which defines the order of the points described by the other two coordinates \a + Unlike QCPGraph, plottables of this type may have multiple points with the + same key coordinate, + so their visual representation can have \a loops. This is realized by + introducing a third + coordinate \a t, which defines the order of the points described by the other + two coordinates \a x and \a y. To plot data, assign it with the \ref setData or \ref addData functions. \section appearance Changing the appearance - The appearance of the curve is determined by the pen and the brush (\ref setPen, \ref setBrush). + The appearance of the curve is determined by the pen and the brush (\ref + setPen, \ref setBrush). \section usage Usage - Like all data representing objects in QCustomPlot, the QCPCurve is a plottable (QCPAbstractPlottable). So - the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, QCustomPlot::addPlottable, + Like all data representing objects in QCustomPlot, the QCPCurve is a plottable + (QCPAbstractPlottable). So + the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, + QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.) Usually, you first create an instance: \code - QCPCurve *newCurve = new QCPCurve(customPlot->xAxis, customPlot->yAxis);\endcode + QCPCurve *newCurve = new QCPCurve(customPlot->xAxis, + customPlot->yAxis);\endcode add it to the customPlot with QCustomPlot::addPlottable: \code customPlot->addPlottable(newCurve);\endcode @@ -17492,15 +20080,20 @@ QCPCurveData::QCPCurveData( double t, double key, double value ) : t( t ), key( */ /*! - Constructs a curve which uses \a keyAxis as its key axis ("x") and \a valueAxis as its value - axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance and not have - the same orientation. If either of these restrictions is violated, a corresponding message is + Constructs a curve which uses \a keyAxis as its key axis ("x") and \a + valueAxis as its value + axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot + instance and not have + the same orientation. If either of these restrictions is violated, a + corresponding message is printed to the debug output (qDebug), the construction is not aborted, though. - The constructed QCPCurve can be added to the plot with QCustomPlot::addPlottable, QCustomPlot + The constructed QCPCurve can be added to the plot with + QCustomPlot::addPlottable, QCustomPlot then takes ownership of the graph. */ -QCPCurve::QCPCurve( QCPAxis* keyAxis, QCPAxis* valueAxis ) : QCPAbstractPlottable( keyAxis, valueAxis ) +QCPCurve::QCPCurve( QCPAxis* keyAxis, QCPAxis* valueAxis ) + : QCPAbstractPlottable( keyAxis, valueAxis ) { mData = new QCPCurveDataMap; mPen.setColor( Qt::blue ); @@ -17524,8 +20117,10 @@ QCPCurve::~QCPCurve() /*! Replaces the current data with the provided \a data. - If \a copy is set to true, data points in \a data will only be copied. if false, the plottable - takes ownership of the passed data and replaces the internal data pointer with it. This is + If \a copy is set to true, data points in \a data will only be copied. if + false, the plottable + takes ownership of the passed data and replaces the internal data pointer with + it. This is significantly faster than copying for large datasets. */ void QCPCurve::setData( QCPCurveDataMap* data, bool copy ) @@ -17543,11 +20138,15 @@ void QCPCurve::setData( QCPCurveDataMap* data, bool copy ) /*! \overload - Replaces the current data with the provided points in \a t, \a key and \a value tuples. The - provided vectors should have equal length. Else, the number of added points will be the size of + Replaces the current data with the provided points in \a t, \a key and \a + value tuples. The + provided vectors should have equal length. Else, the number of added points + will be the size of the smallest vector. */ -void QCPCurve::setData( const QVector& t, const QVector& key, const QVector& value ) +void QCPCurve::setData( const QVector& t, + const QVector& key, + const QVector& value ) { mData->clear(); int n = t.size(); @@ -17565,8 +20164,10 @@ void QCPCurve::setData( const QVector& t, const QVector& key, co /*! \overload - Replaces the current data with the provided \a key and \a value pairs. The t parameter - of each data point will be set to the integer index of the respective key/value pair. + Replaces the current data with the provided \a key and \a value pairs. The t + parameter + of each data point will be set to the integer index of the respective + key/value pair. */ void QCPCurve::setData( const QVector& key, const QVector& value ) { @@ -17585,7 +20186,8 @@ void QCPCurve::setData( const QVector& key, const QVector& value /*! Sets the visual appearance of single data points in the plot. If set to \ref - QCPScatterStyle::ssNone, no scatter points are drawn (e.g. for line-only plots with appropriate + QCPScatterStyle::ssNone, no scatter points are drawn (e.g. for line-only plots + with appropriate line style). \see QCPScatterStyle, setLineStyle @@ -17596,8 +20198,10 @@ void QCPCurve::setScatterStyle( const QCPScatterStyle& style ) } /*! - Sets how the single data points are connected in the plot or how they are represented visually - apart from the scatter symbol. For scatter-only plots, set \a style to \ref lsNone and \ref + Sets how the single data points are connected in the plot or how they are + represented visually + apart from the scatter symbol. For scatter-only plots, set \a style to \ref + lsNone and \ref setScatterStyle to the desired scatter style. \see setScatterStyle @@ -17626,7 +20230,8 @@ void QCPCurve::addData( const QCPCurveData& data ) } /*! \overload - Adds the provided single data point as \a t, \a key and \a value tuple to the current data + Adds the provided single data point as \a t, \a key and \a value tuple to the + current data \see removeData */ void QCPCurve::addData( double t, double key, double value ) @@ -17640,8 +20245,10 @@ void QCPCurve::addData( double t, double key, double value ) /*! \overload - Adds the provided single data point as \a key and \a value pair to the current data The t - parameter of the data point is set to the t of the last data point plus 1. If there is no last + Adds the provided single data point as \a key and \a value pair to the current + data The t + parameter of the data point is set to the t of the last data point plus 1. If + there is no last data point, t will be set to 0. \see removeData @@ -17659,10 +20266,13 @@ void QCPCurve::addData( double key, double value ) } /*! \overload - Adds the provided data points as \a t, \a key and \a value tuples to the current data. + Adds the provided data points as \a t, \a key and \a value tuples to the + current data. \see removeData */ -void QCPCurve::addData( const QVector& ts, const QVector& keys, const QVector& values ) +void QCPCurve::addData( const QVector& ts, + const QVector& keys, + const QVector& values ) { int n = ts.size(); n = qMin( n, keys.size() ); @@ -17702,8 +20312,10 @@ void QCPCurve::removeDataAfter( double t ) } /*! - Removes all data points with curve parameter t between \a fromt and \a tot. if \a fromt is - greater or equal to \a tot, the function does nothing. To remove a single data point with known + Removes all data points with curve parameter t between \a fromt and \a tot. if + \a fromt is + greater or equal to \a tot, the function does nothing. To remove a single data + point with known t, use \ref removeData(double t). \see addData, clearData @@ -17720,9 +20332,12 @@ void QCPCurve::removeData( double fromt, double tot ) /*! \overload - Removes a single data point at curve parameter \a t. If the position is not known with absolute - precision, consider using \ref removeData(double fromt, double tot) with a small fuzziness - interval around the suspected position, depeding on the precision with which the curve parameter + Removes a single data point at curve parameter \a t. If the position is not + known with absolute + precision, consider using \ref removeData(double fromt, double tot) with a + small fuzziness + interval around the suspected position, depeding on the precision with which + the curve parameter is known. \see addData, clearData @@ -17776,7 +20391,8 @@ void QCPCurve::draw( QCPPainter* painter ) QCPCurveDataMap::const_iterator it; for( it = mData->constBegin(); it != mData->constEnd(); ++it ) { - if( QCP::isInvalidData( it.value().t ) || QCP::isInvalidData( it.value().key, it.value().value ) ) + if( QCP::isInvalidData( it.value().t ) || + QCP::isInvalidData( it.value().key, it.value().value ) ) qDebug() << Q_FUNC_INFO << "Data point at" << it.key() << "invalid." << "Plottable name:" << name(); } @@ -17797,8 +20413,10 @@ void QCPCurve::draw( QCPPainter* painter ) applyDefaultAntialiasingHint( painter ); painter->setPen( mainPen() ); painter->setBrush( Qt::NoBrush ); - // if drawing solid line and not in PDF, use much faster line drawing instead of polyline: - if( mParentPlot->plottingHints().testFlag( QCP::phFastPolylines ) && painter->pen().style() == Qt::SolidLine && + // if drawing solid line and not in PDF, use much faster line drawing + // instead of polyline: + if( mParentPlot->plottingHints().testFlag( QCP::phFastPolylines ) && + painter->pen().style() == Qt::SolidLine && !painter->modes().testFlag( QCPPainter::pmVectorized ) && !painter->modes().testFlag( QCPPainter::pmNoCaching ) ) { @@ -17826,17 +20444,19 @@ void QCPCurve::drawLegendIcon( QCPPainter* painter, const QRectF& rect ) const if( mBrush.style() != Qt::NoBrush ) { applyFillAntialiasingHint( painter ); - painter->fillRect( QRectF( rect.left(), rect.top() + rect.height() / 2.0, rect.width(), rect.height() / 3.0 ), - mBrush ); + painter->fillRect( + QRectF( rect.left(), rect.top() + rect.height() / 2.0, rect.width(), rect.height() / 3.0 ), + mBrush ); } // draw line vertically centered: if( mLineStyle != lsNone ) { applyDefaultAntialiasingHint( painter ); painter->setPen( mPen ); - painter->drawLine( - QLineF( rect.left(), rect.top() + rect.height() / 2.0, rect.right() + 5, - rect.top() + rect.height() / 2.0 ) ); // +5 on x2 else last segment is missing from dashed/dotted pens + painter->drawLine( QLineF( rect.left(), rect.top() + rect.height() / 2.0, rect.right() + 5, + rect.top() + rect.height() / 2.0 ) ); // +5 on x2 else last segment + // is missing from + // dashed/dotted pens } // draw scatter symbol: if( !mScatterStyle.isNone() ) @@ -17848,8 +20468,8 @@ void QCPCurve::drawLegendIcon( QCPPainter* painter, const QRectF& rect ) const mScatterStyle.pixmap().size().height() > rect.height() ) ) { QCPScatterStyle scaledStyle( mScatterStyle ); - scaledStyle.setPixmap( - scaledStyle.pixmap().scaled( rect.size().toSize(), Qt::KeepAspectRatio, Qt::SmoothTransformation ) ); + scaledStyle.setPixmap( scaledStyle.pixmap().scaled( rect.size().toSize(), Qt::KeepAspectRatio, + Qt::SmoothTransformation ) ); scaledStyle.applyTo( painter, mPen ); scaledStyle.drawShape( painter, QRectF( rect ).center() ); } @@ -17863,8 +20483,10 @@ void QCPCurve::drawLegendIcon( QCPPainter* painter, const QRectF& rect ) const /*! \internal - Draws scatter symbols at every data point passed in \a pointData. scatter symbols are independent of - the line style and are always drawn if scatter shape is not \ref QCPScatterStyle::ssNone. + Draws scatter symbols at every data point passed in \a pointData. scatter + symbols are independent of + the line style and are always drawn if scatter shape is not \ref + QCPScatterStyle::ssNone. */ void QCPCurve::drawScatterPlot( QCPPainter* painter, const QVector* pointData ) const { @@ -17877,8 +20499,10 @@ void QCPCurve::drawScatterPlot( QCPPainter* painter, const QVector* poi /*! \internal - called by QCPCurve::draw to generate a point vector (pixels) which represents the line of the - curve. Line segments that aren't visible in the current axis rect are handled in an optimized + called by QCPCurve::draw to generate a point vector (pixels) which represents + the line of the + curve. Line segments that aren't visible in the current axis rect are handled + in an optimized way. */ void QCPCurve::getCurveData( QVector* lineData ) const @@ -17887,9 +20511,11 @@ void QCPCurve::getCurveData( QVector* lineData ) const 1__|_4_|__7 2__|_R_|__8 3 | 6 | 9 - General idea: If the two points of a line segment are in the same region (that is not R), the line segment corner + General idea: If the two points of a line segment are in the same region + (that is not R), the line segment corner is removed. - Curves outside R become straight lines closely outside of R which greatly reduces drawing time, yet keeps the look + Curves outside R become straight lines closely outside of R which greatly + reduces drawing time, yet keeps the look of lines and fills inside R consistent. The region R has index 5. @@ -17913,7 +20539,8 @@ void QCPCurve::getCurveData( QVector* lineData ) const double RTop = valueAxis->range().upper; double x, y; // current key/value bool addedLastAlready = true; - bool firstPoint = true; // first point must always be drawn, to make sure fill works correctly + bool firstPoint = true; // first point must always be drawn, to make sure fill + // works correctly for( it = mData->constBegin(); it != mData->constEnd(); ++it ) { x = it.value().key; @@ -17948,37 +20575,51 @@ void QCPCurve::getCurveData( QVector* lineData ) const } /* - Watch out, the next part is very tricky. It modifies the curve such that it seems like the - whole thing is still drawn, but actually the points outside the axisRect are simplified - ("optimized") greatly. There are some subtle special cases when line segments are large and - thereby each subsequent point may be in a different region or even skip some. + Watch out, the next part is very tricky. It modifies the curve such that + it seems like the + whole thing is still drawn, but actually the points outside the axisRect + are simplified + ("optimized") greatly. There are some subtle special cases when line + segments are large and + thereby each subsequent point may be in a different region or even skip + some. */ // determine whether to keep current point: if( currentRegion == 5 || - ( firstPoint && - mBrush.style() != Qt::NoBrush ) ) // current is in R, add current and last if it wasn't added already + ( firstPoint && mBrush.style() != Qt::NoBrush ) ) // current is in R, add + // current and last if it + // wasn't added already { - if( !addedLastAlready ) // in case curve just entered R, make sure the last point outside R is also drawn + if( !addedLastAlready ) // in case curve just entered R, make sure the last + // point outside R is also drawn // correctly - lineData->append( - coordsToPixels( ( it - 1 ).value().key, ( it - 1 ).value().value ) ); // add last point to vector - else if( lastRegion != 5 ) // added last already. If that's the case, we probably added it at optimized position. - // So go back and make sure it's at original position (else the angle changes under - // which this segment enters R) + lineData->append( coordsToPixels( ( it - 1 ).value().key, + ( it - 1 ).value().value ) ); // add last point to vector + else if( lastRegion != 5 ) // added last already. If that's the case, we + // probably added it at optimized position. + // So go back and make sure it's at original position (else the angle + // changes under + // which this segment enters R) { - if( !firstPoint ) // because on firstPoint, currentRegion is 5 and addedLastAlready is true, although there is + if( !firstPoint ) // because on firstPoint, currentRegion is 5 and + // addedLastAlready is true, although there is // no last point - lineData->replace( lineData->size() - 1, coordsToPixels( ( it - 1 ).value().key, ( it - 1 ).value().value ) ); + lineData->replace( lineData->size() - 1, + coordsToPixels( ( it - 1 ).value().key, ( it - 1 ).value().value ) ); } - lineData->append( coordsToPixels( it.value().key, it.value().value ) ); // add current point to vector + lineData->append( + coordsToPixels( it.value().key, it.value().value ) ); // add current point to vector addedLastAlready = true; // so in next iteration, we don't add this point twice } - else if( currentRegion != lastRegion ) // changed region, add current and last if not added already + else if( currentRegion != lastRegion ) // changed region, add current and + // last if not added already { - // using outsideCoordsToPixels instead of coorsToPixels for optimized point placement (places points just outside + // using outsideCoordsToPixels instead of coorsToPixels for optimized + // point placement (places points just outside // axisRect instead of potentially far away) - // if we're coming from R or we skip diagonally over the corner regions (so line might still be visible in R), we + // if we're coming from R or we skip diagonally over the corner regions + // (so line might still be visible in R), we // can't place points optimized if( lastRegion == 5 || // coming from R ( ( lastRegion == 2 && currentRegion == 4 ) || @@ -17997,17 +20638,20 @@ void QCPCurve::getCurveData( QVector* lineData ) const // add current point, original: lineData->append( coordsToPixels( it.value().key, it.value().value ) ); } - else // no special case that forbids optimized point placement, so do it: + else // no special case that forbids optimized point placement, so do + // it: { // always add last point if not added already, optimized: if( !addedLastAlready ) - lineData->append( - outsideCoordsToPixels( ( it - 1 ).value().key, ( it - 1 ).value().value, currentRegion, axisRect ) ); + lineData->append( outsideCoordsToPixels( ( it - 1 ).value().key, ( it - 1 ).value().value, + currentRegion, axisRect ) ); // add current point, optimized: - lineData->append( outsideCoordsToPixels( it.value().key, it.value().value, currentRegion, axisRect ) ); + lineData->append( + outsideCoordsToPixels( it.value().key, it.value().value, currentRegion, axisRect ) ); } - addedLastAlready = - true; // so that if next point enters 5, or crosses another region boundary, we don't add this point twice + addedLastAlready = true; // so that if next point enters 5, or crosses + // another region boundary, we don't add this + // point twice } else // neither in R, nor crossed a region boundary, skip current point { @@ -18016,17 +20660,20 @@ void QCPCurve::getCurveData( QVector* lineData ) const lastRegion = currentRegion; firstPoint = false; } - // If curve ends outside R, we want to add very last point so the fill looks like it should when the curve started + // If curve ends outside R, we want to add very last point so the fill looks + // like it should when the curve started // inside R: if( lastRegion != 5 && mBrush.style() != Qt::NoBrush && !mData->isEmpty() ) - lineData->append( - coordsToPixels( ( mData->constEnd() - 1 ).value().key, ( mData->constEnd() - 1 ).value().value ) ); + lineData->append( coordsToPixels( ( mData->constEnd() - 1 ).value().key, + ( mData->constEnd() - 1 ).value().value ) ); } /*! \internal - Calculates the (minimum) distance (in pixels) the curve's representation has from the given \a - pixelPoint in pixels. This is used to determine whether the curve was clicked or not, e.g. in + Calculates the (minimum) distance (in pixels) the curve's representation has + from the given \a + pixelPoint in pixels. This is used to determine whether the curve was clicked + or not, e.g. in \ref selectTest. */ double QCPCurve::pointDistance( const QPointF& pixelPoint ) const @@ -18038,7 +20685,8 @@ double QCPCurve::pointDistance( const QPointF& pixelPoint ) const } if( mData->size() == 1 ) { - QPointF dataPoint = coordsToPixels( mData->constBegin().key(), mData->constBegin().value().value ); + QPointF dataPoint = + coordsToPixels( mData->constBegin().key(), mData->constBegin().value().value ); return QVector2D( dataPoint - pixelPoint ).length(); } @@ -18058,16 +20706,26 @@ double QCPCurve::pointDistance( const QPointF& pixelPoint ) const /*! \internal - This is a specialized \ref coordsToPixels function for points that are outside the visible - axisRect and just crossing a boundary (since \ref getCurveData reduces non-visible curve segments - to those line segments that cross region boundaries, see documentation there). It only uses the - coordinate parallel to the region boundary of the axisRect. The other coordinate is picked just - outside the axisRect (how far is determined by the scatter size and the line width). Together - with the optimization in \ref getCurveData this improves performance for large curves (or zoomed - in ones) significantly while keeping the illusion the whole curve and its filling is still being + This is a specialized \ref coordsToPixels function for points that are outside + the visible + axisRect and just crossing a boundary (since \ref getCurveData reduces + non-visible curve segments + to those line segments that cross region boundaries, see documentation there). + It only uses the + coordinate parallel to the region boundary of the axisRect. The other + coordinate is picked just + outside the axisRect (how far is determined by the scatter size and the line + width). Together + with the optimization in \ref getCurveData this improves performance for large + curves (or zoomed + in ones) significantly while keeping the illusion the whole curve and its + filling is still being drawn for the viewer. */ -QPointF QCPCurve::outsideCoordsToPixels( double key, double value, int region, QRect axisRect ) const +QPointF QCPCurve::outsideCoordsToPixels( double key, + double value, + int region, + QRect axisRect ) const { int margin = qCeil( qMax( mScatterStyle.size(), (double)mPen.widthF() ) ) + 2; QPointF result = coordsToPixels( key, value ); @@ -18216,17 +20874,21 @@ QCPBarData::QCPBarData( double key, double value ) : key( key ), value( value ) \section appearance Changing the appearance - The appearance of the bars is determined by the pen and the brush (\ref setPen, \ref setBrush). + The appearance of the bars is determined by the pen and the brush (\ref + setPen, \ref setBrush). - Bar charts are stackable. This means, Two QCPBars plottables can be placed on top of each other - (see \ref QCPBars::moveAbove). Then, when two bars are at the same key position, they will appear + Bar charts are stackable. This means, Two QCPBars plottables can be placed on + top of each other + (see \ref QCPBars::moveAbove). Then, when two bars are at the same key + position, they will appear stacked. \section usage Usage Like all data representing objects in QCustomPlot, the QCPBars is a plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies - (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.) + (QCustomPlot::plottable, QCustomPlot::addPlottable, + QCustomPlot::removePlottable, etc.) Usually, you first create an instance: \code @@ -18255,15 +20917,20 @@ QCPBarData::QCPBarData( double key, double value ) : key( key ), value( value ) */ /*! - Constructs a bar chart which uses \a keyAxis as its key axis ("x") and \a valueAxis as its value - axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance and not have - the same orientation. If either of these restrictions is violated, a corresponding message is + Constructs a bar chart which uses \a keyAxis as its key axis ("x") and \a + valueAxis as its value + axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot + instance and not have + the same orientation. If either of these restrictions is violated, a + corresponding message is printed to the debug output (qDebug), the construction is not aborted, though. - The constructed QCPBars can be added to the plot with QCustomPlot::addPlottable, QCustomPlot + The constructed QCPBars can be added to the plot with + QCustomPlot::addPlottable, QCustomPlot then takes ownership of the bar chart. */ -QCPBars::QCPBars( QCPAxis* keyAxis, QCPAxis* valueAxis ) : QCPAbstractPlottable( keyAxis, valueAxis ) +QCPBars::QCPBars( QCPAxis* keyAxis, QCPAxis* valueAxis ) + : QCPAbstractPlottable( keyAxis, valueAxis ) { mData = new QCPBarDataMap; mPen.setColor( Qt::blue ); @@ -18296,8 +20963,10 @@ void QCPBars::setWidth( double width ) /*! Replaces the current data with the provided \a data. - If \a copy is set to true, data points in \a data will only be copied. if false, the plottable - takes ownership of the passed data and replaces the internal data pointer with it. This is + If \a copy is set to true, data points in \a data will only be copied. if + false, the plottable + takes ownership of the passed data and replaces the internal data pointer with + it. This is significantly faster than copying for large datasets. */ void QCPBars::setData( QCPBarDataMap* data, bool copy ) @@ -18315,8 +20984,10 @@ void QCPBars::setData( QCPBarDataMap* data, bool copy ) /*! \overload - Replaces the current data with the provided points in \a key and \a value tuples. The - provided vectors should have equal length. Else, the number of added points will be the size of + Replaces the current data with the provided points in \a key and \a value + tuples. The + provided vectors should have equal length. Else, the number of added points + will be the size of the smallest vector. */ void QCPBars::setData( const QVector& key, const QVector& value ) @@ -18334,13 +21005,18 @@ void QCPBars::setData( const QVector& key, const QVector& value } /*! - Moves this bars plottable below \a bars. In other words, the bars of this plottable will appear - below the bars of \a bars. The move target \a bars must use the same key and value axis as this + Moves this bars plottable below \a bars. In other words, the bars of this + plottable will appear + below the bars of \a bars. The move target \a bars must use the same key and + value axis as this plottable. - Inserting into and removing from existing bar stacking is handled gracefully. If \a bars already - has a bars object below itself, this bars object is inserted between the two. If this bars object - is already between two other bars, the two other bars will be stacked on top of each other after + Inserting into and removing from existing bar stacking is handled gracefully. + If \a bars already + has a bars object below itself, this bars object is inserted between the two. + If this bars object + is already between two other bars, the two other bars will be stacked on top + of each other after the operation. To remove this bars plottable from any stacking, set \a bars to 0. @@ -18353,11 +21029,13 @@ void QCPBars::moveBelow( QCPBars* bars ) return; if( bars && ( bars->keyAxis() != mKeyAxis.data() || bars->valueAxis() != mValueAxis.data() ) ) { - qDebug() << Q_FUNC_INFO << "passed QCPBars* doesn't have same key and value axis as this QCPBars"; + qDebug() << Q_FUNC_INFO << "passed QCPBars* doesn't have same key and " + "value axis as this QCPBars"; return; } // remove from stacking: - connectBars( mBarBelow.data(), mBarAbove.data() ); // Note: also works if one (or both) of them is 0 + connectBars( mBarBelow.data(), + mBarAbove.data() ); // Note: also works if one (or both) of them is 0 // if new bar given, insert this bar below it: if( bars ) { @@ -18368,13 +21046,18 @@ void QCPBars::moveBelow( QCPBars* bars ) } /*! - Moves this bars plottable above \a bars. In other words, the bars of this plottable will appear - above the bars of \a bars. The move target \a bars must use the same key and value axis as this + Moves this bars plottable above \a bars. In other words, the bars of this + plottable will appear + above the bars of \a bars. The move target \a bars must use the same key and + value axis as this plottable. - Inserting into and removing from existing bar stacking is handled gracefully. If \a bars already - has a bars object below itself, this bars object is inserted between the two. If this bars object - is already between two other bars, the two other bars will be stacked on top of each other after + Inserting into and removing from existing bar stacking is handled gracefully. + If \a bars already + has a bars object below itself, this bars object is inserted between the two. + If this bars object + is already between two other bars, the two other bars will be stacked on top + of each other after the operation. To remove this bars plottable from any stacking, set \a bars to 0. @@ -18387,11 +21070,13 @@ void QCPBars::moveAbove( QCPBars* bars ) return; if( bars && ( bars->keyAxis() != mKeyAxis.data() || bars->valueAxis() != mValueAxis.data() ) ) { - qDebug() << Q_FUNC_INFO << "passed QCPBars* doesn't have same key and value axis as this QCPBars"; + qDebug() << Q_FUNC_INFO << "passed QCPBars* doesn't have same key and " + "value axis as this QCPBars"; return; } // remove from stacking: - connectBars( mBarBelow.data(), mBarAbove.data() ); // Note: also works if one (or both) of them is 0 + connectBars( mBarBelow.data(), + mBarAbove.data() ); // Note: also works if one (or both) of them is 0 // if new bar given, insert this bar above it: if( bars ) { @@ -18420,7 +21105,8 @@ void QCPBars::addData( const QCPBarData& data ) } /*! \overload - Adds the provided single data point as \a key and \a value tuple to the current data + Adds the provided single data point as \a key and \a value tuple to the + current data \see removeData */ void QCPBars::addData( double key, double value ) @@ -18432,7 +21118,8 @@ void QCPBars::addData( double key, double value ) } /*! \overload - Adds the provided data points as \a key and \a value tuples to the current data. + Adds the provided data points as \a key and \a value tuples to the current + data. \see removeData */ void QCPBars::addData( const QVector& keys, const QVector& values ) @@ -18473,8 +21160,10 @@ void QCPBars::removeDataAfter( double key ) } /*! - Removes all data points with key between \a fromKey and \a toKey. if \a fromKey is - greater or equal to \a toKey, the function does nothing. To remove a single data point with known + Removes all data points with key between \a fromKey and \a toKey. if \a + fromKey is + greater or equal to \a toKey, the function does nothing. To remove a single + data point with known key, use \ref removeData(double key). \see addData, clearData @@ -18491,9 +21180,12 @@ void QCPBars::removeData( double fromKey, double toKey ) /*! \overload - Removes a single data point at \a key. If the position is not known with absolute precision, - consider using \ref removeData(double fromKey, double toKey) with a small fuzziness interval - around the suspected position, depeding on the precision with which the key is known. + Removes a single data point at \a key. If the position is not known with + absolute precision, + consider using \ref removeData(double fromKey, double toKey) with a small + fuzziness interval + around the suspected position, depeding on the precision with which the key is + known. \see addData, clearData */ @@ -18598,7 +21290,8 @@ void QCPBars::drawLegendIcon( QCPPainter* painter, const QRectF& rect ) const /*! \internal - Returns the polygon of a single bar with \a key and \a value. The Polygon is open at the bottom + Returns the polygon of a single bar with \a key and \a value. The Polygon is + open at the bottom and shifted according to the bar stacking (see \ref moveAbove). */ QPolygonF QCPBars::getBarPolygon( double key, double value ) const @@ -18614,11 +21307,14 @@ QPolygonF QCPBars::getBarPolygon( double key, double value ) const /*! \internal - This function is called to find at which value to start drawing the base of a bar at \a key, when + This function is called to find at which value to start drawing the base of a + bar at \a key, when it is stacked on top of another QCPBars (e.g. with \ref moveAbove). - positive and negative bars are separated per stack (positive are stacked above 0-value upwards, - negative are stacked below 0-value downwards). This can be indicated with \a positive. So if the + positive and negative bars are separated per stack (positive are stacked above + 0-value upwards, + negative are stacked below 0-value downwards). This can be indicated with \a + positive. So if the bar for which we need the base value is negative, set \a positive to false. */ double QCPBars::getBaseValue( double key, bool positive ) const @@ -18626,7 +21322,8 @@ double QCPBars::getBaseValue( double key, bool positive ) const if( mBarBelow ) { double max = 0; - // find bars of mBarBelow that are approximately at key and find largest one: + // find bars of mBarBelow that are approximately at key and find largest + // one: QCPBarDataMap::const_iterator it = mBarBelow.data()->mData->lowerBound( key - mWidth * 0.1 ); QCPBarDataMap::const_iterator itEnd = mBarBelow.data()->mData->upperBound( key + mWidth * 0.1 ); while( it != itEnd ) @@ -18644,8 +21341,10 @@ double QCPBars::getBaseValue( double key, bool positive ) const /*! \internal - Connects \a below and \a above to each other via their mBarAbove/mBarBelow properties. - The bar(s) currently below lower and upper will become disconnected to lower/upper. + Connects \a below and \a above to each other via their mBarAbove/mBarBelow + properties. + The bar(s) currently below lower and upper will become disconnected to + lower/upper. If lower is zero, upper will be disconnected at the bottom. If upper is zero, lower will be disconnected at the top. @@ -18759,7 +21458,8 @@ QCPRange QCPBars::getValueRange( bool& foundRange, SignDomain inSignDomain ) con \image html QCPStatisticalBox.png - To plot data, assign it with the individual parameter functions or use \ref setData to set all + To plot data, assign it with the individual parameter functions or use \ref + setData to set all parameters at once. The individual functions are: \li \ref setMinimum \li \ref setLowerQuartile @@ -18772,31 +21472,40 @@ QCPRange QCPBars::getValueRange( bool& foundRange, SignDomain inSignDomain ) con \section appearance Changing the appearance - The appearance of the box itself is controlled via \ref setPen and \ref setBrush. You may change + The appearance of the box itself is controlled via \ref setPen and \ref + setBrush. You may change the width of the box with \ref setWidth in plot coordinates (not pixels). - Analog functions exist for the minimum/maximum-whiskers: \ref setWhiskerPen, \ref - setWhiskerBarPen, \ref setWhiskerWidth. The whisker width is the width of the bar at the top + Analog functions exist for the minimum/maximum-whiskers: \ref setWhiskerPen, + \ref + setWhiskerBarPen, \ref setWhiskerWidth. The whisker width is the width of the + bar at the top (maximum) and bottom (minimum). The median indicator line has its own pen, \ref setMedianPen. - If the whisker backbone pen is changed, make sure to set the capStyle to Qt::FlatCap. Else, the - backbone line might exceed the whisker bars by a few pixels due to the pen cap being not + If the whisker backbone pen is changed, make sure to set the capStyle to + Qt::FlatCap. Else, the + backbone line might exceed the whisker bars by a few pixels due to the pen cap + being not perfectly flat. - The Outlier data points are drawn as normal scatter points. Their look can be controlled with + The Outlier data points are drawn as normal scatter points. Their look can be + controlled with \ref setOutlierStyle \section usage Usage - Like all data representing objects in QCustomPlot, the QCPStatisticalBox is a plottable + Like all data representing objects in QCustomPlot, the QCPStatisticalBox is a + plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies - (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.) + (QCustomPlot::plottable, QCustomPlot::addPlottable, + QCustomPlot::removePlottable, etc.) Usually, you first create an instance: \code - QCPStatisticalBox *newBox = new QCPStatisticalBox(customPlot->xAxis, customPlot->yAxis);\endcode + QCPStatisticalBox *newBox = new QCPStatisticalBox(customPlot->xAxis, + customPlot->yAxis);\endcode add it to the customPlot with QCustomPlot::addPlottable: \code customPlot->addPlottable(newBox);\endcode @@ -18808,22 +21517,27 @@ QCPRange QCPBars::getValueRange( bool& foundRange, SignDomain inSignDomain ) con */ /*! - Constructs a statistical box which uses \a keyAxis as its key axis ("x") and \a valueAxis as its - value axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance and - not have the same orientation. If either of these restrictions is violated, a corresponding - message is printed to the debug output (qDebug), the construction is not aborted, though. + Constructs a statistical box which uses \a keyAxis as its key axis ("x") and + \a valueAxis as its + value axis ("y"). \a keyAxis and \a valueAxis must reside in the same + QCustomPlot instance and + not have the same orientation. If either of these restrictions is violated, a + corresponding + message is printed to the debug output (qDebug), the construction is not + aborted, though. - The constructed statistical box can be added to the plot with QCustomPlot::addPlottable, + The constructed statistical box can be added to the plot with + QCustomPlot::addPlottable, QCustomPlot then takes ownership of the statistical box. */ QCPStatisticalBox::QCPStatisticalBox( QCPAxis* keyAxis, QCPAxis* valueAxis ) - : QCPAbstractPlottable( keyAxis, valueAxis ), - mKey( 0 ), - mMinimum( 0 ), - mLowerQuartile( 0 ), - mMedian( 0 ), - mUpperQuartile( 0 ), - mMaximum( 0 ) + : QCPAbstractPlottable( keyAxis, valueAxis ) + , mKey( 0 ) + , mMinimum( 0 ) + , mLowerQuartile( 0 ) + , mMedian( 0 ) + , mUpperQuartile( 0 ) + , mMaximum( 0 ) { setOutlierStyle( QCPScatterStyle( QCPScatterStyle::ssCircle, Qt::blue, 6 ) ); setWhiskerWidth( 0.2 ); @@ -18847,8 +21561,10 @@ void QCPStatisticalBox::setKey( double key ) } /*! - Sets the parameter "minimum" of the statistical box plot. This is the position of the lower - whisker, typically the minimum measurement of the sample that's not considered an outlier. + Sets the parameter "minimum" of the statistical box plot. This is the position + of the lower + whisker, typically the minimum measurement of the sample that's not considered + an outlier. \see setMaximum, setWhiskerPen, setWhiskerBarPen, setWhiskerWidth */ @@ -18858,8 +21574,10 @@ void QCPStatisticalBox::setMinimum( double value ) } /*! - Sets the parameter "lower Quartile" of the statistical box plot. This is the lower end of the - box. The lower and the upper quartiles are the two statistical quartiles around the median of the + Sets the parameter "lower Quartile" of the statistical box plot. This is the + lower end of the + box. The lower and the upper quartiles are the two statistical quartiles + around the median of the sample, they contain 50% of the sample data. \see setUpperQuartile, setPen, setBrush, setWidth @@ -18870,8 +21588,10 @@ void QCPStatisticalBox::setLowerQuartile( double value ) } /*! - Sets the parameter "median" of the statistical box plot. This is the value of the median mark - inside the quartile box. The median separates the sample data in half (50% of the sample data is + Sets the parameter "median" of the statistical box plot. This is the value of + the median mark + inside the quartile box. The median separates the sample data in half (50% of + the sample data is below/above the median). \see setMedianPen @@ -18882,8 +21602,10 @@ void QCPStatisticalBox::setMedian( double value ) } /*! - Sets the parameter "upper Quartile" of the statistical box plot. This is the upper end of the - box. The lower and the upper quartiles are the two statistical quartiles around the median of the + Sets the parameter "upper Quartile" of the statistical box plot. This is the + upper end of the + box. The lower and the upper quartiles are the two statistical quartiles + around the median of the sample, they contain 50% of the sample data. \see setLowerQuartile, setPen, setBrush, setWidth @@ -18894,8 +21616,10 @@ void QCPStatisticalBox::setUpperQuartile( double value ) } /*! - Sets the parameter "maximum" of the statistical box plot. This is the position of the upper - whisker, typically the maximum measurement of the sample that's not considered an outlier. + Sets the parameter "maximum" of the statistical box plot. This is the position + of the upper + whisker, typically the maximum measurement of the sample that's not considered + an outlier. \see setMinimum, setWhiskerPen, setWhiskerBarPen, setWhiskerWidth */ @@ -18905,8 +21629,10 @@ void QCPStatisticalBox::setMaximum( double value ) } /*! - Sets a vector of outlier values that will be drawn as scatters. Any data points in the sample - that are not within the whiskers (\ref setMinimum, \ref setMaximum) should be considered outliers + Sets a vector of outlier values that will be drawn as scatters. Any data + points in the sample + that are not within the whiskers (\ref setMinimum, \ref setMaximum) should be + considered outliers and displayed as such. \see setOutlierStyle @@ -18919,7 +21645,8 @@ void QCPStatisticalBox::setOutliers( const QVector& values ) /*! Sets all parameters of the statistical box plot at once. - \see setKey, setMinimum, setLowerQuartile, setMedian, setUpperQuartile, setMaximum + \see setKey, setMinimum, setLowerQuartile, setMedian, setUpperQuartile, + setMaximum */ void QCPStatisticalBox::setData( double key, double minimum, @@ -18947,7 +21674,8 @@ void QCPStatisticalBox::setWidth( double width ) } /*! - Sets the width of the whiskers (\ref setMinimum, \ref setMaximum) in key coordinates. + Sets the width of the whiskers (\ref setMinimum, \ref setMaximum) in key + coordinates. \see setWidth */ @@ -18957,9 +21685,11 @@ void QCPStatisticalBox::setWhiskerWidth( double width ) } /*! - Sets the pen used for drawing the whisker backbone (That's the line parallel to the value axis). + Sets the pen used for drawing the whisker backbone (That's the line parallel + to the value axis). - Make sure to set the \a pen capStyle to Qt::FlatCap to prevent the whisker backbone from reaching + Make sure to set the \a pen capStyle to Qt::FlatCap to prevent the whisker + backbone from reaching a few pixels past the whisker bars, when using a non-zero pen width. \see setWhiskerBarPen @@ -18970,7 +21700,8 @@ void QCPStatisticalBox::setWhiskerPen( const QPen& pen ) } /*! - Sets the pen used for drawing the whisker bars (Those are the lines parallel to the key axis at + Sets the pen used for drawing the whisker bars (Those are the lines parallel + to the key axis at each end of the whisker backbone). \see setWhiskerPen @@ -18981,7 +21712,8 @@ void QCPStatisticalBox::setWhiskerBarPen( const QPen& pen ) } /*! - Sets the pen used for drawing the median indicator line inside the statistical box. + Sets the pen used for drawing the median indicator line inside the statistical + box. */ void QCPStatisticalBox::setMedianPen( const QPen& pen ) { @@ -19011,7 +21743,9 @@ void QCPStatisticalBox::clearData() } /* inherits documentation from base class */ -double QCPStatisticalBox::selectTest( const QPointF& pos, bool onlySelectable, QVariant* details ) const +double QCPStatisticalBox::selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details ) const { Q_UNUSED( details ) if( onlySelectable && !mSelectable ) @@ -19034,7 +21768,8 @@ double QCPStatisticalBox::selectTest( const QPointF& pos, bool onlySelectable, Q // min/max whiskers: if( QCPRange( mMinimum, mMaximum ).contains( posValue ) ) - return qAbs( mKeyAxis.data()->coordToPixel( mKey ) - mKeyAxis.data()->coordToPixel( posKey ) ); + return qAbs( mKeyAxis.data()->coordToPixel( mKey ) - + mKeyAxis.data()->coordToPixel( posKey ) ); } return -1; } @@ -19086,8 +21821,10 @@ void QCPStatisticalBox::drawLegendIcon( QCPPainter* painter, const QRectF& rect /*! \internal - Draws the quartile box. \a box is an output parameter that returns the quartile box (in pixel - coordinates) which is used to set the clip rect of the painter before calling \ref drawMedian (so + Draws the quartile box. \a box is an output parameter that returns the + quartile box (in pixel + coordinates) which is used to set the clip rect of the painter before calling + \ref drawMedian (so the median doesn't draw outside the quartile box). */ void QCPStatisticalBox::drawQuartileBox( QCPPainter* painter, QRectF* quartileBox ) const @@ -19190,7 +21927,8 @@ QCPRange QCPStatisticalBox::getKeyRange( bool& foundRange, SignDomain inSignDoma /* inherits documentation from base class */ QCPRange QCPStatisticalBox::getValueRange( bool& foundRange, SignDomain inSignDomain ) const { - QVector values; // values that must be considered (i.e. all outliers and the five box-parameters) + QVector values; // values that must be considered (i.e. all outliers + // and the five box-parameters) values.reserve( mOutliers.size() + 5 ); values << mMaximum << mUpperQuartile << mMedian << mLowerQuartile << mMinimum; values << mOutliers; @@ -19201,8 +21939,8 @@ QCPRange QCPStatisticalBox::getValueRange( bool& foundRange, SignDomain inSignDo double lower = 0; for( int i = 0; i < values.size(); ++i ) { - if( ( inSignDomain == sdNegative && values.at( i ) < 0 ) || ( inSignDomain == sdPositive && values.at( i ) > 0 ) || - ( inSignDomain == sdBoth ) ) + if( ( inSignDomain == sdNegative && values.at( i ) < 0 ) || + ( inSignDomain == sdPositive && values.at( i ) > 0 ) || ( inSignDomain == sdBoth ) ) { if( values.at( i ) > upper || !haveUpper ) { @@ -19236,28 +21974,44 @@ QCPRange QCPStatisticalBox::getValueRange( bool& foundRange, SignDomain inSignDo /*! \class QCPColorMapData \brief Holds the two-dimensional data of a QCPColorMap plottable. - This class is a data storage for \ref QCPColorMap. It holds a two-dimensional array, which \ref - QCPColorMap then displays as a 2D image in the plot, where the array values are represented by a + This class is a data storage for \ref QCPColorMap. It holds a two-dimensional + array, which \ref + QCPColorMap then displays as a 2D image in the plot, where the array values + are represented by a color, depending on the value. - The size of the array can be controlled via \ref setSize (or \ref setKeySize, \ref setValueSize). - Which plot coordinates these cells correspond to can be configured with \ref setRange (or \ref + The size of the array can be controlled via \ref setSize (or \ref setKeySize, + \ref setValueSize). + Which plot coordinates these cells correspond to can be configured with \ref + setRange (or \ref setKeyRange, \ref setValueRange). - The data cells can be accessed in two ways: They can be directly addressed by an integer index - with \ref setCell. This is the fastest method. Alternatively, they can be addressed by their plot - coordinate with \ref setData. plot coordinate to cell index transformations and vice versa are + The data cells can be accessed in two ways: They can be directly addressed by + an integer index + with \ref setCell. This is the fastest method. Alternatively, they can be + addressed by their plot + coordinate with \ref setData. plot coordinate to cell index transformations + and vice versa are provided by the functions \ref coordToCell and \ref cellToCoord. - This class also buffers the minimum and maximum values that are in the data set, to provide - QCPColorMap::rescaleDataRange with the necessary information quickly. Setting a cell to a value - that is greater than the current maximum increases this maximum to the new value. However, - setting the cell that currently holds the maximum value to a smaller value doesn't decrease the - maximum again, because finding the true new maximum would require going through the entire data - array, which might be time consuming. The same holds for the data minimum. This functionality is - given by \ref recalculateDataBounds, such that you can decide when it is sensible to find the - true current minimum and maximum. The method QCPColorMap::rescaleDataRange offers a convenience - parameter \a recalculateDataBounds which may be set to true to automatically call \ref + This class also buffers the minimum and maximum values that are in the data + set, to provide + QCPColorMap::rescaleDataRange with the necessary information quickly. Setting + a cell to a value + that is greater than the current maximum increases this maximum to the new + value. However, + setting the cell that currently holds the maximum value to a smaller value + doesn't decrease the + maximum again, because finding the true new maximum would require going + through the entire data + array, which might be time consuming. The same holds for the data minimum. + This functionality is + given by \ref recalculateDataBounds, such that you can decide when it is + sensible to find the + true current minimum and maximum. The method QCPColorMap::rescaleDataRange + offers a convenience + parameter \a recalculateDataBounds which may be set to true to automatically + call \ref recalculateDataBounds internally. */ @@ -19265,27 +22019,33 @@ QCPRange QCPStatisticalBox::getValueRange( bool& foundRange, SignDomain inSignDo /*! \fn bool QCPColorMapData::isEmpty() const - Returns whether this instance carries no data. This is equivalent to having a size where at least + Returns whether this instance carries no data. This is equivalent to having a + size where at least one of the dimensions is 0 (see \ref setSize). */ /* end of documentation of inline functions */ /*! - Constructs a new QCPColorMapData instance. The instance has \a keySize cells in the key direction - and \a valueSize cells in the value direction. These cells will be displayed by the \ref QCPColorMap + Constructs a new QCPColorMapData instance. The instance has \a keySize cells + in the key direction + and \a valueSize cells in the value direction. These cells will be displayed + by the \ref QCPColorMap at the coordinates \a keyRange and \a valueRange. \see setSize, setKeySize, setValueSize, setRange, setKeyRange, setValueRange */ -QCPColorMapData::QCPColorMapData( int keySize, int valueSize, const QCPRange& keyRange, const QCPRange& valueRange ) - : mKeySize( 0 ), - mValueSize( 0 ), - mKeyRange( keyRange ), - mValueRange( valueRange ), - mIsEmpty( true ), - mData( 0 ), - mDataModified( true ) +QCPColorMapData::QCPColorMapData( int keySize, + int valueSize, + const QCPRange& keyRange, + const QCPRange& valueRange ) + : mKeySize( 0 ) + , mValueSize( 0 ) + , mKeyRange( keyRange ) + , mValueRange( valueRange ) + , mIsEmpty( true ) + , mData( 0 ) + , mDataModified( true ) { setSize( keySize, valueSize ); fill( 0 ); @@ -19298,7 +22058,8 @@ QCPColorMapData::~QCPColorMapData() } /*! - Constructs a new QCPColorMapData instance copying the data and range of \a other. + Constructs a new QCPColorMapData instance copying the data and range of \a + other. */ QCPColorMapData::QCPColorMapData( const QCPColorMapData& other ) : mKeySize( 0 ), mValueSize( 0 ), mIsEmpty( true ), mData( 0 ), mDataModified( true ) @@ -19328,9 +22089,12 @@ QCPColorMapData& QCPColorMapData::operator=( const QCPColorMapData& other ) /* undocumented getter */ double QCPColorMapData::data( double key, double value ) { - int keyCell = ( key - mKeyRange.lower ) / ( mKeyRange.upper - mKeyRange.lower ) * ( mKeySize - 1 ) + 0.5; + int keyCell = + ( key - mKeyRange.lower ) / ( mKeyRange.upper - mKeyRange.lower ) * ( mKeySize - 1 ) + 0.5; int valueCell = - ( 1.0 - ( value - mValueRange.lower ) / ( mValueRange.upper - mValueRange.lower ) ) * ( mValueSize - 1 ) + 0.5; + ( 1.0 - ( value - mValueRange.lower ) / ( mValueRange.upper - mValueRange.lower ) ) * + ( mValueSize - 1 ) + + 0.5; if( keyCell >= 0 && keyCell < mKeySize && valueCell >= 0 && valueCell < mValueSize ) return mData[valueCell * mKeySize + keyCell]; else @@ -19347,13 +22111,16 @@ double QCPColorMapData::cell( int keyIndex, int valueIndex ) } /*! - Resizes the data array to have \a keySize cells in the key dimension and \a valueSize cells in + Resizes the data array to have \a keySize cells in the key dimension and \a + valueSize cells in the value dimension. - The current data is discarded and the map cells are set to 0, unless the map had already the + The current data is discarded and the map cells are set to 0, unless the map + had already the requested size. - Setting at least one of \a keySize or \a valueSize to zero frees the internal data array and \ref + Setting at least one of \a keySize or \a valueSize to zero frees the internal + data array and \ref isEmpty returns true. \see setRange, setKeySize, setValueSize @@ -19371,7 +22138,8 @@ void QCPColorMapData::setSize( int keySize, int valueSize ) { #ifdef __EXCEPTIONS try - { // 2D arrays get memory intensive fast. So if the allocation fails, at least output debug message + { // 2D arrays get memory intensive fast. So if the allocation fails, + // at least output debug message #endif mData = new double[mKeySize * mValueSize]; #ifdef __EXCEPTIONS @@ -19384,7 +22152,8 @@ void QCPColorMapData::setSize( int keySize, int valueSize ) if( mData ) fill( 0 ); else - qDebug() << Q_FUNC_INFO << "out of memory for data dimensions " << mKeySize << "*" << mValueSize; + qDebug() << Q_FUNC_INFO << "out of memory for data dimensions " << mKeySize << "*" + << mValueSize; } else mData = 0; @@ -19395,10 +22164,12 @@ void QCPColorMapData::setSize( int keySize, int valueSize ) /*! Resizes the data array to have \a keySize cells in the key dimension. - The current data is discarded and the map cells are set to 0, unless the map had already the + The current data is discarded and the map cells are set to 0, unless the map + had already the requested size. - Setting \a keySize to zero frees the internal data array and \ref isEmpty returns true. + Setting \a keySize to zero frees the internal data array and \ref isEmpty + returns true. \see setKeyRange, setSize, setValueSize */ @@ -19410,10 +22181,12 @@ void QCPColorMapData::setKeySize( int keySize ) /*! Resizes the data array to have \a valueSize cells in the value dimension. - The current data is discarded and the map cells are set to 0, unless the map had already the + The current data is discarded and the map cells are set to 0, unless the map + had already the requested size. - Setting \a valueSize to zero frees the internal data array and \ref isEmpty returns true. + Setting \a valueSize to zero frees the internal data array and \ref isEmpty + returns true. \see setValueRange, setSize, setKeySize */ @@ -19423,11 +22196,14 @@ void QCPColorMapData::setValueSize( int valueSize ) } /*! - Sets the coordinate ranges the data shall be distributed over. This defines the rectangular area + Sets the coordinate ranges the data shall be distributed over. This defines + the rectangular area covered by the color map in plot coordinates. - The outer cells will be centered on the range boundaries given to this function. For example, if - the key size (\ref setKeySize) is 3 and \a keyRange is set to QCPRange(2, 3) there will + The outer cells will be centered on the range boundaries given to this + function. For example, if + the key size (\ref setKeySize) is 3 and \a keyRange is set to QCPRange(2, + 3) there will be cells centered on the key coordinates 2, 2.5 and 3. \see setSize @@ -19439,11 +22215,15 @@ void QCPColorMapData::setRange( const QCPRange& keyRange, const QCPRange& valueR } /*! - Sets the coordinate range the data shall be distributed over in the key dimension. Together with - the value range, This defines the rectangular area covered by the color map in plot coordinates. + Sets the coordinate range the data shall be distributed over in the key + dimension. Together with + the value range, This defines the rectangular area covered by the color map in + plot coordinates. - The outer cells will be centered on the range boundaries given to this function. For example, if - the key size (\ref setKeySize) is 3 and \a keyRange is set to QCPRange(2, 3) there will + The outer cells will be centered on the range boundaries given to this + function. For example, if + the key size (\ref setKeySize) is 3 and \a keyRange is set to QCPRange(2, + 3) there will be cells centered on the key coordinates 2, 2.5 and 3. \see setRange, setValueRange, setSize @@ -19454,11 +22234,15 @@ void QCPColorMapData::setKeyRange( const QCPRange& keyRange ) } /*! - Sets the coordinate range the data shall be distributed over in the value dimension. Together with - the key range, This defines the rectangular area covered by the color map in plot coordinates. + Sets the coordinate range the data shall be distributed over in the value + dimension. Together with + the key range, This defines the rectangular area covered by the color map in + plot coordinates. - The outer cells will be centered on the range boundaries given to this function. For example, if - the value size (\ref setValueSize) is 3 and \a valueRange is set to QCPRange(2, 3) there + The outer cells will be centered on the range boundaries given to this + function. For example, if + the value size (\ref setValueSize) is 3 and \a valueRange is set to + QCPRange(2, 3) there will be cells centered on the value coordinates 2, 2.5 and 3. \see setRange, setKeyRange, setSize @@ -19469,15 +22253,19 @@ void QCPColorMapData::setValueRange( const QCPRange& valueRange ) } /*! - Sets the data of the cell, which lies at the plot coordinates given by \a key and \a value, to \a + Sets the data of the cell, which lies at the plot coordinates given by \a key + and \a value, to \a z. \see setCell, setRange */ void QCPColorMapData::setData( double key, double value, double z ) { - int keyCell = ( key - mKeyRange.lower ) / ( mKeyRange.upper - mKeyRange.lower ) * ( mKeySize - 1 ) + 0.5; - int valueCell = ( value - mValueRange.lower ) / ( mValueRange.upper - mValueRange.lower ) * ( mValueSize - 1 ) + 0.5; + int keyCell = + ( key - mKeyRange.lower ) / ( mKeyRange.upper - mKeyRange.lower ) * ( mKeySize - 1 ) + 0.5; + int valueCell = ( value - mValueRange.lower ) / ( mValueRange.upper - mValueRange.lower ) * + ( mValueSize - 1 ) + + 0.5; if( keyCell >= 0 && keyCell < mKeySize && valueCell >= 0 && valueCell < mValueSize ) { mData[valueCell * mKeySize + keyCell] = z; @@ -19490,12 +22278,16 @@ void QCPColorMapData::setData( double key, double value, double z ) } /*! - Sets the data of the cell with indices \a keyIndex and \a valueIndex to \a z. The indices - enumerate the cells starting from zero, up to the map's size-1 in the respective dimension (see + Sets the data of the cell with indices \a keyIndex and \a valueIndex to \a z. + The indices + enumerate the cells starting from zero, up to the map's size-1 in the + respective dimension (see \ref setSize). - In the standard plot configuration (horizontal key axis and vertical value axis, both not - range-reversed), the cell with indices (0, 0) is in the bottom left corner and the cell with + In the standard plot configuration (horizontal key axis and vertical value + axis, both not + range-reversed), the cell with indices (0, 0) is in the bottom left corner and + the cell with indices (keySize-1, valueSize-1) is in the top right corner of the color map. \see setData, setSize @@ -19514,16 +22306,23 @@ void QCPColorMapData::setCell( int keyIndex, int valueIndex, double z ) } /*! - Goes through the data and updates the buffered minimum and maximum data values. + Goes through the data and updates the buffered minimum and maximum data + values. - Calling this method is only advised if you are about to call \ref QCPColorMap::rescaleDataRange - and can not guarantee that the cells holding the maximum or minimum data haven't been overwritten - with a smaller or larger value respectively, since the buffered maximum/minimum values have been - updated the last time. Why this is the case is explained in the class description (\ref + Calling this method is only advised if you are about to call \ref + QCPColorMap::rescaleDataRange + and can not guarantee that the cells holding the maximum or minimum data + haven't been overwritten + with a smaller or larger value respectively, since the buffered + maximum/minimum values have been + updated the last time. Why this is the case is explained in the class + description (\ref QCPColorMapData). - Note that the method \ref QCPColorMap::rescaleDataRange provides a parameter \a - recalculateDataBounds for convenience. Setting this to true will call this method for you, before + Note that the method \ref QCPColorMap::rescaleDataRange provides a parameter + \a + recalculateDataBounds for convenience. Setting this to true will call this + method for you, before doing the rescale. */ void QCPColorMapData::recalculateDataBounds() @@ -19567,13 +22366,17 @@ void QCPColorMapData::fill( double z ) } /*! - Transforms plot coordinates given by \a key and \a value to cell indices of this QCPColorMapData - instance. The resulting cell indices are returned via the output parameters \a keyIndex and \a + Transforms plot coordinates given by \a key and \a value to cell indices of + this QCPColorMapData + instance. The resulting cell indices are returned via the output parameters \a + keyIndex and \a valueIndex. - The retrieved key/value cell indices can then be used for example with \ref setCell. + The retrieved key/value cell indices can then be used for example with \ref + setCell. - If you are only interested in a key or value index, you may pass 0 as \a valueIndex or \a + If you are only interested in a key or value index, you may pass 0 as \a + valueIndex or \a keyIndex. \see cellToCoord, QCPAxis::coordToPixel @@ -19581,17 +22384,23 @@ void QCPColorMapData::fill( double z ) void QCPColorMapData::coordToCell( double key, double value, int* keyIndex, int* valueIndex ) const { if( keyIndex ) - *keyIndex = ( key - mKeyRange.lower ) / ( mKeyRange.upper - mKeyRange.lower ) * ( mKeySize - 1 ) + 0.5; + *keyIndex = + ( key - mKeyRange.lower ) / ( mKeyRange.upper - mKeyRange.lower ) * ( mKeySize - 1 ) + 0.5; if( valueIndex ) - *valueIndex = ( value - mValueRange.lower ) / ( mValueRange.upper - mValueRange.lower ) * ( mValueSize - 1 ) + 0.5; + *valueIndex = ( value - mValueRange.lower ) / ( mValueRange.upper - mValueRange.lower ) * + ( mValueSize - 1 ) + + 0.5; } /*! - Transforms cell indices given by \a keyIndex and \a valueIndex to cell indices of this QCPColorMapData - instance. The resulting coordinates are returned via the output parameters \a key and \a + Transforms cell indices given by \a keyIndex and \a valueIndex to cell indices + of this QCPColorMapData + instance. The resulting coordinates are returned via the output parameters \a + key and \a value. - If you are only interested in a key or value coordinate, you may pass 0 as \a key or \a + If you are only interested in a key or value coordinate, you may pass 0 as \a + key or \a value. \see coordToCell, QCPAxis::pixelToCoord @@ -19599,9 +22408,11 @@ void QCPColorMapData::coordToCell( double key, double value, int* keyIndex, int* void QCPColorMapData::cellToCoord( int keyIndex, int valueIndex, double* key, double* value ) const { if( key ) - *key = keyIndex / (double)( mKeySize - 1 ) * ( mKeyRange.upper - mKeyRange.lower ) + mKeyRange.lower; + *key = keyIndex / (double)( mKeySize - 1 ) * ( mKeyRange.upper - mKeyRange.lower ) + + mKeyRange.lower; if( value ) - *value = valueIndex / (double)( mValueSize - 1 ) * ( mValueRange.upper - mValueRange.lower ) + mValueRange.lower; + *value = valueIndex / (double)( mValueSize - 1 ) * ( mValueRange.upper - mValueRange.lower ) + + mValueRange.lower; } //////////////////////////////////////////////////////////////////////////////////////////////////// @@ -19613,50 +22424,71 @@ void QCPColorMapData::cellToCoord( int keyIndex, int valueIndex, double* key, do \image html QCPColorMap.png - The data is stored in the class \ref QCPColorMapData, which can be accessed via the data() + The data is stored in the class \ref QCPColorMapData, which can be accessed + via the data() method. - A color map has three dimensions to represent a data point: The \a key dimension, the \a value - dimension and the \a data dimension. As with other plottables such as graphs, \a key and \a value - correspond to two orthogonal axes on the QCustomPlot surface that you specify in the QColorMap - constructor. The \a data dimension however is encoded as the color of the point at (\a key, \a + A color map has three dimensions to represent a data point: The \a key + dimension, the \a value + dimension and the \a data dimension. As with other plottables such as graphs, + \a key and \a value + correspond to two orthogonal axes on the QCustomPlot surface that you specify + in the QColorMap + constructor. The \a data dimension however is encoded as the color of the + point at (\a key, \a value). Set the number of points (or \a cells) in the key/value dimension via \ref - QCPColorMapData::setSize. The plot coordinate range over which these points will be displayed is - specified via \ref QCPColorMapData::setRange. The first cell will be centered on the lower range - boundary and the last cell will be centered on the upper range boundary. The data can be set by - either accessing the cells directly with QCPColorMapData::setCell or by addressing the cells via - their plot coordinates with \ref QCPColorMapData::setData. If possible, you should prefer - setCell, since it doesn't need to do any coordinate transformation and thus performs a bit + QCPColorMapData::setSize. The plot coordinate range over which these points + will be displayed is + specified via \ref QCPColorMapData::setRange. The first cell will be centered + on the lower range + boundary and the last cell will be centered on the upper range boundary. The + data can be set by + either accessing the cells directly with QCPColorMapData::setCell or by + addressing the cells via + their plot coordinates with \ref QCPColorMapData::setData. If possible, you + should prefer + setCell, since it doesn't need to do any coordinate transformation and thus + performs a bit better. - The cell with index (0, 0) is at the bottom left, if the color map uses normal (i.e. not reversed) + The cell with index (0, 0) is at the bottom left, if the color map uses normal + (i.e. not reversed) key and value axes. - To show the user which colors correspond to which \a data values, a \ref QCPColorScale is - typically placed to the right of the axis rect. See the documentation there for details on how to + To show the user which colors correspond to which \a data values, a \ref + QCPColorScale is + typically placed to the right of the axis rect. See the documentation there + for details on how to add and use a color scale. \section appearance Changing the appearance - The central part of the appearance is the color gradient, which can be specified via \ref - setGradient. See the documentation of \ref QCPColorGradient for details on configuring a color + The central part of the appearance is the color gradient, which can be + specified via \ref + setGradient. See the documentation of \ref QCPColorGradient for details on + configuring a color gradient. - The \a data range that is mapped to the colors of the gradient can be specified with \ref - setDataRange. To make the data range encompass the whole data set minimum to maximum, call \ref + The \a data range that is mapped to the colors of the gradient can be + specified with \ref + setDataRange. To make the data range encompass the whole data set minimum to + maximum, call \ref rescaleDataRange. \section usage Usage - Like all data representing objects in QCustomPlot, the QCPColorMap is a plottable + Like all data representing objects in QCustomPlot, the QCPColorMap is a + plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies - (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.) + (QCustomPlot::plottable, QCustomPlot::addPlottable, + QCustomPlot::removePlottable, etc.) Usually, you first create an instance: \code - QCPColorMap *colorMap = new QCPColorMap(customPlot->xAxis, customPlot->yAxis);\endcode + QCPColorMap *colorMap = new QCPColorMap(customPlot->xAxis, + customPlot->yAxis);\endcode add it to the customPlot with QCustomPlot::addPlottable: \code customPlot->addPlottable(colorMap);\endcode @@ -19673,9 +22505,12 @@ void QCPColorMapData::cellToCoord( int keyIndex, int valueIndex, double* key, do customPlot->replot(); \endcode - \note The QCPColorMap always displays the data at equal key/value intervals, even if the key or - value axis is set to a logarithmic scaling. If you want to use QCPColorMap with logarithmic axes, - you shouldn't use the \ref QCPColorMapData::setData method as it uses a linear transformation to + \note The QCPColorMap always displays the data at equal key/value intervals, + even if the key or + value axis is set to a logarithmic scaling. If you want to use QCPColorMap + with logarithmic axes, + you shouldn't use the \ref QCPColorMapData::setData method as it uses a linear + transformation to determine the cell index. Rather directly access the cell index with \ref QCPColorMapData::setCell. */ @@ -19684,7 +22519,8 @@ void QCPColorMapData::cellToCoord( int keyIndex, int valueIndex, double* key, do /*! \fn QCPColorMapData *QCPColorMap::data() const - Returns a pointer to the internal data storage of type \ref QCPColorMapData. Access this to + Returns a pointer to the internal data storage of type \ref QCPColorMapData. + Access this to modify data points (cells) and the color map key/value range. \see setData @@ -19720,16 +22556,17 @@ void QCPColorMapData::cellToCoord( int keyIndex, int valueIndex, double* key, do /*! Constructs a color map with the specified \a keyAxis and \a valueAxis. - The constructed QCPColorMap can be added to the plot with QCustomPlot::addPlottable, QCustomPlot + The constructed QCPColorMap can be added to the plot with + QCustomPlot::addPlottable, QCustomPlot then takes ownership of the color map. */ QCPColorMap::QCPColorMap( QCPAxis* keyAxis, QCPAxis* valueAxis ) - : QCPAbstractPlottable( keyAxis, valueAxis ), - mDataScaleType( QCPAxis::stLinear ), - mMapData( new QCPColorMapData( 10, 10, QCPRange( 0, 5 ), QCPRange( 0, 5 ) ) ), - mInterpolate( true ), - mTightBoundary( false ), - mMapImageInvalidated( true ) + : QCPAbstractPlottable( keyAxis, valueAxis ) + , mDataScaleType( QCPAxis::stLinear ) + , mMapData( new QCPColorMapData( 10, 10, QCPRange( 0, 5 ), QCPRange( 0, 5 ) ) ) + , mInterpolate( true ) + , mTightBoundary( false ) + , mMapImageInvalidated( true ) { } @@ -19741,8 +22578,10 @@ QCPColorMap::~QCPColorMap() /*! Replaces the current \ref data with the provided \a data. - If \a copy is set to true, the \a data object will only be copied. if false, the color map - takes ownership of the passed data and replaces the internal data pointer with it. This is + If \a copy is set to true, the \a data object will only be copied. if false, + the color map + takes ownership of the passed data and replaces the internal data pointer with + it. This is significantly faster than copying for large datasets. */ void QCPColorMap::setData( QCPColorMapData* data, bool copy ) @@ -19760,10 +22599,12 @@ void QCPColorMap::setData( QCPColorMapData* data, bool copy ) } /*! - Sets the data range of this color map to \a dataRange. The data range defines which data values + Sets the data range of this color map to \a dataRange. The data range defines + which data values are mapped to the color gradient. - To make the data range span the full range of the data set, use \ref rescaleDataRange. + To make the data range span the full range of the data set, use \ref + rescaleDataRange. \see QCPColorScale::setDataRange */ @@ -19783,7 +22624,8 @@ void QCPColorMap::setDataRange( const QCPRange& dataRange ) } /*! - Sets whether the data is correlated with the color gradient linearly or logarithmically. + Sets whether the data is correlated with the color gradient linearly or + logarithmically. \see QCPColorScale::setDataScaleType */ @@ -19800,12 +22642,16 @@ void QCPColorMap::setDataScaleType( QCPAxis::ScaleType scaleType ) } /*! - Sets the color gradient that is used to represent the data. For more details on how to create an + Sets the color gradient that is used to represent the data. For more details + on how to create an own gradient or use one of the preset gradients, see \ref QCPColorGradient. - The colors defined by the gradient will be used to represent data values in the currently set - data range, see \ref setDataRange. Data points that are outside this data range will either be - colored uniformly with the respective gradient boundary color, or the gradient will repeat, + The colors defined by the gradient will be used to represent data values in + the currently set + data range, see \ref setDataRange. Data points that are outside this data + range will either be + colored uniformly with the respective gradient boundary color, or the gradient + will repeat, depending on \ref QCPColorGradient::setPeriodic. \see QCPColorScale::setGradient @@ -19821,10 +22667,12 @@ void QCPColorMap::setGradient( const QCPColorGradient& gradient ) } /*! - Sets whether the color map image shall use bicubic interpolation when displaying the color map + Sets whether the color map image shall use bicubic interpolation when + displaying the color map shrinked or expanded, and not at a 1:1 pixel-to-data scale. - \image html QCPColorMap-interpolate.png "A 10*10 color map, with interpolation and without interpolation enabled" + \image html QCPColorMap-interpolate.png "A 10*10 color map, with interpolation + and without interpolation enabled" */ void QCPColorMap::setInterpolate( bool enabled ) { @@ -19832,15 +22680,22 @@ void QCPColorMap::setInterpolate( bool enabled ) } /*! - Sets whether the outer most data rows and columns are clipped to the specified key and value - range (see \ref QCPColorMapData::setKeyRange, \ref QCPColorMapData::setValueRange). + Sets whether the outer most data rows and columns are clipped to the specified + key and value + range (see \ref QCPColorMapData::setKeyRange, \ref + QCPColorMapData::setValueRange). - if \a enabled is set to false, the data points at the border of the color map are drawn with the - same width and height as all other data points. Since the data points are represented by - rectangles of one color centered on the data coordinate, this means that the shown color map - extends by half a data point over the specified key/value range in each direction. + if \a enabled is set to false, the data points at the border of the color map + are drawn with the + same width and height as all other data points. Since the data points are + represented by + rectangles of one color centered on the data coordinate, this means that the + shown color map + extends by half a data point over the specified key/value range in each + direction. - \image html QCPColorMap-tightboundary.png "A color map, with tight boundary enabled and disabled" + \image html QCPColorMap-tightboundary.png "A color map, with tight boundary + enabled and disabled" */ void QCPColorMap::setTightBoundary( bool enabled ) { @@ -19850,27 +22705,35 @@ void QCPColorMap::setTightBoundary( bool enabled ) /*! Associates the color scale \a colorScale with this color map. - This means that both the color scale and the color map synchronize their gradient, data range and - data scale type (\ref setGradient, \ref setDataRange, \ref setDataScaleType). Multiple color maps - can be associated with one single color scale. This causes the color maps to also synchronize + This means that both the color scale and the color map synchronize their + gradient, data range and + data scale type (\ref setGradient, \ref setDataRange, \ref setDataScaleType). + Multiple color maps + can be associated with one single color scale. This causes the color maps to + also synchronize those properties, via the mutual color scale. - This function causes the color map to adopt the current color gradient, data range and data scale - type of \a colorScale. After this call, you may change these properties at either the color map + This function causes the color map to adopt the current color gradient, data + range and data scale + type of \a colorScale. After this call, you may change these properties at + either the color map or the color scale, and the setting will be applied to both. - Pass 0 as \a colorScale to disconnect the color scale from this color map again. + Pass 0 as \a colorScale to disconnect the color scale from this color map + again. */ void QCPColorMap::setColorScale( QCPColorScale* colorScale ) { if( mColorScale ) // unconnect signals from old color scale { - disconnect( this, SIGNAL( dataRangeChanged( QCPRange ) ), mColorScale.data(), SLOT( setDataRange( QCPRange ) ) ); + disconnect( this, SIGNAL( dataRangeChanged( QCPRange ) ), mColorScale.data(), + SLOT( setDataRange( QCPRange ) ) ); disconnect( this, SIGNAL( dataScaleTypeChanged( QCPAxis::ScaleType ) ), mColorScale.data(), SLOT( setDataScaleType( QCPAxis::ScaleType ) ) ); disconnect( this, SIGNAL( gradientChanged( QCPColorGradient ) ), mColorScale.data(), SLOT( setGradient( QCPColorGradient ) ) ); - disconnect( mColorScale.data(), SIGNAL( dataRangeChanged( QCPRange ) ), this, SLOT( setDataRange( QCPRange ) ) ); + disconnect( mColorScale.data(), SIGNAL( dataRangeChanged( QCPRange ) ), this, + SLOT( setDataRange( QCPRange ) ) ); disconnect( mColorScale.data(), SIGNAL( gradientChanged( QCPColorGradient ) ), this, SLOT( setGradient( QCPColorGradient ) ) ); disconnect( mColorScale.data(), SIGNAL( dataScaleTypeChanged( QCPAxis::ScaleType ) ), this, @@ -19882,12 +22745,14 @@ void QCPColorMap::setColorScale( QCPColorScale* colorScale ) setGradient( mColorScale.data()->gradient() ); setDataRange( mColorScale.data()->dataRange() ); setDataScaleType( mColorScale.data()->dataScaleType() ); - connect( this, SIGNAL( dataRangeChanged( QCPRange ) ), mColorScale.data(), SLOT( setDataRange( QCPRange ) ) ); + connect( this, SIGNAL( dataRangeChanged( QCPRange ) ), mColorScale.data(), + SLOT( setDataRange( QCPRange ) ) ); connect( this, SIGNAL( dataScaleTypeChanged( QCPAxis::ScaleType ) ), mColorScale.data(), SLOT( setDataScaleType( QCPAxis::ScaleType ) ) ); connect( this, SIGNAL( gradientChanged( QCPColorGradient ) ), mColorScale.data(), SLOT( setGradient( QCPColorGradient ) ) ); - connect( mColorScale.data(), SIGNAL( dataRangeChanged( QCPRange ) ), this, SLOT( setDataRange( QCPRange ) ) ); + connect( mColorScale.data(), SIGNAL( dataRangeChanged( QCPRange ) ), this, + SLOT( setDataRange( QCPRange ) ) ); connect( mColorScale.data(), SIGNAL( gradientChanged( QCPColorGradient ) ), this, SLOT( setGradient( QCPColorGradient ) ) ); connect( mColorScale.data(), SIGNAL( dataScaleTypeChanged( QCPAxis::ScaleType ) ), this, @@ -19896,21 +22761,33 @@ void QCPColorMap::setColorScale( QCPColorScale* colorScale ) } /*! - Sets the data range (\ref setDataRange) to span the minimum and maximum values that occur in the - current data set. This corresponds to the \ref rescaleKeyAxis or \ref rescaleValueAxis methods, + Sets the data range (\ref setDataRange) to span the minimum and maximum values + that occur in the + current data set. This corresponds to the \ref rescaleKeyAxis or \ref + rescaleValueAxis methods, only for the third data dimension of the color map. - The minimum and maximum values of the data set are buffered in the internal QCPColorMapData - instance (\ref data). As data is updated via its \ref QCPColorMapData::setCell or \ref - QCPColorMapData::setData, the buffered minimum and maximum values are updated, too. For - performance reasons, however, they are only updated in an expanding fashion. So the buffered - maximum can only increase and the buffered minimum can only decrease. In consequence, changes to - the data that actually lower the maximum of the data set (by overwriting the cell holding the - current maximum with a smaller value), aren't recognized and the buffered maximum overestimates - the true maximum of the data set. The same happens for the buffered minimum. To recalculate the + The minimum and maximum values of the data set are buffered in the internal + QCPColorMapData + instance (\ref data). As data is updated via its \ref QCPColorMapData::setCell + or \ref + QCPColorMapData::setData, the buffered minimum and maximum values are updated, + too. For + performance reasons, however, they are only updated in an expanding fashion. + So the buffered + maximum can only increase and the buffered minimum can only decrease. In + consequence, changes to + the data that actually lower the maximum of the data set (by overwriting the + cell holding the + current maximum with a smaller value), aren't recognized and the buffered + maximum overestimates + the true maximum of the data set. The same happens for the buffered minimum. + To recalculate the true minimum and maximum by explicitly looking at each cell, the method - QCPColorMapData::recalculateDataBounds can be used. For convenience, setting the parameter \a - recalculateDataBounds calls this method before setting the data range to the buffered minimum and + QCPColorMapData::recalculateDataBounds can be used. For convenience, setting + the parameter \a + recalculateDataBounds calls this method before setting the data range to the + buffered minimum and maximum. \see setDataRange @@ -19923,35 +22800,46 @@ void QCPColorMap::rescaleDataRange( bool recalculateDataBounds ) } /*! - Takes the current appearance of the color map and updates the legend icon, which is used to + Takes the current appearance of the color map and updates the legend icon, + which is used to represent this color map in the legend (see \ref QCPLegend). - The \a transformMode specifies whether the rescaling is done by a faster, low quality image - scaling algorithm (Qt::FastTransformation) or by a slower, higher quality algorithm + The \a transformMode specifies whether the rescaling is done by a faster, low + quality image + scaling algorithm (Qt::FastTransformation) or by a slower, higher quality + algorithm (Qt::SmoothTransformation). - The current color map appearance is scaled down to \a thumbSize. Ideally, this should be equal to - the size of the legend icon (see \ref QCPLegend::setIconSize). If it isn't exactly the configured - legend icon size, the thumb will be rescaled during drawing of the legend item. + The current color map appearance is scaled down to \a thumbSize. Ideally, this + should be equal to + the size of the legend icon (see \ref QCPLegend::setIconSize). If it isn't + exactly the configured + legend icon size, the thumb will be rescaled during drawing of the legend + item. \see setDataRange */ void QCPColorMap::updateLegendIcon( Qt::TransformationMode transformMode, const QSize& thumbSize ) { if( mMapImage.isNull() && !data()->isEmpty() ) - updateMapImage(); // try to update map image if it's null (happens if no draw has happened yet) + updateMapImage(); // try to update map image if it's null (happens if no + // draw has happened yet) - if( !mMapImage.isNull() ) // might still be null, e.g. if data is empty, so check here again + if( !mMapImage.isNull() ) // might still be null, e.g. if data is empty, so + // check here again { - bool mirrorX = ( keyAxis()->orientation() == Qt::Horizontal ? keyAxis() : valueAxis() )->rangeReversed(); - bool mirrorY = ( valueAxis()->orientation() == Qt::Vertical ? valueAxis() : keyAxis() )->rangeReversed(); + bool mirrorX = + ( keyAxis()->orientation() == Qt::Horizontal ? keyAxis() : valueAxis() )->rangeReversed(); + bool mirrorY = + ( valueAxis()->orientation() == Qt::Vertical ? valueAxis() : keyAxis() )->rangeReversed(); mLegendIcon = QPixmap::fromImage( mMapImage.mirrored( mirrorX, mirrorY ) ) .scaled( thumbSize, Qt::KeepAspectRatio, transformMode ); } } /*! - Clears the colormap data by calling \ref QCPColorMapData::clear() on the internal data. This also + Clears the colormap data by calling \ref QCPColorMapData::clear() on the + internal data. This also resizes the map to 0x0 cells. */ void QCPColorMap::clearData() @@ -19983,11 +22871,15 @@ double QCPColorMap::selectTest( const QPointF& pos, bool onlySelectable, QVarian /*! \internal - Updates the internal map image buffer by going through the internal \ref QCPColorMapData and - turning the data values into color pixels with \ref QCPColorGradient::colorize. + Updates the internal map image buffer by going through the internal \ref + QCPColorMapData and + turning the data values into color pixels with \ref + QCPColorGradient::colorize. - This method is called by \ref QCPColorMap::draw if either the data has been modified or the map image - has been invalidated for a different reason (e.g. a change of the data range with \ref + This method is called by \ref QCPColorMap::draw if either the data has been + modified or the map image + has been invalidated for a different reason (e.g. a change of the data range + with \ref setDataRange). */ void QCPColorMap::updateMapImage() @@ -19996,12 +22888,15 @@ void QCPColorMap::updateMapImage() if( !keyAxis ) return; - // resize mMapImage to correct dimensions, according to key/value axes orientation: + // resize mMapImage to correct dimensions, according to key/value axes + // orientation: if( keyAxis->orientation() == Qt::Horizontal && - ( mMapImage.size().width() != mMapData->keySize() || mMapImage.size().height() != mMapData->valueSize() ) ) + ( mMapImage.size().width() != mMapData->keySize() || + mMapImage.size().height() != mMapData->valueSize() ) ) mMapImage = QImage( QSize( mMapData->keySize(), mMapData->valueSize() ), QImage::Format_RGB32 ); else if( keyAxis->orientation() == Qt::Vertical && - ( mMapImage.size().width() != mMapData->valueSize() || mMapImage.size().height() != mMapData->keySize() ) ) + ( mMapImage.size().width() != mMapData->valueSize() || + mMapImage.size().height() != mMapData->keySize() ) ) mMapImage = QImage( QSize( mMapData->valueSize(), mMapData->keySize() ), QImage::Format_RGB32 ); const int keySize = mMapData->keySize(); @@ -20014,10 +22909,10 @@ void QCPColorMap::updateMapImage() const int rowCount = keySize; for( int line = 0; line < lineCount; ++line ) { - QRgb* pixels = reinterpret_cast( - mMapImage.scanLine( lineCount - 1 - line ) ); // invert scanline index because QImage counts scanlines from - // top, but our vertical index counts from bottom (mathematical - // coordinate system) + QRgb* pixels = reinterpret_cast( mMapImage.scanLine( + lineCount - 1 - line ) ); // invert scanline index because QImage counts scanlines from + // top, but our vertical index counts from bottom (mathematical + // coordinate system) mGradient.colorize( rawData + line * rowCount, mDataRange, pixels, rowCount, 1, mDataScaleType == QCPAxis::stLogarithmic ); } @@ -20028,10 +22923,10 @@ void QCPColorMap::updateMapImage() const int rowCount = valueSize; for( int line = 0; line < lineCount; ++line ) { - QRgb* pixels = reinterpret_cast( - mMapImage.scanLine( lineCount - 1 - line ) ); // invert scanline index because QImage counts scanlines from - // top, but our vertical index counts from bottom (mathematical - // coordinate system) + QRgb* pixels = reinterpret_cast( mMapImage.scanLine( + lineCount - 1 - line ) ); // invert scanline index because QImage counts scanlines from + // top, but our vertical index counts from bottom (mathematical + // coordinate system) mGradient.colorize( rawData + line, mDataRange, pixels, rowCount, lineCount, mDataScaleType == QCPAxis::stLogarithmic ); } @@ -20059,22 +22954,26 @@ void QCPColorMap::draw( QCPPainter* painter ) halfSampleKey = 0.5 * mMapData->keyRange().size() / (double)( mMapData->keySize() - 1 ); if( mMapData->valueSize() > 1 ) halfSampleValue = 0.5 * mMapData->valueRange().size() / (double)( mMapData->valueSize() - 1 ); - QRectF imageRect( - coordsToPixels( mMapData->keyRange().lower - halfSampleKey, mMapData->valueRange().lower - halfSampleValue ), - coordsToPixels( mMapData->keyRange().upper + halfSampleKey, mMapData->valueRange().upper + halfSampleValue ) ); + QRectF imageRect( coordsToPixels( mMapData->keyRange().lower - halfSampleKey, + mMapData->valueRange().lower - halfSampleValue ), + coordsToPixels( mMapData->keyRange().upper + halfSampleKey, + mMapData->valueRange().upper + halfSampleValue ) ); imageRect = imageRect.normalized(); - bool mirrorX = ( keyAxis()->orientation() == Qt::Horizontal ? keyAxis() : valueAxis() )->rangeReversed(); - bool mirrorY = ( valueAxis()->orientation() == Qt::Vertical ? valueAxis() : keyAxis() )->rangeReversed(); + bool mirrorX = + ( keyAxis()->orientation() == Qt::Horizontal ? keyAxis() : valueAxis() )->rangeReversed(); + bool mirrorY = + ( valueAxis()->orientation() == Qt::Vertical ? valueAxis() : keyAxis() )->rangeReversed(); bool smoothBackup = painter->renderHints().testFlag( QPainter::SmoothPixmapTransform ); painter->setRenderHint( QPainter::SmoothPixmapTransform, mInterpolate ); QRegion clipBackup; if( mTightBoundary ) { clipBackup = painter->clipRegion(); - painter->setClipRect( QRectF( coordsToPixels( mMapData->keyRange().lower, mMapData->valueRange().lower ), - coordsToPixels( mMapData->keyRange().upper, mMapData->valueRange().upper ) ) - .normalized(), - Qt::IntersectClip ); + painter->setClipRect( + QRectF( coordsToPixels( mMapData->keyRange().lower, mMapData->valueRange().lower ), + coordsToPixels( mMapData->keyRange().upper, mMapData->valueRange().upper ) ) + .normalized(), + Qt::IntersectClip ); } painter->drawImage( imageRect, mMapImage.mirrored( mirrorX, mirrorY ) ); if( mTightBoundary ) @@ -20089,7 +22988,8 @@ void QCPColorMap::drawLegendIcon( QCPPainter* painter, const QRectF& rect ) cons // draw map thumbnail: if( !mLegendIcon.isNull() ) { - QPixmap scaledIcon = mLegendIcon.scaled( rect.size().toSize(), Qt::KeepAspectRatio, Qt::FastTransformation ); + QPixmap scaledIcon = + mLegendIcon.scaled( rect.size().toSize(), Qt::KeepAspectRatio, Qt::FastTransformation ); QRectF iconRect = QRectF( 0, 0, scaledIcon.width(), scaledIcon.height() ); iconRect.moveCenter( rect.center() ); painter->drawPixmap( iconRect.topLeft(), scaledIcon ); @@ -20155,7 +23055,8 @@ QCPRange QCPColorMap::getValueRange( bool& foundRange, SignDomain inSignDomain ) /*! \class QCPItemStraightLine \brief A straight line that spans infinitely in both directions - \image html QCPItemStraightLine.png "Straight line example. Blue dotted circles are anchors, solid blue discs are + \image html QCPItemStraightLine.png "Straight line example. Blue dotted + circles are anchors, solid blue discs are positions." It has two positions, \a point1 and \a point2, which define the straight line. @@ -20167,7 +23068,9 @@ QCPRange QCPColorMap::getValueRange( bool& foundRange, SignDomain inSignDomain ) The constructed item can be added to the plot with QCustomPlot::addItem. */ QCPItemStraightLine::QCPItemStraightLine( QCustomPlot* parentPlot ) - : QCPAbstractItem( parentPlot ), point1( createPosition( "point1" ) ), point2( createPosition( "point2" ) ) + : QCPAbstractItem( parentPlot ) + , point1( createPosition( "point1" ) ) + , point2( createPosition( "point2" ) ) { point1->setCoords( 0, 0 ); point2->setCoords( 1, 1 ); @@ -20201,14 +23104,17 @@ void QCPItemStraightLine::setSelectedPen( const QPen& pen ) } /* inherits documentation from base class */ -double QCPItemStraightLine::selectTest( const QPointF& pos, bool onlySelectable, QVariant* details ) const +double QCPItemStraightLine::selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details ) const { Q_UNUSED( details ) if( onlySelectable && !mSelectable ) return -1; return distToStraightLine( QVector2D( point1->pixelPoint() ), - QVector2D( point2->pixelPoint() - point1->pixelPoint() ), QVector2D( pos ) ); + QVector2D( point2->pixelPoint() - point1->pixelPoint() ), + QVector2D( pos ) ); } /* inherits documentation from base class */ @@ -20218,8 +23124,8 @@ void QCPItemStraightLine::draw( QCPPainter* painter ) QVector2D end( point2->pixelPoint() ); // get visible segment of straight line inside clipRect: double clipPad = mainPen().widthF(); - QLineF line = - getRectClippedStraightLine( start, end - start, clipRect().adjusted( -clipPad, -clipPad, clipPad, clipPad ) ); + QLineF line = getRectClippedStraightLine( + start, end - start, clipRect().adjusted( -clipPad, -clipPad, clipPad, clipPad ) ); // paint visible segment, if existent: if( !line.isNull() ) { @@ -20230,7 +23136,8 @@ void QCPItemStraightLine::draw( QCPPainter* painter ) /*! \internal - finds the shortest distance of \a point to the straight line defined by the base point \a + finds the shortest distance of \a point to the straight line defined by the + base point \a base and the direction vector \a vec. This is a helper function for \ref selectTest. @@ -20239,12 +23146,14 @@ double QCPItemStraightLine::distToStraightLine( const QVector2D& base, const QVector2D& vec, const QVector2D& point ) const { - return qAbs( ( base.y() - point.y() ) * vec.x() - ( base.x() - point.x() ) * vec.y() ) / vec.length(); + return qAbs( ( base.y() - point.y() ) * vec.x() - ( base.x() - point.x() ) * vec.y() ) / + vec.length(); } /*! \internal - Returns the section of the straight line defined by \a base and direction vector \a + Returns the section of the straight line defined by \a base and direction + vector \a vec, that is visible in the specified \a rect. This is a helper function for \ref draw. @@ -20266,7 +23175,8 @@ QLineF QCPItemStraightLine::getRectClippedStraightLine( const QVector2D& base, gamma = base.x() - bx + ( by - base.y() ) * vec.x() / vec.y(); if( gamma >= 0 && gamma <= rect.width() ) result.setLine( bx + gamma, rect.top(), bx + gamma, - rect.bottom() ); // no need to check bottom because we know line is vertical + rect.bottom() ); // no need to check bottom because we know + // line is vertical } else if( qFuzzyIsNull( vec.y() ) ) // line is horizontal { @@ -20276,7 +23186,8 @@ QLineF QCPItemStraightLine::getRectClippedStraightLine( const QVector2D& base, gamma = base.y() - by + ( bx - base.x() ) * vec.y() / vec.x(); if( gamma >= 0 && gamma <= rect.height() ) result.setLine( rect.left(), by + gamma, rect.right(), - by + gamma ); // no need to check right because we know line is horizontal + by + gamma ); // no need to check right because we know line + // is horizontal } else // line is skewed { @@ -20313,7 +23224,8 @@ QLineF QCPItemStraightLine::getRectClippedStraightLine( const QVector2D& base, } else if( pointVectors.size() > 2 ) { - // line probably goes through corner of rect, and we got two points there. single out the point pair with greatest + // line probably goes through corner of rect, and we got two points there. + // single out the point pair with greatest // distance: double distSqrMax = 0; QVector2D pv1, pv2; @@ -20353,11 +23265,14 @@ QPen QCPItemStraightLine::mainPen() const /*! \class QCPItemLine \brief A line from one point to another - \image html QCPItemLine.png "Line example. Blue dotted circles are anchors, solid blue discs are positions." + \image html QCPItemLine.png "Line example. Blue dotted circles are anchors, + solid blue discs are positions." - It has two positions, \a start and \a end, which define the end points of the line. + It has two positions, \a start and \a end, which define the end points of the + line. - With \ref setHead and \ref setTail you may set different line ending styles, e.g. to create an arrow. + With \ref setHead and \ref setTail you may set different line ending styles, + e.g. to create an arrow. */ /*! @@ -20366,7 +23281,9 @@ QPen QCPItemStraightLine::mainPen() const The constructed item can be added to the plot with QCustomPlot::addItem. */ QCPItemLine::QCPItemLine( QCustomPlot* parentPlot ) - : QCPAbstractItem( parentPlot ), start( createPosition( "start" ) ), end( createPosition( "end" ) ) + : QCPAbstractItem( parentPlot ) + , start( createPosition( "start" ) ) + , end( createPosition( "end" ) ) { start->setCoords( 0, 0 ); end->setCoords( 1, 1 ); @@ -20400,10 +23317,13 @@ void QCPItemLine::setSelectedPen( const QPen& pen ) } /*! - Sets the line ending style of the head. The head corresponds to the \a end position. + Sets the line ending style of the head. The head corresponds to the \a end + position. - Note that due to the overloaded QCPLineEnding constructor, you may directly specify - a QCPLineEnding::EndingStyle here, e.g. \code setHead(QCPLineEnding::esSpikeArrow) \endcode + Note that due to the overloaded QCPLineEnding constructor, you may directly + specify + a QCPLineEnding::EndingStyle here, e.g. \code + setHead(QCPLineEnding::esSpikeArrow) \endcode \see setTail */ @@ -20413,10 +23333,13 @@ void QCPItemLine::setHead( const QCPLineEnding& head ) } /*! - Sets the line ending style of the tail. The tail corresponds to the \a start position. + Sets the line ending style of the tail. The tail corresponds to the \a start + position. - Note that due to the overloaded QCPLineEnding constructor, you may directly specify - a QCPLineEnding::EndingStyle here, e.g. \code setTail(QCPLineEnding::esSpikeArrow) \endcode + Note that due to the overloaded QCPLineEnding constructor, you may directly + specify + a QCPLineEnding::EndingStyle here, e.g. \code + setTail(QCPLineEnding::esSpikeArrow) \endcode \see setHead */ @@ -20445,7 +23368,8 @@ void QCPItemLine::draw( QCPPainter* painter ) // get visible segment of straight line inside clipRect: double clipPad = qMax( mHead.boundingDistance(), mTail.boundingDistance() ); clipPad = qMax( clipPad, (double)mainPen().widthF() ); - QLineF line = getRectClippedLine( startVec, endVec, clipRect().adjusted( -clipPad, -clipPad, clipPad, clipPad ) ); + QLineF line = getRectClippedLine( startVec, endVec, + clipRect().adjusted( -clipPad, -clipPad, clipPad, clipPad ) ); // paint visible segment, if existent: if( !line.isNull() ) { @@ -20461,12 +23385,15 @@ void QCPItemLine::draw( QCPPainter* painter ) /*! \internal - Returns the section of the line defined by \a start and \a end, that is visible in the specified + Returns the section of the line defined by \a start and \a end, that is + visible in the specified \a rect. This is a helper function for \ref draw. */ -QLineF QCPItemLine::getRectClippedLine( const QVector2D& start, const QVector2D& end, const QRect& rect ) const +QLineF QCPItemLine::getRectClippedLine( const QVector2D& start, + const QVector2D& end, + const QRect& rect ) const { bool containsStart = rect.contains( start.x(), start.y() ); bool containsEnd = rect.contains( end.x(), end.y() ); @@ -20539,7 +23466,8 @@ QLineF QCPItemLine::getRectClippedLine( const QVector2D& start, const QVector2D& } else if( pointVectors.size() > 2 ) { - // line probably goes through corner of rect, and we got two points there. single out the point pair with greatest + // line probably goes through corner of rect, and we got two points there. + // single out the point pair with greatest // distance: double distSqrMax = 0; QVector2D pv1, pv2; @@ -20578,18 +23506,25 @@ QPen QCPItemLine::mainPen() const /*! \class QCPItemCurve \brief A curved line from one point to another - \image html QCPItemCurve.png "Curve example. Blue dotted circles are anchors, solid blue discs are positions." + \image html QCPItemCurve.png "Curve example. Blue dotted circles are anchors, + solid blue discs are positions." - It has four positions, \a start and \a end, which define the end points of the line, and two - control points which define the direction the line exits from the start and the direction from + It has four positions, \a start and \a end, which define the end points of the + line, and two + control points which define the direction the line exits from the start and + the direction from which it approaches the end: \a startDir and \a endDir. - With \ref setHead and \ref setTail you may set different line ending styles, e.g. to create an + With \ref setHead and \ref setTail you may set different line ending styles, + e.g. to create an arrow. - Often it is desirable for the control points to stay at fixed relative positions to the start/end - point. This can be achieved by setting the parent anchor e.g. of \a startDir simply to \a start, - and then specify the desired pixel offset with QCPItemPosition::setCoords on \a startDir. + Often it is desirable for the control points to stay at fixed relative + positions to the start/end + point. This can be achieved by setting the parent anchor e.g. of \a startDir + simply to \a start, + and then specify the desired pixel offset with QCPItemPosition::setCoords on + \a startDir. */ /*! @@ -20598,11 +23533,11 @@ QPen QCPItemLine::mainPen() const The constructed item can be added to the plot with QCustomPlot::addItem. */ QCPItemCurve::QCPItemCurve( QCustomPlot* parentPlot ) - : QCPAbstractItem( parentPlot ), - start( createPosition( "start" ) ), - startDir( createPosition( "startDir" ) ), - endDir( createPosition( "endDir" ) ), - end( createPosition( "end" ) ) + : QCPAbstractItem( parentPlot ) + , start( createPosition( "start" ) ) + , startDir( createPosition( "startDir" ) ) + , endDir( createPosition( "endDir" ) ) + , end( createPosition( "end" ) ) { start->setCoords( 0, 0 ); startDir->setCoords( 0.5, 0 ); @@ -20638,10 +23573,13 @@ void QCPItemCurve::setSelectedPen( const QPen& pen ) } /*! - Sets the line ending style of the head. The head corresponds to the \a end position. + Sets the line ending style of the head. The head corresponds to the \a end + position. - Note that due to the overloaded QCPLineEnding constructor, you may directly specify - a QCPLineEnding::EndingStyle here, e.g. \code setHead(QCPLineEnding::esSpikeArrow) \endcode + Note that due to the overloaded QCPLineEnding constructor, you may directly + specify + a QCPLineEnding::EndingStyle here, e.g. \code + setHead(QCPLineEnding::esSpikeArrow) \endcode \see setTail */ @@ -20651,10 +23589,13 @@ void QCPItemCurve::setHead( const QCPLineEnding& head ) } /*! - Sets the line ending style of the tail. The tail corresponds to the \a start position. + Sets the line ending style of the tail. The tail corresponds to the \a start + position. - Note that due to the overloaded QCPLineEnding constructor, you may directly specify - a QCPLineEnding::EndingStyle here, e.g. \code setTail(QCPLineEnding::esSpikeArrow) \endcode + Note that due to the overloaded QCPLineEnding constructor, you may directly + specify + a QCPLineEnding::EndingStyle here, e.g. \code + setTail(QCPLineEnding::esSpikeArrow) \endcode \see setHead */ @@ -20703,9 +23644,11 @@ void QCPItemCurve::draw( QCPPainter* painter ) cubicPath.cubicTo( startDirVec, endDirVec, endVec ); // paint visible segment, if existent: - QRect clip = clipRect().adjusted( -mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), mainPen().widthF() ); + QRect clip = clipRect().adjusted( -mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), + mainPen().widthF() ); QRect cubicRect = cubicPath.controlPointRect().toRect(); - if( cubicRect.isEmpty() ) // may happen when start and end exactly on same x or y position + if( cubicRect.isEmpty() ) // may happen when start and end exactly on same x or + // y position cubicRect.adjust( 0, 0, 1, 1 ); if( clip.intersects( cubicRect ) ) { @@ -20713,7 +23656,8 @@ void QCPItemCurve::draw( QCPPainter* painter ) painter->drawPath( cubicPath ); painter->setBrush( Qt::SolidPattern ); if( mTail.style() != QCPLineEnding::esNone ) - mTail.draw( painter, QVector2D( startVec ), M_PI - cubicPath.angleAtPercent( 0 ) / 180.0 * M_PI ); + mTail.draw( painter, QVector2D( startVec ), + M_PI - cubicPath.angleAtPercent( 0 ) / 180.0 * M_PI ); if( mHead.style() != QCPLineEnding::esNone ) mHead.draw( painter, QVector2D( endVec ), -cubicPath.angleAtPercent( 1 ) / 180.0 * M_PI ); } @@ -20736,9 +23680,11 @@ QPen QCPItemCurve::mainPen() const /*! \class QCPItemRect \brief A rectangle - \image html QCPItemRect.png "Rectangle example. Blue dotted circles are anchors, solid blue discs are positions." + \image html QCPItemRect.png "Rectangle example. Blue dotted circles are + anchors, solid blue discs are positions." - It has two positions, \a topLeft and \a bottomRight, which define the rectangle. + It has two positions, \a topLeft and \a bottomRight, which define the + rectangle. */ /*! @@ -20747,15 +23693,15 @@ QPen QCPItemCurve::mainPen() const The constructed item can be added to the plot with QCustomPlot::addItem. */ QCPItemRect::QCPItemRect( QCustomPlot* parentPlot ) - : QCPAbstractItem( parentPlot ), - topLeft( createPosition( "topLeft" ) ), - bottomRight( createPosition( "bottomRight" ) ), - top( createAnchor( "top", aiTop ) ), - topRight( createAnchor( "topRight", aiTopRight ) ), - right( createAnchor( "right", aiRight ) ), - bottom( createAnchor( "bottom", aiBottom ) ), - bottomLeft( createAnchor( "bottomLeft", aiBottomLeft ) ), - left( createAnchor( "left", aiLeft ) ) + : QCPAbstractItem( parentPlot ) + , topLeft( createPosition( "topLeft" ) ) + , bottomRight( createPosition( "bottomRight" ) ) + , top( createAnchor( "top", aiTop ) ) + , topRight( createAnchor( "topRight", aiTopRight ) ) + , right( createAnchor( "right", aiRight ) ) + , bottom( createAnchor( "bottom", aiBottom ) ) + , bottomLeft( createAnchor( "bottomLeft", aiBottomLeft ) ) + , left( createAnchor( "left", aiLeft ) ) { topLeft->setCoords( 0, 1 ); bottomRight->setCoords( 1, 0 ); @@ -20791,7 +23737,8 @@ void QCPItemRect::setSelectedPen( const QPen& pen ) } /*! - Sets the brush that will be used to fill the rectangle. To disable filling, set \a brush to + Sets the brush that will be used to fill the rectangle. To disable filling, + set \a brush to Qt::NoBrush. \see setSelectedBrush, setPen @@ -20802,7 +23749,8 @@ void QCPItemRect::setBrush( const QBrush& brush ) } /*! - Sets the brush that will be used to fill the rectangle when selected. To disable filling, set \a + Sets the brush that will be used to fill the rectangle when selected. To + disable filling, set \a brush to Qt::NoBrush. \see setBrush @@ -20834,7 +23782,8 @@ void QCPItemRect::draw( QCPPainter* painter ) QRectF rect = QRectF( p1, p2 ).normalized(); double clipPad = mainPen().widthF(); QRectF boundingRect = rect.adjusted( -clipPad, -clipPad, clipPad, clipPad ); - if( boundingRect.intersects( clipRect() ) ) // only draw if bounding rect of rect item is visible in cliprect + if( boundingRect.intersects( clipRect() ) ) // only draw if bounding rect of rect + // item is visible in cliprect { painter->setPen( mainPen() ); painter->setBrush( mainBrush() ); @@ -20868,7 +23817,8 @@ QPointF QCPItemRect::anchorPixelPoint( int anchorId ) const /*! \internal - Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected + Returns the pen that should be used for drawing lines. Returns mPen when the + item is not selected and mSelectedPen when it is. */ QPen QCPItemRect::mainPen() const @@ -20878,7 +23828,8 @@ QPen QCPItemRect::mainPen() const /*! \internal - Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item + Returns the brush that should be used for drawing fills of the item. Returns + mBrush when the item is not selected and mSelectedBrush when it is. */ QBrush QCPItemRect::mainBrush() const @@ -20893,12 +23844,16 @@ QBrush QCPItemRect::mainBrush() const /*! \class QCPItemText \brief A text label - \image html QCPItemText.png "Text example. Blue dotted circles are anchors, solid blue discs are positions." + \image html QCPItemText.png "Text example. Blue dotted circles are anchors, + solid blue discs are positions." - Its position is defined by the member \a position and the setting of \ref setPositionAlignment. - The latter controls which part of the text rect shall be aligned with \a position. + Its position is defined by the member \a position and the setting of \ref + setPositionAlignment. + The latter controls which part of the text rect shall be aligned with \a + position. - The text alignment itself (i.e. left, center, right) can be controlled with \ref + The text alignment itself (i.e. left, center, right) can be controlled with + \ref setTextAlignment. The text may be rotated around the \a position point with \ref setRotation. @@ -20910,16 +23865,16 @@ QBrush QCPItemRect::mainBrush() const The constructed item can be added to the plot with QCustomPlot::addItem. */ QCPItemText::QCPItemText( QCustomPlot* parentPlot ) - : QCPAbstractItem( parentPlot ), - position( createPosition( "position" ) ), - topLeft( createAnchor( "topLeft", aiTopLeft ) ), - top( createAnchor( "top", aiTop ) ), - topRight( createAnchor( "topRight", aiTopRight ) ), - right( createAnchor( "right", aiRight ) ), - bottomRight( createAnchor( "bottomRight", aiBottomRight ) ), - bottom( createAnchor( "bottom", aiBottom ) ), - bottomLeft( createAnchor( "bottomLeft", aiBottomLeft ) ), - left( createAnchor( "left", aiLeft ) ) + : QCPAbstractItem( parentPlot ) + , position( createPosition( "position" ) ) + , topLeft( createAnchor( "topLeft", aiTopLeft ) ) + , top( createAnchor( "top", aiTop ) ) + , topRight( createAnchor( "topRight", aiTopRight ) ) + , right( createAnchor( "right", aiRight ) ) + , bottomRight( createAnchor( "bottomRight", aiBottomRight ) ) + , bottom( createAnchor( "bottom", aiBottom ) ) + , bottomLeft( createAnchor( "bottomLeft", aiBottomLeft ) ) + , left( createAnchor( "left", aiLeft ) ) { position->setCoords( 0, 0 ); @@ -20957,7 +23912,8 @@ void QCPItemText::setSelectedColor( const QColor& color ) } /*! - Sets the pen that will be used do draw a rectangular border around the text. To disable the + Sets the pen that will be used do draw a rectangular border around the text. + To disable the border, set \a pen to Qt::NoPen. \see setSelectedPen, setBrush, setPadding @@ -20968,7 +23924,8 @@ void QCPItemText::setPen( const QPen& pen ) } /*! - Sets the pen that will be used do draw a rectangular border around the text, when the item is + Sets the pen that will be used do draw a rectangular border around the text, + when the item is selected. To disable the border, set \a pen to Qt::NoPen. \see setPen @@ -20979,7 +23936,8 @@ void QCPItemText::setSelectedPen( const QPen& pen ) } /*! - Sets the brush that will be used do fill the background of the text. To disable the + Sets the brush that will be used do fill the background of the text. To + disable the background, set \a brush to Qt::NoBrush. \see setSelectedBrush, setPen, setPadding @@ -20990,7 +23948,8 @@ void QCPItemText::setBrush( const QBrush& brush ) } /*! - Sets the brush that will be used do fill the background of the text, when the item is selected. To disable the + Sets the brush that will be used do fill the background of the text, when the + item is selected. To disable the background, set \a brush to Qt::NoBrush. \see setBrush @@ -21021,7 +23980,8 @@ void QCPItemText::setSelectedFont( const QFont& font ) } /*! - Sets the text that will be displayed. Multi-line texts are supported by inserting a line break + Sets the text that will be displayed. Multi-line texts are supported by + inserting a line break character, e.g. '\n'. \see setFont, setColor, setTextAlignment @@ -21035,12 +23995,15 @@ void QCPItemText::setText( const QString& text ) Sets which point of the text rect shall be aligned with \a position. Examples: - \li If \a alignment is Qt::AlignHCenter | Qt::AlignTop, the text will be positioned such + \li If \a alignment is Qt::AlignHCenter | Qt::AlignTop, the text will + be positioned such that the top of the text rect will be horizontally centered on \a position. - \li If \a alignment is Qt::AlignLeft | Qt::AlignBottom, \a position will indicate the + \li If \a alignment is Qt::AlignLeft | Qt::AlignBottom, \a position + will indicate the bottom left corner of the text rect. - If you want to control the alignment of (multi-lined) text within the text rect, use \ref + If you want to control the alignment of (multi-lined) text within the text + rect, use \ref setTextAlignment. */ void QCPItemText::setPositionAlignment( Qt::Alignment alignment ) @@ -21049,7 +24012,8 @@ void QCPItemText::setPositionAlignment( Qt::Alignment alignment ) } /*! - Controls how (multi-lined) text is aligned inside the text rect (typically Qt::AlignLeft, Qt::AlignCenter or + Controls how (multi-lined) text is aligned inside the text rect (typically + Qt::AlignLeft, Qt::AlignCenter or Qt::AlignRight). */ void QCPItemText::setTextAlignment( Qt::Alignment alignment ) @@ -21058,7 +24022,8 @@ void QCPItemText::setTextAlignment( Qt::Alignment alignment ) } /*! - Sets the angle in degrees by which the text (and the text rectangle, if visible) will be rotated + Sets the angle in degrees by which the text (and the text rectangle, if + visible) will be rotated around \a position. */ void QCPItemText::setRotation( double degrees ) @@ -21067,8 +24032,10 @@ void QCPItemText::setRotation( double degrees ) } /*! - Sets the distance between the border of the text rectangle and the text. The appearance (and - visibility) of the text rectangle can be controlled with \ref setPen and \ref setBrush. + Sets the distance between the border of the text rectangle and the text. The + appearance (and + visibility) of the text rectangle can be controlled with \ref setPen and \ref + setBrush. */ void QCPItemText::setPadding( const QMargins& padding ) { @@ -21082,8 +24049,10 @@ double QCPItemText::selectTest( const QPointF& pos, bool onlySelectable, QVarian if( onlySelectable && !mSelectable ) return -1; - // The rect may be rotated, so we transform the actual clicked pos to the rotated - // coordinate system, so we can use the normal rectSelectTest function for non-rotated rects: + // The rect may be rotated, so we transform the actual clicked pos to the + // rotated + // coordinate system, so we can use the normal rectSelectTest function for + // non-rotated rects: QPointF positionPixels( position->pixelPoint() ); QTransform inputTransform; inputTransform.translate( positionPixels.x(), positionPixels.y() ); @@ -21092,7 +24061,8 @@ double QCPItemText::selectTest( const QPointF& pos, bool onlySelectable, QVarian QPointF rotatedPos = inputTransform.map( pos ); QFontMetrics fontMetrics( mFont ); QRect textRect = fontMetrics.boundingRect( 0, 0, 0, 0, Qt::TextDontClip | mTextAlignment, mText ); - QRect textBoxRect = textRect.adjusted( -mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom() ); + QRect textBoxRect = + textRect.adjusted( -mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom() ); QPointF textPos = getTextDrawPoint( positionPixels, textBoxRect, mPositionAlignment ); textBoxRect.moveTopLeft( textPos.toPoint() ); @@ -21108,10 +24078,13 @@ void QCPItemText::draw( QCPPainter* painter ) if( !qFuzzyIsNull( mRotation ) ) transform.rotate( mRotation ); painter->setFont( mainFont() ); - QRect textRect = painter->fontMetrics().boundingRect( 0, 0, 0, 0, Qt::TextDontClip | mTextAlignment, mText ); - QRect textBoxRect = textRect.adjusted( -mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom() ); - QPointF textPos = getTextDrawPoint( QPointF( 0, 0 ), textBoxRect, - mPositionAlignment ); // 0, 0 because the transform does the translation + QRect textRect = + painter->fontMetrics().boundingRect( 0, 0, 0, 0, Qt::TextDontClip | mTextAlignment, mText ); + QRect textBoxRect = + textRect.adjusted( -mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom() ); + QPointF textPos = + getTextDrawPoint( QPointF( 0, 0 ), textBoxRect, + mPositionAlignment ); // 0, 0 because the transform does the translation textRect.moveTopLeft( textPos.toPoint() + QPoint( mPadding.left(), mPadding.top() ) ); textBoxRect.moveTopLeft( textPos.toPoint() ); double clipPad = mainPen().widthF(); @@ -21143,9 +24116,11 @@ QPointF QCPItemText::anchorPixelPoint( int anchorId ) const transform.rotate( mRotation ); QFontMetrics fontMetrics( mainFont() ); QRect textRect = fontMetrics.boundingRect( 0, 0, 0, 0, Qt::TextDontClip | mTextAlignment, mText ); - QRectF textBoxRect = textRect.adjusted( -mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom() ); - QPointF textPos = getTextDrawPoint( QPointF( 0, 0 ), textBoxRect, - mPositionAlignment ); // 0, 0 because the transform does the translation + QRectF textBoxRect = + textRect.adjusted( -mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom() ); + QPointF textPos = + getTextDrawPoint( QPointF( 0, 0 ), textBoxRect, + mPositionAlignment ); // 0, 0 because the transform does the translation textBoxRect.moveTopLeft( textPos.toPoint() ); QPolygonF rectPoly = transform.map( QPolygonF( textBoxRect ) ); @@ -21175,15 +24150,22 @@ QPointF QCPItemText::anchorPixelPoint( int anchorId ) const /*! \internal - Returns the point that must be given to the QPainter::drawText function (which expects the top - left point of the text rect), according to the position \a pos, the text bounding box \a rect and + Returns the point that must be given to the QPainter::drawText function (which + expects the top + left point of the text rect), according to the position \a pos, the text + bounding box \a rect and the requested \a positionAlignment. - For example, if \a positionAlignment is Qt::AlignLeft | Qt::AlignBottom the returned point - will be shifted upward by the height of \a rect, starting from \a pos. So if the text is finally - drawn at that point, the lower left corner of the resulting text rect is at \a pos. + For example, if \a positionAlignment is Qt::AlignLeft | + Qt::AlignBottom the returned point + will be shifted upward by the height of \a rect, starting from \a pos. So if + the text is finally + drawn at that point, the lower left corner of the resulting text rect is at \a + pos. */ -QPointF QCPItemText::getTextDrawPoint( const QPointF& pos, const QRectF& rect, Qt::Alignment positionAlignment ) const +QPointF QCPItemText::getTextDrawPoint( const QPointF& pos, + const QRectF& rect, + Qt::Alignment positionAlignment ) const { if( positionAlignment == 0 || positionAlignment == ( Qt::AlignLeft | Qt::AlignTop ) ) return pos; @@ -21202,7 +24184,8 @@ QPointF QCPItemText::getTextDrawPoint( const QPointF& pos, const QRectF& rect, Q /*! \internal - Returns the font that should be used for drawing text. Returns mFont when the item is not selected + Returns the font that should be used for drawing text. Returns mFont when the + item is not selected and mSelectedFont when it is. */ QFont QCPItemText::mainFont() const @@ -21212,7 +24195,8 @@ QFont QCPItemText::mainFont() const /*! \internal - Returns the color that should be used for drawing text. Returns mColor when the item is not + Returns the color that should be used for drawing text. Returns mColor when + the item is not selected and mSelectedColor when it is. */ QColor QCPItemText::mainColor() const @@ -21222,7 +24206,8 @@ QColor QCPItemText::mainColor() const /*! \internal - Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected + Returns the pen that should be used for drawing lines. Returns mPen when the + item is not selected and mSelectedPen when it is. */ QPen QCPItemText::mainPen() const @@ -21232,7 +24217,8 @@ QPen QCPItemText::mainPen() const /*! \internal - Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item + Returns the brush that should be used for drawing fills of the item. Returns + mBrush when the item is not selected and mSelectedBrush when it is. */ QBrush QCPItemText::mainBrush() const @@ -21247,9 +24233,11 @@ QBrush QCPItemText::mainBrush() const /*! \class QCPItemEllipse \brief An ellipse - \image html QCPItemEllipse.png "Ellipse example. Blue dotted circles are anchors, solid blue discs are positions." + \image html QCPItemEllipse.png "Ellipse example. Blue dotted circles are + anchors, solid blue discs are positions." - It has two positions, \a topLeft and \a bottomRight, which define the rect the ellipse will be drawn in. + It has two positions, \a topLeft and \a bottomRight, which define the rect the + ellipse will be drawn in. */ /*! @@ -21258,18 +24246,18 @@ QBrush QCPItemText::mainBrush() const The constructed item can be added to the plot with QCustomPlot::addItem. */ QCPItemEllipse::QCPItemEllipse( QCustomPlot* parentPlot ) - : QCPAbstractItem( parentPlot ), - topLeft( createPosition( "topLeft" ) ), - bottomRight( createPosition( "bottomRight" ) ), - topLeftRim( createAnchor( "topLeftRim", aiTopLeftRim ) ), - top( createAnchor( "top", aiTop ) ), - topRightRim( createAnchor( "topRightRim", aiTopRightRim ) ), - right( createAnchor( "right", aiRight ) ), - bottomRightRim( createAnchor( "bottomRightRim", aiBottomRightRim ) ), - bottom( createAnchor( "bottom", aiBottom ) ), - bottomLeftRim( createAnchor( "bottomLeftRim", aiBottomLeftRim ) ), - left( createAnchor( "left", aiLeft ) ), - center( createAnchor( "center", aiCenter ) ) + : QCPAbstractItem( parentPlot ) + , topLeft( createPosition( "topLeft" ) ) + , bottomRight( createPosition( "bottomRight" ) ) + , topLeftRim( createAnchor( "topLeftRim", aiTopLeftRim ) ) + , top( createAnchor( "top", aiTop ) ) + , topRightRim( createAnchor( "topRightRim", aiTopRightRim ) ) + , right( createAnchor( "right", aiRight ) ) + , bottomRightRim( createAnchor( "bottomRightRim", aiBottomRightRim ) ) + , bottom( createAnchor( "bottom", aiBottom ) ) + , bottomLeftRim( createAnchor( "bottomLeftRim", aiBottomLeftRim ) ) + , left( createAnchor( "left", aiLeft ) ) + , center( createAnchor( "center", aiCenter ) ) { topLeft->setCoords( 0, 1 ); bottomRight->setCoords( 1, 0 ); @@ -21305,7 +24293,8 @@ void QCPItemEllipse::setSelectedPen( const QPen& pen ) } /*! - Sets the brush that will be used to fill the ellipse. To disable filling, set \a brush to + Sets the brush that will be used to fill the ellipse. To disable filling, set + \a brush to Qt::NoBrush. \see setSelectedBrush, setPen @@ -21316,7 +24305,8 @@ void QCPItemEllipse::setBrush( const QBrush& brush ) } /*! - Sets the brush that will be used to fill the ellipse when selected. To disable filling, set \a + Sets the brush that will be used to fill the ellipse when selected. To disable + filling, set \a brush to Qt::NoBrush. \see setBrush @@ -21327,7 +24317,9 @@ void QCPItemEllipse::setSelectedBrush( const QBrush& brush ) } /* inherits documentation from base class */ -double QCPItemEllipse::selectTest( const QPointF& pos, bool onlySelectable, QVariant* details ) const +double QCPItemEllipse::selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details ) const { Q_UNUSED( details ) if( onlySelectable && !mSelectable ) @@ -21363,8 +24355,10 @@ void QCPItemEllipse::draw( QCPPainter* painter ) if( p1.toPoint() == p2.toPoint() ) return; QRectF ellipseRect = QRectF( p1, p2 ).normalized(); - QRect clip = clipRect().adjusted( -mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), mainPen().widthF() ); - if( ellipseRect.intersects( clip ) ) // only draw if bounding rect of ellipse is visible in cliprect + QRect clip = clipRect().adjusted( -mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), + mainPen().widthF() ); + if( ellipseRect.intersects( + clip ) ) // only draw if bounding rect of ellipse is visible in cliprect { painter->setPen( mainPen() ); painter->setBrush( mainBrush() ); @@ -21416,7 +24410,8 @@ QPointF QCPItemEllipse::anchorPixelPoint( int anchorId ) const /*! \internal - Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected + Returns the pen that should be used for drawing lines. Returns mPen when the + item is not selected and mSelectedPen when it is. */ QPen QCPItemEllipse::mainPen() const @@ -21426,7 +24421,8 @@ QPen QCPItemEllipse::mainPen() const /*! \internal - Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item + Returns the brush that should be used for drawing fills of the item. Returns + mBrush when the item is not selected and mSelectedBrush when it is. */ QBrush QCPItemEllipse::mainBrush() const @@ -21441,14 +24437,19 @@ QBrush QCPItemEllipse::mainBrush() const /*! \class QCPItemPixmap \brief An arbitrary pixmap - \image html QCPItemPixmap.png "Pixmap example. Blue dotted circles are anchors, solid blue discs are positions." + \image html QCPItemPixmap.png "Pixmap example. Blue dotted circles are + anchors, solid blue discs are positions." - It has two positions, \a topLeft and \a bottomRight, which define the rectangle the pixmap will - be drawn in. Depending on the scale setting (\ref setScaled), the pixmap will be either scaled to + It has two positions, \a topLeft and \a bottomRight, which define the + rectangle the pixmap will + be drawn in. Depending on the scale setting (\ref setScaled), the pixmap will + be either scaled to fit the rectangle or be drawn aligned to the topLeft position. - If scaling is enabled and \a topLeft is further to the bottom/right than \a bottomRight (as shown - on the right side of the example image), the pixmap will be flipped in the respective + If scaling is enabled and \a topLeft is further to the bottom/right than \a + bottomRight (as shown + on the right side of the example image), the pixmap will be flipped in the + respective orientations. */ @@ -21458,15 +24459,15 @@ QBrush QCPItemEllipse::mainBrush() const The constructed item can be added to the plot with QCustomPlot::addItem. */ QCPItemPixmap::QCPItemPixmap( QCustomPlot* parentPlot ) - : QCPAbstractItem( parentPlot ), - topLeft( createPosition( "topLeft" ) ), - bottomRight( createPosition( "bottomRight" ) ), - top( createAnchor( "top", aiTop ) ), - topRight( createAnchor( "topRight", aiTopRight ) ), - right( createAnchor( "right", aiRight ) ), - bottom( createAnchor( "bottom", aiBottom ) ), - bottomLeft( createAnchor( "bottomLeft", aiBottomLeft ) ), - left( createAnchor( "left", aiLeft ) ) + : QCPAbstractItem( parentPlot ) + , topLeft( createPosition( "topLeft" ) ) + , bottomRight( createPosition( "bottomRight" ) ) + , top( createAnchor( "top", aiTop ) ) + , topRight( createAnchor( "topRight", aiTopRight ) ) + , right( createAnchor( "right", aiRight ) ) + , bottom( createAnchor( "bottom", aiBottom ) ) + , bottomLeft( createAnchor( "bottomLeft", aiBottomLeft ) ) + , left( createAnchor( "left", aiLeft ) ) { topLeft->setCoords( 0, 1 ); bottomRight->setCoords( 1, 0 ); @@ -21491,7 +24492,8 @@ void QCPItemPixmap::setPixmap( const QPixmap& pixmap ) } /*! - Sets whether the pixmap will be scaled to fit the rectangle defined by the \a topLeft and \a + Sets whether the pixmap will be scaled to fit the rectangle defined by the \a + topLeft and \a bottomRight positions. */ void QCPItemPixmap::setScaled( bool scaled, Qt::AspectRatioMode aspectRatioMode ) @@ -21512,7 +24514,8 @@ void QCPItemPixmap::setPen( const QPen& pen ) } /*! - Sets the pen that will be used to draw a border around the pixmap when selected + Sets the pen that will be used to draw a border around the pixmap when + selected \see setPen, setSelected */ @@ -21589,13 +24592,18 @@ QPointF QCPItemPixmap::anchorPixelPoint( int anchorId ) const /*! \internal - Creates the buffered scaled image (\a mScaledPixmap) to fit the specified \a finalRect. The - parameters \a flipHorz and \a flipVert control whether the resulting image shall be flipped - horizontally or vertically. (This is used when \a topLeft is further to the bottom/right than \a + Creates the buffered scaled image (\a mScaledPixmap) to fit the specified \a + finalRect. The + parameters \a flipHorz and \a flipVert control whether the resulting image + shall be flipped + horizontally or vertically. (This is used when \a topLeft is further to the + bottom/right than \a bottomRight.) - This function only creates the scaled pixmap when the buffered pixmap has a different size than - the expected result, so calling this function repeatedly, e.g. in the \ref draw function, does + This function only creates the scaled pixmap when the buffered pixmap has a + different size than + the expected result, so calling this function repeatedly, e.g. in the \ref + draw function, does not cause expensive rescaling every time. If scaling is disabled, sets mScaledPixmap to a null QPixmap. @@ -21611,9 +24619,11 @@ void QCPItemPixmap::updateScaledPixmap( QRect finalRect, bool flipHorz, bool fli finalRect = getFinalRect( &flipHorz, &flipVert ); if( finalRect.size() != mScaledPixmap.size() ) { - mScaledPixmap = mPixmap.scaled( finalRect.size(), mAspectRatioMode, Qt::SmoothTransformation ); + mScaledPixmap = + mPixmap.scaled( finalRect.size(), mAspectRatioMode, Qt::SmoothTransformation ); if( flipHorz || flipVert ) - mScaledPixmap = QPixmap::fromImage( mScaledPixmap.toImage().mirrored( flipHorz, flipVert ) ); + mScaledPixmap = + QPixmap::fromImage( mScaledPixmap.toImage().mirrored( flipHorz, flipVert ) ); } } else if( !mScaledPixmap.isNull() ) @@ -21622,17 +24632,24 @@ void QCPItemPixmap::updateScaledPixmap( QRect finalRect, bool flipHorz, bool fli /*! \internal - Returns the final (tight) rect the pixmap is drawn in, depending on the current item positions + Returns the final (tight) rect the pixmap is drawn in, depending on the + current item positions and scaling settings. - The output parameters \a flippedHorz and \a flippedVert return whether the pixmap should be drawn - flipped horizontally or vertically in the returned rect. (The returned rect itself is always - normalized, i.e. the top left corner of the rect is actually further to the top/left than the - bottom right corner). This is the case when the item position \a topLeft is further to the + The output parameters \a flippedHorz and \a flippedVert return whether the + pixmap should be drawn + flipped horizontally or vertically in the returned rect. (The returned rect + itself is always + normalized, i.e. the top left corner of the rect is actually further to the + top/left than the + bottom right corner). This is the case when the item position \a topLeft is + further to the bottom/right than \a bottomRight. - If scaling is disabled, returns a rect with size of the original pixmap and the top left corner - aligned with the item position \a topLeft. The position \a bottomRight is ignored. + If scaling is disabled, returns a rect with size of the original pixmap and + the top left corner + aligned with the item position \a topLeft. The position \a bottomRight is + ignored. */ QRect QCPItemPixmap::getFinalRect( bool* flippedHorz, bool* flippedVert ) const { @@ -21676,7 +24693,8 @@ QRect QCPItemPixmap::getFinalRect( bool* flippedHorz, bool* flippedVert ) const /*! \internal - Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected + Returns the pen that should be used for drawing lines. Returns mPen when the + item is not selected and mSelectedPen when it is. */ QPen QCPItemPixmap::mainPen() const @@ -21691,31 +24709,46 @@ QPen QCPItemPixmap::mainPen() const /*! \class QCPItemTracer \brief Item that sticks to QCPGraph data points - \image html QCPItemTracer.png "Tracer example. Blue dotted circles are anchors, solid blue discs are positions." + \image html QCPItemTracer.png "Tracer example. Blue dotted circles are + anchors, solid blue discs are positions." - The tracer can be connected with a QCPGraph via \ref setGraph. Then it will automatically adopt - the coordinate axes of the graph and update its \a position to be on the graph's data. This means - the key stays controllable via \ref setGraphKey, but the value will follow the graph data. If a - QCPGraph is connected, note that setting the coordinates of the tracer item directly via \a - position will have no effect because they will be overriden in the next redraw (this is when the + The tracer can be connected with a QCPGraph via \ref setGraph. Then it will + automatically adopt + the coordinate axes of the graph and update its \a position to be on the + graph's data. This means + the key stays controllable via \ref setGraphKey, but the value will follow the + graph data. If a + QCPGraph is connected, note that setting the coordinates of the tracer item + directly via \a + position will have no effect because they will be overriden in the next redraw + (this is when the coordinate update happens). - If the specified key in \ref setGraphKey is outside the key bounds of the graph, the tracer will + If the specified key in \ref setGraphKey is outside the key bounds of the + graph, the tracer will stay at the corresponding end of the graph. - With \ref setInterpolating you may specify whether the tracer may only stay exactly on data - points or whether it interpolates data points linearly, if given a key that lies between two data + With \ref setInterpolating you may specify whether the tracer may only stay + exactly on data + points or whether it interpolates data points linearly, if given a key that + lies between two data points of the graph. - The tracer has different visual styles, see \ref setStyle. It is also possible to make the tracer - have no own visual appearance (set the style to \ref tsNone), and just connect other item + The tracer has different visual styles, see \ref setStyle. It is also possible + to make the tracer + have no own visual appearance (set the style to \ref tsNone), and just connect + other item positions to the tracer \a position (used as an anchor) via \ref QCPItemPosition::setParentAnchor. - \note The tracer position is only automatically updated upon redraws. So when the data of the - graph changes and immediately afterwards (without a redraw) the a position coordinates of the - tracer are retrieved, they will not reflect the updated data of the graph. In this case \ref - updatePosition must be called manually, prior to reading the tracer coordinates. + \note The tracer position is only automatically updated upon redraws. So when + the data of the + graph changes and immediately afterwards (without a redraw) the a position + coordinates of the + tracer are retrieved, they will not reflect the updated data of the graph. In + this case \ref + updatePosition must be called manually, prior to reading the tracer + coordinates. */ /*! @@ -21773,7 +24806,8 @@ void QCPItemTracer::setBrush( const QBrush& brush ) } /*! - Sets the brush that will be used to draw any fills of the tracer, when selected. + Sets the brush that will be used to draw any fills of the tracer, when + selected. \see setBrush, setSelected */ @@ -21783,7 +24817,8 @@ void QCPItemTracer::setSelectedBrush( const QBrush& brush ) } /*! - Sets the size of the tracer in pixels, if the style supports setting a size (e.g. \ref tsSquare + Sets the size of the tracer in pixels, if the style supports setting a size + (e.g. \ref tsSquare does, \ref tsCrosshair does not). */ void QCPItemTracer::setSize( double size ) @@ -21794,7 +24829,8 @@ void QCPItemTracer::setSize( double size ) /*! Sets the style/visual appearance of the tracer. - If you only want to use the tracer \a position as an anchor for other items, set \a style to + If you only want to use the tracer \a position as an anchor for other items, + set \a style to \ref tsNone. */ void QCPItemTracer::setStyle( QCPItemTracer::TracerStyle style ) @@ -21803,11 +24839,15 @@ void QCPItemTracer::setStyle( QCPItemTracer::TracerStyle style ) } /*! - Sets the QCPGraph this tracer sticks to. The tracer \a position will be set to type - QCPItemPosition::ptPlotCoords and the axes will be set to the axes of \a graph. + Sets the QCPGraph this tracer sticks to. The tracer \a position will be set to + type + QCPItemPosition::ptPlotCoords and the axes will be set to the axes of \a + graph. - To free the tracer from any graph, set \a graph to 0. The tracer \a position can then be placed - freely like any other item position. This is the state the tracer will assume when its graph gets + To free the tracer from any graph, set \a graph to 0. The tracer \a position + can then be placed + freely like any other item position. This is the state the tracer will assume + when its graph gets deleted while still attached to it. \see setGraphKey @@ -21833,11 +24873,14 @@ void QCPItemTracer::setGraph( QCPGraph* graph ) } /*! - Sets the key of the graph's data point the tracer will be positioned at. This is the only free + Sets the key of the graph's data point the tracer will be positioned at. This + is the only free coordinate of a tracer when attached to a graph. - Depending on \ref setInterpolating, the tracer will be either positioned on the data point - closest to \a key, or will stay exactly at \a key and interpolate the value linearly. + Depending on \ref setInterpolating, the tracer will be either positioned on + the data point + closest to \a key, or will stay exactly at \a key and interpolate the value + linearly. \see setGraph, setInterpolating */ @@ -21847,13 +24890,18 @@ void QCPItemTracer::setGraphKey( double key ) } /*! - Sets whether the value of the graph's data points shall be interpolated, when positioning the + Sets whether the value of the graph's data points shall be interpolated, when + positioning the tracer. - If \a enabled is set to false and a key is given with \ref setGraphKey, the tracer is placed on - the data point of the graph which is closest to the key, but which is not necessarily exactly - there. If \a enabled is true, the tracer will be positioned exactly at the specified key, and - the appropriate value will be interpolated from the graph's data points linearly. + If \a enabled is set to false and a key is given with \ref setGraphKey, the + tracer is placed on + the data point of the graph which is closest to the key, but which is not + necessarily exactly + there. If \a enabled is true, the tracer will be positioned exactly at the + specified key, and + the appropriate value will be interpolated from the graph's data points + linearly. \see setGraph, setGraphKey */ @@ -21878,16 +24926,19 @@ double QCPItemTracer::selectTest( const QPointF& pos, bool onlySelectable, QVari return -1; case tsPlus: { - if( clipRect().intersects( QRectF( center - QPointF( w, w ), center + QPointF( w, w ) ).toRect() ) ) - return qSqrt( qMin( distSqrToLine( center + QPointF( -w, 0 ), center + QPointF( w, 0 ), pos ), - distSqrToLine( center + QPointF( 0, -w ), center + QPointF( 0, w ), pos ) ) ); + if( clipRect().intersects( + QRectF( center - QPointF( w, w ), center + QPointF( w, w ) ).toRect() ) ) + return qSqrt( + qMin( distSqrToLine( center + QPointF( -w, 0 ), center + QPointF( w, 0 ), pos ), + distSqrToLine( center + QPointF( 0, -w ), center + QPointF( 0, w ), pos ) ) ); break; } case tsCrosshair: { - return qSqrt( - qMin( distSqrToLine( QPointF( clip.left(), center.y() ), QPointF( clip.right(), center.y() ), pos ), - distSqrToLine( QPointF( center.x(), clip.top() ), QPointF( center.x(), clip.bottom() ), pos ) ) ); + return qSqrt( qMin( distSqrToLine( QPointF( clip.left(), center.y() ), + QPointF( clip.right(), center.y() ), pos ), + distSqrToLine( QPointF( center.x(), clip.top() ), + QPointF( center.x(), clip.bottom() ), pos ) ) ); } case tsCircle: { @@ -21971,13 +25022,19 @@ void QCPItemTracer::draw( QCPPainter* painter ) } /*! - If the tracer is connected with a graph (\ref setGraph), this function updates the tracer's \a - position to reside on the graph data, depending on the configured key (\ref setGraphKey). + If the tracer is connected with a graph (\ref setGraph), this function updates + the tracer's \a + position to reside on the graph data, depending on the configured key (\ref + setGraphKey). - It is called automatically on every redraw and normally doesn't need to be called manually. One - exception is when you want to read the tracer coordinates via \a position and are not sure that - the graph's data (or the tracer key with \ref setGraphKey) hasn't changed since the last redraw. - In that situation, call this function before accessing \a position, to make sure you don't get + It is called automatically on every redraw and normally doesn't need to be + called manually. One + exception is when you want to read the tracer coordinates via \a position and + are not sure that + the graph's data (or the tracer key with \ref setGraphKey) hasn't changed + since the last redraw. + In that situation, call this function before accessing \a position, to make + sure you don't get out-of-date coordinates. If there is no graph set on this tracer, this function does nothing. @@ -22008,7 +25065,8 @@ void QCPItemTracer::updatePosition() double slope = 0; if( !qFuzzyCompare( (double)it.key(), (double)prevIt.key() ) ) slope = ( it.value().value - prevIt.value().value ) / ( it.key() - prevIt.key() ); - position->setCoords( mGraphKey, ( mGraphKey - prevIt.key() ) * slope + prevIt.value().value ); + position->setCoords( mGraphKey, + ( mGraphKey - prevIt.key() ) * slope + prevIt.value().value ); } else { @@ -22037,7 +25095,8 @@ void QCPItemTracer::updatePosition() /*! \internal - Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected + Returns the pen that should be used for drawing lines. Returns mPen when the + item is not selected and mSelectedPen when it is. */ QPen QCPItemTracer::mainPen() const @@ -22047,7 +25106,8 @@ QPen QCPItemTracer::mainPen() const /*! \internal - Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item + Returns the brush that should be used for drawing fills of the item. Returns + mBrush when the item is not selected and mSelectedBrush when it is. */ QBrush QCPItemTracer::mainBrush() const @@ -22062,20 +25122,27 @@ QBrush QCPItemTracer::mainBrush() const /*! \class QCPItemBracket \brief A bracket for referencing/highlighting certain parts in the plot. - \image html QCPItemBracket.png "Bracket example. Blue dotted circles are anchors, solid blue discs are positions." + \image html QCPItemBracket.png "Bracket example. Blue dotted circles are + anchors, solid blue discs are positions." - It has two positions, \a left and \a right, which define the span of the bracket. If \a left is - actually farther to the left than \a right, the bracket is opened to the bottom, as shown in the + It has two positions, \a left and \a right, which define the span of the + bracket. If \a left is + actually farther to the left than \a right, the bracket is opened to the + bottom, as shown in the example image. - The bracket supports multiple styles via \ref setStyle. The length, i.e. how far the bracket + The bracket supports multiple styles via \ref setStyle. The length, i.e. how + far the bracket stretches away from the embraced span, can be controlled with \ref setLength. \image html QCPItemBracket-length.png -
    Demonstrating the effect of different values for \ref setLength, for styles \ref - bsCalligraphic and \ref bsSquare. Anchors and positions are displayed for reference.
    +
    Demonstrating the effect of different values for \ref setLength, for + styles \ref + bsCalligraphic and \ref bsSquare. Anchors and positions are displayed for + reference.
    - It provides an anchor \a center, to allow connection of other items, e.g. an arrow (QCPItemLine + It provides an anchor \a center, to allow connection of other items, e.g. an + arrow (QCPItemLine or QCPItemCurve) or a text label (QCPItemText), to the bracket. */ @@ -22085,10 +25152,10 @@ QBrush QCPItemTracer::mainBrush() const The constructed item can be added to the plot with QCustomPlot::addItem. */ QCPItemBracket::QCPItemBracket( QCustomPlot* parentPlot ) - : QCPAbstractItem( parentPlot ), - left( createPosition( "left" ) ), - right( createPosition( "right" ) ), - center( createAnchor( "center", aiCenter ) ) + : QCPAbstractItem( parentPlot ) + , left( createPosition( "left" ) ) + , right( createPosition( "right" ) ) + , center( createAnchor( "center", aiCenter ) ) { left->setCoords( 0, 0 ); right->setCoords( 1, 1 ); @@ -22106,8 +25173,10 @@ QCPItemBracket::~QCPItemBracket() /*! Sets the pen that will be used to draw the bracket. - Note that when the style is \ref bsCalligraphic, only the color will be taken from the pen, the - stroke and width are ignored. To change the apparent stroke width of a calligraphic bracket, use + Note that when the style is \ref bsCalligraphic, only the color will be taken + from the pen, the + stroke and width are ignored. To change the apparent stroke width of a + calligraphic bracket, use \ref setLength, which has a similar effect. \see setSelectedPen @@ -22128,12 +25197,16 @@ void QCPItemBracket::setSelectedPen( const QPen& pen ) } /*! - Sets the \a length in pixels how far the bracket extends in the direction towards the embraced - span of the bracket (i.e. perpendicular to the left-right-direction) + Sets the \a length in pixels how far the bracket extends in the direction + towards the embraced + span of the bracket (i.e. perpendicular to the + left-right-direction) \image html QCPItemBracket-length.png -
    Demonstrating the effect of different values for \ref setLength, for styles \ref - bsCalligraphic and \ref bsSquare. Anchors and positions are displayed for reference.
    +
    Demonstrating the effect of different values for \ref setLength, for + styles \ref + bsCalligraphic and \ref bsSquare. Anchors and positions are displayed for + reference.
    */ void QCPItemBracket::setLength( double length ) { @@ -22151,7 +25224,9 @@ void QCPItemBracket::setStyle( QCPItemBracket::BracketStyle style ) } /* inherits documentation from base class */ -double QCPItemBracket::selectTest( const QPointF& pos, bool onlySelectable, QVariant* details ) const +double QCPItemBracket::selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details ) const { Q_UNUSED( details ) if( onlySelectable && !mSelectable ) @@ -22167,7 +25242,8 @@ double QCPItemBracket::selectTest( const QPointF& pos, bool onlySelectable, QVar lengthVec = lengthVec.normalized() * mLength; QVector2D centerVec = ( rightVec + leftVec ) * 0.5f - lengthVec; - return qSqrt( distSqrToLine( ( centerVec - widthVec ).toPointF(), ( centerVec + widthVec ).toPointF(), pos ) ); + return qSqrt( distSqrToLine( ( centerVec - widthVec ).toPointF(), + ( centerVec + widthVec ).toPointF(), pos ) ); } /* inherits documentation from base class */ @@ -22186,7 +25262,8 @@ void QCPItemBracket::draw( QCPPainter* painter ) QPolygon boundingPoly; boundingPoly << leftVec.toPoint() << rightVec.toPoint() << ( rightVec - lengthVec ).toPoint() << ( leftVec - lengthVec ).toPoint(); - QRect clip = clipRect().adjusted( -mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), mainPen().widthF() ); + QRect clip = clipRect().adjusted( -mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), + mainPen().widthF() ); if( clip.intersects( boundingPoly.boundingRect() ) ) { painter->setPen( mainPen() ); @@ -22194,9 +25271,12 @@ void QCPItemBracket::draw( QCPPainter* painter ) { case bsSquare: { - painter->drawLine( ( centerVec + widthVec ).toPointF(), ( centerVec - widthVec ).toPointF() ); - painter->drawLine( ( centerVec + widthVec ).toPointF(), ( centerVec + widthVec + lengthVec ).toPointF() ); - painter->drawLine( ( centerVec - widthVec ).toPointF(), ( centerVec - widthVec + lengthVec ).toPointF() ); + painter->drawLine( ( centerVec + widthVec ).toPointF(), + ( centerVec - widthVec ).toPointF() ); + painter->drawLine( ( centerVec + widthVec ).toPointF(), + ( centerVec + widthVec + lengthVec ).toPointF() ); + painter->drawLine( ( centerVec - widthVec ).toPointF(), + ( centerVec - widthVec + lengthVec ).toPointF() ); break; } case bsRound: @@ -22204,7 +25284,8 @@ void QCPItemBracket::draw( QCPPainter* painter ) painter->setBrush( Qt::NoBrush ); QPainterPath path; path.moveTo( ( centerVec + widthVec + lengthVec ).toPointF() ); - path.cubicTo( ( centerVec + widthVec ).toPointF(), ( centerVec + widthVec ).toPointF(), centerVec.toPointF() ); + path.cubicTo( ( centerVec + widthVec ).toPointF(), ( centerVec + widthVec ).toPointF(), + centerVec.toPointF() ); path.cubicTo( ( centerVec - widthVec ).toPointF(), ( centerVec - widthVec ).toPointF(), ( centerVec - widthVec + lengthVec ).toPointF() ); painter->drawPath( path ); @@ -22216,7 +25297,8 @@ void QCPItemBracket::draw( QCPPainter* painter ) QPainterPath path; path.moveTo( ( centerVec + widthVec + lengthVec ).toPointF() ); path.cubicTo( ( centerVec + widthVec - lengthVec * 0.8f ).toPointF(), - ( centerVec + 0.4f * widthVec + lengthVec ).toPointF(), centerVec.toPointF() ); + ( centerVec + 0.4f * widthVec + lengthVec ).toPointF(), + centerVec.toPointF() ); path.cubicTo( ( centerVec - 0.4f * widthVec + lengthVec ).toPointF(), ( centerVec - widthVec - lengthVec * 0.8f ).toPointF(), ( centerVec - widthVec + lengthVec ).toPointF() ); @@ -22231,7 +25313,8 @@ void QCPItemBracket::draw( QCPPainter* painter ) path.moveTo( ( centerVec + widthVec + lengthVec ).toPointF() ); path.cubicTo( ( centerVec + widthVec - lengthVec * 0.8f ).toPointF(), - ( centerVec + 0.4f * widthVec + 0.8f * lengthVec ).toPointF(), centerVec.toPointF() ); + ( centerVec + 0.4f * widthVec + 0.8f * lengthVec ).toPointF(), + centerVec.toPointF() ); path.cubicTo( ( centerVec - 0.4f * widthVec + 0.8f * lengthVec ).toPointF(), ( centerVec - widthVec - lengthVec * 0.8f ).toPointF(), ( centerVec - widthVec + lengthVec ).toPointF() ); diff --git a/app/external/qcustomplot.h b/app/external/qcustomplot.h index de6d57f..d6b5721 100644 --- a/app/external/qcustomplot.h +++ b/app/external/qcustomplot.h @@ -26,29 +26,29 @@ #ifndef QCUSTOMPLOT_H #define QCUSTOMPLOT_H -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include #include +#include +#include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include +#include #if QT_VERSION < QT_VERSION_CHECK( 5, 0, 0 ) -#include -#include #include +#include +#include #else #include #include @@ -85,7 +85,8 @@ class QCPColorScale; #endif /*! - The QCP Namespace contains general enums and QFlags used throughout the QCustomPlot library + The QCP Namespace contains general enums and QFlags used throughout the + QCustomPlot library */ namespace QCP { @@ -111,13 +112,17 @@ enum MarginSide Q_DECLARE_FLAGS( MarginSides, MarginSide ) /*! - Defines what objects of a plot can be forcibly drawn antialiased/not antialiased. If an object is - neither forcibly drawn antialiased nor forcibly drawn not antialiased, it is up to the respective - element how it is drawn. Typically it provides a \a setAntialiased function for this. + Defines what objects of a plot can be forcibly drawn antialiased/not + antialiased. If an object is + neither forcibly drawn antialiased nor forcibly drawn not antialiased, it is + up to the respective + element how it is drawn. Typically it provides a \a setAntialiased function + for this. \c AntialiasedElements is a flag of or-combined elements of this enum type. - \see QCustomPlot::setAntialiasedElements, QCustomPlot::setNotAntialiasedElements + \see QCustomPlot::setAntialiasedElements, + QCustomPlot::setNotAntialiasedElements */ enum AntialiasedElement { @@ -131,16 +136,18 @@ enum AntialiasedElement , aeLegendItems = 0x0010 ///< 0x0010 Legend items , - aePlottables = - 0x0020 ///< 0x0020 Main lines of plottables (excluding error bars, see element \ref aeErrorBars) + aePlottables = 0x0020 ///< 0x0020 Main lines of plottables (excluding + /// error bars, see element \ref aeErrorBars) , aeItems = 0x0040 ///< 0x0040 Main lines of items , - aeScatters = 0x0080 ///< 0x0080 Scatter symbols of plottables (excluding scatter symbols of type ssPixmap) + aeScatters = 0x0080 ///< 0x0080 Scatter symbols of plottables + ///(excluding scatter symbols of type ssPixmap) , aeErrorBars = 0x0100 ///< 0x0100 Error bars , - aeFills = 0x0200 ///< 0x0200 Borders of fills (e.g. under or between graphs) + aeFills = 0x0200 ///< 0x0200 Borders of fills (e.g. under or between + /// graphs) , aeZeroLine = 0x0400 ///< 0x0400 Zero-lines, see \ref QCPGrid::setZeroLinePen , @@ -151,7 +158,8 @@ enum AntialiasedElement Q_DECLARE_FLAGS( AntialiasedElements, AntialiasedElement ) /*! - Defines plotting hints that control various aspects of the quality and speed of plotting. + Defines plotting hints that control various aspects of the quality and speed + of plotting. \see QCustomPlot::setPlottingHints */ @@ -159,17 +167,20 @@ enum PlottingHint { phNone = 0x000 ///< 0x000 No hints are set , - phFastPolylines = - 0x001 ///< 0x001 Graph/Curve lines are drawn with a faster method. This reduces the quality - ///< especially of the line segment joins. (Only relevant for solid line pens.) + phFastPolylines = 0x001 ///< 0x001 Graph/Curve lines are drawn with a + /// faster method. This reduces the quality + ///< especially of the line segment joins. (Only relevant for + /// solid line pens.) , - phForceRepaint = 0x002 ///< 0x002 causes an immediate repaint() instead of a soft update() when - /// QCustomPlot::replot() is called with parameter \ref QCustomPlot::rpHint. - ///< This is set by default to prevent the plot from freezing on fast consecutive replots (e.g. user + phForceRepaint = 0x002 ///< 0x002 causes an immediate repaint() + /// instead of a soft update() when + /// QCustomPlot::replot() is called with parameter \ref QCustomPlot::rpHint. + ///< This is set by default to prevent the plot from freezing + /// on fast consecutive replots (e.g. user /// drags ranges with mouse). , - phCacheLabels = - 0x004 ///< 0x004 axis (tick) labels will be cached as pixmaps, increasing replot performance. + phCacheLabels = 0x004 ///< 0x004 axis (tick) labels will be cached as + /// pixmaps, increasing replot performance. }; Q_DECLARE_FLAGS( PlottingHints, PlottingHint ) @@ -182,35 +193,42 @@ Q_DECLARE_FLAGS( PlottingHints, PlottingHint ) */ enum Interaction { - iRangeDrag = 0x001 ///< 0x001 Axis ranges are draggable (see \ref QCPAxisRect::setRangeDrag, \ref - /// QCPAxisRect::setRangeDragAxes) + iRangeDrag = 0x001 ///< 0x001 Axis ranges are draggable (see \ref + /// QCPAxisRect::setRangeDrag, \ref + /// QCPAxisRect::setRangeDragAxes) , - iRangeZoom = 0x002 ///< 0x002 Axis ranges are zoomable with the mouse wheel (see \ref - /// QCPAxisRect::setRangeZoom, \ref QCPAxisRect::setRangeZoomAxes) + iRangeZoom = 0x002 ///< 0x002 Axis ranges are zoomable with the mouse + /// wheel (see \ref + /// QCPAxisRect::setRangeZoom, \ref QCPAxisRect::setRangeZoomAxes) , - iMultiSelect = 0x004 ///< 0x004 The user can select multiple objects by holding the modifier set by \ref - /// QCustomPlot::setMultiSelectModifier while clicking + iMultiSelect = 0x004 ///< 0x004 The user can select multiple objects + /// by holding the modifier set by \ref + /// QCustomPlot::setMultiSelectModifier while clicking , - iSelectPlottables = - 0x008 ///< 0x008 Plottables are selectable (e.g. graphs, curves, bars,... see QCPAbstractPlottable) + iSelectPlottables = 0x008 ///< 0x008 Plottables are selectable (e.g. + /// graphs, curves, bars,... see + /// QCPAbstractPlottable) , - iSelectAxes = 0x010 ///< 0x010 Axes are selectable (or parts of them, see QCPAxis::setSelectableParts) + iSelectAxes = 0x010 ///< 0x010 Axes are selectable (or parts of them, + /// see QCPAxis::setSelectableParts) , - iSelectLegend = - 0x020 ///< 0x020 Legends are selectable (or their child items, see QCPLegend::setSelectableParts) + iSelectLegend = 0x020 ///< 0x020 Legends are selectable (or their + /// child items, see QCPLegend::setSelectableParts) , - iSelectItems = - 0x040 ///< 0x040 Items are selectable (Rectangles, Arrows, Textitems, etc. see \ref QCPAbstractItem) + iSelectItems = 0x040 ///< 0x040 Items are selectable (Rectangles, + /// Arrows, Textitems, etc. see \ref QCPAbstractItem) , - iSelectOther = - 0x080 ///< 0x080 All other objects are selectable (e.g. your own derived layerables, the plot title,...) + iSelectOther = 0x080 ///< 0x080 All other objects are selectable + ///(e.g. your own derived layerables, the plot title,...) }; Q_DECLARE_FLAGS( Interactions, Interaction ) /*! \internal - Returns whether the specified \a value is considered an invalid data value for plottables (i.e. - is \e nan or \e +/-inf). This function is used to check data validity upon replots, when the + Returns whether the specified \a value is considered an invalid data value for + plottables (i.e. + is \e nan or \e +/-inf). This function is used to check data validity upon + replots, when the compiler flag \c QCUSTOMPLOT_CHECK_DATA is set. */ inline bool isInvalidData( double value ) @@ -260,7 +278,8 @@ inline void setMarginValue( QMargins& margins, QCP::MarginSide side, int value ) /*! \internal - Returns the value of the specified \a side of \a margins. If \a side is \ref QCP::msNone or + Returns the value of the specified \a side of \a margins. If \a side is \ref + QCP::msNone or \ref QCP::msAll, returns 0. \see setMarginValue @@ -297,17 +316,21 @@ class QCP_LIB_DECL QCPScatterStyle /*! Defines the shape used for scatter points. - On plottables/items that draw scatters, the sizes of these visualizations (with exception of - \ref ssDot and \ref ssPixmap) can be controlled with the \ref setSize function. Scatters are + On plottables/items that draw scatters, the sizes of these visualizations + (with exception of + \ref ssDot and \ref ssPixmap) can be controlled with the \ref setSize + function. Scatters are drawn with the pen and brush specified with \ref setPen and \ref setBrush. */ Q_ENUMS( ScatterShape ) enum ScatterShape { - ssNone ///< no scatter symbols are drawn (e.g. in QCPGraph, data only represented with lines) + ssNone ///< no scatter symbols are drawn (e.g. in QCPGraph, data only + /// represented with lines) , - ssDot ///< \enumimage{ssDot.png} a single pixel (use \ref ssDisc or \ref ssCircle if you want a round shape with a - /// certain radius) + ssDot ///< \enumimage{ssDot.png} a single pixel (use \ref ssDisc or \ref + /// ssCircle if you want a round shape with a + /// certain radius) , ssCross ///< \enumimage{ssCross.png} a cross , @@ -315,31 +338,40 @@ class QCP_LIB_DECL QCPScatterStyle , ssCircle ///< \enumimage{ssCircle.png} a circle , - ssDisc ///< \enumimage{ssDisc.png} a circle which is filled with the pen's color (not the brush as with ssCircle) + ssDisc ///< \enumimage{ssDisc.png} a circle which is filled with the pen's + /// color (not the brush as with ssCircle) , ssSquare ///< \enumimage{ssSquare.png} a square , ssDiamond ///< \enumimage{ssDiamond.png} a diamond , - ssStar ///< \enumimage{ssStar.png} a star with eight arms, i.e. a combination of cross and plus + ssStar ///< \enumimage{ssStar.png} a star with eight arms, i.e. a + /// combination of cross and plus , - ssTriangle ///< \enumimage{ssTriangle.png} an equilateral triangle, standing on baseline + ssTriangle ///< \enumimage{ssTriangle.png} an equilateral triangle, standing + /// on baseline , - ssTriangleInverted ///< \enumimage{ssTriangleInverted.png} an equilateral triangle, standing on corner + ssTriangleInverted ///< \enumimage{ssTriangleInverted.png} an equilateral + /// triangle, standing on corner , - ssCrossSquare ///< \enumimage{ssCrossSquare.png} a square with a cross inside + ssCrossSquare ///< \enumimage{ssCrossSquare.png} a square with a cross + /// inside , ssPlusSquare ///< \enumimage{ssPlusSquare.png} a square with a plus inside , - ssCrossCircle ///< \enumimage{ssCrossCircle.png} a circle with a cross inside + ssCrossCircle ///< \enumimage{ssCrossCircle.png} a circle with a cross + /// inside , ssPlusCircle ///< \enumimage{ssPlusCircle.png} a circle with a plus inside , - ssPeace ///< \enumimage{ssPeace.png} a circle, with one vertical and two downward diagonal lines + ssPeace ///< \enumimage{ssPeace.png} a circle, with one vertical and two + /// downward diagonal lines , - ssPixmap ///< a custom pixmap specified by \ref setPixmap, centered on the data point coordinates + ssPixmap ///< a custom pixmap specified by \ref setPixmap, centered on the + /// data point coordinates , - ssCustom ///< custom painter operations are performed per scatter (As QPainterPath, see \ref setCustomPath) + ssCustom ///< custom painter operations are performed per scatter (As + /// QPainterPath, see \ref setCustomPath) }; QCPScatterStyle(); @@ -394,7 +426,8 @@ class QCP_LIB_DECL QCPPainter : public QPainter Q_GADGET public: /*! - Defines special modes the painter can operate in. They disable or enable certain subsets of + Defines special modes the painter can operate in. They disable or enable + certain subsets of features/fixes/workarounds, depending on whether they are wanted on the respective output device. */ @@ -402,14 +435,18 @@ class QCP_LIB_DECL QCPPainter : public QPainter { pmDefault = 0x00 ///< 0x00 Default mode for painting on screen devices , - pmVectorized = 0x01 ///< 0x01 Mode for vectorized painting (e.g. PDF export). For example, this prevents - /// some antialiasing fixes. + pmVectorized = 0x01 ///< 0x01 Mode for vectorized painting (e.g. + /// PDF export). For example, this prevents + /// some antialiasing fixes. , - pmNoCaching = 0x02 ///< 0x02 Mode for all sorts of exports (e.g. PNG, PDF,...). For example, this prevents - /// using cached pixmap labels + pmNoCaching = 0x02 ///< 0x02 Mode for all sorts of exports (e.g. + /// PNG, PDF,...). For example, this prevents + /// using cached pixmap labels , - pmNonCosmetic = 0x04 ///< 0x04 Turns pen widths 0 to 1, i.e. disables cosmetic pens. (A cosmetic pen is - /// always drawn with width 1 pixel in the vector image/pdf viewer, independent of zoom.) + pmNonCosmetic = 0x04 ///< 0x04 Turns pen widths 0 to 1, i.e. + /// disables cosmetic pens. (A cosmetic pen is + /// always drawn with width 1 pixel in the vector image/pdf viewer, + /// independent of zoom.) }; Q_FLAGS( PainterMode PainterModes ) Q_DECLARE_FLAGS( PainterModes, PainterMode ) @@ -541,7 +578,10 @@ class QCP_LIB_DECL QCPLayerable : public QObject virtual void applyDefaultAntialiasingHint( QCPPainter* painter ) const = 0; virtual void draw( QCPPainter* painter ) = 0; // events: - virtual void selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ); + virtual void selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ); virtual void deselectEvent( bool* selectionStateChanged ); // non-property methods: @@ -708,14 +748,17 @@ class QCP_LIB_DECL QCPMarginGroup : public QObject ~QCPMarginGroup(); // non-virtual methods: - QList elements( QCP::MarginSide side ) const { return mChildren.value( side ); } + QList elements( QCP::MarginSide side ) const + { + return mChildren.value( side ); + } bool isEmpty() const; void clear(); protected: // non-property members: QCustomPlot* mParentPlot; - QHash > mChildren; + QHash> mChildren; // non-virtual methods: int commonMargin( QCP::MarginSide side ) const; @@ -742,17 +785,20 @@ class QCP_LIB_DECL QCPLayoutElement : public QCPLayerable /// \endcond public: /*! - Defines the phases of the update process, that happens just before a replot. At each phase, + Defines the phases of the update process, that happens just before a replot. + At each phase, \ref update is called with the according UpdatePhase value. */ enum UpdatePhase { - upPreparation ///< Phase used for any type of preparation that needs to be done before margin calculation and - /// layout + upPreparation ///< Phase used for any type of preparation that needs to be + /// done before margin calculation and + /// layout , upMargins ///< Phase in which the margins are calculated and set , - upLayout ///< Final phase in which the layout system places the rects of the elements + upLayout ///< Final phase in which the layout system places the rects of the + /// elements }; Q_ENUMS( UpdatePhase ) @@ -768,7 +814,10 @@ class QCP_LIB_DECL QCPLayoutElement : public QCPLayerable QCP::MarginSides autoMargins() const { return mAutoMargins; } QSize minimumSize() const { return mMinimumSize; } QSize maximumSize() const { return mMaximumSize; } - QCPMarginGroup* marginGroup( QCP::MarginSide side ) const { return mMarginGroups.value( side, (QCPMarginGroup*)0 ); } + QCPMarginGroup* marginGroup( QCP::MarginSide side ) const + { + return mMarginGroups.value( side, (QCPMarginGroup*)0 ); + } QHash marginGroups() const { return mMarginGroups; } // setters: void setOuterRect( const QRect& rect ); @@ -866,7 +915,8 @@ class QCP_LIB_DECL QCPLayoutGrid : public QCPLayout /// \cond INCLUDE_QPROPERTIES Q_PROPERTY( int rowCount READ rowCount ) Q_PROPERTY( int columnCount READ columnCount ) - Q_PROPERTY( QList columnStretchFactors READ columnStretchFactors WRITE setColumnStretchFactors ) + Q_PROPERTY( + QList columnStretchFactors READ columnStretchFactors WRITE setColumnStretchFactors ) Q_PROPERTY( QList rowStretchFactors READ rowStretchFactors WRITE setRowStretchFactors ) Q_PROPERTY( int columnSpacing READ columnSpacing WRITE setColumnSpacing ) Q_PROPERTY( int rowSpacing READ rowSpacing WRITE setRowSpacing ) @@ -911,7 +961,7 @@ class QCP_LIB_DECL QCPLayoutGrid : public QCPLayout protected: // property members: - QList > mElements; + QList> mElements; QList mColumnStretchFactors; QList mRowStretchFactors; int mColumnSpacing, mRowSpacing; @@ -929,13 +979,16 @@ class QCP_LIB_DECL QCPLayoutInset : public QCPLayout Q_OBJECT public: /*! - Defines how the placement and sizing is handled for a certain element in a QCPLayoutInset. + Defines how the placement and sizing is handled for a certain element in a + QCPLayoutInset. */ enum InsetPlacement { - ipFree ///< The element may be positioned/sized arbitrarily, see \ref setInsetRect + ipFree ///< The element may be positioned/sized arbitrarily, see \ref + /// setInsetRect , - ipBorderAligned ///< The element is aligned to one of the layout sides, see \ref setInsetAlignment + ipBorderAligned ///< The element is aligned to one of the layout sides, see + ///\ref setInsetAlignment }; explicit QCPLayoutInset(); @@ -984,11 +1037,14 @@ class QCP_LIB_DECL QCPLineEnding \image html QCPLineEnding.png - The width and length of these decorations can be controlled with the functions \ref setWidth - and \ref setLength. Some decorations like \ref esDisc, \ref esSquare, \ref esDiamond and \ref esBar only + The width and length of these decorations can be controlled with the + functions \ref setWidth + and \ref setLength. Some decorations like \ref esDisc, \ref esSquare, \ref + esDiamond and \ref esBar only support a width, the length property is ignored. - \see QCPItemLine::setHead, QCPItemLine::setTail, QCPItemCurve::setHead, QCPItemCurve::setTail, + \see QCPItemLine::setHead, QCPItemLine::setTail, QCPItemCurve::setHead, + QCPItemCurve::setTail, QCPAxis::setLowerEnding, QCPAxis::setUpperEnding */ Q_ENUMS( EndingStyle ) @@ -1010,8 +1066,9 @@ class QCP_LIB_DECL QCPLineEnding , esBar ///< A bar perpendicular to the line , - esHalfBar ///< A bar perpendicular to the line, pointing out to only one side (to which side can be changed with - ///\ref setInverted) + esHalfBar ///< A bar perpendicular to the line, pointing out to only one + /// side (to which side can be changed with + ///\ref setInverted) , esSkewedBar ///< A bar that is skewed (skew controllable via \ref setLength) }; @@ -1135,11 +1192,15 @@ class QCP_LIB_DECL QCPAxis : public QCPLayerable Q_PROPERTY( int labelPadding READ labelPadding WRITE setLabelPadding ) Q_PROPERTY( int padding READ padding WRITE setPadding ) Q_PROPERTY( int offset READ offset WRITE setOffset ) - Q_PROPERTY( SelectableParts selectedParts READ selectedParts WRITE setSelectedParts NOTIFY selectionChanged ) - Q_PROPERTY( SelectableParts selectableParts READ selectableParts WRITE setSelectableParts NOTIFY selectableChanged ) - Q_PROPERTY( QFont selectedTickLabelFont READ selectedTickLabelFont WRITE setSelectedTickLabelFont ) + Q_PROPERTY( SelectableParts selectedParts READ selectedParts WRITE setSelectedParts NOTIFY + selectionChanged ) + Q_PROPERTY( SelectableParts selectableParts READ selectableParts WRITE setSelectableParts NOTIFY + selectableChanged ) + Q_PROPERTY( + QFont selectedTickLabelFont READ selectedTickLabelFont WRITE setSelectedTickLabelFont ) Q_PROPERTY( QFont selectedLabelFont READ selectedLabelFont WRITE setSelectedLabelFont ) - Q_PROPERTY( QColor selectedTickLabelColor READ selectedTickLabelColor WRITE setSelectedTickLabelColor ) + Q_PROPERTY( + QColor selectedTickLabelColor READ selectedTickLabelColor WRITE setSelectedTickLabelColor ) Q_PROPERTY( QColor selectedLabelColor READ selectedLabelColor WRITE setSelectedLabelColor ) Q_PROPERTY( QPen selectedBasePen READ selectedBasePen WRITE setSelectedBasePen ) Q_PROPERTY( QPen selectedTickPen READ selectedTickPen WRITE setSelectedTickPen ) @@ -1150,34 +1211,43 @@ class QCP_LIB_DECL QCPAxis : public QCPLayerable /// \endcond public: /*! - Defines at which side of the axis rect the axis will appear. This also affects how the tick + Defines at which side of the axis rect the axis will appear. This also + affects how the tick marks are drawn, on which side the labels are placed etc. */ enum AxisType { - atLeft = 0x01 ///< 0x01 Axis is vertical and on the left side of the axis rect + atLeft = 0x01 ///< 0x01 Axis is vertical and on the left side of + /// the axis rect , - atRight = 0x02 ///< 0x02 Axis is vertical and on the right side of the axis rect + atRight = 0x02 ///< 0x02 Axis is vertical and on the right side of + /// the axis rect , - atTop = 0x04 ///< 0x04 Axis is horizontal and on the top side of the axis rect + atTop = 0x04 ///< 0x04 Axis is horizontal and on the top side of + /// the axis rect , - atBottom = 0x08 ///< 0x08 Axis is horizontal and on the bottom side of the axis rect + atBottom = 0x08 ///< 0x08 Axis is horizontal and on the bottom side + /// of the axis rect }; Q_FLAGS( AxisType AxisTypes ) Q_DECLARE_FLAGS( AxisTypes, AxisType ) /*! - When automatic tick label generation is enabled (\ref setAutoTickLabels), defines how the + When automatic tick label generation is enabled (\ref setAutoTickLabels), + defines how the coordinate of the tick is interpreted, i.e. translated into a string. \see setTickLabelType */ enum LabelType { - ltNumber ///< Tick coordinate is regarded as normal number and will be displayed as such. (see \ref - /// setNumberFormat) + ltNumber ///< Tick coordinate is regarded as normal number and will be + /// displayed as such. (see \ref + /// setNumberFormat) , - ltDateTime ///< Tick coordinate is regarded as a date/time (seconds since 1970-01-01T00:00:00 UTC) and will be - /// displayed and formatted as such. (for details, see \ref setDateTimeFormat) + ltDateTime ///< Tick coordinate is regarded as a date/time (seconds since + /// 1970-01-01T00:00:00 UTC) and will be + /// displayed and formatted as such. (for details, see \ref + /// setDateTimeFormat) }; Q_ENUMS( LabelType ) /*! @@ -1188,8 +1258,9 @@ class QCP_LIB_DECL QCPAxis : public QCPLayerable { stLinear ///< Linear scaling , - stLogarithmic ///< Logarithmic scaling with correspondingly transformed plots and (major) tick marks at every base - /// power (see \ref setScaleLogBase). + stLogarithmic ///< Logarithmic scaling with correspondingly transformed + /// plots and (major) tick marks at every base + /// power (see \ref setScaleLogBase). }; Q_ENUMS( ScaleType ) /*! @@ -1202,7 +1273,8 @@ class QCP_LIB_DECL QCPAxis : public QCPLayerable , spAxis = 0x001 ///< The axis backbone and tick marks , - spTickLabels = 0x002 ///< Tick labels (numbers) of this axis (as a whole, not individually) + spTickLabels = 0x002 ///< Tick labels (numbers) of this axis (as a whole, + /// not individually) , spAxisLabel = 0x004 ///< The axis label }; @@ -1385,7 +1457,8 @@ class QCP_LIB_DECL QCPAxis : public QCPLayerable double mTickStep; int mSubTickCount, mAutoTickCount; bool mAutoTicks, mAutoTickStep, mAutoSubTicks; - // int mTickLengthIn, mTickLengthOut, mSubTickLengthIn, mSubTickLengthOut; // QCPAxisPainter + // int mTickLengthIn, mTickLengthOut, mSubTickLengthIn, mSubTickLengthOut; // + // QCPAxisPainter QPen mTickPen, mSelectedTickPen; QPen mSubTickPen, mSelectedSubTickPen; // scale and range: @@ -1415,7 +1488,10 @@ class QCP_LIB_DECL QCPAxis : public QCPLayerable virtual void draw( QCPPainter* painter ); virtual QCP::Interaction selectionCategory() const; // events: - virtual void selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ); + virtual void selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ); virtual void deselectEvent( bool* selectionStateChanged ); // non-virtual methods: @@ -1465,8 +1541,9 @@ class QCPAxisPainterPrivate int tickLabelPadding; // directly accessed by QCPAxis setters/getters double tickLabelRotation; // directly accessed by QCPAxis setters/getters bool substituteExponent; - bool numberMultiplyCross; // directly accessed by QCPAxis setters/getters - int tickLengthIn, tickLengthOut, subTickLengthIn, subTickLengthOut; // directly accessed by QCPAxis setters/getters + bool numberMultiplyCross; // directly accessed by QCPAxis setters/getters + int tickLengthIn, tickLengthOut, subTickLengthIn, + subTickLengthOut; // directly accessed by QCPAxis setters/getters QPen tickPen, subTickPen; QFont tickLabelFont; QColor tickLabelColor; @@ -1492,7 +1569,8 @@ class QCPAxisPainterPrivate QFont baseFont, expFont; }; QCustomPlot* mParentPlot; - QByteArray mLabelParameterHash; // to determine whether mLabelCache needs to be cleared due to changed parameters + QByteArray mLabelParameterHash; // to determine whether mLabelCache needs to + // be cleared due to changed parameters QCache mLabelCache; QRect mAxisSelectionBox, mTickLabelsSelectionBox, mLabelSelectionBox; @@ -1503,10 +1581,15 @@ class QCPAxisPainterPrivate int distanceToAxis, const QString& text, QSize* tickLabelsSize ); - virtual void drawTickLabel( QCPPainter* painter, double x, double y, const TickLabelData& labelData ) const; + virtual void drawTickLabel( QCPPainter* painter, + double x, + double y, + const TickLabelData& labelData ) const; virtual TickLabelData getTickLabelData( const QFont& font, const QString& text ) const; virtual QPointF getTickLabelDrawOffset( const TickLabelData& labelData ) const; - virtual void getMaxTickLabelSize( const QFont& font, const QString& text, QSize* tickLabelsSize ) const; + virtual void getMaxTickLabelSize( const QFont& font, + const QString& text, + QSize* tickLabelsSize ) const; }; class QCP_LIB_DECL QCPAbstractPlottable : public QCPLayerable @@ -1558,7 +1641,9 @@ class QCP_LIB_DECL QCPAbstractPlottable : public QCPLayerable // introduced virtual methods: virtual void clearData() = 0; - virtual double selectTest( const QPointF& pos, bool onlySelectable, QVariant* details = 0 ) const = 0; + virtual double selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details = 0 ) const = 0; virtual bool addToLegend(); virtual bool removeFromLegend() const; @@ -1573,7 +1658,8 @@ class QCP_LIB_DECL QCPAbstractPlottable : public QCPLayerable protected: /*! - Represents negative and positive sign domain for passing to \ref getKeyRange and \ref getValueRange. + Represents negative and positive sign domain for passing to \ref getKeyRange + and \ref getValueRange. */ enum SignDomain { @@ -1598,7 +1684,10 @@ class QCP_LIB_DECL QCPAbstractPlottable : public QCPLayerable virtual QCP::Interaction selectionCategory() const; void applyDefaultAntialiasingHint( QCPPainter* painter ) const; // events: - virtual void selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ); + virtual void selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ); virtual void deselectEvent( bool* selectionStateChanged ); // introduced virtual methods: @@ -1629,7 +1718,10 @@ class QCP_LIB_DECL QCPAbstractPlottable : public QCPLayerable class QCP_LIB_DECL QCPItemAnchor { public: - QCPItemAnchor( QCustomPlot* parentPlot, QCPAbstractItem* parentItem, const QString name, int anchorId = -1 ); + QCPItemAnchor( QCustomPlot* parentPlot, + QCPAbstractItem* parentItem, + const QString name, + int anchorId = -1 ); virtual ~QCPItemAnchor(); // getters: @@ -1650,7 +1742,8 @@ class QCP_LIB_DECL QCPItemAnchor virtual QCPItemPosition* toQCPItemPosition() { return 0; } // non-virtual methods: void addChild( QCPItemPosition* pos ); // called from pos when this anchor is set as parent - void removeChild( QCPItemPosition* pos ); // called from pos when its parent anchor is reset or pos deleted + void removeChild( QCPItemPosition* pos ); // called from pos when its parent + // anchor is reset or pos deleted private: Q_DISABLE_COPY( QCPItemAnchor ) @@ -1662,29 +1755,37 @@ class QCP_LIB_DECL QCPItemPosition : public QCPItemAnchor { public: /*! - Defines the ways an item position can be specified. Thus it defines what the numbers passed to + Defines the ways an item position can be specified. Thus it defines what the + numbers passed to \ref setCoords actually mean. \see setType */ enum PositionType { - ptAbsolute ///< Static positioning in pixels, starting from the top left corner of the viewport/widget. + ptAbsolute ///< Static positioning in pixels, starting from the top left + /// corner of the viewport/widget. , - ptViewportRatio ///< Static positioning given by a fraction of the viewport size. For example, if you call - /// setCoords(0, 0), the position will be at the top - ///< left corner of the viewport/widget. setCoords(1, 1) will be at the bottom right corner, setCoords(0.5, 0) will + ptViewportRatio ///< Static positioning given by a fraction of the viewport + /// size. For example, if you call + /// setCoords(0, 0), the position will be at the top + ///< left corner of the viewport/widget. setCoords(1, 1) will be at the + /// bottom right corner, setCoords(0.5, 0) will /// be horizontally centered and ///< vertically at the top of the viewport/widget, etc. , - ptAxisRectRatio ///< Static positioning given by a fraction of the axis rect size (see \ref setAxisRect). For - /// example, if you call setCoords(0, 0), the position will be at the top - ///< left corner of the axis rect. setCoords(1, 1) will be at the bottom right corner, setCoords(0.5, 0) will be + ptAxisRectRatio ///< Static positioning given by a fraction of the axis rect + /// size (see \ref setAxisRect). For + /// example, if you call setCoords(0, 0), the position will be at the top + ///< left corner of the axis rect. setCoords(1, 1) will be at the bottom + /// right corner, setCoords(0.5, 0) will be /// horizontally centered and - ///< vertically at the top of the axis rect, etc. You can also go beyond the axis rect by providing negative + ///< vertically at the top of the axis rect, etc. You can also go beyond the + /// axis rect by providing negative /// coordinates or coordinates larger than 1. , - ptPlotCoords ///< Dynamic positioning at a plot coordinate defined by two axes (see \ref setAxes). + ptPlotCoords ///< Dynamic positioning at a plot coordinate defined by two + /// axes (see \ref setAxes). }; QCPItemPosition( QCustomPlot* parentPlot, QCPAbstractItem* parentItem, const QString name ); @@ -1749,7 +1850,9 @@ class QCP_LIB_DECL QCPAbstractItem : public QCPLayerable Q_SLOT void setSelected( bool selected ); // reimplemented virtual methods: - virtual double selectTest( const QPointF& pos, bool onlySelectable, QVariant* details = 0 ) const = 0; + virtual double selectTest( const QPointF& pos, + bool onlySelectable, + QVariant* details = 0 ) const = 0; // non-virtual methods: QList positions() const { return mPositions; } @@ -1776,7 +1879,10 @@ class QCP_LIB_DECL QCPAbstractItem : public QCPLayerable virtual void applyDefaultAntialiasingHint( QCPPainter* painter ) const; virtual void draw( QCPPainter* painter ) = 0; // events: - virtual void selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ); + virtual void selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ); virtual void deselectEvent( bool* selectionStateChanged ); // introduced virtual methods: @@ -1802,12 +1908,15 @@ class QCP_LIB_DECL QCustomPlot : public QWidget Q_PROPERTY( QRect viewport READ viewport WRITE setViewport ) Q_PROPERTY( QPixmap background READ background WRITE setBackground ) Q_PROPERTY( bool backgroundScaled READ backgroundScaled WRITE setBackgroundScaled ) - Q_PROPERTY( Qt::AspectRatioMode backgroundScaledMode READ backgroundScaledMode WRITE setBackgroundScaledMode ) + Q_PROPERTY( Qt::AspectRatioMode backgroundScaledMode READ backgroundScaledMode WRITE + setBackgroundScaledMode ) Q_PROPERTY( QCPLayoutGrid* plotLayout READ plotLayout ) - Q_PROPERTY( bool autoAddPlottableToLegend READ autoAddPlottableToLegend WRITE setAutoAddPlottableToLegend ) + Q_PROPERTY( bool autoAddPlottableToLegend READ autoAddPlottableToLegend WRITE + setAutoAddPlottableToLegend ) Q_PROPERTY( int selectionTolerance READ selectionTolerance WRITE setSelectionTolerance ) Q_PROPERTY( bool noAntialiasingOnDrag READ noAntialiasingOnDrag WRITE setNoAntialiasingOnDrag ) - Q_PROPERTY( Qt::KeyboardModifier multiSelectModifier READ multiSelectModifier WRITE setMultiSelectModifier ) + Q_PROPERTY( Qt::KeyboardModifier multiSelectModifier READ multiSelectModifier WRITE + setMultiSelectModifier ) /// \endcond public: /*! @@ -1824,19 +1933,23 @@ class QCP_LIB_DECL QCustomPlot : public QWidget Q_ENUMS( LayerInsertMode ) /*! - Defines with what timing the QCustomPlot surface is refreshed after a replot. + Defines with what timing the QCustomPlot surface is refreshed after a + replot. \see replot */ enum RefreshPriority { - rpImmediate ///< The QCustomPlot surface is immediately refreshed, by calling QWidget::repaint() after the replot + rpImmediate ///< The QCustomPlot surface is immediately refreshed, by + /// calling QWidget::repaint() after the replot , - rpQueued ///< Queues the refresh such that it is performed at a slightly delayed point in time after the replot, by - /// calling QWidget::update() after the replot + rpQueued ///< Queues the refresh such that it is performed at a slightly + /// delayed point in time after the replot, by + /// calling QWidget::update() after the replot , - rpHint ///< Whether to use immediate repaint or queued update depends on whether the plotting hint \ref - /// QCP::phForceRepaint is set, see \ref setPlottingHints. + rpHint ///< Whether to use immediate repaint or queued update depends on + /// whether the plotting hint \ref + /// QCP::phForceRepaint is set, see \ref setPlottingHints. }; explicit QCustomPlot( QWidget* parent = 0 ); @@ -1859,14 +1972,17 @@ class QCP_LIB_DECL QCustomPlot : public QWidget // setters: void setViewport( const QRect& rect ); void setBackground( const QPixmap& pm ); - void setBackground( const QPixmap& pm, bool scaled, Qt::AspectRatioMode mode = Qt::KeepAspectRatioByExpanding ); + void setBackground( const QPixmap& pm, + bool scaled, + Qt::AspectRatioMode mode = Qt::KeepAspectRatioByExpanding ); void setBackground( const QBrush& brush ); void setBackgroundScaled( bool scaled ); void setBackgroundScaledMode( Qt::AspectRatioMode mode ); void setAntialiasedElements( const QCP::AntialiasedElements& antialiasedElements ); void setAntialiasedElement( QCP::AntialiasedElement antialiasedElement, bool enabled = true ); void setNotAntialiasedElements( const QCP::AntialiasedElements& notAntialiasedElements ); - void setNotAntialiasedElement( QCP::AntialiasedElement notAntialiasedElement, bool enabled = true ); + void setNotAntialiasedElement( QCP::AntialiasedElement notAntialiasedElement, + bool enabled = true ); void setAutoAddPlottableToLegend( bool on ); void setInteractions( const QCP::Interactions& interactions ); void setInteraction( const QCP::Interaction& interaction, bool enabled = true ); @@ -1918,7 +2034,9 @@ class QCP_LIB_DECL QCustomPlot : public QWidget bool setCurrentLayer( const QString& name ); bool setCurrentLayer( QCPLayer* layer ); int layerCount() const; - bool addLayer( const QString& name, QCPLayer* otherLayer = 0, LayerInsertMode insertMode = limAbove ); + bool addLayer( const QString& name, + QCPLayer* otherLayer = 0, + LayerInsertMode insertMode = limAbove ); bool removeLayer( QCPLayer* layer ); bool moveLayer( QCPLayer* layer, QCPLayer* otherLayer, LayerInsertMode insertMode = limAbove ); @@ -1939,8 +2057,16 @@ class QCP_LIB_DECL QCustomPlot : public QWidget int height = 0, const QString& pdfCreator = "", const QString& pdfTitle = "" ); - bool savePng( const QString& fileName, int width = 0, int height = 0, double scale = 1.0, int quality = -1 ); - bool saveJpg( const QString& fileName, int width = 0, int height = 0, double scale = 1.0, int quality = -1 ); + bool savePng( const QString& fileName, + int width = 0, + int height = 0, + double scale = 1.0, + int quality = -1 ); + bool saveJpg( const QString& fileName, + int width = 0, + int height = 0, + double scale = 1.0, + int quality = -1 ); bool saveBmp( const QString& fileName, int width = 0, int height = 0, double scale = 1.0 ); bool saveRastered( const QString& fileName, int width, @@ -1983,7 +2109,8 @@ class QCP_LIB_DECL QCustomPlot : public QWidget QCPLayoutGrid* mPlotLayout; bool mAutoAddPlottableToLegend; QList mPlottables; - QList mGraphs; // extra list of plottables also in mPlottables that are of type QCPGraph + QList mGraphs; // extra list of plottables also in mPlottables + // that are of type QCPGraph QList mItems; QList mLayers; QCP::AntialiasedElements mAntialiasedElements, mNotAntialiasedElements; @@ -2023,7 +2150,9 @@ class QCP_LIB_DECL QCustomPlot : public QWidget // non-virtual methods: void updateLayerIndices() const; - QCPLayerable* layerableAt( const QPointF& pos, bool onlySelectable, QVariant* selectionDetails = 0 ) const; + QCPLayerable* layerableAt( const QPointF& pos, + bool onlySelectable, + QVariant* selectionDetails = 0 ) const; void drawBackground( QCPPainter* painter ); friend class QCPLegend; @@ -2037,7 +2166,8 @@ class QCP_LIB_DECL QCPColorGradient Q_GADGET public: /*! - Defines the color spaces in which color interpolation between gradient stops can be performed. + Defines the color spaces in which color interpolation between gradient stops + can be performed. \see setColorInterpolation */ @@ -2045,46 +2175,59 @@ class QCP_LIB_DECL QCPColorGradient { ciRGB ///< Color channels red, green and blue are linearly interpolated , - ciHSV ///< Color channels hue, saturation and value are linearly interpolated (The hue is interpolated over the - /// shortest angle distance) + ciHSV ///< Color channels hue, saturation and value are linearly + /// interpolated (The hue is interpolated over the + /// shortest angle distance) }; Q_ENUMS( ColorInterpolation ) /*! - Defines the available presets that can be loaded with \ref loadPreset. See the documentation + Defines the available presets that can be loaded with \ref loadPreset. See + the documentation there for an image of the presets. */ enum GradientPreset { - gpGrayscale ///< Continuous lightness from black to white (suited for non-biased data representation) + gpGrayscale ///< Continuous lightness from black to white (suited for + /// non-biased data representation) , - gpHot ///< Continuous lightness from black over firey colors to white (suited for non-biased data representation) + gpHot ///< Continuous lightness from black over firey colors to white + ///(suited for non-biased data representation) , - gpCold ///< Continuous lightness from black over icey colors to white (suited for non-biased data representation) + gpCold ///< Continuous lightness from black over icey colors to white + ///(suited for non-biased data representation) , - gpNight ///< Continuous lightness from black over weak blueish colors to white (suited for non-biased data - /// representation) + gpNight ///< Continuous lightness from black over weak blueish colors to + /// white (suited for non-biased data + /// representation) , gpCandy ///< Blue over pink to white , - gpGeography ///< Colors suitable to represent different elevations on geographical maps + gpGeography ///< Colors suitable to represent different elevations on + /// geographical maps , - gpIon ///< Half hue spectrum from black over purple to blue and finally green (creates banding illusion but allows - /// more precise magnitude estimates) + gpIon ///< Half hue spectrum from black over purple to blue and finally + /// green (creates banding illusion but allows + /// more precise magnitude estimates) , - gpThermal ///< Colors suitable for thermal imaging, ranging from dark blue over purple to orange, yellow and white + gpThermal ///< Colors suitable for thermal imaging, ranging from dark blue + /// over purple to orange, yellow and white , - gpPolar ///< Colors suitable to emphasize polarity around the center, with blue for negative, black in the middle - /// and red for positive values + gpPolar ///< Colors suitable to emphasize polarity around the center, with + /// blue for negative, black in the middle + /// and red for positive values , - gpSpectrum ///< An approximation of the visible light spectrum (creates banding illusion but allows more precise - /// magnitude estimates) + gpSpectrum ///< An approximation of the visible light spectrum (creates + /// banding illusion but allows more precise + /// magnitude estimates) , - gpJet ///< Hue variation similar to a spectrum, often used in numerical visualization (creates banding illusion but - /// allows more precise magnitude estimates) + gpJet ///< Hue variation similar to a spectrum, often used in numerical + /// visualization (creates banding illusion but + /// allows more precise magnitude estimates) , - gpHues ///< Full hue cycle, with highest and lowest color red (suitable for periodic data, such as angles and - /// phases, see \ref setPeriodic) + gpHues ///< Full hue cycle, with highest and lowest color red (suitable for + /// periodic data, such as angles and + /// phases, see \ref setPeriodic) }; Q_ENUMS( GradientPreset ) @@ -2135,7 +2278,8 @@ class QCP_LIB_DECL QCPAxisRect : public QCPLayoutElement /// \cond INCLUDE_QPROPERTIES Q_PROPERTY( QPixmap background READ background WRITE setBackground ) Q_PROPERTY( bool backgroundScaled READ backgroundScaled WRITE setBackgroundScaled ) - Q_PROPERTY( Qt::AspectRatioMode backgroundScaledMode READ backgroundScaledMode WRITE setBackgroundScaledMode ) + Q_PROPERTY( Qt::AspectRatioMode backgroundScaledMode READ backgroundScaledMode WRITE + setBackgroundScaledMode ) Q_PROPERTY( Qt::Orientations rangeDrag READ rangeDrag WRITE setRangeDrag ) Q_PROPERTY( Qt::Orientations rangeZoom READ rangeZoom WRITE setRangeZoom ) /// \endcond @@ -2155,7 +2299,9 @@ class QCP_LIB_DECL QCPAxisRect : public QCPLayoutElement // setters: void setBackground( const QPixmap& pm ); - void setBackground( const QPixmap& pm, bool scaled, Qt::AspectRatioMode mode = Qt::KeepAspectRatioByExpanding ); + void setBackground( const QPixmap& pm, + bool scaled, + Qt::AspectRatioMode mode = Qt::KeepAspectRatioByExpanding ); void setBackground( const QBrush& brush ); void setBackgroundScaled( bool scaled ); void setBackgroundScaledMode( Qt::AspectRatioMode mode ); @@ -2213,7 +2359,7 @@ class QCP_LIB_DECL QCPAxisRect : public QCPLayoutElement QCP::AntialiasedElements mAADragBackup, mNotAADragBackup; QPoint mDragStart; bool mDragging; - QHash > mAxes; + QHash> mAxes; // reimplemented virtual methods: virtual void applyDefaultAntialiasingHint( QCPPainter* painter ) const; @@ -2288,7 +2434,10 @@ class QCP_LIB_DECL QCPAbstractLegendItem : public QCPLayoutElement virtual QRect clipRect() const; virtual void draw( QCPPainter* painter ) = 0; // events: - virtual void selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ); + virtual void selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ); virtual void deselectEvent( bool* selectionStateChanged ); private: @@ -2330,8 +2479,10 @@ class QCP_LIB_DECL QCPLegend : public QCPLayoutGrid Q_PROPERTY( QSize iconSize READ iconSize WRITE setIconSize ) Q_PROPERTY( int iconTextPadding READ iconTextPadding WRITE setIconTextPadding ) Q_PROPERTY( QPen iconBorderPen READ iconBorderPen WRITE setIconBorderPen ) - Q_PROPERTY( SelectableParts selectableParts READ selectableParts WRITE setSelectableParts NOTIFY selectionChanged ) - Q_PROPERTY( SelectableParts selectedParts READ selectedParts WRITE setSelectedParts NOTIFY selectableChanged ) + Q_PROPERTY( SelectableParts selectableParts READ selectableParts WRITE setSelectableParts NOTIFY + selectionChanged ) + Q_PROPERTY( SelectableParts selectedParts READ selectedParts WRITE setSelectedParts NOTIFY + selectableChanged ) Q_PROPERTY( QPen selectedBorderPen READ selectedBorderPen WRITE setSelectedBorderPen ) Q_PROPERTY( QPen selectedIconBorderPen READ selectedIconBorderPen WRITE setSelectedIconBorderPen ) Q_PROPERTY( QBrush selectedBrush READ selectedBrush WRITE setSelectedBrush ) @@ -2350,7 +2501,8 @@ class QCP_LIB_DECL QCPLegend : public QCPLayoutGrid , spLegendBox = 0x001 ///< 0x001 The legend box (frame) , - spItems = 0x002 ///< 0x002 Legend items individually (see \ref selectedItems) + spItems = 0x002 ///< 0x002 Legend items individually (see \ref + /// selectedItems) }; Q_FLAGS( SelectablePart SelectableParts ) Q_DECLARE_FLAGS( SelectableParts, SelectablePart ) @@ -2429,7 +2581,10 @@ class QCP_LIB_DECL QCPLegend : public QCPLayoutGrid virtual void applyDefaultAntialiasingHint( QCPPainter* painter ) const; virtual void draw( QCPPainter* painter ); // events: - virtual void selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ); + virtual void selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ); virtual void deselectEvent( bool* selectionStateChanged ); // non-virtual methods: @@ -2501,7 +2656,10 @@ class QCP_LIB_DECL QCPPlotTitle : public QCPLayoutElement virtual QSize minimumSizeHint() const; virtual QSize maximumSizeHint() const; // events: - virtual void selectEvent( QMouseEvent* event, bool additive, const QVariant& details, bool* selectionStateChanged ); + virtual void selectEvent( QMouseEvent* event, + bool additive, + const QVariant& details, + bool* selectionStateChanged ); virtual void deselectEvent( bool* selectionStateChanged ); // non-virtual methods: @@ -2522,7 +2680,8 @@ class QCPColorScaleAxisRectPrivate : public QCPAxisRect QCPColorScale* mParentColorScale; QImage mGradientImage; bool mGradientImageInvalidated; - // re-using some methods of QCPAxisRect to make them available to friend class QCPColorScale + // re-using some methods of QCPAxisRect to make them available to friend class + // QCPColorScale using QCPAxisRect::calculateAutoMargin; using QCPAxisRect::mousePressEvent; using QCPAxisRect::mouseMoveEvent; @@ -2542,7 +2701,8 @@ class QCP_LIB_DECL QCPColorScale : public QCPLayoutElement /// \cond INCLUDE_QPROPERTIES Q_PROPERTY( QCPAxis::AxisType type READ type WRITE setType ) Q_PROPERTY( QCPRange dataRange READ dataRange WRITE setDataRange NOTIFY dataRangeChanged ) - Q_PROPERTY( QCPAxis::ScaleType dataScaleType READ dataScaleType WRITE setDataScaleType NOTIFY dataScaleTypeChanged ) + Q_PROPERTY( QCPAxis::ScaleType dataScaleType READ dataScaleType WRITE setDataScaleType NOTIFY + dataScaleTypeChanged ) Q_PROPERTY( QCPColorGradient gradient READ gradient WRITE setGradient NOTIFY gradientChanged ) Q_PROPERTY( QString label READ label WRITE setLabel ) Q_PROPERTY( int barWidth READ barWidth WRITE setBarWidth ) @@ -2651,25 +2811,31 @@ class QCP_LIB_DECL QCPGraph : public QCPAbstractPlottable /// \endcond public: /*! - Defines how the graph's line is represented visually in the plot. The line is drawn with the + Defines how the graph's line is represented visually in the plot. The line + is drawn with the current pen of the graph (\ref setPen). \see setLineStyle */ enum LineStyle { - lsNone ///< data points are not connected with any lines (e.g. data only represented - ///< with symbols according to the scatter style, see \ref setScatterStyle) + lsNone ///< data points are not connected with any lines (e.g. data only + /// represented + ///< with symbols according to the scatter style, see \ref setScatterStyle) , lsLine ///< data points are connected by a straight line , - lsStepLeft ///< line is drawn as steps where the step height is the value of the left data point + lsStepLeft ///< line is drawn as steps where the step height is the value of + /// the left data point , - lsStepRight ///< line is drawn as steps where the step height is the value of the right data point + lsStepRight ///< line is drawn as steps where the step height is the value + /// of the right data point , - lsStepCenter ///< line is drawn as steps where the step is in between two data points + lsStepCenter ///< line is drawn as steps where the step is in between two + /// data points , - lsImpulse ///< each data point is represented by a line parallel to the value axis, which reaches from the data - /// point to the zero-value-line + lsImpulse ///< each data point is represented by a line parallel to the + /// value axis, which reaches from the data + /// point to the zero-value-line }; Q_ENUMS( LineStyle ) /*! @@ -2683,7 +2849,8 @@ class QCP_LIB_DECL QCPGraph : public QCPAbstractPlottable , etValue ///< Error bars for the value dimension of the data point are shown , - etBoth ///< Error bars for both key and value dimensions of the data point are shown + etBoth ///< Error bars for both key and value dimensions of the data point + /// are shown }; Q_ENUMS( ErrorType ) @@ -2703,12 +2870,16 @@ class QCP_LIB_DECL QCPGraph : public QCPAbstractPlottable // setters: void setData( QCPDataMap* data, bool copy = false ); void setData( const QVector& key, const QVector& value ); - void setDataKeyError( const QVector& key, const QVector& value, const QVector& keyError ); + void setDataKeyError( const QVector& key, + const QVector& value, + const QVector& keyError ); void setDataKeyError( const QVector& key, const QVector& value, const QVector& keyErrorMinus, const QVector& keyErrorPlus ); - void setDataValueError( const QVector& key, const QVector& value, const QVector& valueError ); + void setDataValueError( const QVector& key, + const QVector& value, + const QVector& valueError ); void setDataValueError( const QVector& key, const QVector& value, const QVector& valueErrorMinus, @@ -2748,9 +2919,12 @@ class QCP_LIB_DECL QCPGraph : public QCPAbstractPlottable using QCPAbstractPlottable::rescaleAxes; using QCPAbstractPlottable::rescaleKeyAxis; using QCPAbstractPlottable::rescaleValueAxis; - void rescaleAxes( bool onlyEnlarge, bool includeErrorBars ) const; // overloads base class interface - void rescaleKeyAxis( bool onlyEnlarge, bool includeErrorBars ) const; // overloads base class interface - void rescaleValueAxis( bool onlyEnlarge, bool includeErrorBars ) const; // overloads base class interface + void rescaleAxes( bool onlyEnlarge, + bool includeErrorBars ) const; // overloads base class interface + void rescaleKeyAxis( bool onlyEnlarge, + bool includeErrorBars ) const; // overloads base class interface + void rescaleValueAxis( bool onlyEnlarge, + bool includeErrorBars ) const; // overloads base class interface protected: // property members: @@ -2789,10 +2963,12 @@ class QCP_LIB_DECL QCPGraph : public QCPAbstractPlottable void getLinePlotData( QVector* linePixelData, QVector* scatterData ) const; void getStepLeftPlotData( QVector* linePixelData, QVector* scatterData ) const; void getStepRightPlotData( QVector* linePixelData, QVector* scatterData ) const; - void getStepCenterPlotData( QVector* linePixelData, QVector* scatterData ) const; + void getStepCenterPlotData( QVector* linePixelData, + QVector* scatterData ) const; void getImpulsePlotData( QVector* linePixelData, QVector* scatterData ) const; void drawError( QCPPainter* painter, double x, double y, const QCPData& data ) const; - void getVisibleDataBounds( QCPDataMap::const_iterator& lower, QCPDataMap::const_iterator& upper ) const; + void getVisibleDataBounds( QCPDataMap::const_iterator& lower, + QCPDataMap::const_iterator& upper ) const; int countDataInBounds( const QCPDataMap::const_iterator& lower, const QCPDataMap::const_iterator& upper, int maxCount ) const; @@ -2823,7 +2999,8 @@ class QCP_LIB_DECL QCPCurveData Q_DECLARE_TYPEINFO( QCPCurveData, Q_MOVABLE_TYPE ); /*! \typedef QCPCurveDataMap - Container for storing QCPCurveData items in a sorted fashion. The key of the map + Container for storing QCPCurveData items in a sorted fashion. The key of the + map is the t member of the QCPCurveData instance. This is the container in which QCPCurve holds its data. @@ -2843,7 +3020,8 @@ class QCP_LIB_DECL QCPCurve : public QCPAbstractPlottable /// \endcond public: /*! - Defines how the curve's line is represented visually in the plot. The line is drawn with the + Defines how the curve's line is represented visually in the plot. The line + is drawn with the current pen of the curve (\ref setPen). \see setLineStyle */ @@ -2862,7 +3040,9 @@ class QCP_LIB_DECL QCPCurve : public QCPAbstractPlottable LineStyle lineStyle() const { return mLineStyle; } // setters: void setData( QCPCurveDataMap* data, bool copy = false ); - void setData( const QVector& t, const QVector& key, const QVector& value ); + void setData( const QVector& t, + const QVector& key, + const QVector& value ); void setData( const QVector& key, const QVector& value ); void setScatterStyle( const QCPScatterStyle& style ); void setLineStyle( LineStyle style ); @@ -2872,7 +3052,9 @@ class QCP_LIB_DECL QCPCurve : public QCPAbstractPlottable void addData( const QCPCurveData& data ); void addData( double t, double key, double value ); void addData( double key, double value ); - void addData( const QVector& ts, const QVector& keys, const QVector& values ); + void addData( const QVector& ts, + const QVector& keys, + const QVector& values ); void removeDataBefore( double t ); void removeDataAfter( double t ); void removeData( double fromt, double tot ); @@ -3032,7 +3214,12 @@ class QCP_LIB_DECL QCPStatisticalBox : public QCPAbstractPlottable void setUpperQuartile( double value ); void setMaximum( double value ); void setOutliers( const QVector& values ); - void setData( double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum ); + void setData( double key, + double minimum, + double lowerQuartile, + double median, + double upperQuartile, + double maximum ); void setWidth( double width ); void setWhiskerWidth( double width ); void setWhiskerPen( const QPen& pen ); @@ -3072,7 +3259,10 @@ class QCP_LIB_DECL QCPStatisticalBox : public QCPAbstractPlottable class QCP_LIB_DECL QCPColorMapData { public: - QCPColorMapData( int keySize, int valueSize, const QCPRange& keyRange, const QCPRange& valueRange ); + QCPColorMapData( int keySize, + int valueSize, + const QCPRange& keyRange, + const QCPRange& valueRange ); ~QCPColorMapData(); QCPColorMapData( const QCPColorMapData& other ); QCPColorMapData& operator=( const QCPColorMapData& other ); @@ -3122,7 +3312,8 @@ class QCP_LIB_DECL QCPColorMap : public QCPAbstractPlottable Q_OBJECT /// \cond INCLUDE_QPROPERTIES Q_PROPERTY( QCPRange dataRange READ dataRange WRITE setDataRange NOTIFY dataRangeChanged ) - Q_PROPERTY( QCPAxis::ScaleType dataScaleType READ dataScaleType WRITE setDataScaleType NOTIFY dataScaleTypeChanged ) + Q_PROPERTY( QCPAxis::ScaleType dataScaleType READ dataScaleType WRITE setDataScaleType NOTIFY + dataScaleTypeChanged ) Q_PROPERTY( QCPColorGradient gradient READ gradient WRITE setGradient NOTIFY gradientChanged ) Q_PROPERTY( bool interpolate READ interpolate WRITE setInterpolate ) Q_PROPERTY( bool tightBoundary READ tightBoundary WRITE setTightBoundary ) @@ -3222,8 +3413,12 @@ class QCP_LIB_DECL QCPItemStraightLine : public QCPAbstractItem virtual void draw( QCPPainter* painter ); // non-virtual methods: - double distToStraightLine( const QVector2D& point1, const QVector2D& vec, const QVector2D& point ) const; - QLineF getRectClippedStraightLine( const QVector2D& point1, const QVector2D& vec, const QRect& rect ) const; + double distToStraightLine( const QVector2D& point1, + const QVector2D& vec, + const QVector2D& point ) const; + QLineF getRectClippedStraightLine( const QVector2D& point1, + const QVector2D& vec, + const QRect& rect ) const; QPen mainPen() const; }; @@ -3266,7 +3461,9 @@ class QCP_LIB_DECL QCPItemLine : public QCPAbstractItem virtual void draw( QCPPainter* painter ); // non-virtual methods: - QLineF getRectClippedLine( const QVector2D& start, const QVector2D& end, const QRect& rect ) const; + QLineF getRectClippedLine( const QVector2D& start, + const QVector2D& end, + const QRect& rect ) const; QPen mainPen() const; }; @@ -3467,7 +3664,9 @@ class QCP_LIB_DECL QCPItemText : public QCPAbstractItem virtual QPointF anchorPixelPoint( int anchorId ) const; // non-virtual methods: - QPointF getTextDrawPoint( const QPointF& pos, const QRectF& rect, Qt::Alignment positionAlignment ) const; + QPointF getTextDrawPoint( const QPointF& pos, + const QRectF& rect, + Qt::Alignment positionAlignment ) const; QFont mainFont() const; QColor mainColor() const; QPen mainPen() const; @@ -3601,7 +3800,9 @@ class QCP_LIB_DECL QCPItemPixmap : public QCPAbstractItem virtual QPointF anchorPixelPoint( int anchorId ) const; // non-virtual methods: - void updateScaledPixmap( QRect finalRect = QRect(), bool flipHorz = false, bool flipVert = false ); + void updateScaledPixmap( QRect finalRect = QRect(), + bool flipHorz = false, + bool flipVert = false ); QRect getFinalRect( bool* flippedHorz = 0, bool* flippedVert = 0 ) const; QPen mainPen() const; }; @@ -3622,7 +3823,8 @@ class QCP_LIB_DECL QCPItemTracer : public QCPAbstractItem /// \endcond public: /*! - The different visual appearances a tracer item can have. Some styles size may be controlled with \ref setSize. + The different visual appearances a tracer item can have. Some styles size + may be controlled with \ref setSize. \see setStyle */ @@ -3708,7 +3910,8 @@ class QCP_LIB_DECL QCPItemBracket : public QCPAbstractItem , bsCurly ///< A curly brace , - bsCalligraphic ///< A curly brace with varying stroke width giving a calligraphic impression + bsCalligraphic ///< A curly brace with varying stroke width giving a + /// calligraphic impression }; QCPItemBracket( QCustomPlot* parentPlot ); diff --git a/app/main.cpp b/app/main.cpp index ad6191a..7a3d9db 100644 --- a/app/main.cpp +++ b/app/main.cpp @@ -22,12 +22,12 @@ * \brief main file */ +#include "ConfigureFormatDialog.h" +#include "PlaYUVerApp.h" +#include "PlaYUVerAppDefs.h" +#include "VideoSubWindow.h" #include "config.h" #include -#include "PlaYUVerAppDefs.h" -#include "PlaYUVerApp.h" -#include "VideoSubWindow.h" -#include "ConfigureFormatDialog.h" #ifdef USE_QTDBUS #include "PlaYUVerAppAdaptor.h" #endif @@ -74,16 +74,17 @@ int main( int argc, char* argv[] ) bool foundRunningService = false; if( !force_new ) { - QDBusReply there = sessionBusInterface->isServiceRegistered( PLAYUVER_DBUS_SESSION_NAME ); + QDBusReply there = + sessionBusInterface->isServiceRegistered( PLAYUVER_DBUS_SESSION_NAME ); foundRunningService = there.isValid() && there.value(); } if( foundRunningService ) { // open given session - QDBusMessage m = - QDBusMessage::createMethodCall( PLAYUVER_DBUS_SESSION_NAME, QStringLiteral( PLAYUVER_DBUS_PATH ), - QStringLiteral( PLAYUVER_DBUS_SESSION_NAME ), QStringLiteral( "activate" ) ); + QDBusMessage m = QDBusMessage::createMethodCall( + PLAYUVER_DBUS_SESSION_NAME, QStringLiteral( PLAYUVER_DBUS_PATH ), + QStringLiteral( PLAYUVER_DBUS_SESSION_NAME ), QStringLiteral( "activate" ) ); QDBusConnection::sessionBus().call( m ); @@ -120,7 +121,8 @@ int main( int argc, char* argv[] ) } } } - // this will wait until exiting is emitted by the used instance, if wanted... + // this will wait until exiting is emitted by the used instance, if + // wanted... return needToBlock ? application.exec() : 0; } } @@ -138,8 +140,9 @@ int main( int argc, char* argv[] ) } #ifdef USE_FERVOR - FvUpdater::sharedUpdater()->SetFeedURL( "http://192.168.96.201/share/PlaYUVerProject/PlaYUVerUpdate-" UPDATE_CHANNEL - ".xml" ); + FvUpdater::sharedUpdater()->SetFeedURL( + "http://192.168.96.201/share/PlaYUVerProject/" + "PlaYUVerUpdate-" UPDATE_CHANNEL ".xml" ); FvUpdater::sharedUpdater()->SetDependencies( "ALL" ); #endif diff --git a/lib/PlaYUVerDefs.h b/lib/PlaYUVerDefs.h index c2e4951..f3bbaeb 100644 --- a/lib/PlaYUVerDefs.h +++ b/lib/PlaYUVerDefs.h @@ -82,10 +82,14 @@ typedef UChar Byte; // Limits definition // ==================================================================================================================== -// #define MAX_UINT 0xFFFFFFFFU ///< max. value of unsigned 32-bit integer -// #define MAX_INT 2147483647 ///< max. value of signed 32-bit integer -// #define MAX_INT64 0x7FFFFFFFFFFFFFFFLL ///< max. value of signed 64-bit integer -// #define MAX_DOUBLE 1.7e+308 ///< max. value of double-type value +// #define MAX_UINT 0xFFFFFFFFU ///< max. value of unsigned +// 32-bit integer +// #define MAX_INT 2147483647 ///< max. value of signed +// 32-bit integer +// #define MAX_INT64 0x7FFFFFFFFFFFFFFFLL ///< max. value of +// signed 64-bit integer +// #define MAX_DOUBLE 1.7e+308 ///< max. value of +// double-type value // ==================================================================================================================== // PlaYUVer definitions @@ -139,7 +143,8 @@ struct PlaYUVerFailure : public std::exception String m_class_name; String m_error_msg; PlaYUVerFailure( String error_msg ) throw() : m_error_msg( error_msg ) {} - PlaYUVerFailure( String class_name, String error_msg ) throw() : m_class_name( class_name ), m_error_msg( error_msg ) + PlaYUVerFailure( String class_name, String error_msg ) throw() + : m_class_name( class_name ), m_error_msg( error_msg ) { } ~PlaYUVerFailure() throw() {} diff --git a/lib/PlaYUVerFrame.cpp b/lib/PlaYUVerFrame.cpp index 2c1d7f9..3a1c13e 100644 --- a/lib/PlaYUVerFrame.cpp +++ b/lib/PlaYUVerFrame.cpp @@ -22,8 +22,8 @@ * \brief Video Frame handling */ -#include "config.h" #include "PlaYUVerFrame.h" +#include "config.h" #include #ifdef USE_OPENCV @@ -75,12 +75,18 @@ Int PlaYUVerFrame::findPixelFormat( const String& name ) return -1; } -static Int getImgMemory( Pel**** array3D, Int dim1, Int dim2, Int log2ChromaHeight, Int log2ChromaWidth ) +static Int getImgMemory( Pel**** array3D, + Int dim1, + Int dim2, + Int log2ChromaHeight, + Int log2ChromaWidth ) { Int dim0 = 3; Int i; UInt64 total_mem_size = 0; - UInt64 mem_size = ( dim1 * dim2 + CHROMASHIFT( dim1, log2ChromaHeight ) * CHROMASHIFT( dim2, log2ChromaWidth ) * 2 ); + UInt64 mem_size = + ( dim1 * dim2 + + CHROMASHIFT( dim1, log2ChromaHeight ) * CHROMASHIFT( dim2, log2ChromaWidth ) * 2 ); total_mem_size += getMem2D( array3D, dim0, dim1 ); @@ -130,7 +136,8 @@ struct PlaYUVerFramePrivate UInt m_uiWidth; //!< Width of the frame UInt m_uiHeight; //!< Height of the frame - Int m_iPixelFormat; //!< Pixel format number (it follows the list of supported pixel formats) + Int m_iPixelFormat; //!< Pixel format number (it follows the list of supported + //! pixel formats) Int m_iNumberChannels; //!< Number of channels UInt m_uiBitsPel; //!< Bits per pixel/channel // Int m_iEndianness; //!< Endiannes of bytes @@ -215,7 +222,8 @@ struct PlaYUVerFramePrivate * \brief Constructors */ -PlaYUVerFrame::PlaYUVerFrame( UInt width, UInt height, Int pelFormat, Int bitsPixel ) : d( new PlaYUVerFramePrivate ) +PlaYUVerFrame::PlaYUVerFrame( UInt width, UInt height, Int pelFormat, Int bitsPixel ) + : d( new PlaYUVerFramePrivate ) { d->init( width, height, pelFormat, bitsPixel ); } @@ -238,7 +246,8 @@ PlaYUVerFrame::PlaYUVerFrame( const PlaYUVerFrame* other ) : d( new PlaYUVerFram PlaYUVerFrame::PlaYUVerFrame( const PlaYUVerFrame& other, UInt x, UInt y, UInt width, UInt height ) : d( new PlaYUVerFramePrivate ) { - const PlaYUVerPixFmtDescriptor* pcPelFormat = &( g_PlaYUVerPixFmtDescriptorsList[other.getPelFormat()] ); + const PlaYUVerPixFmtDescriptor* pcPelFormat = + &( g_PlaYUVerPixFmtDescriptorsList[other.getPelFormat()] ); if( pcPelFormat->log2ChromaWidth ) { if( x % ( 1 << pcPelFormat->log2ChromaWidth ) ) @@ -260,13 +269,18 @@ PlaYUVerFrame::PlaYUVerFrame( const PlaYUVerFrame& other, UInt x, UInt y, UInt w copyFrom( other, x, y ); } -PlaYUVerFrame::PlaYUVerFrame( const PlaYUVerFrame* other, UInt posX, UInt posY, UInt areaWidth, UInt areaHeight ) +PlaYUVerFrame::PlaYUVerFrame( const PlaYUVerFrame* other, + UInt posX, + UInt posY, + UInt areaWidth, + UInt areaHeight ) : d( new PlaYUVerFramePrivate ) { if( !other ) return; - const PlaYUVerPixFmtDescriptor* pcPelFormat = &( g_PlaYUVerPixFmtDescriptorsList[other->getPelFormat()] ); + const PlaYUVerPixFmtDescriptor* pcPelFormat = + &( g_PlaYUVerPixFmtDescriptorsList[other->getPelFormat()] ); if( pcPelFormat->log2ChromaWidth ) { if( posX % ( 1 << pcPelFormat->log2ChromaWidth ) ) @@ -320,7 +334,8 @@ Bool PlaYUVerFrame::haveSameFmt( const PlaYUVerFrame& other, UInt match ) const if( match & MATCH_BITS ) bRet &= ( getBitsPel() == other.getBitsPel() ); if( match & MATCH_COLOR_SPACE_IGNORE_GRAY ) - bRet &= ( getColorSpace() == PlaYUVerPixel::COLOR_GRAY || getColorSpace() == other.getColorSpace() ); + bRet &= ( getColorSpace() == PlaYUVerPixel::COLOR_GRAY || + getColorSpace() == other.getColorSpace() ); return bRet; } @@ -407,15 +422,18 @@ UInt64 PlaYUVerFrame::getBytesPerFrame() return getBytesPerFrame( d->m_uiWidth, d->m_uiHeight, d->m_iPixelFormat, d->m_uiBitsPel ); } -UInt64 PlaYUVerFrame::getBytesPerFrame( UInt uiWidth, UInt uiHeight, Int iPixelFormat, UInt bitsPixel ) +UInt64 PlaYUVerFrame::getBytesPerFrame( UInt uiWidth, + UInt uiHeight, + Int iPixelFormat, + UInt bitsPixel ) { const PlaYUVerPixFmtDescriptor* pcPelFormat = &( g_PlaYUVerPixFmtDescriptorsList[iPixelFormat] ); UInt bytesPerPixel = ( bitsPixel - 1 ) / 8 + 1; UInt64 numberBytes = uiWidth * uiHeight; if( pcPelFormat->numberChannels > 1 ) { - UInt64 numberBytesChroma = - CHROMASHIFT( uiWidth, pcPelFormat->log2ChromaWidth ) * CHROMASHIFT( uiHeight, pcPelFormat->log2ChromaHeight ); + UInt64 numberBytesChroma = CHROMASHIFT( uiWidth, pcPelFormat->log2ChromaWidth ) * + CHROMASHIFT( uiHeight, pcPelFormat->log2ChromaHeight ); numberBytes += ( pcPelFormat->numberChannels - 1 ) * numberBytesChroma; } return numberBytes * bytesPerPixel; @@ -432,7 +450,8 @@ Void PlaYUVerFrame::clear() ratioW = ch > 0 ? d->m_pcPelFormat->log2ChromaWidth : 0; ratioH = ch > 0 ? d->m_pcPelFormat->log2ChromaHeight : 0; pPel = d->m_pppcInputPel[ch][0]; - for( i = 0; i < CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ); i++ ) + for( i = 0; i < CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ); + i++ ) { *pPel++ = uiValue; } @@ -480,7 +499,9 @@ PlaYUVerPixel PlaYUVerFrame::getPixelValue( Int xPos, Int yPos ) return PixelValue; } -PlaYUVerPixel PlaYUVerFrame::getPixelValue( Int xPos, Int yPos, PlaYUVerPixel::ColorSpace eColorSpace ) +PlaYUVerPixel PlaYUVerFrame::getPixelValue( Int xPos, + Int yPos, + PlaYUVerPixel::ColorSpace eColorSpace ) { PlaYUVerPixel PixelValue( d->m_pcPelFormat->colorSpace ); for( UInt ch = 0; ch < d->m_pcPelFormat->numberChannels; ch++ ) @@ -511,7 +532,8 @@ Void PlaYUVerFrame::copyFrom( const PlaYUVerFrame& other ) return; d->m_bHasRGBPel = false; d->m_bHasHistogram = false; - memcpy( *d->m_pppcInputPel[LUMA], other.getPelBufferYUV()[LUMA][0], getBytesPerFrame() * sizeof( Pel ) ); + memcpy( *d->m_pppcInputPel[LUMA], other.getPelBufferYUV()[LUMA][0], + getBytesPerFrame() * sizeof( Pel ) ); } Void PlaYUVerFrame::copyFrom( const PlaYUVerFrame* other ) @@ -579,7 +601,9 @@ Void PlaYUVerFrame::frameFromBuffer( Byte* Buff, Int iEndianness ) { ratioW = i > 1 ? d->m_pcPelFormat->log2ChromaWidth : 0; ratioH = i > 1 ? d->m_pcPelFormat->log2ChromaHeight : 0; - ppBuff[i] = ppBuff[i - 1] + CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ) * bytesPixel; + ppBuff[i] = + ppBuff[i - 1] + + CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ) * bytesPixel; } for( ch = 0; ch < d->m_pcPelFormat->numberChannels; ch++ ) @@ -589,16 +613,19 @@ Void PlaYUVerFrame::frameFromBuffer( Byte* Buff, Int iEndianness ) step = d->m_pcPelFormat->comp[ch].step_minus1; pPel = d->m_pppcInputPel[ch][0]; - pTmpBuff = ppBuff[d->m_pcPelFormat->comp[ch].plane] + ( d->m_pcPelFormat->comp[ch].offset_plus1 - 1 ); + pTmpBuff = + ppBuff[d->m_pcPelFormat->comp[ch].plane] + ( d->m_pcPelFormat->comp[ch].offset_plus1 - 1 ); - for( i = 0; i < CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ); i++ ) + for( i = 0; i < CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ); + i++ ) { *pPel = 0; for( b = startByte; b != endByte; b += incByte ) { *pPel += *pTmpBuff << ( b * 8 ); pTmpBuff++; - // Check max value and bound it to "maxval" to prevent segfault when calculating histogram + // Check max value and bound it to "maxval" to prevent segfault when + // calculating histogram if( *pPel > maxval ) *pPel = 0; // ----- @@ -636,7 +663,9 @@ Void PlaYUVerFrame::frameToBuffer( Byte* output_buffer, Int iEndianness ) { ratioW = i > 1 ? d->m_pcPelFormat->log2ChromaWidth : 0; ratioH = i > 1 ? d->m_pcPelFormat->log2ChromaHeight : 0; - ppBuff[i] = ppBuff[i - 1] + CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ) * bytesPixel; + ppBuff[i] = + ppBuff[i - 1] + + CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ) * bytesPixel; } for( ch = 0; ch < d->m_pcPelFormat->numberChannels; ch++ ) @@ -648,7 +677,8 @@ Void PlaYUVerFrame::frameToBuffer( Byte* output_buffer, Int iEndianness ) pTmpPel = d->m_pppcInputPel[ch][0]; pTmpBuff = ppBuff[d->m_pcPelFormat->comp[ch].plane]; - for( i = 0; i < CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ); i++ ) + for( i = 0; i < CHROMASHIFT( d->m_uiHeight, ratioH ) * CHROMASHIFT( d->m_uiWidth, ratioW ); + i++ ) { for( b = startByte; b != endByte; b += incByte ) { @@ -810,7 +840,8 @@ Void PlaYUVerFrame::calcHistogram() } if( ( colorSpace == PlaYUVerPixel::COLOR_RGB || colorSpace == PlaYUVerPixel::COLOR_ARGB ) ) { - PlaYUVerPixel currPixel( colorSpace, *( data[COLOR_R] ), *( data[COLOR_G] ), *( data[COLOR_B] ) ); + PlaYUVerPixel currPixel( colorSpace, *( data[COLOR_R] ), *( data[COLOR_G] ), + *( data[COLOR_B] ) ); luma = currPixel.ConvertPixel( PlaYUVerPixel::COLOR_YUV ).Y(); d->m_puiHistogram[luma + j * d->m_uiHistoSegments]++; } @@ -858,7 +889,8 @@ Int getRealHistoChannel( Int colorSpace, Int channel ) } break; case PlaYUVerPixel::COLOR_ARGB: - if( channel != COLOR_R && channel != COLOR_G && channel != COLOR_B && channel != COLOR_A && channel != LUMA ) + if( channel != COLOR_R && channel != COLOR_G && channel != COLOR_B && channel != COLOR_A && + channel != LUMA ) { return -1; } @@ -1392,7 +1424,8 @@ float compute_ssim( Pel** refImg, cur_distortion /= (float)win_cnt; - if( cur_distortion >= 1.0 && cur_distortion < 1.01 ) // avoid float accuracy problem at very low QP(e.g.2) + if( cur_distortion >= 1.0 && + cur_distortion < 1.01 ) // avoid float accuracy problem at very low QP(e.g.2) cur_distortion = 1.0; return cur_distortion; @@ -1403,13 +1436,13 @@ Double PlaYUVerFrame::getSSIM( PlaYUVerFrame* Org, Int component ) Double dSSIM = 1; if( component == LUMA ) { - dSSIM = compute_ssim( d->m_pppcInputPel[component], Org->getPelBufferYUV()[component], d->m_uiWidth, d->m_uiHeight, - 8, 8, 255, 8 ); + dSSIM = compute_ssim( d->m_pppcInputPel[component], Org->getPelBufferYUV()[component], + d->m_uiWidth, d->m_uiHeight, 8, 8, 255, 8 ); } else { - dSSIM = compute_ssim( d->m_pppcInputPel[component], Org->getPelBufferYUV()[component], getChromaWidth(), - getChromaHeight(), 4, 4, 255, 8 ); + dSSIM = compute_ssim( d->m_pppcInputPel[component], Org->getPelBufferYUV()[component], + getChromaWidth(), getChromaHeight(), 4, 4, 255, 8 ); } return dSSIM; } diff --git a/lib/PlaYUVerFramePixelFormats.cpp b/lib/PlaYUVerFramePixelFormats.cpp index f0d2d6d..6e652f6 100644 --- a/lib/PlaYUVerFramePixelFormats.cpp +++ b/lib/PlaYUVerFramePixelFormats.cpp @@ -22,13 +22,13 @@ * \brief Handling the pixel formats definition */ -#include "config.h" #include "PlaYUVerFramePixelFormats.h" +#include "config.h" #ifdef USE_SSE #include -#include #include +#include #endif #include "LibMemory.h" @@ -199,112 +199,112 @@ Void fillARGB32bufferYUV420p( Pel*** in, UChar* out, UInt width, UInt height, UI } #endif -const PlaYUVerPixFmtDescriptor g_PlaYUVerPixFmtDescriptorsList[PlaYUVerFrame::NUMBER_PEL_FORMATS] = { - { - "YUV420p", - PlaYUVerPixel::COLOR_YUV, - 3, - 3, - 1, - 1, - ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_YUV420P ), - { - {0, 0, 1}, /* Y */ - {1, 0, 1}, /* U */ - {2, 0, 1}, /* V */ - }, - }, - { - "YUV422p", - PlaYUVerPixel::COLOR_YUV, - 3, - 3, - 1, - 0, - ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_YUV422P ), - { - {0, 0, 1}, /* Y */ - {1, 0, 1}, /* U */ - {2, 0, 1}, /* V */ - }, - }, - { - "YUV444p", - PlaYUVerPixel::COLOR_YUV, - 3, - 3, - 0, - 0, - ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_YUV444P ), - { - {0, 0, 1}, /* Y */ - {1, 0, 1}, /* U */ - {2, 0, 1}, /* V */ - }, - }, - { - "YUYV422", - PlaYUVerPixel::COLOR_YUV, - 3, - 1, - 1, - 0, - ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_YUYV422 ), - { - {0, 1, 1}, /* Y */ - {0, 3, 2}, /* U */ - {0, 3, 4}, /* V */ - }, - }, - { - "GRAY", - PlaYUVerPixel::COLOR_GRAY, - 1, - 1, - 0, - 0, - ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_GRAY8 ), - {{0, 0, 1}}, /* Y */ - }, - { - "RGBp", - PlaYUVerPixel::COLOR_RGB, - 3, - 3, - 0, - 0, - ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_RGB24 ), - { - {0, 0, 1}, /* R */ - {1, 0, 1}, /* G */ - {2, 0, 1}, /* B */ - }, - }, - { - "RGB", - PlaYUVerPixel::COLOR_RGB, - 3, - 1, - 0, - 0, - ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_RGB24 ), - { - {0, 2, 1}, /* R */ - {0, 2, 2}, /* G */ - {0, 2, 3}, /* B */ - }, - }, - { - "BGR", - PlaYUVerPixel::COLOR_RGB, - 3, - 1, - 0, - 0, - ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_BGR24 ), - { - {0, 2, 3}, /* B */ - {0, 2, 2}, /* R */ - {0, 2, 1}, /* G */ - }, - }}; +const PlaYUVerPixFmtDescriptor g_PlaYUVerPixFmtDescriptorsList[PlaYUVerFrame::NUMBER_PEL_FORMATS] = + {{ + "YUV420p", + PlaYUVerPixel::COLOR_YUV, + 3, + 3, + 1, + 1, + ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_YUV420P ), + { + {0, 0, 1}, /* Y */ + {1, 0, 1}, /* U */ + {2, 0, 1}, /* V */ + }, + }, + { + "YUV422p", + PlaYUVerPixel::COLOR_YUV, + 3, + 3, + 1, + 0, + ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_YUV422P ), + { + {0, 0, 1}, /* Y */ + {1, 0, 1}, /* U */ + {2, 0, 1}, /* V */ + }, + }, + { + "YUV444p", + PlaYUVerPixel::COLOR_YUV, + 3, + 3, + 0, + 0, + ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_YUV444P ), + { + {0, 0, 1}, /* Y */ + {1, 0, 1}, /* U */ + {2, 0, 1}, /* V */ + }, + }, + { + "YUYV422", + PlaYUVerPixel::COLOR_YUV, + 3, + 1, + 1, + 0, + ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_YUYV422 ), + { + {0, 1, 1}, /* Y */ + {0, 3, 2}, /* U */ + {0, 3, 4}, /* V */ + }, + }, + { + "GRAY", + PlaYUVerPixel::COLOR_GRAY, + 1, + 1, + 0, + 0, + ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_GRAY8 ), + {{0, 0, 1}}, /* Y */ + }, + { + "RGBp", + PlaYUVerPixel::COLOR_RGB, + 3, + 3, + 0, + 0, + ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_RGB24 ), + { + {0, 0, 1}, /* R */ + {1, 0, 1}, /* G */ + {2, 0, 1}, /* B */ + }, + }, + { + "RGB", + PlaYUVerPixel::COLOR_RGB, + 3, + 1, + 0, + 0, + ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_RGB24 ), + { + {0, 2, 1}, /* R */ + {0, 2, 2}, /* G */ + {0, 2, 3}, /* B */ + }, + }, + { + "BGR", + PlaYUVerPixel::COLOR_RGB, + 3, + 1, + 0, + 0, + ADD_FFMPEG_PEL_FMT( AV_PIX_FMT_BGR24 ), + { + {0, 2, 3}, /* B */ + {0, 2, 2}, /* R */ + {0, 2, 1}, /* G */ + }, + }}; diff --git a/lib/PlaYUVerFramePixelFormats.h b/lib/PlaYUVerFramePixelFormats.h index b8c6471..1a57ffa 100644 --- a/lib/PlaYUVerFramePixelFormats.h +++ b/lib/PlaYUVerFramePixelFormats.h @@ -26,14 +26,15 @@ #define __PLAYUVERFRAMEPIXELFORMATS_H__ #include "PlaYUVerDefs.h" -#include "PlaYUVerPixel.h" #include "PlaYUVerFrame.h" +#include "PlaYUVerPixel.h" #define CHROMA_RESAMPLING( X ) ( ( ( X + 1 ) >> 1 ) << 1 ) #define CHROMARATIO( SIZE, RATIO ) ( RATIO > 1 ? ( ( SIZE + 1 ) / RATIO ) : SIZE ) -#define PEL_RGB( r, g, b ) ( 0xffu << 24 ) | ( ( r & 0xff ) << 16 ) | ( ( g & 0xff ) << 8 ) | ( b & 0xff ) +#define PEL_RGB( r, g, b ) \ + ( 0xffu << 24 ) | ( ( r & 0xff ) << 16 ) | ( ( g & 0xff ) << 8 ) | ( b & 0xff ) typedef struct PlaYUVerComponentDescriptor { diff --git a/lib/PlaYUVerOptions.cpp b/lib/PlaYUVerOptions.cpp index f3d47f6..d5158dc 100644 --- a/lib/PlaYUVerOptions.cpp +++ b/lib/PlaYUVerOptions.cpp @@ -36,11 +36,11 @@ * \brief Options handler */ -#include "config.h" #include "PlaYUVerOptions.h" +#include "config.h" -#include #include +#include #include "lib/PlaYUVerModuleIf.h" #include "modules/PlaYUVerModuleFactory.h" @@ -60,7 +60,10 @@ struct ParseFailure : public std::exception class BoolOption : public OptionBase { public: - BoolOption( const String& name, const String& desc ) : OptionBase( name, desc ) { is_binary = true; } + BoolOption( const String& name, const String& desc ) : OptionBase( name, desc ) + { + is_binary = true; + } void parse( const String& arg ) { arg_count++; } }; @@ -101,7 +104,7 @@ inline void StandardOption::parse( const String& arg ) } template <> -inline void StandardOption >::parse( const String& arg ) +inline void StandardOption>::parse( const String& arg ) { UInt aux_opt_storage; std::istringstream arg_ss( arg, std::istringstream::in ); @@ -119,7 +122,7 @@ inline void StandardOption >::parse( const String& arg ) } template <> -inline void StandardOption >::parse( const String& arg ) +inline void StandardOption>::parse( const String& arg ) { Int aux_opt_storage; std::istringstream arg_ss( arg, std::istringstream::in ); @@ -146,7 +149,7 @@ inline void StandardOption::parse( const String& arg ) /* string vector parsing is specialized */ template <> -inline void StandardOption >::parse( const String& arg ) +inline void StandardOption>::parse( const String& arg ) { opt_storage.push_back( arg ); arg_count++; @@ -201,11 +204,21 @@ PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, T& storage, co return *this; } -template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, Bool& storage, const String& desc ); -template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, UInt& storage, const String& desc ); -template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, Int& storage, const String& desc ); -template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, Int64& storage, const String& desc ); -template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, String& storage, const String& desc ); +template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, + Bool& storage, + const String& desc ); +template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, + UInt& storage, + const String& desc ); +template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, + Int& storage, + const String& desc ); +template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, + Int64& storage, + const String& desc ); +template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, + String& storage, + const String& desc ); template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, std::vector& storage, const String& desc ); @@ -223,7 +236,8 @@ template PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, * FunctionOption::Func is called. It is upto this function to correctly * handle evaluating the option's value. */ -// PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, FunctionOption::Func *func, const String& desc ) +// PlaYUVerOptions& PlaYUVerOptions::operator()( const String& name, +// FunctionOption::Func *func, const String& desc ) // { // addOption( new FunctionOption( name, parent, func, desc ) ); // return *this; @@ -335,7 +349,10 @@ static void setOptions( PlaYUVerOptions::OptionsList& opt_list, const string& va } } -Bool PlaYUVerOptions::storePair( Bool allow_long, Bool allow_short, const string& name, const string& value ) +Bool PlaYUVerOptions::storePair( Bool allow_long, + Bool allow_short, + const string& name, + const string& value ) { bool found = false; PlaYUVerOptions::OptionMap::iterator opt_it; @@ -646,7 +663,8 @@ Void PlaYUVerOptions::doHelp( ostream& out, UInt columns ) line << opt_desc.substr( cur_pos ); break; } - /* find a suitable point to split text (avoid spliting in middle of word) */ + /* find a suitable point to split text (avoid spliting in middle of word) + */ size_t split_pos = opt_desc.find_last_of( ' ', cur_pos + desc_width ); if( split_pos != string::npos ) { diff --git a/lib/PlaYUVerOptions.h b/lib/PlaYUVerOptions.h index ac7db10..a508e5a 100644 --- a/lib/PlaYUVerOptions.h +++ b/lib/PlaYUVerOptions.h @@ -51,7 +51,10 @@ class OptionBase { public: - OptionBase( const String& name, const String& desc ) : arg_count( 0 ), opt_string( name ), opt_desc( desc ) {} + OptionBase( const String& name, const String& desc ) + : arg_count( 0 ), opt_string( name ), opt_desc( desc ) + { + } virtual ~OptionBase() {} /* parse argument arg, to obtain a value for the option */ virtual void parse( const String& arg ) = 0; @@ -125,7 +128,8 @@ class PlaYUVerOptions * handle evaluating the option's value. */ // PlaYUVerOptions& - // operator()( const String& name, OptionFunc::Func *func, const String& desc ); + // operator()( const String& name, OptionFunc::Func *func, const String& + // desc ); Bool checkListingOpts(); Void listModules(); diff --git a/lib/PlaYUVerPixel.cpp b/lib/PlaYUVerPixel.cpp index aca4381..1599e6c 100644 --- a/lib/PlaYUVerPixel.cpp +++ b/lib/PlaYUVerPixel.cpp @@ -22,10 +22,10 @@ * \brief Pixel handling */ -#include -#include -#include "PlaYUVerFrame.h" #include "PlaYUVerPixel.h" +#include "PlaYUVerFrame.h" +#include +#include PlaYUVerPixel::PlaYUVerPixel() : m_iColorSpace( COLOR_INVALID ) { diff --git a/lib/PlaYUVerPixel.h b/lib/PlaYUVerPixel.h index 5e2200d..21fb00c 100644 --- a/lib/PlaYUVerPixel.h +++ b/lib/PlaYUVerPixel.h @@ -25,13 +25,18 @@ #ifndef __PLAYUVERPIXEL_H__ #define __PLAYUVERPIXEL_H__ -#include -#include -#include -#include #include "PlaYUVerDefs.h" +#include +#include +#include +#include -static inline Void YuvToRgb( const Int& iY, const Int& iU, const Int& iV, Int& iR, Int& iG, Int& iB ) +static inline Void YuvToRgb( const Int& iY, + const Int& iU, + const Int& iV, + Int& iR, + Int& iG, + Int& iB ) { iR = iY + ( ( 1436 * ( iV - 128 ) ) >> 10 ); iG = iY - ( ( 352 * ( iU - 128 ) + 731 * ( iV - 128 ) ) >> 10 ); @@ -41,7 +46,12 @@ static inline Void YuvToRgb( const Int& iY, const Int& iU, const Int& iV, Int& i iB = iB < 0 ? 0 : iB > 255 ? 255 : iB; } -static inline Void rgbToYuv( const Int& iR, const Int& iG, const Int& iB, Int& iY, Int& iU, Int& iV ) +static inline Void rgbToYuv( const Int& iR, + const Int& iG, + const Int& iB, + Int& iY, + Int& iU, + Int& iV ) { iY = ( 299 * iR + 587 * iG + 114 * iB + 500 ) / 1000; iU = ( 1000 * ( iB - iY ) + 226816 ) / 1772; diff --git a/lib/PlaYUVerStream.cpp b/lib/PlaYUVerStream.cpp index d233d1d..0e2109b 100644 --- a/lib/PlaYUVerStream.cpp +++ b/lib/PlaYUVerStream.cpp @@ -23,8 +23,8 @@ */ // Self -#include "config.h" #include "PlaYUVerStream.h" +#include "config.h" // System #include @@ -33,8 +33,8 @@ #include "LibMemory.h" #include "PlaYUVerFrame.h" #include "PlaYUVerStreamHandlerIf.h" -#include "StreamHandlerRaw.h" #include "StreamHandlerPortableMap.h" +#include "StreamHandlerRaw.h" #ifdef USE_FFMPEG #include "StreamHandlerLibav.h" #endif @@ -120,7 +120,8 @@ CreateStreamHandlerFn PlaYUVerStream::findStreamHandler( String strFilename, boo { return supportedFmts[i].formatFct; } - // else if( strFilename.find( supportedFmts[i].formatExt ) != String::npos ) + // else if( strFilename.find( supportedFmts[i].formatExt ) != + // String::npos ) // { // return supportedFmts[i].formatFct; // } @@ -182,7 +183,8 @@ Bool PlaYUVerStream::open( String filename, } for( UInt i = 0; i < PlaYUVerFrame::supportedPixelFormatListNames().size(); i++ ) { - if( lowercase( PlaYUVerFrame::supportedPixelFormatListNames()[i] ) == lowercase( input_format_name ) ) + if( lowercase( PlaYUVerFrame::supportedPixelFormatListNames()[i] ) == + lowercase( input_format_name ) ) { input_format = i; break; @@ -237,7 +239,8 @@ Bool PlaYUVerStream::open( String filename, return m_bInit; } - if( m_pcHandler->m_uiWidth <= 0 || m_pcHandler->m_uiHeight <= 0 || m_pcHandler->m_iPixelFormat < 0 ) + if( m_pcHandler->m_uiWidth <= 0 || m_pcHandler->m_uiHeight <= 0 || + m_pcHandler->m_iPixelFormat < 0 ) { close(); throw PlaYUVerFailure( "PlaYUVerStream", "Incorrect configuration" ); @@ -251,8 +254,9 @@ Bool PlaYUVerStream::open( String filename, { try { - m_ppcFrameBuffer[i] = new PlaYUVerFrame( m_pcHandler->m_uiWidth, m_pcHandler->m_uiHeight, - m_pcHandler->m_iPixelFormat, m_pcHandler->m_uiBitsPerPixel ); + m_ppcFrameBuffer[i] = + new PlaYUVerFrame( m_pcHandler->m_uiWidth, m_pcHandler->m_uiHeight, + m_pcHandler->m_iPixelFormat, m_pcHandler->m_uiBitsPerPixel ); } catch( PlaYUVerFailure& e ) { @@ -304,8 +308,9 @@ Bool PlaYUVerStream::reload() m_pcHandler->setBytesPerFrame( m_pcCurrFrame->getBytesPerFrame() ); m_uiTotalFrameNum = m_pcHandler->calculateFrameNumber(); - if( m_pcHandler->m_uiWidth <= 0 || m_pcHandler->m_uiHeight <= 0 || m_pcHandler->m_iPixelFormat < 0 || - m_pcHandler->m_uiBitsPerPixel == 0 || m_uiTotalFrameNum < 1 ) + if( m_pcHandler->m_uiWidth <= 0 || m_pcHandler->m_uiHeight <= 0 || + m_pcHandler->m_iPixelFormat < 0 || m_pcHandler->m_uiBitsPerPixel == 0 || + m_uiTotalFrameNum < 1 ) { return false; } @@ -421,8 +426,9 @@ Void PlaYUVerStream::loadAll() getMem1D( &m_ppcFrameBuffer, m_uiFrameBufferSize ); for( UInt i = 0; i < m_uiFrameBufferSize; i++ ) { - m_ppcFrameBuffer[i] = new PlaYUVerFrame( m_pcHandler->m_uiWidth, m_pcHandler->m_uiHeight, - m_pcHandler->m_iPixelFormat, m_pcHandler->m_uiBitsPerPixel ); + m_ppcFrameBuffer[i] = + new PlaYUVerFrame( m_pcHandler->m_uiWidth, m_pcHandler->m_uiHeight, + m_pcHandler->m_iPixelFormat, m_pcHandler->m_uiBitsPerPixel ); if( !m_ppcFrameBuffer[i] ) { close(); @@ -518,8 +524,9 @@ Bool PlaYUVerStream::saveFrame( const String& filename ) Bool PlaYUVerStream::saveFrame( const String& filename, PlaYUVerFrame* saveFrame ) { PlaYUVerStream auxSaveStream; - if( !auxSaveStream.open( filename, saveFrame->getWidth(), saveFrame->getHeight(), saveFrame->getPelFormat(), - saveFrame->getBitsPel(), PLAYUVER_LITTLE_ENDIAN, 1, false ) ) + if( !auxSaveStream.open( filename, saveFrame->getWidth(), saveFrame->getHeight(), + saveFrame->getPelFormat(), saveFrame->getBitsPel(), + PLAYUVER_LITTLE_ENDIAN, 1, false ) ) { return false; } diff --git a/lib/StreamHandlerLibav.cpp b/lib/StreamHandlerLibav.cpp index aa373b3..b4929cd 100644 --- a/lib/StreamHandlerLibav.cpp +++ b/lib/StreamHandlerLibav.cpp @@ -22,25 +22,32 @@ * \brief Interface with libav libs */ -#include #include "StreamHandlerLibav.h" +#include "LibMemory.h" #include "PlaYUVerFrame.h" #include "PlaYUVerFramePixelFormats.h" -#include "LibMemory.h" +#include std::vector StreamHandlerLibav::supportedReadFormats() { INI_REGIST_PLAYUVER_SUPPORTED_FMT; REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Portable Network Graphics", "png" ); - REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Joint Photographic Experts Group", "jpg" ); + REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Joint Photographic Experts Group", + "jpg" ); REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Windows Bitmap", "bmp" ); REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Tagged Image File Format", "tiff" ); - // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Audio video interleaved", "avi" ); - // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Windows media video", "wmv" ); - // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "MPEG4", "mp4" ); - // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Matroska Multimedia Container", "mkv" ); - // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "H.264 streams", "h264" ); - // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "HEVC streams", "hevc" ); + // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Audio video + // interleaved", "avi" ); + // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Windows + // media video", "wmv" ); + // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "MPEG4", + // "mp4" ); + // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "Matroska + // Multimedia Container", "mkv" ); + // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "H.264 + // streams", "h264" ); + // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerLibav::Create, "HEVC + // streams", "hevc" ); END_REGIST_PLAYUVER_SUPPORTED_FMT; } @@ -113,10 +120,12 @@ Bool StreamHandlerLibav::openHandler( String strFilename, Bool bInput ) // av_dict_set( &format_opts, "video_size", aux_string, 0 ); // } - // Int ffmpeg_pel_format = g_PlaYUVerPixFmtDescriptorsList[pixel_format].ffmpegPelFormat; + // Int ffmpeg_pel_format = + // g_PlaYUVerPixFmtDescriptorsList[pixel_format].ffmpegPelFormat; // if( ffmpeg_pel_format >= 0 ) // { - // av_dict_set( &format_opts, "pixel_format", av_get_pix_fmt_name( AVPixelFormat( ffmpeg_pel_format ) ), 0 ); + // av_dict_set( &format_opts, "pixel_format", av_get_pix_fmt_name( + // AVPixelFormat( ffmpeg_pel_format ) ), 0 ); // } /* open input file, and allocate format context */ @@ -139,7 +148,8 @@ Bool StreamHandlerLibav::openHandler( String strFilename, Bool bInput ) m_cCodecCtx = m_cStream->codec; // /* allocate image where the decoded image will be put */ - // ret = av_image_alloc( video_dst_data, video_dst_linesize, m_cCodecCtx->width, m_cCodecCtx->height, + // ret = av_image_alloc( video_dst_data, video_dst_linesize, + // m_cCodecCtx->width, m_cCodecCtx->height, // m_cCodecCtx->pix_fmt, 1 ); // if( ret < 0 ) // { @@ -149,7 +159,8 @@ Bool StreamHandlerLibav::openHandler( String strFilename, Bool bInput ) // } // video_dst_bufsize = ret; - m_uiFrameBufferSize = av_image_get_buffer_size( m_cCodecCtx->pix_fmt, m_cCodecCtx->width, m_cCodecCtx->height, 1 ); + m_uiFrameBufferSize = av_image_get_buffer_size( m_cCodecCtx->pix_fmt, m_cCodecCtx->width, + m_cCodecCtx->height, 1 ); getMem1D( &m_pchFrameBuffer, m_uiFrameBufferSize ); } @@ -224,7 +235,8 @@ Bool StreamHandlerLibav::openHandler( String strFilename, Bool bInput ) av_dump_format( m_cFmtCtx, 0, filename, 0 ); if( !m_cStream ) { - // qDebug( ) << " Could not find audio or video stream in the input, aborting !!!" << endl; + // qDebug( ) << " Could not find audio or video stream in the input, + // aborting !!!" << endl; closeHandler(); return false; } @@ -350,11 +362,13 @@ Bool StreamHandlerLibav::read( PlaYUVerFrame* pcFrame ) if( bGotFrame ) { - // av_image_copy_to_buffer( m_pchFrameBuffer, m_uiFrameBufferSize, m_cFrame->data, m_cFrame->linesize, + // av_image_copy_to_buffer( m_pchFrameBuffer, m_uiFrameBufferSize, + // m_cFrame->data, m_cFrame->linesize, // m_cCodecCtx->pix_fmt, m_cCodecCtx->width, // m_cCodecCtx->height, 1 ); - av_image_copy_to_buffer( m_pStreamBuffer, m_uiFrameBufferSize, m_cFrame->data, m_cFrame->linesize, - m_cCodecCtx->pix_fmt, m_cCodecCtx->width, m_cCodecCtx->height, 1 ); + av_image_copy_to_buffer( m_pStreamBuffer, m_uiFrameBufferSize, m_cFrame->data, + m_cFrame->linesize, m_cCodecCtx->pix_fmt, m_cCodecCtx->width, + m_cCodecCtx->height, 1 ); if( orig_pkt.size ) av_free_packet( &orig_pkt ); diff --git a/lib/StreamHandlerLibav.h b/lib/StreamHandlerLibav.h index 6e1934d..17b7df4 100644 --- a/lib/StreamHandlerLibav.h +++ b/lib/StreamHandlerLibav.h @@ -26,8 +26,8 @@ #define __LIBAVCONTEXTHANDLE_H__ #include -#include #include +#include #ifndef __PRI64_PREFIX #define __PRI64_PREFIX "l" @@ -38,10 +38,10 @@ #endif extern "C" { +#include #include #include #include -#include } #include "PlaYUVerDefs.h" diff --git a/lib/StreamHandlerOpenCV.cpp b/lib/StreamHandlerOpenCV.cpp index 011a6c1..e211e5a 100644 --- a/lib/StreamHandlerOpenCV.cpp +++ b/lib/StreamHandlerOpenCV.cpp @@ -30,9 +30,9 @@ #include // Own +#include "LibMemory.h" #include "PlaYUVerFrame.h" #include "PlaYUVerFramePixelFormats.h" -#include "LibMemory.h" using cv::Mat; using cv::VideoCapture; @@ -40,7 +40,8 @@ using cv::VideoCapture; std::vector StreamHandlerOpenCV::supportedReadFormats() { INI_REGIST_PLAYUVER_SUPPORTED_FMT; - // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerOpenCV::Create, "Device", "/dev/" ); + // REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerOpenCV::Create, "Device", + // "/dev/" ); END_REGIST_PLAYUVER_SUPPORTED_FMT; } @@ -49,7 +50,8 @@ std::vector StreamHandlerOpenCV::supportedWriteFormats( INI_REGIST_PLAYUVER_SUPPORTED_FMT; REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerOpenCV::Create, "Portable PixMap ", "ppm" ); REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerOpenCV::Create, "Portable Network Graphics", "png" ); - REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerOpenCV::Create, "Joint Photographic Experts Group", "jpg" ); + REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerOpenCV::Create, "Joint Photographic Experts Group", + "jpg" ); REGIST_PLAYUVER_SUPPORTED_FMT( &StreamHandlerOpenCV::Create, "Windows Bitmap", "bmp" ); END_REGIST_PLAYUVER_SUPPORTED_FMT; } @@ -78,7 +80,8 @@ Bool StreamHandlerOpenCV::openHandler( String strFilename, Bool bInput ) } else { - m_strCodecName = m_strFormatName = uppercase( strFilename.substr( strFilename.find_last_of( "." ) + 1 ) ); + m_strCodecName = m_strFormatName = + uppercase( strFilename.substr( strFilename.find_last_of( "." ) + 1 ) ); Mat cvMat = cv::imread( m_cFilename ); m_uiWidth = cvMat.cols; m_uiHeight = cvMat.rows; diff --git a/lib/StreamHandlerPortableMap.cpp b/lib/StreamHandlerPortableMap.cpp index c9c8564..03dacc8 100644 --- a/lib/StreamHandlerPortableMap.cpp +++ b/lib/StreamHandlerPortableMap.cpp @@ -22,12 +22,12 @@ * \brief Handling portable pixmap formats */ -#include -#include #include "StreamHandlerPortableMap.h" +#include "LibMemory.h" #include "PlaYUVerFrame.h" #include "PlaYUVerFramePixelFormats.h" -#include "LibMemory.h" +#include +#include Bool StreamHandlerPortableMap::openHandler( String strFilename, Bool bInput ) { @@ -62,7 +62,8 @@ Bool StreamHandlerPortableMap::openHandler( String strFilename, Bool bInput ) ; sscanf( line, "%d", &m_iMaxValue ); m_uiBitsPerPixel = log( m_iMaxValue + 1 ) / log( 2 ); - m_iPixelFormat = m_iMagicNumber == 2 || m_iMagicNumber == 5 ? PlaYUVerFrame::GRAY : PlaYUVerFrame::RGB24; + m_iPixelFormat = + m_iMagicNumber == 2 || m_iMagicNumber == 5 ? PlaYUVerFrame::GRAY : PlaYUVerFrame::RGB24; } } else diff --git a/modules/AbsoluteFrameDifference.cpp b/modules/AbsoluteFrameDifference.cpp index 6d676d4..30d642d 100644 --- a/modules/AbsoluteFrameDifference.cpp +++ b/modules/AbsoluteFrameDifference.cpp @@ -27,17 +27,22 @@ AbsoluteFrameDifference::AbsoluteFrameDifference() { /* Module Definition */ - m_iModuleAPI = MODULE_API_2; // Use API version 2 (recommended). - // See this example for details on the functions prototype - m_iModuleType = FRAME_PROCESSING_MODULE; // Apply module to the frames or to the whole sequence. + m_iModuleAPI = MODULE_API_2; // Use API version 2 (recommended). + // See this example for details on the functions prototype + m_iModuleType = FRAME_PROCESSING_MODULE; // Apply module to the frames or to + // the whole sequence. m_pchModuleCategory = "Measurements"; // Category (sub-menu) m_pchModuleName = "AbsoluteFrameDifference"; // Name m_pchModuleTooltip = "Measure the absolute difference " // Description "between two images (Y plane), e. g., abs( Y1 - Y2 )"; - m_uiNumberOfFrames = MODULE_REQUIRES_TWO_FRAMES; // Number of Frames required (ONE_FRAME, TWO_FRAMES, THREE_FRAMES) - m_uiModuleRequirements = MODULE_REQUIRES_NEW_WINDOW; // Module requirements (check PlaYUVerModulesIf.h). - // Several requirements should be "or" between each others. + m_uiNumberOfFrames = MODULE_REQUIRES_TWO_FRAMES; // Number of Frames required + // (ONE_FRAME, TWO_FRAMES, + // THREE_FRAMES) + m_uiModuleRequirements = MODULE_REQUIRES_NEW_WINDOW; // Module requirements + // (check + // PlaYUVerModulesIf.h). + // Several requirements should be "or" between each others. m_pcFrameDifference = NULL; } @@ -51,8 +56,8 @@ Bool AbsoluteFrameDifference::create( std::vector apcFrameList ) PlaYUVerFrame::MATCH_BITS ) ) return false; - m_pcFrameDifference = - new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), PlaYUVerFrame::GRAY ); + m_pcFrameDifference = new PlaYUVerFrame( apcFrameList[0]->getWidth(), + apcFrameList[0]->getHeight(), PlaYUVerFrame::GRAY ); return true; } diff --git a/modules/DisparityStereoBM.cpp b/modules/DisparityStereoBM.cpp index 378382d..e12d49a 100644 --- a/modules/DisparityStereoBM.cpp +++ b/modules/DisparityStereoBM.cpp @@ -19,7 +19,8 @@ /** * \file DisparityStereoBM.cpp - * \brief Measure the disparity between two images using the Stereo Var method (OpenCV) + * \brief Measure the disparity between two images using the Stereo Var + * method (OpenCV) */ #include "DisparityStereoBM.h" @@ -31,9 +32,12 @@ DisparityStereoBM::DisparityStereoBM() m_iModuleType = FRAME_PROCESSING_MODULE; m_pchModuleCategory = "Stereo"; m_pchModuleName = "Disparity-BM"; - m_pchModuleTooltip = "Measure the disparity between two images using the Stereo BM method (OpenCV)"; + m_pchModuleTooltip = + "Measure the disparity between two images using the " + "Stereo BM method (OpenCV)"; m_uiNumberOfFrames = MODULE_REQUIRES_TWO_FRAMES; - m_uiModuleRequirements = MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; + m_uiModuleRequirements = + MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; m_cModuleOptions.addOptions() /**/ ( "block_size", m_uiBlockSize, "Block Size (positive odd number) [9]" ); @@ -45,8 +49,8 @@ DisparityStereoBM::DisparityStereoBM() Bool DisparityStereoBM::create( std::vector apcFrameList ) { _BASIC_MODULE_API_2_CHECK_ - m_pcDisparityFrame = - new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), PlaYUVerFrame::GRAY ); + m_pcDisparityFrame = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + PlaYUVerFrame::GRAY ); if( ( m_uiBlockSize % 2 ) == 0 ) { m_uiBlockSize++; diff --git a/modules/DisparityStereoBM.h b/modules/DisparityStereoBM.h index d222b1a..d92b275 100644 --- a/modules/DisparityStereoBM.h +++ b/modules/DisparityStereoBM.h @@ -19,7 +19,8 @@ /** * \file DisparityStereoBM.h - * \brief Measure the disparity between two images using the Stereo Var method (OpenCV) + * \brief Measure the disparity between two images using the Stereo Var + * method (OpenCV) */ #ifndef __DISPARITYSTEREOBM_H__ diff --git a/modules/DisparityStereoSGBM.cpp b/modules/DisparityStereoSGBM.cpp index b4e0dca..6e98757 100644 --- a/modules/DisparityStereoSGBM.cpp +++ b/modules/DisparityStereoSGBM.cpp @@ -19,7 +19,8 @@ /** * \file DisparityStereoSGBM.cpp - * \brief Measure the disparity between two images using the SGBM method (OpenCV) + * \brief Measure the disparity between two images using the SGBM method + * (OpenCV) */ #include "DisparityStereoSGBM.h" @@ -31,13 +32,16 @@ DisparityStereoSGBM::DisparityStereoSGBM() m_iModuleType = FRAME_PROCESSING_MODULE; m_pchModuleCategory = "Stereo"; m_pchModuleName = "Disparity-SGBM"; - m_pchModuleTooltip = "Measure the disparity between two images using the Stereo SGBM method (OpenCV)"; + m_pchModuleTooltip = + "Measure the disparity between two images using the " + "Stereo SGBM method (OpenCV)"; m_uiNumberOfFrames = MODULE_REQUIRES_TWO_FRAMES; - m_uiModuleRequirements = MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; + m_uiModuleRequirements = + MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; m_cModuleOptions.addOptions() /**/ - ( "block_size", m_uiBlockSize, "Block Size (positive odd number) [3]" )( "HHAlgorithm", m_bUseHH, - "Use HH algorithm [false]" ); + ( "block_size", m_uiBlockSize, "Block Size (positive odd number) [3]" )( + "HHAlgorithm", m_bUseHH, "Use HH algorithm [false]" ); m_pcDisparityFrame = NULL; m_uiBlockSize = 3; @@ -47,8 +51,8 @@ DisparityStereoSGBM::DisparityStereoSGBM() Bool DisparityStereoSGBM::create( std::vector apcFrameList ) { _BASIC_MODULE_API_2_CHECK_ - m_pcDisparityFrame = - new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), PlaYUVerFrame::GRAY ); + m_pcDisparityFrame = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + PlaYUVerFrame::GRAY ); if( ( m_uiBlockSize % 2 ) == 0 ) { m_uiBlockSize++; @@ -67,7 +71,8 @@ Bool DisparityStereoSGBM::create( std::vector apcFrameList ) m_cStereoMatch->setSpeckleWindowSize( 100 ); m_cStereoMatch->setSpeckleRange( 32 ); m_cStereoMatch->setDisp12MaxDiff( 1 ); - // m_cStereoMatch->setMode( alg == STEREO_HH ? StereoSGBM::MODE_HH : StereoSGBM::MODE_SGBM ); + // m_cStereoMatch->setMode( alg == STEREO_HH ? StereoSGBM::MODE_HH : + // StereoSGBM::MODE_SGBM ); m_cStereoMatch->setMode( m_bUseHH ? cv::StereoSGBM::MODE_HH : cv::StereoSGBM::MODE_SGBM ); #else m_cStereoMatch.preFilterCap = 63; diff --git a/modules/DisparityStereoSGBM.h b/modules/DisparityStereoSGBM.h index a86b7aa..22f9b4b 100644 --- a/modules/DisparityStereoSGBM.h +++ b/modules/DisparityStereoSGBM.h @@ -19,18 +19,26 @@ /** * \file DisparityStereoSGBM.h - * \brief Measure the disparity between two images using the SGBM method (OpenCV) + * \brief Measure the disparity between two images using the SGBM method + * (OpenCV) * The class implements the modified H. Hirschmuller algorithm * that differs from the original one as follows: - * - By default, the algorithm is single-pass, which means that you consider only 5 directions - * instead of 8. Set mode=StereoSGBM::MODE_HH in createStereoSGBM to run the full variant of the + * - By default, the algorithm is single-pass, which means that you consider + * only 5 directions + * instead of 8. Set mode=StereoSGBM::MODE_HH in createStereoSGBM to run the + * full variant of the * algorithm but beware that it may consume a lot of memory. - * - The algorithm matches blocks, not individual pixels. Though, setting blockSize=1 reduces the + * - The algorithm matches blocks, not individual pixels. Though, setting + * blockSize=1 reduces the * blocks to single pixels. - * - Mutual information cost function is not implemented. Instead, a simpler Birchfield-Tomasi - * sub-pixel metric from @cite BT98 is used. Though, the color images are supported as well. - * - Some pre- and post- processing steps from K. Konolige algorithm StereoBM are included, for - * example: pre-filtering (StereoBM::PREFILTER_XSOBEL type) and post-filtering (uniqueness + * - Mutual information cost function is not implemented. Instead, a simpler + * Birchfield-Tomasi + * sub-pixel metric from @cite BT98 is used. Though, the color images are + * supported as well. + * - Some pre- and post- processing steps from K. Konolige algorithm StereoBM + * are included, for + * example: pre-filtering (StereoBM::PREFILTER_XSOBEL type) and post-filtering + * (uniqueness * check, quadratic interpolation and speckle filtering). */ diff --git a/modules/DisparityStereoVar.cpp b/modules/DisparityStereoVar.cpp index ff1ea45..fc018f2 100644 --- a/modules/DisparityStereoVar.cpp +++ b/modules/DisparityStereoVar.cpp @@ -19,7 +19,8 @@ /** * \file DisparityStereoVar.cpp - * \brief Measure the disparity between two images using the Stereo Var method (OpenCV) + * \brief Measure the disparity between two images using the Stereo Var + * method (OpenCV) */ #include "DisparityStereoVar.h" @@ -31,7 +32,9 @@ DisparityStereoVar::DisparityStereoVar() m_iModuleType = FRAME_PROCESSING_MODULE; m_pchModuleCategory = "Disparity"; m_pchModuleName = "StereoVar"; - m_pchModuleTooltip = "Measure the disparity between two images using the Stereo Var method (OpenCV)"; + m_pchModuleTooltip = + "Measure the disparity between two images using the " + "Stereo Var method (OpenCV)"; m_uiNumberOfFrames = MODULE_REQUIRES_TWO_FRAMES; m_uiModuleRequirements = MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW; @@ -47,15 +50,15 @@ DisparityStereoVar::DisparityStereoVar() m_cStereoVar.lambda = 0.03f; m_cStereoVar.penalization = m_cStereoVar.PENALIZATION_TICHONOV; // ignored with USE_AUTO_PARAMS m_cStereoVar.cycle = m_cStereoVar.CYCLE_V; // ignored with USE_AUTO_PARAMS - m_cStereoVar.flags = m_cStereoVar.USE_SMART_ID | m_cStereoVar.USE_AUTO_PARAMS | m_cStereoVar.USE_INITIAL_DISPARITY | - m_cStereoVar.USE_MEDIAN_FILTERING; + m_cStereoVar.flags = m_cStereoVar.USE_SMART_ID | m_cStereoVar.USE_AUTO_PARAMS | + m_cStereoVar.USE_INITIAL_DISPARITY | m_cStereoVar.USE_MEDIAN_FILTERING; } Bool DisparityStereoVar::create( std::vector apcFrameList ) { _BASIC_MODULE_API_2_CHECK_ - m_pcDisparityFrame = - new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), PlaYUVerFrame::GRAY ); + m_pcDisparityFrame = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + PlaYUVerFrame::GRAY ); m_cStereoVar.minDisp = -( ( ( apcFrameList[0]->getWidth() / 8 ) + 15 ) & -16 ); return true; } diff --git a/modules/DisparityStereoVar.h b/modules/DisparityStereoVar.h index 7e80bba..e34ba15 100644 --- a/modules/DisparityStereoVar.h +++ b/modules/DisparityStereoVar.h @@ -19,7 +19,8 @@ /** * \file DisparityStereoVar.h - * \brief Measure the disparity between two images using the Stereo Var method (OpenCV) + * \brief Measure the disparity between two images using the Stereo Var + * method (OpenCV) */ #ifndef __DISPARITYSTEREOVAR_H__ diff --git a/modules/EightBitsSampling.cpp b/modules/EightBitsSampling.cpp index 75cfa02..c59f995 100644 --- a/modules/EightBitsSampling.cpp +++ b/modules/EightBitsSampling.cpp @@ -43,8 +43,9 @@ Bool EightBitsSampling::create( std::vector apcFrameList ) if( apcFrameList[0]->getBitsPel() > 8 ) { m_pcSubSampledFrame = NULL; - m_pcSubSampledFrame = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), - apcFrameList[0]->getPelFormat(), 8 ); + m_pcSubSampledFrame = + new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + apcFrameList[0]->getPelFormat(), 8 ); return true; } return false; diff --git a/modules/FilterComponent.cpp b/modules/FilterComponent.cpp index c4480d5..5048195 100644 --- a/modules/FilterComponent.cpp +++ b/modules/FilterComponent.cpp @@ -58,19 +58,25 @@ FilterComponentLuma::FilterComponentLuma() { /* Module Definition */ m_iModuleAPI = MODULE_API_2; - m_iModuleType = FRAME_PROCESSING_MODULE; // Apply module to the frames or to the whole sequence. + m_iModuleType = FRAME_PROCESSING_MODULE; // Apply module to the frames or to + // the whole sequence. // Currently only support for frame m_pchModuleCategory = "FilterComponent"; // Category (sub-menu) m_pchModuleName = "Luma"; // Name m_pchModuleTooltip = "Filter Y matrix of YUV frame"; // Description - m_uiNumberOfFrames = MODULE_REQUIRES_ONE_FRAME; // Number of Frames required (ONE_FRAME, TWO_FRAMES, THREE_FRAMES) - m_uiModuleRequirements = MODULE_REQUIRES_NOTHING; // Module requirements (check PlaYUVerModulesIf.h). - // Several requirements should be "or" between each others. + m_uiNumberOfFrames = MODULE_REQUIRES_ONE_FRAME; // Number of Frames required + // (ONE_FRAME, TWO_FRAMES, + // THREE_FRAMES) + m_uiModuleRequirements = MODULE_REQUIRES_NOTHING; // Module requirements + // (check + // PlaYUVerModulesIf.h). + // Several requirements should be "or" between each others. } Bool FilterComponentLuma::create( std::vector apcFrameList ) { - return createFilter( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), apcFrameList[0]->getBitsPel() ); + return createFilter( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + apcFrameList[0]->getBitsPel() ); } PlaYUVerFrame* FilterComponentLuma::process( std::vector apcFrameList ) diff --git a/modules/FrameCrop.cpp b/modules/FrameCrop.cpp index a67b35d..3d64d4e 100644 --- a/modules/FrameCrop.cpp +++ b/modules/FrameCrop.cpp @@ -34,10 +34,12 @@ FrameCrop::FrameCrop() m_uiNumberOfFrames = MODULE_REQUIRES_ONE_FRAME; m_uiModuleRequirements = MODULE_REQUIRES_OPTIONS; - m_cModuleOptions.addOptions() /**/ - ( "xPosition", m_uiXPosition, "X cordinate of the left-top corner of the crop region [0]" ) /**/ - ( "yPosition", m_uiYPosition, "Y cordinate of the left-top corner of the crop region [0]" ) /**/ - ( "width", m_iXSize, "Width of the crop region [-1]" ) /**/ + m_cModuleOptions.addOptions() /**/ + ( "xPosition", m_uiXPosition, + "X cordinate of the left-top corner of the crop region [0]" ) /**/ + ( "yPosition", m_uiYPosition, + "Y cordinate of the left-top corner of the crop region [0]" ) /**/ + ( "width", m_iXSize, "Width of the crop region [-1]" ) /**/ ( "height", m_iYSize, "Height of the crop region [-1]" ); m_pcCropedFrame = NULL; @@ -58,7 +60,8 @@ Void FrameCrop::create( PlaYUVerFrame* frame ) { m_iYSize = frame->getHeight() - m_uiYPosition; } - m_pcCropedFrame = new PlaYUVerFrame( m_iXSize, m_iYSize, frame->getPelFormat(), frame->getBitsPel() ); + m_pcCropedFrame = + new PlaYUVerFrame( m_iXSize, m_iYSize, frame->getPelFormat(), frame->getBitsPel() ); } PlaYUVerFrame* FrameCrop::process( PlaYUVerFrame* frame ) diff --git a/modules/FrameDifference.cpp b/modules/FrameDifference.cpp index eabcd08..c89546a 100644 --- a/modules/FrameDifference.cpp +++ b/modules/FrameDifference.cpp @@ -31,7 +31,9 @@ FrameDifference::FrameDifference() m_iModuleType = FRAME_PROCESSING_MODULE; m_pchModuleCategory = "Measurements"; m_pchModuleName = "FrameDifference"; - m_pchModuleTooltip = "Measure the difference between two images (Y plane), Y1 - Y2, with max absolute diff of 128"; + m_pchModuleTooltip = + "Measure the difference between two images (Y plane), " + "Y1 - Y2, with max absolute diff of 128"; m_uiModuleRequirements = MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; m_uiNumberOfFrames = MODULE_REQUIRES_TWO_FRAMES; @@ -50,8 +52,8 @@ Bool FrameDifference::create( std::vector apcFrameList ) UInt uiMaxBitsPixel = 0; for( UInt i = 0; i < apcFrameList.size(); i++ ) { - if( !apcFrameList[i]->haveSameFmt( apcFrameList[0], - PlaYUVerFrame::MATCH_COLOR_SPACE | PlaYUVerFrame::MATCH_RESOLUTION ) ) + if( !apcFrameList[i]->haveSameFmt( + apcFrameList[0], PlaYUVerFrame::MATCH_COLOR_SPACE | PlaYUVerFrame::MATCH_RESOLUTION ) ) return false; if( apcFrameList[i]->getBitsPel() > uiMaxBitsPixel ) { @@ -67,8 +69,9 @@ Bool FrameDifference::create( std::vector apcFrameList ) m_iDiffBitShift = ( uiMaxBitsPixel + 1 ) - m_uiBitsPixel; m_iMaxDiffValue = ( 1 << ( m_uiBitsPixel - 1 ) ); - m_pcFrameDifference = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), - PlaYUVerFrame::GRAY, m_uiBitsPixel ); + m_pcFrameDifference = + new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + PlaYUVerFrame::GRAY, m_uiBitsPixel ); return true; } diff --git a/modules/FrameMask.cpp b/modules/FrameMask.cpp index 144cefd..7b60963 100644 --- a/modules/FrameMask.cpp +++ b/modules/FrameMask.cpp @@ -49,9 +49,9 @@ Bool FrameMask::create( std::vector apcFrameList ) for( UInt i = 1; i < apcFrameList.size(); i++ ) { - if( !apcFrameList[i]->haveSameFmt( apcFrameList[0], PlaYUVerFrame::MATCH_COLOR_SPACE_IGNORE_GRAY | - PlaYUVerFrame::MATCH_RESOLUTION | - PlaYUVerFrame::MATCH_BITS ) ) + if( !apcFrameList[i]->haveSameFmt( + apcFrameList[0], PlaYUVerFrame::MATCH_COLOR_SPACE_IGNORE_GRAY | + PlaYUVerFrame::MATCH_RESOLUTION | PlaYUVerFrame::MATCH_BITS ) ) { return false; } @@ -79,8 +79,8 @@ Bool FrameMask::create( std::vector apcFrameList ) break; } - m_pcFrameProcessed = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), iPelFmt, - apcFrameList[0]->getBitsPel() ); + m_pcFrameProcessed = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + iPelFmt, apcFrameList[0]->getBitsPel() ); return true; } diff --git a/modules/FrameShift.cpp b/modules/FrameShift.cpp index 2fcd123..d7bce39 100644 --- a/modules/FrameShift.cpp +++ b/modules/FrameShift.cpp @@ -58,11 +58,13 @@ PlaYUVerFrame* FrameShift::process( std::vector apcFrameList ) UInt xStartOut = m_iShiftHor >= 0 ? m_iShiftHor : 0; UInt xStartIn = m_iShiftHor >= 0 ? 0 : -m_iShiftHor; - UInt xEndOut = m_iShiftHor >= 0 ? m_pcProcessedFrame->getWidth() : m_pcProcessedFrame->getWidth() + m_iShiftHor; + UInt xEndOut = m_iShiftHor >= 0 ? m_pcProcessedFrame->getWidth() + : m_pcProcessedFrame->getWidth() + m_iShiftHor; UInt yStartOut = m_iShiftVer >= 0 ? m_iShiftVer : 0; UInt yStartIn = m_iShiftVer >= 0 ? 0 : -m_iShiftVer; - UInt yEndOut = m_iShiftVer >= 0 ? m_pcProcessedFrame->getHeight() : m_pcProcessedFrame->getHeight() + m_iShiftVer; + UInt yEndOut = m_iShiftVer >= 0 ? m_pcProcessedFrame->getHeight() + : m_pcProcessedFrame->getHeight() + m_iShiftVer; m_pcProcessedFrame->clear(); diff --git a/modules/InterFrameVariance.cpp b/modules/InterFrameVariance.cpp index fb492ba..b3e839b 100644 --- a/modules/InterFrameVariance.cpp +++ b/modules/InterFrameVariance.cpp @@ -30,13 +30,16 @@ InterFrameVariance::InterFrameVariance() /* Module Definition */ m_iModuleAPI = MODULE_API_2; // Use API version 2 (recommended). // See this example for details on the functions prototype - m_iModuleType = FRAME_PROCESSING_MODULE; // Apply module to the frames or to the whole sequence. + m_iModuleType = FRAME_PROCESSING_MODULE; // Apply module to the frames or to + // the whole sequence. m_pchModuleCategory = "Measurements"; // Category (sub-menu) m_pchModuleName = "InterFrameVariance"; // Name m_pchModuleTooltip = "Measure the variance across several frames"; - m_uiNumberOfFrames = - MODULE_REQUIRES_SEVERAL_FRAMES; // Number of Frames required (This module allows a variable number of inputs) - m_uiModuleRequirements = MODULE_REQUIRES_NEW_WINDOW; // Module requirements (check PlaYUVerModulesIf.h). + m_uiNumberOfFrames = MODULE_REQUIRES_SEVERAL_FRAMES; // Number of Frames required (This module + // allows a variable number of inputs) + m_uiModuleRequirements = MODULE_REQUIRES_NEW_WINDOW; // Module requirements + // (check + // PlaYUVerModulesIf.h). // Several requirements should be "or" between each others. m_pcFrameVariance = NULL; } @@ -53,8 +56,8 @@ Bool InterFrameVariance::create( std::vector apcFrameList ) PlaYUVerFrame::MATCH_BITS ) ) return false; - m_pcFrameVariance = - new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), PlaYUVerFrame::GRAY, 8 ); + m_pcFrameVariance = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + PlaYUVerFrame::GRAY, 8 ); getMem2D( &m_pVariance, apcFrameList[0]->getHeight(), apcFrameList[0]->getWidth() ); return true; diff --git a/modules/LumaAverage.cpp b/modules/LumaAverage.cpp index d21661c..219747f 100644 --- a/modules/LumaAverage.cpp +++ b/modules/LumaAverage.cpp @@ -27,14 +27,19 @@ LumaAverage::LumaAverage() { /* Module Definition */ - m_iModuleType = FRAME_MEASUREMENT_MODULE; // Apply module to the frames or to the whole sequence. + m_iModuleType = FRAME_MEASUREMENT_MODULE; // Apply module to the frames or to + // the whole sequence. // Currently only support for frame m_pchModuleCategory = "Measurements"; // Category (sub-menu) m_pchModuleName = "LumaAverage"; // Name m_pchModuleTooltip = "Measure the average of luma component"; // Description - m_uiNumberOfFrames = MODULE_REQUIRES_ONE_FRAME; // Number of Frames required (ONE_FRAME, TWO_FRAMES, THREE_FRAMES) - m_uiModuleRequirements = MODULE_REQUIRES_NOTHING; // Module requirements (check PlaYUVerModulesIf.h). - // Several requirements should be "or" between each others. + m_uiNumberOfFrames = MODULE_REQUIRES_ONE_FRAME; // Number of Frames required + // (ONE_FRAME, TWO_FRAMES, + // THREE_FRAMES) + m_uiModuleRequirements = MODULE_REQUIRES_NOTHING; // Module requirements + // (check + // PlaYUVerModulesIf.h). + // Several requirements should be "or" between each others. } Void LumaAverage::create( PlaYUVerFrame* frame ) diff --git a/modules/MeasureOpticalFlowDualTVL1.cpp b/modules/MeasureOpticalFlowDualTVL1.cpp index 562310a..ce65c80 100644 --- a/modules/MeasureOpticalFlowDualTVL1.cpp +++ b/modules/MeasureOpticalFlowDualTVL1.cpp @@ -40,10 +40,12 @@ MeasureOpticalFlowDualTVL1::MeasureOpticalFlowDualTVL1() m_pchModuleName = "MeasureOpticalFlowDualTVL1"; m_pchModuleTooltip = "Measure optical flow"; m_uiNumberOfFrames = MODULE_REQUIRES_TWO_FRAMES; - m_uiModuleRequirements = MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; + m_uiModuleRequirements = + MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; m_cModuleOptions.addOptions() /**/ - ( "Show reconstruction", m_bShowReconstruction, "Show reconstructed frame instead of MVs [false]" ); + ( "Show reconstruction", m_bShowReconstruction, + "Show reconstructed frame instead of MVs [false]" ); m_bShowReconstruction = false; m_pcOutputFrame = NULL; @@ -61,7 +63,8 @@ Bool MeasureOpticalFlowDualTVL1::create( std::vector apcFrameLis m_iStep = 16; m_cTvl1 = cv::createOptFlow_DualTVL1(); - m_pcOutputFrame = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), PlaYUVerFrame::GRAY ); + m_pcOutputFrame = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + PlaYUVerFrame::GRAY ); return true; } diff --git a/modules/OpticalFlow.cpp b/modules/OpticalFlow.cpp index f89d068..c6803f8 100644 --- a/modules/OpticalFlow.cpp +++ b/modules/OpticalFlow.cpp @@ -45,10 +45,12 @@ OpticalFlowModule::OpticalFlowModule() m_iModuleType = FRAME_PROCESSING_MODULE; m_pchModuleCategory = "OpticalFlow"; m_uiNumberOfFrames = MODULE_REQUIRES_TWO_FRAMES; - m_uiModuleRequirements = MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; + m_uiModuleRequirements = + MODULE_REQUIRES_SKIP_WHILE_PLAY | MODULE_REQUIRES_NEW_WINDOW | MODULE_REQUIRES_OPTIONS; m_cModuleOptions.addOptions() /**/ - ( "Show reconstruction", m_bShowReconstruction, "Show reconstructed frame instead of MVs [false]" ); + ( "Show reconstruction", m_bShowReconstruction, + "Show reconstructed frame instead of MVs [false]" ); m_bShowReconstruction = false; m_pcOutputFrame = NULL; @@ -65,7 +67,8 @@ Bool OpticalFlowModule::commonCreate( std::vector apcFrameList ) return false; m_iStep = 16; - m_pcOutputFrame = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), PlaYUVerFrame::GRAY ); + m_pcOutputFrame = new PlaYUVerFrame( apcFrameList[0]->getWidth(), apcFrameList[0]->getHeight(), + PlaYUVerFrame::GRAY ); return true; } diff --git a/modules/PlaYUVerModuleFactory.cpp b/modules/PlaYUVerModuleFactory.cpp index b22f4e4..198649e 100644 --- a/modules/PlaYUVerModuleFactory.cpp +++ b/modules/PlaYUVerModuleFactory.cpp @@ -22,11 +22,11 @@ * \brief PlaYUVer modules factory */ -#include "config.h" #include "PlaYUVerModuleFactory.h" +#include "config.h" -#include #include +#include #ifdef USE_DYNLOAD #include #endif diff --git a/modules/SetChromaHalfScale.cpp b/modules/SetChromaHalfScale.cpp index 2189ea9..4c0e24d 100644 --- a/modules/SetChromaHalfScale.cpp +++ b/modules/SetChromaHalfScale.cpp @@ -40,8 +40,8 @@ SetChromaHalfScale::SetChromaHalfScale() Void SetChromaHalfScale::create( PlaYUVerFrame* frame ) { m_pcProcessedFrame = NULL; - m_pcProcessedFrame = - new PlaYUVerFrame( frame->getWidth(), frame->getHeight(), frame->getPelFormat(), frame->getBitsPel() ); + m_pcProcessedFrame = new PlaYUVerFrame( frame->getWidth(), frame->getHeight(), + frame->getPelFormat(), frame->getBitsPel() ); } PlaYUVerFrame* SetChromaHalfScale::process( PlaYUVerFrame* frame ) diff --git a/modules/WeightedPSNR.cpp b/modules/WeightedPSNR.cpp index 70f1aa1..ad904e4 100644 --- a/modules/WeightedPSNR.cpp +++ b/modules/WeightedPSNR.cpp @@ -57,7 +57,8 @@ Bool WeightedPSNR::create( std::vector apcFrameList ) } for( UInt i = 1; i < apcFrameList.size(); i++ ) { - if( !apcFrameList[i]->haveSameFmt( apcFrameList[1], PlaYUVerFrame::MATCH_COLOR_SPACE | PlaYUVerFrame::MATCH_BITS ) ) + if( !apcFrameList[i]->haveSameFmt( + apcFrameList[1], PlaYUVerFrame::MATCH_COLOR_SPACE | PlaYUVerFrame::MATCH_BITS ) ) return false; } return true; diff --git a/tools/PlaYUVerTools.cpp b/tools/PlaYUVerTools.cpp index d122cce..ce2467b 100644 --- a/tools/PlaYUVerTools.cpp +++ b/tools/PlaYUVerTools.cpp @@ -22,16 +22,16 @@ * \brief Main definition of the PlaYUVerTools APp */ -#include "config.h" #include "PlaYUVerTools.h" +#include "config.h" -#include #include +#include -#include "lib/PlaYUVerPixel.h" #include "lib/PlaYUVerFrame.h" -#include "lib/PlaYUVerStream.h" #include "lib/PlaYUVerModuleIf.h" +#include "lib/PlaYUVerPixel.h" +#include "lib/PlaYUVerStream.h" #include "modules/PlaYUVerModuleFactory.h" PlaYUVerTools::PlaYUVerTools() @@ -102,7 +102,8 @@ Int PlaYUVerTools::openInputs() pcStream = new PlaYUVerStream; try { - if( !pcStream->open( inputFileNames[i], resolutionString, fmtString, uiBitPerPixel, uiEndianness, 1, true ) ) + if( !pcStream->open( inputFileNames[i], resolutionString, fmtString, uiBitPerPixel, + uiEndianness, 1, true ) ) { log( LOG_ERROR, "Cannot open input stream %s! ", inputFileNames[i].c_str() ); return 2; @@ -111,8 +112,8 @@ Int PlaYUVerTools::openInputs() } catch( const char* msg ) { - log( LOG_ERROR, "Cannot open input stream %s with the following error: \n%s\n", inputFileNames[i].c_str(), - msg ); + log( LOG_ERROR, "Cannot open input stream %s with the following error: \n%s\n", + inputFileNames[i].c_str(), msg ); return 2; } } @@ -128,8 +129,8 @@ Int PlaYUVerTools::openInputs() for( UInt i = 0; i < m_apcInputStreams.size(); i++ ) { m_uiNumberOfFrames = std::min( m_uiNumberOfFrames, m_apcInputStreams[i]->getFrameNum() ); - m_uiNumberOfComponents = - std::min( m_uiNumberOfComponents, m_apcInputStreams[i]->getCurrFrame()->getNumberChannels() ); + m_uiNumberOfComponents = std::min( m_uiNumberOfComponents, + m_apcInputStreams[i]->getCurrFrame()->getNumberChannels() ); } return 0; @@ -174,7 +175,9 @@ Int PlaYUVerTools::Open( Int argc, Char* argv[] ) m_pcOutputFileNames.push_back( m_strOutput ); if( m_pcOutputFileNames.size() != m_apcInputStreams.size() ) { - log( LOG_ERROR, "Invalid number of outputs! Each input must have an output filename. " ); + log( LOG_ERROR, + "Invalid number of outputs! Each input must have an " + "output filename. " ); return 2; } @@ -211,14 +214,14 @@ Int PlaYUVerTools::Open( Int argc, Char* argv[] ) PlaYUVerStream* pcOutputStream = new PlaYUVerStream; try { - pcOutputStream->open( m_pcOutputFileNames[0], pcInputFrame->getWidth(), pcInputFrame->getHeight(), - pcInputFrame->getPelFormat(), pcInputFrame->getBitsPel(), PLAYUVER_LITTLE_ENDIAN, 1, - false ); + pcOutputStream->open( m_pcOutputFileNames[0], pcInputFrame->getWidth(), + pcInputFrame->getHeight(), pcInputFrame->getPelFormat(), + pcInputFrame->getBitsPel(), PLAYUVER_LITTLE_ENDIAN, 1, false ); } catch( const char* msg ) { - log( LOG_ERROR, "Cannot open input stream %s with the following error %s!\n", m_pcOutputFileNames[0].c_str(), - msg ); + log( LOG_ERROR, "Cannot open input stream %s with the following error %s!\n", + m_pcOutputFileNames[0].c_str(), msg ); delete pcOutputStream; pcOutputStream = NULL; return 2; @@ -227,7 +230,9 @@ Int PlaYUVerTools::Open( Int argc, Char* argv[] ) if( m_apcOutputStreams.size() != m_apcInputStreams.size() ) { - log( LOG_ERROR, "Invalid number of outputs! Each input must have an output filename. " ); + log( LOG_ERROR, + "Invalid number of outputs! Each input must have an " + "output filename. " ); return 2; } @@ -249,7 +254,8 @@ Int PlaYUVerTools::Open( Int argc, Char* argv[] ) } for( UInt i = 0; i < PlaYUVerFrame::supportedQualityMetricsList().size(); i++ ) { - if( lowercase( PlaYUVerFrame::supportedQualityMetricsList()[i] ) == lowercase( qualityMetric ) ) + if( lowercase( PlaYUVerFrame::supportedQualityMetricsList()[i] ) == + lowercase( qualityMetric ) ) { m_uiQualityMetric = i; } @@ -339,12 +345,13 @@ Int PlaYUVerTools::Open( Int argc, Char* argv[] ) try { pcModStream->open( outputFileNames[0], pcModFrame->getWidth(), pcModFrame->getHeight(), - pcModFrame->getPelFormat(), pcModFrame->getBitsPel(), PLAYUVER_LITTLE_ENDIAN, 1, false ); + pcModFrame->getPelFormat(), pcModFrame->getBitsPel(), + PLAYUVER_LITTLE_ENDIAN, 1, false ); } catch( const char* msg ) { - log( LOG_ERROR, "Cannot open input stream %s with the following error %s!\n", outputFileNames[0].c_str(), - msg ); + log( LOG_ERROR, "Cannot open input stream %s with the following error %s!\n", + outputFileNames[0].c_str(), msg ); delete pcModStream; pcModStream = NULL; return 2; @@ -420,7 +427,8 @@ Int PlaYUVerTools::RateReductionOperation() Int PlaYUVerTools::QualityOperation() { - const char* pchQualityMetricName = PlaYUVerFrame::supportedQualityMetricsList()[m_uiQualityMetric].c_str(); + const char* pchQualityMetricName = + PlaYUVerFrame::supportedQualityMetricsList()[m_uiQualityMetric].c_str(); PlaYUVerFrame* apcCurrFrame[MAX_NUMBER_INPUTS]; Bool abEOF[MAX_NUMBER_INPUTS]; Double adAverageQuality[MAX_NUMBER_INPUTS - 1][PlaYUVerPixel::MAX_NUMBER_COMPONENTS]; @@ -480,7 +488,8 @@ Int PlaYUVerTools::QualityOperation() for( UInt c = 0; c < m_uiNumberOfComponents; c++ ) { dQuality = apcCurrFrame[s]->getQuality( m_uiQualityMetric, apcCurrFrame[0], c ); - adAverageQuality[s - 1][c] = ( adAverageQuality[s - 1][c] * Double( frame ) + dQuality ) / Double( frame + 1 ); + adAverageQuality[s - 1][c] = + ( adAverageQuality[s - 1][c] * Double( frame ) + dQuality ) / Double( frame + 1 ); log( LOG_RESULT, metric_fmt.c_str(), dQuality ); } log( LOG_RESULT, " " ); @@ -566,7 +575,8 @@ Int PlaYUVerTools::ModuleOperation() log( LOG_INFO, " %3d", frame ); log( LOG_RESULT, " %8.3f \n", dMeasurementResult ); dAveragedMeasurementResult = - ( dAveragedMeasurementResult * Double( frame ) + dMeasurementResult ) / Double( frame + 1 ); + ( dAveragedMeasurementResult * Double( frame ) + dMeasurementResult ) / + Double( frame + 1 ); } for( UInt s = 0; s < m_apcInputStreams.size(); s++ ) diff --git a/tools/PlaYUVerToolsCmdParser.cpp b/tools/PlaYUVerToolsCmdParser.cpp index a893787..7c3aa60 100644 --- a/tools/PlaYUVerToolsCmdParser.cpp +++ b/tools/PlaYUVerToolsCmdParser.cpp @@ -24,12 +24,12 @@ #include "PlaYUVerToolsCmdParser.h" -#include #include +#include #include "lib/PlaYUVerFrame.h" -#include "lib/PlaYUVerStream.h" #include "lib/PlaYUVerModuleIf.h" +#include "lib/PlaYUVerStream.h" #include "modules/PlaYUVerModuleFactory.h" PlaYUVerToolsCmdParser::PlaYUVerToolsCmdParser() @@ -90,7 +90,10 @@ Int PlaYUVerToolsCmdParser::parseToolsArgs( Int argc, Char* argv[] ) } else if( m_cOptions.hasOpt( "help" ) ) { - printf( "Usage: %s modules/quality/save [options] -input=input_file [--output=output_file]\n", argv[0] ); + printf( + "Usage: %s modules/quality/save [options] -input=input_file " + "[--output=output_file]\n", + argv[0] ); m_cOptions.doHelp( std::cout ); iRet = 1; }