implot/implot.h

// MIT License

// Copyright (c) 2020 Evan Pezent

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

// ImPlot v0.1 WIP

#pragma once
#include <imgui.h>

//-----------------------------------------------------------------------------
// Basic types and flags
//-----------------------------------------------------------------------------

typedef int ImPlotFlags;
typedef int ImAxisFlags;
typedef int ImPlotCol;
typedef int ImPlotStyleVar;
typedef int ImMarker;

// Options for plots
enum ImPlotFlags_ {
    ImPlotFlags_MousePos    = 1 << 0, // the mouse position, in plot coordinates, will be displayed in the bottom-right
    ImPlotFlags_Legend      = 1 << 1, // a legend will be displayed in the top-left
    ImPlotFlags_Highlight   = 1 << 2, // plot items will be highlighted when their legend entry is hovered
    ImPlotFlags_Selection   = 1 << 3, // the user will be able to box-select with right-mouse
    ImPlotFlags_PixelQuery  = 1 << 4, // query ranges will not change their pixel position if the plot is scrolled/zoomed
    ImPlotFlags_ContextMenu = 1 << 5, // the user will be able to open a context menu with double-right click
    ImPlotFlags_Crosshairs  = 1 << 6, // the default mouse cursor will be replaced with a crosshair when hovered
    ImPlotFlags_CullData    = 1 << 7, // plot data outside the plot area will be culled from rendering
    ImPlotFlags_AntiAliased = 1 << 8, // lines and fills will be anti-aliased (not recommended)
    ImPlotFlags_Default     = ImPlotFlags_MousePos | ImPlotFlags_Legend | ImPlotFlags_Highlight | ImPlotFlags_Selection | ImPlotFlags_ContextMenu | ImPlotFlags_CullData
};

// Options for plot axes (X and Y)
enum ImAxisFlags_ {
    ImAxisFlags_GridLines  = 1 << 0, // grid lines will be displayed
    ImAxisFlags_TickMarks  = 1 << 1, // tick marks will be displayed for each grid line
    ImAxisFlags_TickLabels = 1 << 2, // text labels will be displayed for each grid line
    ImAxisFlags_Invert     = 1 << 3, // the axis will be inverted
    ImAxisFlags_LockMin    = 1 << 4, // the axis minimum value will be locked when panning/zooming
    ImAxisFlags_LockMax    = 1 << 5, // the axis maximum value will be locked when panning/zooming
    ImAxisFlags_Adaptive   = 1 << 6, // grid divisions will adapt to the current pixel size the axis
    ImAxisFlags_LogScale   = 1 << 7, // a logartithmic (base 10) axis scale will be used
    ImAxisFlags_Scientific = 1 << 8, // scientific notation will be used for tick labels if displayed (WIP, not very good yet)
    ImAxisFlags_Default    = ImAxisFlags_GridLines | ImAxisFlags_TickMarks | ImAxisFlags_TickLabels | ImAxisFlags_Adaptive
};

// Plot styling colors 
enum ImPlotCol_ {
    ImPlotCol_Line,          // plot line/outline color (defaults to a rotating color set)
    ImPlotCol_Fill,          // plot fill color for bars (defaults to the current line color)
    ImPlotCol_MarkerOutline, // marker outline color (defaults to the current line color)
    ImPlotCol_MarkerFill,    // marker fill color (defaults to the current line color)
    ImPlotCol_ErrorBar,      // error bar color (defaults to ImGuiCol_Text)
    ImPlotCol_FrameBg,       // plot frame background color (defaults to ImGuiCol_FrameBg)
    ImPlotCol_PlotBg,        // plot area background color (defaults to ImGuiCol_WindowBg)
    ImPlotCol_PlotBorder,    // plot area border color (defaults to ImGuiCol_Text)
    ImPlotCol_XAxis,         // x-axis grid/label color (defaults to ImGuiCol_Text)
    ImPlotCol_YAxis,         // x-axis grid/label color (defaults to ImGuiCol_Text)
    ImPlotCol_Selection,     // box-selection color (defaults to yellow)
    ImPlotCol_Query,         // box-query color (defaults to green)
    ImPlotCol_COUNT
};

enum ImPlotStyleVar_ {
    ImPlotStyleVar_LineWeight,         // float, line weight in pixels
    ImPlotStyleVar_Marker,             // int,   marker specification
    ImPlotStyleVar_MarkerSize,         // float, marker size in pixels (roughly the marker's "radius")
    ImPlotStyleVar_MarkerWeight,       // float, outline weight of markers in pixels
    ImPlotStyleVar_ErrorBarSize,       // float, error bar whisker width in pixels
    ImPlotStyleVar_ErrorBarWeight,     // float, error bar whisker weight in pixels
    ImPlotStyleVar_DigitalBitHeight,   // int, digital channels bit height (at 1)
    ImPlotStyleVar_COUNT
};

// Marker specification
enum ImMarker_ {
    ImMarker_None        = 1 << 0,  // no marker
    ImMarker_Circle      = 1 << 1,  // a circle marker will be rendered at each point 
    ImMarker_Square      = 1 << 2,  // a square maker will be rendered at each point
    ImMarker_Diamond     = 1 << 3,  // a diamond marker will be rendered at each point
    ImMarker_Up          = 1 << 4,  // an upward-pointing triangle marker will up rendered at each point
    ImMarker_Down        = 1 << 5,  // an downward-pointing triangle marker will up rendered at each point
    ImMarker_Left        = 1 << 6,  // an leftward-pointing triangle marker will up rendered at each point
    ImMarker_Right       = 1 << 7,  // an rightward-pointing triangle marker will up rendered at each point
    ImMarker_Cross       = 1 << 8,  // a cross marker will be rendered at each point (not filled)
    ImMarker_Plus        = 1 << 9,  // a plus marker will be rendered at each point (not filled)
    ImMarker_Asterisk    = 1 << 10, // a asterisk marker will be rendered at each point (not filled)
};

/// Plot range utility struct
struct ImPlotRange {
    float XMin, XMax, YMin, YMax;
    ImPlotRange();
    bool Contains(const ImVec2& p);
};

// Plot style structure
struct ImPlotStyle {
    float    LineWeight;              // = 1, line weight in pixels
    ImMarker Marker;                  // = ImMarker_None, marker specification
    float    MarkerSize;              // = 5, marker size in pixels (roughly the marker's "radius")
    float    MarkerWeight;            // = 1, outline weight of markers in pixels
    float    ErrorBarSize;            // = 5, error bar whisker width in pixels
    float    ErrorBarWeight;          // = 1.5, error bar whisker weight in pixels
    int      DigitalBitHeight;        // = 7, digital channels bit height (at 1)
    ImVec4   Colors[ImPlotCol_COUNT]; // array of plot specific colors
    ImPlotStyle();
};

//-----------------------------------------------------------------------------
// Core API
//-----------------------------------------------------------------------------

namespace ImGui {

// Starts a 2D plotting context. If this function returns true, EndPlot() must
// be called, e.g. "if (BeginPlot(...)) { ... EndPlot(); }"". #title_id must
// be unique. If you need to avoid ID collisions or don't want to display a
// title in the plot, use double hashes (e.g. "MyPlot##Hidden"). If #x_label
// and/or #y_label are provided, axes labels will be displayed. Flags are only
// set ONCE during the first call to BeginPlot. 
bool BeginPlot(const char* title_id, 
               const char* x_label = NULL, 
               const char* y_label = NULL, 
               const ImVec2& size  = ImVec2(-1,-1), 
               ImPlotFlags flags   = ImPlotFlags_Default, 
               ImAxisFlags x_flags = ImAxisFlags_Default, 
               ImAxisFlags y_flags = ImAxisFlags_Default);
// Only call EndPlot() if BeginPlot() returns true! Typically called at the end
// of an if statement conditioned on BeginPlot().
void EndPlot();

/// Set the axes ranges of the next plot. Call right before BeginPlot(). If ImGuiCond_Always is used, the axes will be locked.
void SetNextPlotRange(float x_min, float x_max, float y_min, float y_max, ImGuiCond cond = ImGuiCond_Once);
/// Set the X axis range of the next plot. Call right before BeginPlot(). If ImGuiCond_Always is used, the axis will be locked.
void SetNextPlotRangeX(float x_min, float x_max, ImGuiCond cond = ImGuiCond_Once);
/// Set the X axis range of the next plot. Call right before BeginPlot(). If ImGuiCond_Always is used, the axis will be locked.
void SetNextPlotRangeY(float y_min, float y_max, ImGuiCond cond = ImGuiCond_Once);

//-----------------------------------------------------------------------------
// Plot Queries
//-----------------------------------------------------------------------------

/// Returns true if the plot area in the current or most recent plot is hovered.
bool IsPlotHovered();
/// Returns the mouse position in x,y coordinates of the current or most recent plot.
ImVec2 GetPlotMousePos();
/// Returns the current or most recent plot axis range.
ImPlotRange GetPlotRange();
/// Returns true if the current or most recent plot is being queried.
bool IsPlotQueried();
/// Returns the current or most recent plot querey range.
ImPlotRange GetPlotQuery();

//-----------------------------------------------------------------------------
// Plot Items
//-----------------------------------------------------------------------------

// Plots a standard 2D line and/or scatter plot .
void Plot(const char* label_id, const float* values, int count, int offset = 0, int stride = sizeof(float));
void Plot(const char* label_id, const float* xs, const float* ys, int count, int offset = 0, int stride = sizeof(float));
void Plot(const char* label_id, ImVec2 (*getter)(void* data, int idx), void* data, int count, int offset = 0);
// Plots digital channels.
void PlotDigital(const char* label_id, const float* xs, const float* ys, int count, int offset = 0, int stride = sizeof(float) + sizeof(bool));
void PlotDigital(const char* label_id, ImVec2 (*getter)(void* data, int idx), void* data, int count, int offset = 0);
// Plots vertical bars.
void PlotBar(const char* label_id, const float* values, int count, float width = 0.67f, float shift = 0, int offset = 0, int stride = sizeof(float));
void PlotBar(const char* label_id, const float* xs, const float* ys, int count, float width, int offset = 0, int stride = sizeof(float));
void PlotBar(const char* label_id, ImVec2 (*getter)(void* data, int idx), void* data, int count, float width, int offset = 0);
// Plots horizontal bars.
void PlotBarH(const char* label_id, const float* values, int count, float height = 0.67f, float shift = 0, int offset = 0, int stride = sizeof(float));
void PlotBarH(const char* label_id, const float* xs, const float* ys, int count, float height,  int offset = 0, int stride = sizeof(float));
void PlotBarH(const char* label_id, ImVec2 (*getter)(void* data, int idx), void* data, int count, float height,  int offset = 0);
// Plots vertical error bars.
void PlotErrorBars(const char* label_id, const float* xs, const float* ys, const float* err, int count, int offset = 0, int stride = sizeof(float));
void PlotErrorBars(const char* label_id, const float* xs, const float* ys, const float* neg, const float* pos, int count, int offset = 0, int stride = sizeof(float));
void PlotErrorBars(const char* label_id, ImVec4 (*getter)(void* data, int idx), void* data, int count, int offset = 0);
// Plots a text label at point x,y.
void PlotLabel(const char* text, float x, float y, bool vertical = false, const ImVec2& pixel_offset = ImVec2(0,0));

//-----------------------------------------------------------------------------
// Plot Styling
//-----------------------------------------------------------------------------

// Provides access to plot style structure for permanant modifications to colors, sizes, etc.
ImPlotStyle& GetPlotStyle();

// Sets the color palette to be used for plot items.
void SetPlotPalette(const ImVec4* colors, int num_colors);
// Restores the default ImPlot color map.
void RestorePlotPalette();

// Temporarily modify a plot color.
void PushPlotColor(ImPlotCol idx, ImU32 col);
// Temporarily modify a plot color.
void PushPlotColor(ImPlotCol idx, const ImVec4& col);
// Undo temporary color modification. 
void PopPlotColor(int count = 1);

// Temporarily modify a style variable of float type.
void PushPlotStyleVar(ImPlotStyleVar idx, float val);
// Temporarily modify a style variable of int type.
void PushPlotStyleVar(ImPlotStyleVar idx, int val);
// Undo temporary style modification.
void PopPlotStyleVar(int count = 1);

//-----------------------------------------------------------------------------
// Demo
//-----------------------------------------------------------------------------

// Shows the ImPlot demo. Add implot_demo.cpp to your sources!
void ShowImPlotDemoWindow(bool* p_open = NULL);

}  // namespace ImGui