PlotItemStyle.hpp

Go to the documentation of this file.

// This file is part of INSTINCT, the INS Toolkit for Integrated
// Navigation Concepts and Training by the Institute of Navigation of
// the University of Stuttgart, Germany.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
 
#pragma once
 
#include <string>
#include <imgui.h>
#include <implot.h>
 
#include "util/Json.hpp"
#include "util/Plot/Colormap.hpp"
#include "util/Plot/PlotEventTooltip.hpp"
#include "util/Container/ScrollingBuffer.hpp"
 
namespace NAV
{
 
struct PlotItemStyle
{
    enum class LineType : uint8_t
    {
        Scatter, 
        Line,    
    };
 
    std::string legendName;
    std::string legendNameGui;
    LineType lineType = LineType::Line;
    ImVec4 color = IMPLOT_AUTO_COL;
    std::pair<ColormapMaskType, int64_t> colormapMask = { ColormapMaskType::None, -1 };
    size_t colormapMaskDataCmpIdx = 0;
    float thickness = 1.0F;
    std::optional<ImPlotLineFlags> lineFlags;
 
    int stride = 0;
 
    std::pair<ColormapMaskType, int64_t> markerColormapMask = { ColormapMaskType::None, -1 };
    size_t markerColormapMaskDataCmpIdx = 0;
    bool markers = false;
    ImPlotMarker markerStyle = ImPlotMarker_Cross;
    float markerSize = 1.0F;
    float markerWeight = 1.0F;
    ImVec4 markerFillColor = IMPLOT_AUTO_COL;
    ImVec4 markerOutlineColor = IMPLOT_AUTO_COL;
 
    bool errorBoundsEnabled = false;
    size_t errorBoundsDataIdx = 0;
    float errorBoundsAlpha = 0.25F;
    std::string errorBoundsModifierExpression;
    std::string errorBoundsModifierExpressionTemp;
 
    bool eventsEnabled = false;
    ImPlotMarker eventMarkerStyle = ImPlotMarker_Cross;
    float eventMarkerSize = 6.0F;
    float eventMarkerWeight = 2.0F;
    ImVec4 eventMarkerFillColor = ImVec4(1.0, 0.0, 0.0, 1.0);
    ImVec4 eventMarkerOutlineColor = ImVec4(1.0, 0.0, 0.0, 1.0);
    std::string eventTooltipFilterRegex;
 
    struct LegendPopupReturn
    {
        bool changed = false;                 
        bool errorBoundsReCalcNeeded = false; 
    };
 
    LegendPopupReturn showLegendPopup(const char* id,
                                      const char* displayTitle,
                                      int plotDataBufferSize,
                                      int plotElementIdx,
                                      const char* nameId,
                                      ImPlotLineFlags plotLineFlags = ImPlotLineFlags_NoClip | ImPlotLineFlags_SkipNaN,
                                      ScrollingBuffer<ImU32>* colormapMaskColors = nullptr,
                                      ScrollingBuffer<ImU32>* markerColormapMaskColors = nullptr,
                                      const std::function<bool(size_t&, const char*)>& ShowDataReferenceChooser = nullptr,
                                      ScrollingBuffer<double>* eventMarker = nullptr,
                                      std::vector<std::tuple<double, double, PlotEventTooltip>>* eventTooltips = nullptr);
 
    void plotData(const char* plotName,
                  const ScrollingBuffer<double>& xData,
                  const ScrollingBuffer<double>& yData,
                  int plotElementIdx,
                  int defaultStride = 1,
                  ImPlotLineFlags plotLineFlags = ImPlotLineFlags_NoClip | ImPlotLineFlags_SkipNaN,
                  ScrollingBuffer<ImU32>* colormapMaskColors = nullptr,
                  ScrollingBuffer<ImU32>* markerColormapMaskColors = nullptr,
                  const std::array<ScrollingBuffer<double>, 2>* yErrorData = nullptr) const;
};
 
void to_json(json& j, const PlotItemStyle& style);
void from_json(const json& j, PlotItemStyle& style);
 
} // namespace NAV