VisualizationGraphRenderingDelegate.cpp
338 lines
| 12.2 KiB
| text/x-c
|
CppLexer
|
r480 | #include "Visualization/VisualizationGraphRenderingDelegate.h" | ||
|
r916 | #include "Visualization/AxisRenderingUtils.h" | ||
|
r1002 | #include "Visualization/ColorScaleEditor.h" | ||
|
r919 | #include "Visualization/PlottablesRenderingUtils.h" | ||
|
r1009 | #include "Visualization/SqpColorScale.h" | ||
|
r725 | #include "Visualization/VisualizationGraphWidget.h" | ||
|
r480 | #include "Visualization/qcustomplot.h" | ||
|
r490 | #include <Common/DateUtils.h> | ||
|
r729 | #include <Data/IDataSeries.h> | ||
|
r1283 | #include <Variable/Variable.h> | ||
|
r729 | |||
|
r726 | #include <SqpApplication.h> | ||
|
r482 | namespace { | ||
|
r729 | /// Name of the axes layer in QCustomPlot | ||
const auto AXES_LAYER = QStringLiteral("axes"); | ||||
/// Icon used to show x-axis properties | ||||
const auto HIDE_AXIS_ICON_PATH = QStringLiteral(":/icones/down.png"); | ||||
|
r726 | /// Name of the overlay layer in QCustomPlot | ||
const auto OVERLAY_LAYER = QStringLiteral("overlay"); | ||||
|
r729 | /// Pixmap used to show x-axis properties | ||
const auto SHOW_AXIS_ICON_PATH = QStringLiteral(":/icones/up.png"); | ||||
|
r1024 | /// Tooltip format for graphs | ||
const auto GRAPH_TOOLTIP_FORMAT = QStringLiteral("key: %1\nvalue: %2"); | ||||
|
r1027 | /// Tooltip format for colormaps | ||
const auto COLORMAP_TOOLTIP_FORMAT = QStringLiteral("x: %1\ny: %2\nvalue: %3"); | ||||
|
r483 | |||
|
r578 | /// Offset used to shift the tooltip of the mouse | ||
const auto TOOLTIP_OFFSET = QPoint{20, 20}; | ||||
|
r576 | /// Tooltip display rectangle (the tooltip is hidden when the mouse leaves this rectangle) | ||
const auto TOOLTIP_RECT = QRect{10, 10, 10, 10}; | ||||
/// Timeout after which the tooltip is displayed | ||||
const auto TOOLTIP_TIMEOUT = 500; | ||||
|
r482 | |||
|
r485 | void initPointTracerStyle(QCPItemTracer &tracer) noexcept | ||
{ | ||||
tracer.setInterpolating(false); | ||||
|
r577 | tracer.setStyle(QCPItemTracer::tsCircle); | ||
tracer.setSize(3); | ||||
|
r485 | tracer.setPen(QPen(Qt::black)); | ||
tracer.setBrush(Qt::black); | ||||
r1044 | tracer.setSelectable(false); | |||
|
r485 | } | ||
|
r729 | QPixmap pixmap(const QString &iconPath) noexcept | ||
{ | ||||
return QIcon{iconPath}.pixmap(QSize{16, 16}); | ||||
} | ||||
|
r726 | void initClosePixmapStyle(QCPItemPixmap &pixmap) noexcept | ||
{ | ||||
// Icon | ||||
pixmap.setPixmap( | ||||
sqpApp->style()->standardIcon(QStyle::SP_TitleBarCloseButton).pixmap(QSize{16, 16})); | ||||
// Position | ||||
pixmap.topLeft->setType(QCPItemPosition::ptAxisRectRatio); | ||||
pixmap.topLeft->setCoords(1, 0); | ||||
pixmap.setClipToAxisRect(false); | ||||
// Can be selected | ||||
pixmap.setSelectable(true); | ||||
} | ||||
|
r729 | void initXAxisPixmapStyle(QCPItemPixmap &itemPixmap) noexcept | ||
{ | ||||
// Icon | ||||
itemPixmap.setPixmap(pixmap(HIDE_AXIS_ICON_PATH)); | ||||
// Position | ||||
itemPixmap.topLeft->setType(QCPItemPosition::ptAxisRectRatio); | ||||
itemPixmap.topLeft->setCoords(0, 1); | ||||
itemPixmap.setClipToAxisRect(false); | ||||
// Can be selected | ||||
itemPixmap.setSelectable(true); | ||||
} | ||||
|
r726 | void initTitleTextStyle(QCPItemText &text) noexcept | ||
{ | ||||
// Font and background styles | ||||
text.setColor(Qt::gray); | ||||
text.setBrush(Qt::white); | ||||
// Position | ||||
text.setPositionAlignment(Qt::AlignTop | Qt::AlignLeft); | ||||
text.position->setType(QCPItemPosition::ptAxisRectRatio); | ||||
text.position->setCoords(0.5, 0); | ||||
r1044 | text.setSelectable(false); | |||
|
r726 | } | ||
|
r1026 | /** | ||
* Returns the cell index (x or y) of a colormap according to the coordinate passed in parameter. | ||||
* This method handles the fact that a colormap axis can be logarithmic or linear. | ||||
* @param colormap the colormap for which to calculate the index | ||||
* @param coord the coord to convert to cell index | ||||
* @param xCoord calculates the x index if true, calculates y index if false | ||||
* @return the cell index | ||||
*/ | ||||
int colorMapCellIndex(const QCPColorMap &colormap, double coord, bool xCoord) | ||||
{ | ||||
// Determines the axis of the colormap according to xCoord, and whether it is logarithmic or not | ||||
auto isLogarithmic = (xCoord ? colormap.keyAxis() : colormap.valueAxis())->scaleType() | ||||
== QCPAxis::stLogarithmic; | ||||
if (isLogarithmic) { | ||||
// For a logarithmic axis we can't use the conversion method of colormap, so we calculate | ||||
// the index manually based on the position of the coordinate on the axis | ||||
// Gets the axis range and the number of values between range bounds to calculate the step | ||||
// between each value of the range | ||||
auto range = xCoord ? colormap.data()->keyRange() : colormap.data()->valueRange(); | ||||
auto nbValues = (xCoord ? colormap.data()->keySize() : colormap.data()->valueSize()) - 1; | ||||
auto valueStep | ||||
= (std::log10(range.upper) - std::log10(range.lower)) / static_cast<double>(nbValues); | ||||
// According to the coord position, calculates the closest index in the range | ||||
return std::round((std::log10(coord) - std::log10(range.lower)) / valueStep); | ||||
} | ||||
else { | ||||
// For a linear axis, we use the conversion method of colormap | ||||
int index; | ||||
if (xCoord) { | ||||
colormap.data()->coordToCell(coord, 0., &index, nullptr); | ||||
} | ||||
else { | ||||
colormap.data()->coordToCell(0., coord, nullptr, &index); | ||||
} | ||||
return index; | ||||
} | ||||
} | ||||
|
r482 | } // namespace | ||
|
r480 | struct VisualizationGraphRenderingDelegate::VisualizationGraphRenderingDelegatePrivate { | ||
|
r725 | explicit VisualizationGraphRenderingDelegatePrivate(VisualizationGraphWidget &graphWidget) | ||
: m_Plot{graphWidget.plot()}, | ||||
m_PointTracer{new QCPItemTracer{&m_Plot}}, | ||||
m_TracerTimer{}, | ||||
|
r726 | m_ClosePixmap{new QCPItemPixmap{&m_Plot}}, | ||
|
r729 | m_TitleText{new QCPItemText{&m_Plot}}, | ||
m_XAxisPixmap{new QCPItemPixmap{&m_Plot}}, | ||||
m_ShowXAxis{true}, | ||||
|
r920 | m_XAxisLabel{}, | ||
|
r1009 | m_ColorScale{SqpColorScale{m_Plot}} | ||
|
r482 | { | ||
|
r485 | initPointTracerStyle(*m_PointTracer); | ||
|
r482 | |||
|
r576 | m_TracerTimer.setInterval(TOOLTIP_TIMEOUT); | ||
|
r482 | m_TracerTimer.setSingleShot(true); | ||
|
r726 | |||
// Inits "close button" in plot overlay | ||||
m_ClosePixmap->setLayer(OVERLAY_LAYER); | ||||
initClosePixmapStyle(*m_ClosePixmap); | ||||
|
r727 | |||
// Connects pixmap selection to graph widget closing | ||||
r1054 | QObject::connect(&m_Plot, &QCustomPlot::itemClick, | |||
[&graphWidget, this](auto item, auto mouseEvent) { | ||||
if (item == m_ClosePixmap) { | ||||
|
r727 | graphWidget.close(); | ||
} | ||||
}); | ||||
|
r726 | // Inits graph name in plot overlay | ||
m_TitleText->setLayer(OVERLAY_LAYER); | ||||
m_TitleText->setText(graphWidget.name()); | ||||
initTitleTextStyle(*m_TitleText); | ||||
|
r729 | |||
// Inits "show x-axis button" in plot overlay | ||||
m_XAxisPixmap->setLayer(OVERLAY_LAYER); | ||||
initXAxisPixmapStyle(*m_XAxisPixmap); | ||||
// Connects pixmap selection to graph x-axis showing/hiding | ||||
r1054 | QObject::connect(&m_Plot, &QCustomPlot::itemClick, [this](auto item, auto mouseEvent) { | |||
if (m_XAxisPixmap == item) { | ||||
|
r729 | // Changes the selection state and refreshes the x-axis | ||
m_ShowXAxis = !m_ShowXAxis; | ||||
r1054 | this->updateXAxisState(); | |||
|
r729 | m_Plot.layer(AXES_LAYER)->replot(); | ||
// Deselects the x-axis pixmap and updates icon | ||||
m_XAxisPixmap->setPixmap( | ||||
pixmap(m_ShowXAxis ? HIDE_AXIS_ICON_PATH : SHOW_AXIS_ICON_PATH)); | ||||
m_Plot.layer(OVERLAY_LAYER)->replot(); | ||||
} | ||||
}); | ||||
} | ||||
/// Updates state of x-axis according to the current selection of x-axis pixmap | ||||
/// @remarks the method doesn't call plot refresh | ||||
void updateXAxisState() noexcept | ||||
{ | ||||
m_Plot.xAxis->setTickLabels(m_ShowXAxis); | ||||
m_Plot.xAxis->setLabel(m_ShowXAxis ? m_XAxisLabel : QString{}); | ||||
|
r482 | } | ||
|
r480 | |||
QCustomPlot &m_Plot; | ||||
|
r482 | QCPItemTracer *m_PointTracer; | ||
QTimer m_TracerTimer; | ||||
|
r726 | QCPItemPixmap *m_ClosePixmap; /// Graph's close button | ||
QCPItemText *m_TitleText; /// Graph's title | ||||
|
r729 | QCPItemPixmap *m_XAxisPixmap; | ||
bool m_ShowXAxis; /// X-axis properties are shown or hidden | ||||
QString m_XAxisLabel; | ||||
|
r1009 | SqpColorScale m_ColorScale; /// Color scale used for some types of graphs (as spectrograms) | ||
|
r480 | }; | ||
|
r725 | VisualizationGraphRenderingDelegate::VisualizationGraphRenderingDelegate( | ||
VisualizationGraphWidget &graphWidget) | ||||
: impl{spimpl::make_unique_impl<VisualizationGraphRenderingDelegatePrivate>(graphWidget)} | ||||
|
r480 | { | ||
} | ||||
|
r481 | |||
|
r1002 | void VisualizationGraphRenderingDelegate::onMouseDoubleClick(QMouseEvent *event) noexcept | ||
{ | ||||
// Opens color scale editor if color scale is double clicked | ||||
|
r1029 | auto colorScale = static_cast<QCPColorScale *>(impl->m_Plot.layoutElementAt(event->pos())); | ||
|
r1013 | if (impl->m_ColorScale.m_Scale == colorScale) { | ||
if (ColorScaleEditor{impl->m_ColorScale}.exec() == QDialog::Accepted) { | ||||
impl->m_Plot.replot(); | ||||
} | ||||
|
r1002 | } | ||
} | ||||
r1363 | void VisualizationGraphRenderingDelegate::updateTooltip(QMouseEvent *event) noexcept | |||
|
r481 | { | ||
|
r482 | // Cancels pending refresh | ||
impl->m_TracerTimer.disconnect(); | ||||
|
r576 | // Reinits tracers | ||
impl->m_PointTracer->setGraph(nullptr); | ||||
impl->m_PointTracer->setVisible(false); | ||||
impl->m_Plot.replot(); | ||||
|
r1024 | QString tooltip{}; | ||
|
r576 | // Gets the graph under the mouse position | ||
auto eventPos = event->pos(); | ||||
if (auto graph = qobject_cast<QCPGraph *>(impl->m_Plot.plottableAt(eventPos))) { | ||||
auto mouseKey = graph->keyAxis()->pixelToCoord(eventPos.x()); | ||||
auto graphData = graph->data(); | ||||
// Gets the closest data point to the mouse | ||||
auto graphDataIt = graphData->findBegin(mouseKey); | ||||
if (graphDataIt != graphData->constEnd()) { | ||||
|
r1024 | // Sets tooltip | ||
|
r576 | auto key = formatValue(graphDataIt->key, *graph->keyAxis()); | ||
auto value = formatValue(graphDataIt->value, *graph->valueAxis()); | ||||
|
r1024 | tooltip = GRAPH_TOOLTIP_FORMAT.arg(key, value); | ||
|
r576 | |||
// Displays point tracer | ||||
impl->m_PointTracer->setGraph(graph); | ||||
impl->m_PointTracer->setGraphKey(graphDataIt->key); | ||||
impl->m_PointTracer->setLayer( | ||||
impl->m_Plot.layer("main")); // Tracer is set on top of the plot's main layer | ||||
impl->m_PointTracer->setVisible(true); | ||||
|
r484 | impl->m_Plot.replot(); | ||
|
r1024 | } | ||
} | ||||
else if (auto colorMap = qobject_cast<QCPColorMap *>(impl->m_Plot.plottableAt(eventPos))) { | ||||
|
r1025 | // Gets x and y coords | ||
auto x = colorMap->keyAxis()->pixelToCoord(eventPos.x()); | ||||
auto y = colorMap->valueAxis()->pixelToCoord(eventPos.y()); | ||||
|
r1026 | |||
// Calculates x and y cell indexes, and retrieves the underlying value | ||||
auto xCellIndex = colorMapCellIndex(*colorMap, x, true); | ||||
auto yCellIndex = colorMapCellIndex(*colorMap, y, false); | ||||
auto value = colorMap->data()->cell(xCellIndex, yCellIndex); | ||||
|
r1027 | // Sets tooltips | ||
tooltip = COLORMAP_TOOLTIP_FORMAT.arg(formatValue(x, *colorMap->keyAxis()), | ||||
formatValue(y, *colorMap->valueAxis()), | ||||
formatValue(value, *colorMap->colorScale()->axis())); | ||||
|
r1024 | } | ||
|
r482 | |||
|
r1024 | if (!tooltip.isEmpty()) { | ||
// Starts timer to show tooltip after timeout | ||||
auto showTooltip = [tooltip, eventPos, this]() { | ||||
QToolTip::showText(impl->m_Plot.mapToGlobal(eventPos) + TOOLTIP_OFFSET, tooltip, | ||||
&impl->m_Plot, TOOLTIP_RECT); | ||||
}; | ||||
|
r576 | |||
|
r1024 | QObject::connect(&impl->m_TracerTimer, &QTimer::timeout, showTooltip); | ||
impl->m_TracerTimer.start(); | ||||
|
r576 | } | ||
|
r481 | } | ||
|
r728 | |||
|
r1020 | void VisualizationGraphRenderingDelegate::onPlotUpdated() noexcept | ||
{ | ||||
// Updates color scale bounds | ||||
impl->m_ColorScale.updateDataRange(); | ||||
impl->m_Plot.replot(); | ||||
} | ||||
|
r1283 | void VisualizationGraphRenderingDelegate::setAxesUnits(const Variable &variable) noexcept | ||
|
r729 | { | ||
|
r1283 | auto axisHelper = IAxisHelperFactory::create(variable); | ||
axisHelper->setUnits(impl->m_Plot, impl->m_ColorScale); | ||||
// Stores x-axis label to be able to retrieve it when x-axis pixmap is unselected | ||||
impl->m_XAxisLabel = impl->m_Plot.xAxis->label(); | ||||
|
r729 | |||
// Updates x-axis state | ||||
impl->updateXAxisState(); | ||||
impl->m_Plot.layer(AXES_LAYER)->replot(); | ||||
} | ||||
|
r1283 | void VisualizationGraphRenderingDelegate::setGraphProperties(const Variable &variable, | ||
PlottablesMap &plottables) noexcept | ||||
|
r919 | { | ||
|
r1283 | // Axes' properties | ||
auto axisHelper = IAxisHelperFactory::create(variable); | ||||
axisHelper->setProperties(impl->m_Plot, impl->m_ColorScale); | ||||
// Plottables' properties | ||||
auto plottablesHelper = IPlottablesHelperFactory::create(variable); | ||||
|
r919 | plottablesHelper->setProperties(plottables); | ||
} | ||||
|
r728 | void VisualizationGraphRenderingDelegate::showGraphOverlay(bool show) noexcept | ||
{ | ||||
auto overlay = impl->m_Plot.layer(OVERLAY_LAYER); | ||||
overlay->setVisible(show); | ||||
overlay->replot(); | ||||
} | ||||