1
0
Fork 0
mirror of https://github.com/gwm17/implot.git synced 2024-11-23 02:38:53 -05:00
implot/implot.h

578 lines
37 KiB
C
Raw Normal View History

2020-04-27 11:27:59 -04:00
// 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.
2020-09-02 16:55:35 -04:00
// ImPlot v0.7 WIP
2020-04-27 11:27:59 -04:00
#pragma once
#include "imgui.h"
2020-04-27 11:27:59 -04:00
2020-08-30 18:12:36 -04:00
//-----------------------------------------------------------------------------
// Macros and Defines
//-----------------------------------------------------------------------------
// ImPlot version string
2020-09-02 16:55:35 -04:00
#define IMPLOT_VERSION "0.7 WIP"
2020-08-30 18:12:36 -04:00
// Indicates variable should deduced automatically.
#define IMPLOT_AUTO -1
2020-09-01 00:23:48 -04:00
// Special color used to indicate that a color should be deduced automatically.
2020-08-30 18:12:36 -04:00
#define IMPLOT_AUTO_COL ImVec4(0,0,0,-1)
2020-08-16 16:38:51 -04:00
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
2020-08-16 16:38:51 -04:00
// Forward Declarations and Basic Types
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
// Forward declarations
2020-08-16 16:38:51 -04:00
struct ImPlotContext; // ImPlot context (opaque struct, see implot_internal.h)
// Enums/Flags
typedef int ImPlotFlags; // -> enum ImPlotFlags_
typedef int ImPlotAxisFlags; // -> enum ImPlotAxisFlags_
typedef int ImPlotCol; // -> enum ImPlotCol_
typedef int ImPlotStyleVar; // -> enum ImPlotStyleVar_
typedef int ImPlotMarker; // -> enum ImPlotMarker_
typedef int ImPlotColormap; // -> enum ImPlotColormap_
2020-04-27 11:27:59 -04:00
2020-05-31 10:28:34 -04:00
// Options for plots.
2020-04-27 11:27:59 -04:00
enum ImPlotFlags_ {
2020-09-06 01:42:03 -04:00
ImPlotFlags_None = 0, // default
ImPlotFlags_NoLegend = 1 << 0, // the top-left legend will not be displayed
2020-09-06 02:32:15 -04:00
ImPlotFlags_NoMenus = 1 << 1, // the user will not be able to open context menus with double-right click
ImPlotFlags_NoBoxSelect = 1 << 2, // the user will not be able to box-select with right-mouse
2020-09-06 01:42:03 -04:00
ImPlotFlags_NoMousePos = 1 << 3, // the mouse position, in plot coordinates, will not be displayed in the bottom-right
2020-09-06 02:32:15 -04:00
ImPlotFlags_NoHighlight = 1 << 4, // plot items will not be highlighted when their legend entry is hovered
2020-09-06 01:42:03 -04:00
ImPlotFlags_NoChild = 1 << 5, // a child window region will not be used to capture mouse scroll (can boost performance for single ImGui window applications)
2020-09-06 02:32:15 -04:00
ImPlotFlags_YAxis2 = 1 << 6, // enable a 2nd y-axis on the right side
ImPlotFlags_YAxis3 = 1 << 7, // enable a 3rd y-axis on the right side
2020-09-06 01:42:03 -04:00
ImPlotFlags_Query = 1 << 8, // the user will be able to draw query rects with middle-mouse
ImPlotFlags_Crosshairs = 1 << 9, // the default mouse cursor will be replaced with a crosshair when hovered
2020-09-06 02:32:15 -04:00
ImPlotFlags_AntiAliased = 1 << 10, // plot lines will be software anti-aliased (not recommended for density plots, prefer MSAA)
ImPlotFlags_CanvasOnly = ImPlotFlags_NoLegend | ImPlotFlags_NoMenus | ImPlotFlags_NoBoxSelect | ImPlotFlags_NoMousePos
2020-04-27 11:27:59 -04:00
};
2020-05-31 10:28:34 -04:00
// Options for plot axes (X and Y).
enum ImPlotAxisFlags_ {
2020-09-06 02:38:18 -04:00
ImPlotAxisFlags_None = 0, // default
ImPlotAxisFlags_NoGridLines = 1 << 0, // no grid lines will be displayed
ImPlotAxisFlags_NoTickMarks = 1 << 1, // no tick marks will be displayed
ImPlotAxisFlags_NoTickLabels = 1 << 2, // no text labels will be displayed
ImPlotAxisFlags_LogScale = 1 << 3, // a logartithmic (base 10) axis scale will be used (mutually exclusive with ImPlotAxisFlags_Time)
ImPlotAxisFlags_Time = 1 << 4, // axis will display date/time formatted labels (mutually exclusive with ImPlotAxisFlags_LogScale)
ImPlotAxisFlags_Invert = 1 << 5, // the axis will be inverted
ImPlotAxisFlags_LockMin = 1 << 6, // the axis minimum value will be locked when panning/zooming
ImPlotAxisFlags_LockMax = 1 << 7, // the axis maximum value will be locked when panning/zooming
ImPlotAxisFlags_Lock = ImPlotAxisFlags_LockMin | ImPlotAxisFlags_LockMax,
ImPlotAxisFlags_NoDecorations = ImPlotAxisFlags_NoGridLines | ImPlotAxisFlags_NoTickMarks | ImPlotAxisFlags_NoTickLabels
2020-04-27 11:27:59 -04:00
};
2020-05-31 10:28:34 -04:00
// Plot styling colors.
2020-04-27 11:27:59 -04:00
enum ImPlotCol_ {
2020-09-01 00:23:48 -04:00
// item styling colors
ImPlotCol_Line, // plot line/outline color (defaults to next unused color in current colormap)
2020-04-27 11:27:59 -04:00
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)
2020-09-01 00:23:48 -04:00
// plot styling colors
2020-04-27 11:27:59 -04:00
ImPlotCol_FrameBg, // plot frame background color (defaults to ImGuiCol_FrameBg)
ImPlotCol_PlotBg, // plot area background color (defaults to ImGuiCol_WindowBg)
2020-08-24 12:06:29 -04:00
ImPlotCol_PlotBorder, // plot area border color (defaults to ImGuiCol_Border)
2020-08-24 00:45:42 -04:00
ImPlotCol_LegendBg, // legend background color (defaults to ImGuiCol_PopupBg)
ImPlotCol_LegendBorder, // legend border color (defaults to ImPlotCol_PlotBorder)
ImPlotCol_LegendText, // legend text color (defaults to ImPlotCol_InlayText)
ImPlotCol_TitleText, // plot title text color (defaults to ImGuiCol_Text)
ImPlotCol_InlayText, // color of text appearing inside of plots (defaults to ImGuiCol_Text)
ImPlotCol_XAxis, // x-axis label and tick lables color (defaults to ImGuiCol_Text)
ImPlotCol_XAxisGrid, // x-axis grid color (defaults to 25% ImPlotCol_XAxis)
ImPlotCol_YAxis, // y-axis label and tick labels color (defaults to ImGuiCol_Text)
ImPlotCol_YAxisGrid, // y-axis grid color (defaults to 25% ImPlotCol_YAxis)
ImPlotCol_YAxis2, // 2nd y-axis label and tick labels color (defaults to ImGuiCol_Text)
ImPlotCol_YAxisGrid2, // 2nd y-axis grid/label color (defaults to 25% ImPlotCol_YAxis2)
ImPlotCol_YAxis3, // 3rd y-axis label and tick labels color (defaults to ImGuiCol_Text)
ImPlotCol_YAxisGrid3, // 3rd y-axis grid/label color (defaults to 25% ImPlotCol_YAxis3)
2020-04-27 11:27:59 -04:00
ImPlotCol_Selection, // box-selection color (defaults to yellow)
ImPlotCol_Query, // box-query color (defaults to green)
2020-08-24 00:45:42 -04:00
ImPlotCol_Crosshairs, // crosshairs color (defaults to ImPlotCol_PlotBorder)
2020-04-27 11:27:59 -04:00
ImPlotCol_COUNT
};
2020-05-31 10:28:34 -04:00
// Plot styling variables.
2020-04-27 11:27:59 -04:00
enum ImPlotStyleVar_ {
2020-08-24 00:45:42 -04:00
// item styling variables
ImPlotStyleVar_LineWeight, // float, plot item line weight in pixels
ImPlotStyleVar_Marker, // int, marker specification
ImPlotStyleVar_MarkerSize, // float, marker size in pixels (roughly the marker's "radius")
ImPlotStyleVar_MarkerWeight, // float, plot outline weight of markers in pixels
ImPlotStyleVar_FillAlpha, // float, alpha modifier applied to all plot item fills
ImPlotStyleVar_ErrorBarSize, // float, error bar whisker width in pixels
ImPlotStyleVar_ErrorBarWeight, // float, error bar whisker weight in pixels
ImPlotStyleVar_DigitalBitHeight, // float, digital channels bit height (at 1) in pixels
ImPlotStyleVar_DigitalBitGap, // float, digital channels bit padding gap in pixels
// plot styling variables
ImPlotStyleVar_PlotBorderSize, // float, thickness of border around plot area
ImPlotStyleVar_MinorAlpha, // float, alpha multiplier applied to minor axis grid lines
ImPlotStyleVar_MajorTickLen, // ImVec2, major tick lengths for X and Y axes
ImPlotStyleVar_MinorTickLen, // ImVec2, minor tick lengths for X and Y axes
ImPlotStyleVar_MajorTickSize, // ImVec2, line thickness of major ticks
ImPlotStyleVar_MinorTickSize, // ImVec2, line thickness of minor ticks
ImPlotStyleVar_MajorGridSize, // ImVec2, line thickness of major grid lines
ImPlotStyleVar_MinorGridSize, // ImVec2, line thickness of minor grid lines
ImPlotStyleVar_PlotPadding, // ImVec2, padding between widget frame and plot area and/or labels
2020-08-24 00:45:42 -04:00
ImPlotStyleVar_LabelPadding, // ImVec2, padding between axes labels, tick labels, and plot edge
ImPlotStyleVar_LegendPadding, // ImVec2, legend padding from top-left of plot
ImPlotStyleVar_InfoPadding, // ImVec2, padding between plot edge and interior info text
ImPlotStyleVar_PlotMinSize, // ImVec2, minimum size plot frame can be when shrunk
2020-04-27 11:27:59 -04:00
ImPlotStyleVar_COUNT
};
// Marker specifications.
enum ImPlotMarker_ {
2020-09-01 00:23:48 -04:00
ImPlotMarker_None = -1, // no marker
ImPlotMarker_Circle, // a circle marker
ImPlotMarker_Square, // a square maker
ImPlotMarker_Diamond, // a diamond marker
ImPlotMarker_Up, // an upward-pointing triangle marker
ImPlotMarker_Down, // an downward-pointing triangle marker
ImPlotMarker_Left, // an leftward-pointing triangle marker
ImPlotMarker_Right, // an rightward-pointing triangle marker
ImPlotMarker_Cross, // a cross marker (not fillable)
ImPlotMarker_Plus, // a plus marker (not fillable)
ImPlotMarker_Asterisk, // a asterisk marker (not fillable)
ImPlotMarker_COUNT
2020-04-27 11:27:59 -04:00
};
2020-06-01 23:14:22 -04:00
// Built-in colormaps
enum ImPlotColormap_ {
2020-08-24 00:45:42 -04:00
ImPlotColormap_Default = 0, // ImPlot default colormap (n=10)
2020-08-24 12:06:29 -04:00
ImPlotColormap_Deep = 1, // a.k.a. seaborn deep (n=10)
ImPlotColormap_Dark = 2, // a.k.a. matplotlib "Set1" (n=9)
ImPlotColormap_Pastel = 3, // a.k.a. matplotlib "Pastel1" (n=9)
ImPlotColormap_Paired = 4, // a.k.a. matplotlib "Paired" (n=12)
2020-08-24 00:45:42 -04:00
ImPlotColormap_Viridis = 5, // a.k.a. matplotlib "viridis" (n=11)
ImPlotColormap_Plasma = 6, // a.k.a. matplotlib "plasma" (n=11)
ImPlotColormap_Hot = 7, // a.k.a. matplotlib/MATLAB "hot" (n=11)
ImPlotColormap_Cool = 8, // a.k.a. matplotlib/MATLAB "cool" (n=11)
ImPlotColormap_Pink = 9, // a.k.a. matplotlib/MATLAB "pink" (n=11)
ImPlotColormap_Jet = 10, // a.k.a. MATLAB "jet" (n=11)
2020-06-01 23:14:22 -04:00
ImPlotColormap_COUNT
};
// Double precision version of ImVec2 used by ImPlot. Extensible by end users.
2020-05-16 22:09:36 -04:00
struct ImPlotPoint {
2020-05-29 13:39:30 -04:00
double x, y;
ImPlotPoint() { x = y = 0.0; }
2020-08-16 16:38:51 -04:00
ImPlotPoint(double _x, double _y) { x = _x; y = _y; }
2020-05-29 13:39:30 -04:00
double operator[] (size_t idx) const { return (&x)[idx]; }
double& operator[] (size_t idx) { return (&x)[idx]; }
#ifdef IMPLOT_POINT_CLASS_EXTRA
2020-08-24 12:48:00 -04:00
IMPLOT_POINT_CLASS_EXTRA // Define additional constructors and implicit cast operators in imconfig.h
// to convert back and forth between your math types and ImPlotPoint.
2020-05-29 13:39:30 -04:00
#endif
2020-05-16 22:09:36 -04:00
};
2020-05-11 07:13:08 -04:00
// A range defined by a min/max value. Used for plot axes ranges.
struct ImPlotRange {
2020-05-29 13:39:30 -04:00
double Min, Max;
ImPlotRange();
ImPlotRange(double _min, double _max) { Min = _min; Max = _max; }
bool Contains(double value) const { return value >= Min && value <= Max; };
double Size() const { return Max - Min; };
2020-05-11 07:13:08 -04:00
};
// Combination of two ranges for X and Y axes.
struct ImPlotLimits {
ImPlotRange X, Y;
2020-08-16 16:38:51 -04:00
bool Contains(const ImPlotPoint& p) const { return Contains(p.x, p.y); }
bool Contains(double x, double y) const { return X.Contains(x) && Y.Contains(y); }
};
2020-04-27 11:27:59 -04:00
// Plot style structure
struct ImPlotStyle {
2020-08-24 00:45:42 -04:00
// item styling variables
2020-09-06 02:48:47 -04:00
float LineWeight; // = 1, item line weight in pixels
int Marker; // = ImPlotMarker_None, marker specification
float MarkerSize; // = 4, marker size in pixels (roughly the marker's "radius")
float MarkerWeight; // = 1, outline weight of markers in pixels
float FillAlpha; // = 1, alpha modifier applied to plot fills
float ErrorBarSize; // = 5, error bar whisker width in pixels
float ErrorBarWeight; // = 1.5, error bar whisker weight in pixels
float DigitalBitHeight; // = 8, digital channels bit height (at y = 1.0f) in pixels
float DigitalBitGap; // = 4, digital channels bit padding gap in pixels
2020-08-24 00:45:42 -04:00
// plot styling variables
2020-09-06 02:48:47 -04:00
float PlotBorderSize; // = 1, line thickness of border around plot area
float MinorAlpha; // = 0.25 alpha multiplier applied to minor axis grid lines
ImVec2 MajorTickLen; // = 10,10 major tick lengths for X and Y axes
ImVec2 MinorTickLen; // = 5,5 minor tick lengths for X and Y axes
ImVec2 MajorTickSize; // = 1,1 line thickness of major ticks
ImVec2 MinorTickSize; // = 1,1 line thickness of minor ticks
ImVec2 MajorGridSize; // = 1,1 line thickness of major grid lines
ImVec2 MinorGridSize; // = 1,1 line thickness of minor grid lines
ImVec2 PlotPadding; // = 8,8 padding between widget frame and plot area and/or labels
ImVec2 LabelPadding; // = 5,5 padding between axes labels, tick labels, and plot edge
ImVec2 LegendPadding; // = 10,10 legend padding from top-left of plot
ImVec2 InfoPadding; // = 10,10 padding between plot edge and interior info text
ImVec2 PlotMinSize; // = 300,225 minimum size plot frame can be when shrunk
2020-09-06 15:48:16 -04:00
// colors
2020-09-06 02:48:47 -04:00
ImVec4 Colors[ImPlotCol_COUNT]; // array of plot specific colors
2020-09-06 15:48:16 -04:00
// settings/flags
bool AntiAliasedLines; // = false, enable global anti-aliasing on plot lines (overrides ImPlotFlags_AntiAliased)
bool UseLocalTime; // = false, axis labels will be formatted for your timezone when ImPlotAxisFlag_Time is enabled
2020-04-27 11:27:59 -04:00
ImPlotStyle();
};
// Input mapping structure, default values listed in the comments.
struct ImPlotInputMap {
2020-06-15 20:54:58 -04:00
ImGuiMouseButton PanButton; // LMB enables panning when held
ImGuiKeyModFlags PanMod; // none optional modifier that must be held for panning
ImGuiMouseButton FitButton; // LMB fits visible data when double clicked
ImGuiMouseButton ContextMenuButton; // RMB opens plot context menu (if enabled) when double clicked
ImGuiMouseButton BoxSelectButton; // RMB begins box selection when pressed and confirms selection when released
ImGuiKeyModFlags BoxSelectMod; // none optional modifier that must be held for box selection
ImGuiMouseButton BoxSelectCancelButton; // LMB cancels active box selection when pressed
ImGuiMouseButton QueryButton; // MMB begins query selection when pressed and end query selection when released
ImGuiKeyModFlags QueryMod; // none optional modifier that must be held for query selection
ImGuiKeyModFlags QueryToggleMod; // Ctrl when held, active box selections turn into queries
ImGuiKeyModFlags HorizontalMod; // Alt expands active box selection/query horizontally to plot edge when held
ImGuiKeyModFlags VerticalMod; // Shift expands active box selection/query vertically to plot edge when held
ImPlotInputMap();
};
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
2020-08-16 16:38:51 -04:00
// ImPlot End-User API
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
2020-05-12 05:19:34 -04:00
namespace ImPlot {
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
// ImPlot Context
//-----------------------------------------------------------------------------
// Creates a new ImPlot context. Call this after ImGui::CreateContext.
ImPlotContext* CreateContext();
// Destroys an ImPlot context. Call this before ImGui::DestroyContext. NULL = destroy current context
2020-08-16 16:38:51 -04:00
void DestroyContext(ImPlotContext* ctx = NULL);
// Returns the current context. NULL if not context has ben set.
ImPlotContext* GetCurrentContext();
2020-08-16 16:38:51 -04:00
// Sets the current context.
void SetCurrentContext(ImPlotContext* ctx);
//-----------------------------------------------------------------------------
// Begin/End Plot
//-----------------------------------------------------------------------------
2020-04-27 11:27:59 -04:00
// Starts a 2D plotting context. If this function returns true, EndPlot() must
2020-08-16 01:49:34 -04:00
// be called, e.g. "if (BeginPlot(...)) { ... EndPlot(); }". #title_id must
2020-04-27 11:27:59 -04:00
// be unique. If you need to avoid ID collisions or don't want to display a
2020-09-01 00:23:48 -04:00
// title in the plot, use double hashes (e.g. "MyPlot##Hidden" or "##NoTitle").
// If #x_label and/or #y_label are provided, axes labels will be displayed.
2020-05-13 10:11:25 -04:00
bool BeginPlot(const char* title_id,
2020-05-16 10:14:48 -04:00
const char* x_label = NULL,
const char* y_label = NULL,
const ImVec2& size = ImVec2(-1,0),
2020-09-06 01:42:03 -04:00
ImPlotFlags flags = ImPlotFlags_None,
2020-09-06 02:32:15 -04:00
ImPlotAxisFlags x_flags = ImPlotAxisFlags_None,
ImPlotAxisFlags y_flags = ImPlotAxisFlags_None,
ImPlotAxisFlags y2_flags = ImPlotAxisFlags_NoGridLines,
ImPlotAxisFlags y3_flags = ImPlotAxisFlags_NoGridLines);
2020-08-23 00:26:49 -04:00
2020-04-27 11:27:59 -04:00
// Only call EndPlot() if BeginPlot() returns true! Typically called at the end
// of an if statement conditioned on BeginPlot().
void EndPlot();
//-----------------------------------------------------------------------------
2020-07-28 23:22:37 -04:00
// Plot Items
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
// Plots a standard 2D line plot.
void PlotLine(const char* label_id, const float* values, int count, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotLine(const char* label_id, const double* values, int count, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotLine(const char* label_id, const float* xs, const float* ys, int count, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotLine(const char* label_id, const double* xs, const double* ys, int count, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotLine(const char* label_id, const ImVec2* data, int count, int offset = 0);
2020-05-29 13:39:30 -04:00
void PlotLine(const char* label_id, const ImPlotPoint* data, int count, int offset = 0);
2020-05-31 10:17:07 -04:00
void PlotLine(const char* label_id, ImPlotPoint (*getter)(void* data, int idx), void* data, int count, int offset = 0);
2020-08-23 00:26:49 -04:00
// Plots a standard 2D scatter plot. Default marker is ImPlotMarker_Circle.
2020-05-31 10:17:07 -04:00
void PlotScatter(const char* label_id, const float* values, int count, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotScatter(const char* label_id, const double* values, int count, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotScatter(const char* label_id, const float* xs, const float* ys, int count, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotScatter(const char* label_id, const double* xs, const double* ys, int count, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotScatter(const char* label_id, const ImVec2* data, int count, int offset = 0);
2020-05-29 13:39:30 -04:00
void PlotScatter(const char* label_id, const ImPlotPoint* data, int count, int offset = 0);
2020-05-31 10:17:07 -04:00
void PlotScatter(const char* label_id, ImPlotPoint (*getter)(void* data, int idx), void* data, int count, int offset = 0);
2020-06-13 13:42:47 -04:00
// Plots a shaded (filled) region between two lines, or a line and a horizontal reference.
void PlotShaded(const char* label_id, const float* values, int count, float y_ref = 0, int offset = 0, int stride = sizeof(float));
void PlotShaded(const char* label_id, const double* values, int count, double y_ref = 0, int offset = 0, int stride = sizeof(double));
2020-06-13 13:42:47 -04:00
void PlotShaded(const char* label_id, const float* xs, const float* ys, int count, float y_ref = 0, int offset = 0, int stride = sizeof(float));
void PlotShaded(const char* label_id, const double* xs, const double* ys, int count, double y_ref = 0, int offset = 0, int stride = sizeof(double));
void PlotShaded(const char* label_id, const float* xs, const float* ys1, const float* ys2, int count, int offset = 0, int stride = sizeof(float));
void PlotShaded(const char* label_id, const double* xs, const double* ys1, const double* ys2, int count, int offset = 0, int stride = sizeof(double));
void PlotShaded(const char* label_id, ImPlotPoint (*getter1)(void* data, int idx), void* data1, ImPlotPoint (*getter2)(void* data, int idx), void* data2, int count, int offset = 0);
2020-06-13 13:42:47 -04:00
// Plots a vertical bar graph. #width and #shift are in X units.
2020-05-31 10:17:07 -04:00
void PlotBars(const char* label_id, const float* values, int count, float width = 0.67f, float shift = 0, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotBars(const char* label_id, const double* values, int count, double width = 0.67f, double shift = 0, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotBars(const char* label_id, const float* xs, const float* ys, int count, float width, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotBars(const char* label_id, const double* xs, const double* ys, int count, double width, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotBars(const char* label_id, ImPlotPoint (*getter)(void* data, int idx), void* data, int count, double width, int offset = 0);
2020-08-23 00:26:49 -04:00
// Plots a horizontal bar graph. #height and #shift are in Y units.
2020-05-31 10:17:07 -04:00
void PlotBarsH(const char* label_id, const float* values, int count, float height = 0.67f, float shift = 0, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotBarsH(const char* label_id, const double* values, int count, double height = 0.67f, double shift = 0, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotBarsH(const char* label_id, const float* xs, const float* ys, int count, float height, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotBarsH(const char* label_id, const double* xs, const double* ys, int count, double height, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotBarsH(const char* label_id, ImPlotPoint (*getter)(void* data, int idx), void* data, int count, double height, int offset = 0);
// Plots vertical error bar. The label_id should be the same as the label_id of the associated line or bar plot.
2020-05-31 10:17:07 -04:00
void PlotErrorBars(const char* label_id, const float* xs, const float* ys, const float* err, int count, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotErrorBars(const char* label_id, const double* xs, const double* ys, const double* err, int count, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
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));
2020-05-29 13:39:30 -04:00
void PlotErrorBars(const char* label_id, const double* xs, const double* ys, const double* neg, const double* pos, int count, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
// Plots horizontal error bars. The label_id should be the same as the label_id of the associated line or bar plot.
void PlotErrorBarsH(const char* label_id, const float* xs, const float* ys, const float* err, int count, int offset = 0, int stride = sizeof(float));
void PlotErrorBarsH(const char* label_id, const double* xs, const double* ys, const double* err, int count, int offset = 0, int stride = sizeof(double));
void PlotErrorBarsH(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 PlotErrorBarsH(const char* label_id, const double* xs, const double* ys, const double* neg, const double* pos, int count, int offset = 0, int stride = sizeof(double));
2020-06-07 18:39:25 -04:00
2020-09-02 10:17:18 -04:00
/// Plots vertical stems.
void PlotStems(const char* label_id, const float* values, int count, float y_ref = 0, int offset = 0, int stride = sizeof(float));
void PlotStems(const char* label_id, const double* values, int count, double y_ref = 0, int offset = 0, int stride = sizeof(double));
void PlotStems(const char* label_id, const float* xs, const float* ys, int count, float y_ref = 0, int offset = 0, int stride = sizeof(float));
void PlotStems(const char* label_id, const double* xs, const double* ys, int count, double y_ref = 0, int offset = 0, int stride = sizeof(double));
2020-08-23 00:26:49 -04:00
// Plots a pie chart. If the sum of values > 1 or normalize is true, each value will be normalized. Center and radius are in plot units. #label_fmt can be set to NULL for no labels.
void PlotPieChart(const char** label_ids, const float* values, int count, float x, float y, float radius, bool normalize = false, const char* label_fmt = "%.1f", float angle0 = 90);
void PlotPieChart(const char** label_ids, const double* values, int count, double x, double y, double radius, bool normalize = false, const char* label_fmt = "%.1f", double angle0 = 90);
2020-05-31 10:17:07 -04:00
2020-08-23 00:26:49 -04:00
// Plots a 2D heatmap chart. Values are expected to be in row-major order. #label_fmt can be set to NULL for no labels.
void PlotHeatmap(const char* label_id, const float* values, int rows, int cols, float scale_min, float scale_max, const char* label_fmt = "%.1f", const ImPlotPoint& bounds_min = ImPlotPoint(0,0), const ImPlotPoint& bounds_max = ImPlotPoint(1,1));
void PlotHeatmap(const char* label_id, const double* values, int rows, int cols, double scale_min, double scale_max, const char* label_fmt = "%.1f", const ImPlotPoint& bounds_min = ImPlotPoint(0,0), const ImPlotPoint& bounds_max = ImPlotPoint(1,1));
2020-06-01 18:33:01 -04:00
2020-08-23 00:26:49 -04:00
// Plots digital data. Digital plots do not respond to y drag or zoom, and are always referenced to the bottom of the plot.
2020-05-31 10:17:07 -04:00
void PlotDigital(const char* label_id, const float* xs, const float* ys, int count, int offset = 0, int stride = sizeof(float));
2020-05-29 13:39:30 -04:00
void PlotDigital(const char* label_id, const double* xs, const double* ys, int count, int offset = 0, int stride = sizeof(double));
2020-05-31 10:17:07 -04:00
void PlotDigital(const char* label_id, ImPlotPoint (*getter)(void* data, int idx), void* data, int count, int offset = 0);
2020-09-01 22:01:00 -04:00
// Plots a centered text label at point x,y with optional pixel offset. Text color can be changed with ImPlot::PushStyleColor(ImPlotCol_InlayText, ...).
2020-05-31 10:17:07 -04:00
void PlotText(const char* text, float x, float y, bool vertical = false, const ImVec2& pixel_offset = ImVec2(0,0));
2020-05-29 13:39:30 -04:00
void PlotText(const char* text, double x, double y, bool vertical = false, const ImVec2& pixel_offset = ImVec2(0,0));
2020-05-29 09:40:04 -04:00
2020-08-23 00:26:49 -04:00
//-----------------------------------------------------------------------------
// Plot Utils
//-----------------------------------------------------------------------------
// Set the axes range limits of the next plot. Call right before BeginPlot(). If ImGuiCond_Always is used, the axes limits will be locked.
2020-09-03 10:19:34 -04:00
void SetNextPlotLimits(double xmin, double xmax, double ymin, double ymax, ImGuiCond cond = ImGuiCond_Once);
2020-08-23 00:26:49 -04:00
// Set the X axis range limits of the next plot. Call right before BeginPlot(). If ImGuiCond_Always is used, the X axis limits will be locked.
2020-09-03 10:19:34 -04:00
void SetNextPlotLimitsX(double xmin, double xmax, ImGuiCond cond = ImGuiCond_Once);
2020-08-23 00:26:49 -04:00
// Set the Y axis range limits of the next plot. Call right before BeginPlot(). If ImGuiCond_Always is used, the Y axis limits will be locked.
2020-09-03 10:19:34 -04:00
void SetNextPlotLimitsY(double ymin, double ymax, ImGuiCond cond = ImGuiCond_Once, int y_axis = 0);
2020-09-06 17:09:00 -04:00
// Links the next plot limits to external values. Set to NULL for no linkage. The pointer data must remain valid until the matching call EndPlot.
2020-09-03 10:19:34 -04:00
void LinkNextPlotLimits(double* xmin, double* xmax, double* ymin, double* ymax, double* ymin2 = NULL, double* ymax2 = NULL, double* ymin3 = NULL, double* ymax3 = NULL);
2020-08-23 00:26:49 -04:00
// Fits the next plot axes to all plotted data if they are unlocked (equivalent to double-clicks).
void FitNextPlotAxes(bool x = true, bool y = true, bool y2 = true, bool y3 = true);
// Set the X axis ticks and optionally the labels for the next plot.
void SetNextPlotTicksX(const double* values, int n_ticks, const char** labels = NULL, bool show_default = false);
void SetNextPlotTicksX(double x_min, double x_max, int n_ticks, const char** labels = NULL, bool show_default = false);
// Set the Y axis ticks and optionally the labels for the next plot.
void SetNextPlotTicksY(const double* values, int n_ticks, const char** labels = NULL, bool show_default = false, int y_axis = 0);
void SetNextPlotTicksY(double y_min, double y_max, int n_ticks, const char** labels = NULL, bool show_default = false, int y_axis = 0);
2020-08-24 00:45:42 -04:00
// Select which Y axis will be used for subsequent plot elements. The default is '0', or the first (left) Y axis. Enable 2nd and 3rd axes with ImPlotFlags_YAxisX.
void SetPlotYAxis(int y_axis);
2020-08-23 00:26:49 -04:00
// Convert pixels to a position in the current plot's coordinate system. A negative y_axis uses the current value of SetPlotYAxis (0 initially).
2020-08-30 18:12:36 -04:00
ImPlotPoint PixelsToPlot(const ImVec2& pix, int y_axis = IMPLOT_AUTO);
ImPlotPoint PixelsToPlot(float x, float y, int y_axis = IMPLOT_AUTO);
2020-08-23 00:26:49 -04:00
// Convert a position in the current plot's coordinate system to pixels. A negative y_axis uses the current value of SetPlotYAxis (0 initially).
2020-08-30 18:12:36 -04:00
ImVec2 PlotToPixels(const ImPlotPoint& plt, int y_axis = IMPLOT_AUTO);
ImVec2 PlotToPixels(double x, double y, int y_axis = IMPLOT_AUTO);
2020-08-23 00:26:49 -04:00
2020-04-30 09:46:18 -04:00
//-----------------------------------------------------------------------------
// Plot Queries
//-----------------------------------------------------------------------------
2020-09-01 00:23:48 -04:00
// Use these functions to retrieve information about the current plot. They
// MUST be called between BeginPlot and EndPlot!
2020-08-23 00:26:49 -04:00
// Get the current Plot position (top-left) in pixels.
ImVec2 GetPlotPos();
// Get the curent Plot size in pixels.
ImVec2 GetPlotSize();
2020-07-26 22:28:22 -04:00
// Returns true if the plot area in the current plot is hovered.
2020-04-30 09:46:18 -04:00
bool IsPlotHovered();
2020-07-26 22:28:22 -04:00
// Returns true if the XAxis plot area in the current plot is hovered.
bool IsPlotXAxisHovered();
2020-07-26 22:28:22 -04:00
// Returns true if the YAxis[n] plot area in the current plot is hovered.
bool IsPlotYAxisHovered(int y_axis = 0);
2020-07-26 22:28:22 -04:00
// Returns the mouse position in x,y coordinates of the current plot. A negative y_axis uses the current value of SetPlotYAxis (0 initially).
2020-08-30 18:12:36 -04:00
ImPlotPoint GetPlotMousePos(int y_axis = IMPLOT_AUTO);
2020-07-26 22:28:22 -04:00
// Returns the current plot axis range. A negative y_axis uses the current value of SetPlotYAxis (0 initially).
2020-08-30 18:12:36 -04:00
ImPlotLimits GetPlotLimits(int y_axis = IMPLOT_AUTO);
2020-07-26 22:28:22 -04:00
// Returns true if the current plot is being queried.
2020-04-30 09:46:18 -04:00
bool IsPlotQueried();
2020-07-26 22:28:22 -04:00
// Returns the current plot query bounds.
2020-08-30 18:12:36 -04:00
ImPlotLimits GetPlotQuery(int y_axis = IMPLOT_AUTO);
2020-05-11 09:58:12 -04:00
//-----------------------------------------------------------------------------
2020-09-01 00:23:48 -04:00
// Plot and Item Styling
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
// Provides access to plot style structure for permanant modifications to colors, sizes, etc.
2020-05-12 05:19:34 -04:00
ImPlotStyle& GetStyle();
2020-04-27 11:27:59 -04:00
2020-08-24 12:48:00 -04:00
// Style colors for current ImGui style (default).
2020-08-24 12:06:29 -04:00
void StyleColorsAuto(ImPlotStyle* dst = NULL);
// Style colors for ImGui "Classic".
void StyleColorsClassic(ImPlotStyle* dst = NULL);
// Style colors for ImGui "Dark".
void StyleColorsDark(ImPlotStyle* dst = NULL);
// Style colors for ImGui "Light".
void StyleColorsLight(ImPlotStyle* dst = NULL);
2020-09-01 00:23:48 -04:00
// Use PushStyleX to temporarily modify your ImPlotStyle. The modification
// will last until the matching call to PopStyleX. You MUST call a pop for
// every push, otherwise you will leak memory! This behaves just like ImGui.
2020-08-30 18:12:36 -04:00
2020-05-31 10:28:34 -04:00
// Temporarily modify a plot color. Don't forget to call PopStyleColor!
2020-05-12 05:19:34 -04:00
void PushStyleColor(ImPlotCol idx, ImU32 col);
void PushStyleColor(ImPlotCol idx, const ImVec4& col);
2020-09-01 00:23:48 -04:00
// Undo temporary color modification. Undo multiple pushes at once by increasing count.
2020-05-12 05:19:34 -04:00
void PopStyleColor(int count = 1);
2020-04-27 11:27:59 -04:00
2020-05-31 10:28:34 -04:00
// Temporarily modify a style variable of float type. Don't forget to call PopStyleVar!
2020-05-12 05:19:34 -04:00
void PushStyleVar(ImPlotStyleVar idx, float val);
2020-05-31 10:28:34 -04:00
// Temporarily modify a style variable of int type. Don't forget to call PopStyleVar!
2020-05-12 05:19:34 -04:00
void PushStyleVar(ImPlotStyleVar idx, int val);
// Temporarily modify a style variable of ImVec2 type. Don't forget to call PopStyleVar!
void PushStyleVar(ImPlotStyleVar idx, const ImVec2& val);
2020-09-01 00:23:48 -04:00
// Undo temporary style modification. Undo multiple pushes at once by increasing count.
2020-05-12 05:19:34 -04:00
void PopStyleVar(int count = 1);
2020-04-27 11:27:59 -04:00
2020-09-01 00:23:48 -04:00
// The following can be used to modify the style of the next plot item ONLY. They do
// NOT require calls to PopStyleX. Leave style attributes you don't want modified to
// IMPLOT_AUTO or IMPLOT_AUTO_COL. Automatic styles will be deduced from the current
// values in the your ImPlotStyle or from Colormap data.
// Set the line color and weight for the next item only.
void SetNextLineStyle(const ImVec4& col = IMPLOT_AUTO_COL, float weight = IMPLOT_AUTO);
// Set the fill color for the next item only.
void SetNextFillStyle(const ImVec4& col = IMPLOT_AUTO_COL, float alpha_mod = IMPLOT_AUTO);
// Set the marker style for the next item only.
void SetNextMarkerStyle(ImPlotMarker marker = IMPLOT_AUTO, float size = IMPLOT_AUTO, const ImVec4& fill = IMPLOT_AUTO_COL, float weight = IMPLOT_AUTO, const ImVec4& outline = IMPLOT_AUTO_COL);
// Set the error bar style for the next item only.
void SetNextErrorBarStyle(const ImVec4& col = IMPLOT_AUTO_COL, float size = IMPLOT_AUTO, float weight = IMPLOT_AUTO);
// Returns the null terminated string name for an ImPlotCol.
const char* GetStyleColorName(ImPlotCol color);
2020-09-02 16:55:35 -04:00
// Returns the null terminated string name for an ImPlotMarker.
const char* GetMarkerName(ImPlotMarker marker);
2020-09-01 00:23:48 -04:00
//-----------------------------------------------------------------------------
// Colormaps
//-----------------------------------------------------------------------------
// Item styling is based on Colormaps when the relevant ImPlotCol is set to
// IMPLOT_AUTO_COL (default). Several built in colormaps are available and can be
// toggled in the demo. You can push/pop or set your own colormaps as well.
// The Colormap data will be ignored and a custom color will be used if you have either:
// 1) Modified an item style color in your ImPlotStyle to anything but IMPLOT_AUTO_COL.
// 2) Pushed an item style color using PushStyleColor().
// 3) Set the next item style with a SetNextXStyle function.
// Temporarily switch to one of the built-in colormaps.
void PushColormap(ImPlotColormap colormap);
2020-08-23 00:26:49 -04:00
// Temporarily switch to your custom colormap. The pointer data must persist until the matching call to PopColormap!
void PushColormap(const ImVec4* colormap, int size);
// Undo temporary colormap modification.
void PopColormap(int count = 1);
2020-09-01 22:01:00 -04:00
// Permanently sets a custom colormap. The colors will be copied to internal memory. Prefer PushColormap instead of calling this each frame.
void SetColormap(const ImVec4* colormap, int size);
// Permanently switch to one of the built-in colormaps. If samples is greater than 1, the map will be linearly resampled. Don't call this each frame.
void SetColormap(ImPlotColormap colormap, int samples = 0);
2020-09-01 22:01:00 -04:00
// Returns the size of the current colormap.
2020-06-02 13:34:14 -04:00
int GetColormapSize();
2020-09-01 00:23:48 -04:00
// Returns a color from the Color map given an index >= 0 (modulo will be performed).
2020-06-02 13:34:14 -04:00
ImVec4 GetColormapColor(int index);
// Linearly interpolates a color from the current colormap given t between 0 and 1.
ImVec4 LerpColormap(float t);
2020-08-24 12:48:00 -04:00
// Returns the next unused colormap color and advances the colormap. Can be used to skip colors if desired.
2020-08-16 01:49:34 -04:00
ImVec4 NextColormapColor();
2020-09-01 22:01:00 -04:00
2020-09-01 00:23:48 -04:00
// Renders a vertical color scale using the current color map. Call this outside of Begin/EndPlot.
2020-08-23 00:26:49 -04:00
void ShowColormapScale(double scale_min, double scale_max, float height);
2020-09-01 22:01:00 -04:00
2020-09-01 00:23:48 -04:00
// Returns a null terminated string name for a built-in colormap.
const char* GetColormapName(ImPlotColormap colormap);
2020-08-23 00:26:49 -04:00
2020-09-01 00:58:15 -04:00
//-----------------------------------------------------------------------------
// Legend Utils
//-----------------------------------------------------------------------------
// Returns true if a plot item legend entry is hovered.
bool IsLegendEntryHovered(const char* label_id);
// Begin a drag and drop source from a legend entry. The only supported flag is SourceNoPreviewTooltip
bool BeginLegendDragDropSource(const char* label_id, ImGuiDragDropFlags flags = 0);
// End legend drag and drop source.
void EndLegendDragDropSource();
// Begin a popup for a legend entry.
2020-09-01 02:14:09 -04:00
bool BeginLegendPopup(const char* label_id, ImGuiMouseButton mouse_button = 1);
// End a popup for a legend entry.
2020-09-01 02:14:09 -04:00
void EndLegendPopup();
2020-04-30 09:46:18 -04:00
//-----------------------------------------------------------------------------
2020-08-23 00:26:49 -04:00
// Miscellaneous
2020-04-30 09:46:18 -04:00
//-----------------------------------------------------------------------------
2020-08-23 00:26:49 -04:00
// Allows changing how keyboard/mouse interaction works.
ImPlotInputMap& GetInputMap();
2020-06-02 23:07:27 -04:00
2020-08-30 18:12:36 -04:00
// Get the plot draw list for rendering to the current plot area.
ImDrawList* GetPlotDrawList();
2020-05-31 10:28:34 -04:00
// Push clip rect for rendering to current plot area.
2020-04-30 09:46:18 -04:00
void PushPlotClipRect();
2020-05-31 10:28:34 -04:00
// Pop plot clip rect.
2020-04-30 09:46:18 -04:00
void PopPlotClipRect();
2020-09-01 22:01:00 -04:00
// Shows ImPlot style selector dropdown menu.
bool ShowStyleSelector(const char* label);
// Shows ImPlot style editor block (not a window).
void ShowStyleEditor(ImPlotStyle* ref = NULL);
// Add basic help/info block (not a window): how to manipulate ImPlot as an end-user.
void ShowUserGuide();
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
2020-08-24 00:45:42 -04:00
// Demo (add implot_demo.cpp to your sources!)
2020-04-27 11:27:59 -04:00
//-----------------------------------------------------------------------------
2020-08-24 00:45:42 -04:00
// Shows the ImPlot demo.
2020-05-12 05:19:34 -04:00
void ShowDemoWindow(bool* p_open = NULL);
2020-04-27 11:27:59 -04:00
2020-05-12 05:19:34 -04:00
} // namespace ImPlot