Files
imgui-java/imgui-binding/src/main/java/imgui/extension/implot/ImPlot.java
T
SpaiR e70576f322 feat(api): bump Dear ImGui from 1.88 to 1.89.9
resolves #134
resolves #135
resolves #145
resolves #220
resolves #310

- Bump imgui-node-editor to the latest coomit
- Bump implot from 0.13 to 0.16
2025-01-29 15:24:43 +02:00

1640 lines
74 KiB
Java

package imgui.extension.implot;
import imgui.ImDrawList;
import imgui.ImVec2;
import imgui.ImVec4;
import imgui.binding.annotation.ArgValue;
import imgui.binding.annotation.ArgVariant;
import imgui.binding.annotation.BindingMethod;
import imgui.binding.annotation.BindingSource;
import imgui.binding.annotation.OptArg;
import imgui.binding.annotation.ReturnValue;
import imgui.internal.ImGuiContext;
import imgui.type.ImBoolean;
import imgui.type.ImDouble;
import imgui.type.ImFloat;
@BindingSource
public final class ImPlot {
private ImPlot() {
}
/*JNI
#include "_implot.h"
*/
//-----------------------------------------------------------------------------
// [SECTION] Contexts
//-----------------------------------------------------------------------------
/**
* Creates a new ImPlot context. Call this after ImGui.createContext().
*/
@BindingMethod
public static native ImPlotContext CreateContext();
/**
* Destroys an ImPlot context. Call this before ImGui.destroyContext(). NULL = destroy current context.
*/
@BindingMethod
public static native void DestroyContext(@OptArg ImPlotContext ctx);
/**
* Returns the current ImPlot context. NULL if no context has ben set.
*/
@BindingMethod
public static native ImPlotContext GetCurrentContext();
/**
* Sets the current ImPlot context.
*/
@BindingMethod
public static native void SetCurrentContext(ImPlotContext ctx);
@BindingMethod
public static native void SetImGuiContext(ImGuiContext ctx);
//-----------------------------------------------------------------------------
// [SECTION] Begin/End Plot
//-----------------------------------------------------------------------------
// Starts a 2D plotting context. If this function returns true, EndPlot() MUST
// be called! You are encouraged to use the following convention:
//
// if (BeginPlot(...)) {
// PlotLine(...);
// ...
// EndPlot();
// }
//
// Important notes:
//
// - #title_id must be unique to the current ImGui ID scope. If you need to avoid ID
// collisions or don't want to display a title in the plot, use double hashes
// (e.g. "MyPlot##HiddenIdText" or "##NoTitle").
// - #size is the **frame** size of the plot widget, not the plot area. The default
// size of plots (i.e. when ImVec2(0,0)) can be modified in your ImPlotStyle.
@BindingMethod
public static native boolean BeginPlot(String titleId, @OptArg(callValue = "ImVec2(-1,0)") ImVec2 size, @OptArg int flags);
/**
* Only call EndPlot() if beginPlot() returns true! Typically called at the end
* of an if statement conditioned on BeginPlot(). See example in beginPlot().
*/
@BindingMethod
public static native void EndPlot();
//-----------------------------------------------------------------------------
// [SECTION] Begin/End Subplots
//-----------------------------------------------------------------------------
// Starts a subdivided plotting context. If the function returns true,
// EndSubplots() MUST be called! Call BeginPlot/EndPlot AT MOST [rows*cols]
// times in between the begining and end of the subplot context. Plots are
// added in row major order.
//
// Example:
//
// if (BeginSubplots("My Subplot",2,3,ImVec2(800,400)) {
// for (int i = 0; i < 6; ++i) {
// if (BeginPlot(...)) {
// ImPlot::PlotLine(...);
// ...
// EndPlot();
// }
// }
// EndSubplots();
// }
//
// Produces:
//
// [0] | [1] | [2]
// ----|-----|----
// [3] | [4] | [5]
//
// Important notes:
//
// - #title_id must be unique to the current ImGui ID scope. If you need to avoid ID
// collisions or don't want to display a title in the plot, use double hashes
// (e.g. "MySubplot##HiddenIdText" or "##NoTitle").
// - #rows and #cols must be greater than 0.
// - #size is the size of the entire grid of subplots, not the individual plots
// - #row_ratios and #col_ratios must have AT LEAST #rows and #cols elements,
// respectively. These are the sizes of the rows and columns expressed in ratios.
// If the user adjusts the dimensions, the arrays are updated with new ratios.
//
// Important notes regarding BeginPlot from inside of BeginSubplots:
//
// - The #title_id parameter of _BeginPlot_ (see above) does NOT have to be
// unique when called inside of a subplot context. Subplot IDs are hashed
// for your convenience so you don't have call PushID or generate unique title
// strings. Simply pass an empty string to BeginPlot unless you want to title
// each subplot.
// - The #size parameter of _BeginPlot_ (see above) is ignored when inside of a
// subplot context. The actual size of the subplot will be based on the
// #size value you pass to _BeginSubplots_ and #row/#col_ratios if provided.
@BindingMethod
public static native boolean BeginSubplots(String titleID,
int rows,
int cols,
ImVec2 size,
@OptArg(callValue = "ImPlotSubplotFlags_None") int flags,
@OptArg float[] rowRatios,
@OptArg float[] colRatios);
/**
* Only call EndSubplots() if BeginSubplots() returns true! Typically called at the end
* of an if statement conditioned on BeginSublots(). See example above.
*/
@BindingMethod
public static native void EndSubplots();
//-----------------------------------------------------------------------------
// [SECTION] Setup
//-----------------------------------------------------------------------------
// The following API allows you to setup and customize various aspects of the
// current plot. The functions should be called immediately after BeginPlot
// and before any other API calls. Typical usage is as follows:
// if (BeginPlot(...)) { 1) begin a new plot
// SetupAxis(ImAxis_X1, "My X-Axis"); 2) make Setup calls
// SetupAxis(ImAxis_Y1, "My Y-Axis");
// SetupLegend(ImPlotLocation_North);
// ...
// SetupFinish(); 3) [optional] explicitly finish setup
// PlotLine(...); 4) plot items
// ...
// EndPlot(); 5) end the plot
// }
//
// Important notes:
//
// - Always call Setup code at the top of your BeginPlot conditional statement.
// - Setup is locked once you start plotting or explicitly call SetupFinish.
// Do NOT call Setup code after you begin plotting or after you make
// any non-Setup API calls (e.g. utils like PlotToPixels also lock Setup)
// - Calling SetupFinish is OPTIONAL, but probably good practice. If you do not
// call it yourself, then the first subsequent plotting or utility function will
// call it for you.
/**
* Enables an axis or sets the label and/or flags for an existing axis.
* Leave `label` as NULL for no label.
*/
@BindingMethod
public static native void SetupAxis(int axis, @OptArg(callValue = "NULL") String label, @OptArg int flags);
/**
* Sets an axis range limits. If ImPlotCond_Always is used, the axes limits will be locked.
* Inversion with {@code v_min > v_max} is not supported; use SetupAxisLimits instead.
*/
@BindingMethod
public static native void SetupAxisLimits(int axis, double vMin, double vMax, @OptArg int cond);
/**
* Links an axis range limits to external values. Set to NULL for no linkage.
* The pointer data must remain valid until EndPlot.
*/
@BindingMethod
public static native void SetupAxisLinks(int axis, ImDouble linkMin, ImDouble linkMax);
/**
* Sets the format of numeric axis labels via formatter specifier (default="%g").
* Formatted values will be double (i.e. use %f).
*/
@BindingMethod
public static native void SetupAxisFormat(int axis, String fmt);
// TODO: support ImPlotFormatter
/**
* Sets an axis' ticks and optionally the labels. To keep the default ticks,
* set `keepDefault=true`.
*/
@BindingMethod
public static native void SetupAxisTicks(int axis, double[] values, int nTicks, @OptArg(callValue = "NULL") String[] labels, @OptArg boolean keepDefault);
/**
* Sets an axis' ticks and optionally the labels for the next plot.
* To keep the default ticks, set `keepDefault=true`.
*/
@BindingMethod
public static native void SetupAxisTicks(int axis, double vMin, double vMax, int nTicks, @OptArg(callValue = "NULL") String[] labels, @OptArg boolean keepDefault);
/**
* Sets an axis' scale using built-in options.
*/
@BindingMethod
public static native void SetupAxisScale(int axis, int scale);
/**
* Sets an axis' limits constraints.
*/
@BindingMethod
public static native void SetupAxisLimitsConstraints(int axis, double vMin, double vMax);
/**
* Sets an axis' zoom constraints.
*/
@BindingMethod
public static native void SetupAxisZoomConstraints(int axis, double vMin, double vMax);
/**
* Sets the label and/or flags for primary X and Y axes (shorthand for two calls to SetupAxis).
*/
@BindingMethod
public static native void SetupAxes(String xLabel, String yLabel, @OptArg int xFlags, @OptArg int yFlags);
/**
* Sets the primary X and Y axes range limits. If ImPlotCond_Always is used,
* the axes limits will be locked (shorthand for two calls to SetupAxisLimits).
*/
@BindingMethod
public static native void SetupAxesLimits(double xMin, double xMax, double yMin, double yMax, @OptArg int cond);
/**
* Sets up the plot legend.
*/
@BindingMethod
public static native void SetupLegend(int location, @OptArg int flags);
/**
* Sets the location of the current plot's mouse position text (default = South|East).
*/
@BindingMethod
public static native void SetupMouseText(int location, @OptArg int flags);
/**
* Explicitly finalize plot setup. Once you call this, you cannot make any more
* Setup calls for the current plot! Note that calling this function is OPTIONAL;
* it will be called by the first subsequent setup-locking API call.
*/
@BindingMethod
public static native void SetupFinish();
//-----------------------------------------------------------------------------
// [SECTION] SetNext
//-----------------------------------------------------------------------------
// Though you should default to the `Setup` API above, there are some scenarios
// where (re)configuring a plot or axis before `BeginPlot` is needed (e.g. if
// using a preceding button or slider widget to change the plot limits). In
// this case, you can use the `SetNext` API below. While this is not as feature
// rich as the Setup API, most common needs are provided. These functions can be
// called anwhere except for inside of `Begin/EndPlot`. For example:
// if (ImGui::Button("Center Plot"))
// ImPlot::SetNextPlotLimits(-1,1,-1,1);
// if (ImPlot::BeginPlot(...)) {
// ...
// ImPlot::EndPlot();
// }
//
// Important notes:
//
// - You must still enable non-default axes with SetupAxis for these functions
// to work properly.
/**
* Sets an upcoming axis range limits. If ImPlotCond_Always is used, the axes limits will be locked.
*/
@BindingMethod
public static native void SetNextAxisLimits(int axis, double vMin, double vMax, @OptArg int cond);
/**
* Links an upcoming axis range limits to external values. Set to NULL for no linkage.
* The pointer data must remain valid until EndPlot!
*/
@BindingMethod
public static native void SetNextAxisLinks(int axis, ImDouble linkMin, ImDouble linkMax);
/**
* Set an upcoming axis to auto fit to its data.
*/
@BindingMethod
public static native void SetNextAxisToFit(int axis);
/**
* Sets the upcoming primary X and Y axes range limits. If ImPlotCond_Always is used,
* the axes limits will be locked (shorthand for two calls to SetupAxisLimits).
*/
@BindingMethod
public static native void SetNextAxesLimits(double xMin, double xMax, double yMin, double yMax, @OptArg int cond);
/**
* Sets all upcoming axes to auto fit to their data.
*/
@BindingMethod
public static native void SetNextAxesToFit();
//-----------------------------------------------------------------------------
// [SECTION] Plot Items
//-----------------------------------------------------------------------------
// The main plotting API is provied below. Call these functions between
// Begin/EndPlot and after any Setup API calls. Each plots data on the current
// x and y axes, which can be changed with `SetAxis/Axes`.
//
// The templated functions are explicitly instantiated in implot_items.cpp.
// They are not intended to be used generically with custom types. You will get
// a linker error if you try! All functions support the following scalar types:
//
// float, double, ImS8, ImU8, ImS16, ImU16, ImS32, ImU32, ImS64, ImU64
//
//
// If you need to plot custom or non-homogenous data you have a few options:
//
// 1. If your data is a simple struct/class (e.g. Vector2f), you can use striding.
// This is the most performant option if applicable.
//
// struct Vector2f { float X, Y; };
// ...
// Vector2f data[42];
// ImPlot::PlotLine("line", &data[0].x, &data[0].y, 42, 0, sizeof(Vector2f)); // or sizeof(float)*2
//
// 2. Write a custom getter C function or C++ lambda and pass it and optionally your data to
// an ImPlot function post-fixed with a G (e.g. PlotScatterG). This has a slight performance
// cost, but probably not enough to worry about unless your data is very large. Examples:
//
// ImPlotPoint MyDataGetter(void* data, int idx) {
// MyData* my_data = (MyData*)data;
// ImPlotPoint p;
// p.x = my_data->GetTime(idx);
// p.y = my_data->GetValue(idx);
// return p
// }
// ...
// auto my_lambda = [](void*, int idx) {
// double t = idx / 999.0;
// return ImPlotPoint(t, 0.5+0.5*std::sin(2*PI*10*t));
// };
// ...
// if (ImPlot::BeginPlot("MyPlot")) {
// MyData my_data;
// ImPlot::PlotScatterG("scatter", MyDataGetter, &my_data, my_data.Size());
// ImPlot::PlotLineG("line", my_lambda, nullptr, 1000);
// ImPlot::EndPlot();
// }
//
// NB: All types are converted to double before plotting. You may lose information
// if you try plotting extremely large 64-bit integral types. Proceed with caution!
/*JNI
// For a proper type conversion, since C++ doesn't have a "long" type.
#define long ImS64
#define LEN(arg) (int)env->GetArrayLength(obj_##arg)
*/
// values
/**
* Plots a standard 2D line plot.
*/
@BindingMethod
public static native void PlotLine(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void count,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a standard 2D line plot.
*/
@BindingMethod(callName = "PlotLine")
public static native void PlotLineV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
// xs,ys
/**
* Plots a standard 2D line plot.
*/
@BindingMethod
public static native void PlotLine(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg int flags);
/**
* Plots a standard 2D line plot.
*/
@BindingMethod(callName = "PlotLine")
public static native void PlotLineV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
int count,
@OptArg int flags,
@OptArg int offset);
// values
/**
* Plots a standard 2D scatter plot. Default marker is ImPlotMarker_Circle.
*/
@BindingMethod
public static native void PlotScatter(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void count,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a standard 2D scatter plot. Default marker is ImPlotMarker_Circle.
*/
@BindingMethod(callName = "PlotScatter")
public static native void PlotScatterV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
// xs,ys
/**
* Plots a standard 2D scatter plot. Default marker is ImPlotMarker_Circle.
*/
@BindingMethod
public static native void PlotScatter(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg int flags);
/**
* Plots a standard 2D scatter plot. Default marker is ImPlotMarker_Circle.
*/
@BindingMethod(callName = "PlotScatter")
public static native void PlotScatterV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
int count,
@OptArg int flags,
@OptArg int offset);
// values
/**
* Plots a stairstep graph. The y value is continued constantly from every x position, i.e. the interval [x[i], x[i+1]) has the value y[i].
*/
@BindingMethod
public static native void PlotStairs(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void count,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a stairstep graph. The y value is continued constantly from every x position, i.e. the interval [x[i], x[i+1]) has the value y[i].
*/
@BindingMethod(callName = "PlotStairs")
public static native void PlotStairsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
// xs,ys
/**
* Plots a stairstep graph. The y value is continued constantly from every x position, i.e. the interval [x[i], x[i+1]) has the value y[i].
*/
@BindingMethod
public static native void PlotStairs(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg int flags);
/**
* Plots a stairstep graph. The y value is continued constantly from every x position, i.e. the interval [x[i], x[i+1]) has the value y[i].
*/
@BindingMethod(callName = "PlotStairs")
public static native void PlotStairsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
int count,
@OptArg int flags,
@OptArg int offset);
// values
/**
* Plots a shaded (filled) region between two lines, or a line and a horizontal reference. Set y_ref to +/-INFINITY for infinite fill extents.
*/
@BindingMethod
public static native void PlotShaded(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void count,
@OptArg double yRef,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a shaded (filled) region between two lines, or a line and a horizontal reference. Set y_ref to +/-INFINITY for infinite fill extents.
*/
@BindingMethod(callName = "PlotShaded")
public static native void PlotShadedV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
@OptArg double yRef,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
// xs,ys
/**
* Plots a shaded (filled) region between two lines, or a line and a horizontal reference. Set y_ref to +/-INFINITY for infinite fill extents.
*/
@BindingMethod
public static native void PlotShaded(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg double yRef,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a shaded (filled) region between two lines, or a line and a horizontal reference. Set y_ref to +/-INFINITY for infinite fill extents.
*/
@BindingMethod(callName = "PlotShaded")
public static native void PlotShadedV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
int count,
@OptArg double yRef,
@OptArg int flags,
@OptArg int offset);
// xs,ys1,ys2
/**
* Plots a shaded (filled) region between two lines, or a line and a horizontal reference. Set y_ref to +/-INFINITY for infinite fill extents.
*/
@BindingMethod
public static native void PlotShaded(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys1,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys2,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg int flags);
/**
* Plots a shaded (filled) region between two lines, or a line and a horizontal reference. Set y_ref to +/-INFINITY for infinite fill extents.
*/
@BindingMethod(callName = "PlotShaded")
public static native void PlotShadedV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys1,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys2,
int count,
@OptArg int flags,
@OptArg int offset);
// values
/**
* Plots a vertical bar graph. #bar_width and #xstart are in X units.
*/
@BindingMethod
public static native void PlotBars(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void count,
@OptArg double barWidth,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a vertical bar graph. #bar_width and #xstart are in X units.
*/
@BindingMethod(callName = "PlotBars")
public static native void PlotBarsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
@OptArg double barWidth,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
// xs,ys
/**
* Plots a vertical bar graph. #bar_width and #xstart are in X units.
*/
@BindingMethod
public static native void PlotBars(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
@ArgValue(callValue = "0.67") Void barWidth,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a vertical bar graph. #bar_width and #xstart are in X units.
*/
@BindingMethod(callName = "PlotBars")
public static native void PlotBarsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
double barWidth,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a vertical bar graph. #bar_width and #xstart are in X units.
*/
@BindingMethod(callName = "PlotBars")
public static native void PlotBarsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
int count,
double barWidth,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a group of vertical bars. #values is a row-major matrix with #item_count rows and #group_count cols. #label_ids should have #item_count elements.
*/
@BindingMethod
public static native void PlotBarGroups(String[] labelIds,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void itemCount,
int groupCount,
@OptArg double groupSize,
@OptArg double shift,
@OptArg int flags);
/**
* Plots a group of vertical bars. #values is a row-major matrix with #item_count rows and #group_count cols. #label_ids should have #item_count elements.
*/
@BindingMethod(callName = "PlotBarGroups")
public static native void PlotBarGroupsV(String[] labelIds,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int itemCount,
int groupCount,
@OptArg double groupSize,
@OptArg double shift,
@OptArg int flags);
/**
* Plots vertical error bar. The label_id should be the same as the label_id of the associated line or bar plot.
*/
@BindingMethod
public static native void PlotErrorBars(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void err,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg int flags,
@OptArg int offset);
/**
* Plots vertical error bar. The label_id should be the same as the label_id of the associated line or bar plot.
*/
@BindingMethod(callName = "PlotErrorBars")
public static native void PlotErrorBarsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void err,
int count,
@OptArg int flags,
@OptArg int offset);
/**
* Plots vertical error bar. The label_id should be the same as the label_id of the associated line or bar plot.
*/
@BindingMethod
public static native void PlotErrorBars(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void neg,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void pos,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg int flags,
@OptArg int offset);
/**
* Plots vertical error bar. The label_id should be the same as the label_id of the associated line or bar plot.
*/
@BindingMethod(callName = "PlotErrorBars")
public static native void PlotErrorBarsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void neg,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void pos,
int count,
@OptArg int flags,
@OptArg int offset);
// values
/**
* Plots vertical stems.
*/
@BindingMethod
public static native void PlotStems(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void count,
@OptArg double yRef,
@OptArg double xscale,
@OptArg double xstart,
@OptArg int flags,
@OptArg int offset);
/**
* Plots vertical stems.
*/
@BindingMethod(callName = "PlotStems")
public static native void PlotStemsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
@OptArg double yRef,
@OptArg double scale,
@OptArg double start,
@OptArg int flags,
@OptArg int offset);
// xs,ys
/**
* Plots vertical stems.
*/
@BindingMethod
public static native void PlotStems(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg double ref,
@OptArg int flags,
@OptArg int offset);
/**
* Plots vertical stems.
*/
@BindingMethod(callName = "PlotStems")
public static native void PlotStemsV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
int count,
@OptArg double yRef,
@OptArg int flags,
@OptArg int offset);
/**
* Plots infinite vertical or horizontal lines (e.g. for references or asymptotes).
*/
@BindingMethod
public static native void PlotInfLines(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") int count,
@OptArg int flags,
@OptArg int offset);
/**
* Plots infinite vertical or horizontal lines (e.g. for references or asymptotes).
*/
@BindingMethod(callName = "PlotInfLines")
public static native void PlotInfLinesV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
@OptArg int flags,
@OptArg int offset);
/**
* Plots a pie chart. If the sum of values{@code >}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.
*/
@BindingMethod
public static native void PlotPieChart(String[] labelIds,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void count,
double x,
double y,
double radius,
@OptArg(callValue = "\"%.1f\"") String labelFmt,
@OptArg double angle0,
@OptArg int flags);
/**
* Plots a pie chart. If the sum of values{@code >}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.
*/
@BindingMethod(callName = "PlotPieChart")
public static native void PlotPieChartV(String[] labelIds,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
double x,
double y,
double radius,
@OptArg(callValue = "\"%.1f\"") String labelFmt,
@OptArg double angle0,
@OptArg int flags);
/**
* Plots a 2D heatmap chart. Values are expected to be in row-major order. Leave #scale_min and scale_max both at 0 for automatic color scaling, or set them to a predefined range. #label_fmt can be set to NULL for no labels.
*/
@BindingMethod
public static native void PlotHeatmap(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int rows,
int cols,
@OptArg double scaleMin,
@OptArg double scaleMax,
@OptArg(callValue = "\"%.1f\"") String labelFmt,
@OptArg ImPlotPoint boundsMin,
@OptArg ImPlotPoint boundsMax,
@OptArg int flags);
/**
* Plots a horizontal histogram. #bins can be a positive integer or an ImPlotBin_ method. If #cumulative is true, each bin contains its count plus the counts of all previous bins.
* If #density is true, the PDF is visualized. If both are true, the CDF is visualized. If #range is left unspecified, the min/max of #values will be used as the range.
* If #range is specified, outlier values outside of the range are not binned. However, outliers still count toward normalizing and cumulative counts unless #outliers is false. The largest bin count or density is returned.
*/
@BindingMethod
public static native double PlotHistogram(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
@ArgValue(callValue = "LEN(values)") Void count,
@OptArg(callValue = "ImPlotBin_Sturges") int bins,
@OptArg double barScale,
@OptArg(callValue = "ImPlotRange()") ImPlotRange range,
@OptArg int flags);
/**
* Plots a horizontal histogram. #bins can be a positive integer or an ImPlotBin_ method. If #cumulative is true, each bin contains its count plus the counts of all previous bins.
* If #density is true, the PDF is visualized. If both are true, the CDF is visualized. If #range is left unspecified, the min/max of #values will be used as the range.
* If #range is specified, outlier values outside of the range are not binned. However, outliers still count toward normalizing and cumulative counts unless #outliers is false. The largest bin count or density is returned.
*/
@BindingMethod(callName = "PlotHistogram")
public static native double PlotHistogramV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void values,
int count,
@OptArg int bins,
@OptArg double barScale,
@OptArg(callValue = "ImPlotRange()") ImPlotRange range,
@OptArg int flags);
/**
* Plots two dimensional, bivariate histogram as a heatmap. #x_bins and #y_bins can be a positive integer or an ImPlotBin. If #density is true, the PDF is visualized.
* If #range is left unspecified, the min/max of #xs an #ys will be used as the ranges. If #range is specified, outlier values outside of range are not binned.
* However, outliers still count toward the normalizing count for density plots unless #outliers is false. The largest bin count or density is returned.
*/
@BindingMethod
public static native double PlotHistogram2D(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg int xBins,
@OptArg int yBins,
@OptArg(callValue = "ImPlotRect()") ImPlotRect range,
@OptArg int flags);
/**
* Plots two dimensional, bivariate histogram as a heatmap. #x_bins and #y_bins can be a positive integer or an ImPlotBin. If #density is true, the PDF is visualized.
* If #range is left unspecified, the min/max of #xs an #ys will be used as the ranges. If #range is specified, outlier values outside of range are not binned.
* However, outliers still count toward the normalizing count for density plots unless #outliers is false. The largest bin count or density is returned.
*/
@BindingMethod(callName = "PlotHistogram2D")
public static native double PlotHistogram2DV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
int count,
@OptArg int xBins,
@OptArg int yBins,
@OptArg(callValue = "ImPlotRect()") ImPlotRect range,
@OptArg int flags);
/**
* Plots digital data. Digital plots do not respond to y drag or zoom, and are always referenced to the bottom of the plot.
*/
@BindingMethod
public static native void PlotDigital(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
@ArgValue(callValue = "LEN(xs)") Void count,
@OptArg int flags,
@OptArg int offset);
/**
* Plots digital data. Digital plots do not respond to y drag or zoom, and are always referenced to the bottom of the plot.
*/
@BindingMethod(callName = "PlotDigital")
public static native void PlotDigitalV(String labelId,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void xs,
@ArgVariant(type = {"short[]", "int[]", "long[]", "float[]", "double[]"}) Void ys,
int count,
@OptArg int flags,
@OptArg int offset);
/**
* Plots an axis-aligned image. #bounds_min/bounds_max are in plot coordinates (y-up) and #uv0/uv1 are in texture coordinates (y-down).
*/
@BindingMethod
public static native void PlotImage(String labelId,
@ArgValue(callPrefix = "(ImTextureID)(uintptr_t)") long userTextureId,
ImPlotPoint boundsMin,
ImPlotPoint boundsMax,
@OptArg ImVec2 uv0,
@OptArg ImVec2 uv1,
@OptArg ImVec4 tintCol,
@OptArg int flags);
/**
* Plots a centered text label at point x,y with an optional pixel offset. Text color can be changed with ImPlot::PushStyleColor(ImPlotCol_InlayText, ...).
*/
@BindingMethod
public static native void PlotText(String text,
double x,
double y,
@OptArg(callValue = "ImVec2(0,0)") ImVec2 pixOffset,
@OptArg int flags);
/**
* Plots a dummy item (i.e. adds a legend entry colored by ImPlotCol_Line)
*/
@BindingMethod
public static native void PlotDummy(String labelID, @OptArg int flags);
/*JNI
#undef LEN
#undef long
*/
//-----------------------------------------------------------------------------
// [SECTION] Plot Tools
//-----------------------------------------------------------------------------
// The following can be used to render interactive elements and/or annotations.
// Like the item plotting functions above, they apply to the current x and y
// axes, which can be changed with `SetAxis/SetAxes`.
/**
* Shows a draggable point at x, y. `col` defaults to ImGuiCol_Text.
*/
@BindingMethod
public static native boolean DragPoint(int id, ImDouble x, ImDouble y, ImVec4 col, @OptArg(callValue = "4") float size, @OptArg int flags);
/**
* Shows a draggable vertical guide line at an x-value. `col` defaults to ImGuiCol_Text.
*/
@BindingMethod
public static native boolean DragLineX(int id, ImDouble x, ImVec4 col, @OptArg(callValue = "1") float thickness, @OptArg int flags);
/**
* Shows a draggable horizontal guide line at a y-value. `col` defaults to ImGuiCol_Text.
*/
@BindingMethod
public static native boolean DragLineY(int id, ImDouble y, ImVec4 col, @OptArg(callValue = "1") float thickness, @OptArg int flags);
/**
* Shows a draggable and resizeable rectangle.
*/
@BindingMethod
public static native boolean DragRect(int id, ImDouble xMin, ImDouble yMin, ImDouble xMax, ImDouble yMax, ImVec4 col, @OptArg int flags);
/**
* Shows an annotation callout at a chosen point. Clamping keeps annotations in the plot area.
* Annotations are always rendered on top.
*/
@BindingMethod
public static native void Annotation(double x, double y, ImVec4 col, ImVec2 pixOffset, boolean clamp, @OptArg boolean round);
/**
* Shows an annotation callout at a chosen point with formatted text.
* Clamping keeps annotations in the plot area. Annotations are always rendered on top.
*/
@BindingMethod
public static native void Annotation(double x, double y, ImVec4 col, ImVec2 pixOffset, boolean clamp, String fmt, Void NULL);
/**
* Shows a x-axis tag at the specified coordinate value.
*/
@BindingMethod
public static native void TagX(double x, ImVec4 col, @OptArg boolean round);
/**
* Shows a x-axis tag at the specified coordinate value with formatted text.
*/
@BindingMethod
public static native void TagX(double x, ImVec4 col, String fmt, Void NULL);
/**
* Shows a y-axis tag at the specified coordinate value.
*/
@BindingMethod
public static native void TagY(double y, ImVec4 col, @OptArg boolean round);
/**
* Shows a y-axis tag at the specified coordinate value with formatted text.
*/
@BindingMethod
public static native void TagY(double y, ImVec4 col, String fmt, Void NULL);
//-----------------------------------------------------------------------------
// [SECTION] Plot Utils
//-----------------------------------------------------------------------------
/**
* Selects which axis will be used for subsequent plot elements.
*/
@BindingMethod
public static native void SetAxis(int axis);
/**
* Selects which axes will be used for subsequent plot elements.
*/
@BindingMethod
public static native void SetAxes(int xAxis, int yAxis);
/**
* Converts pixels to a position in the current plot's coordinate system.
* Passing IMPLOT_AUTO uses the current axes.
*/
@BindingMethod
public static native ImPlotPoint PixelsToPlot(ImVec2 pix, @OptArg int xAxis, @OptArg int yAxis);
/**
* Converts a position in the current plot's coordinate system to pixels.
* Passing IMPLOT_AUTO uses the current axes.
*/
@BindingMethod
public static native ImVec2 PlotToPixels(ImPlotPoint plt, @OptArg int xAxis, @OptArg int yAxis);
/**
* Gets the current Plot position (top-left) in pixels.
*/
@BindingMethod
public static native ImVec2 GetPlotPos();
/**
* Gets the current Plot size in pixels.
*/
@BindingMethod
public static native ImVec2 GetPlotSize();
/**
* Returns the mouse position in x, y coordinates of the current plot.
* Passing IMPLOT_AUTO uses the current axes.
*/
@BindingMethod
public static native ImPlotPoint GetPlotMousePos(@OptArg int xAxis, @OptArg int yAxis);
/**
* Returns the current plot axis range.
*/
@BindingMethod
public static native ImPlotRect GetPlotLimits(@OptArg int xAxis, @OptArg int yAxis);
/**
* Returns true if the plot area in the current plot is hovered.
*/
@BindingMethod
public static native boolean IsPlotHovered();
/**
* Returns true if the axis label area in the current plot is hovered.
*/
@BindingMethod
public static native boolean IsAxisHovered(int axis);
/**
* Returns true if the bounding frame of a subplot is hovered.
*/
@BindingMethod
public static native boolean IsSubplotsHovered();
/**
* Returns true if the current plot is being box selected.
*/
@BindingMethod
public static native boolean IsPlotSelected();
/**
* Returns the current plot box selection bounds.
* Passing IMPLOT_AUTO uses the current axes.
*/
@BindingMethod
public static native ImPlotRect GetPlotSelection(@OptArg int xAxis, @OptArg int yAxis);
/**
* Cancels the current plot box selection.
*/
@BindingMethod
public static native void CancelPlotSelection();
/**
* Hides or shows the next plot item (i.e. as if it were toggled from the legend).
* Use ImPlotCond_Always if you need to forcefully set this every frame.
*/
@BindingMethod
public static native void HideNextItem(@OptArg(callValue = "true") boolean hidden, @OptArg int cond);
// Use the following around calls to Begin/EndPlot to align l/r/t/b padding.
// Consider using Begin/EndSubplots first. They are more feature rich and
// accomplish the same behaviour by default. The functions below offer lower
// level control of plot alignment.
/**
* Aligns axis padding over multiple plots in a single row or column.
* `group_id` must be unique. If this function returns true, EndAlignedPlots() must be called.
*/
@BindingMethod
public static native boolean BeginAlignedPlots(String groupId, @OptArg boolean vertical);
/**
* Ends aligned plots. Only call EndAlignedPlots() if BeginAlignedPlots() returns true.
*/
@BindingMethod
public static native void EndAlignedPlots();
//-----------------------------------------------------------------------------
// [SECTION] Legend Utils
//-----------------------------------------------------------------------------
/**
* Begins a popup for a legend entry.
*/
@BindingMethod
public static native boolean BeginLegendPopup(String labelId, @OptArg int mouseButton);
/**
* Ends a popup for a legend entry.
*/
@BindingMethod
public static native void EndLegendPopup();
/**
* Returns true if a plot item legend entry is hovered.
*/
@BindingMethod
public static native boolean IsLegendEntryHovered(String labelId);
//-----------------------------------------------------------------------------
// [SECTION] Drag and Drop
//-----------------------------------------------------------------------------
/**
* Turns the current plot's plotting area into a drag and drop target.
* Don't forget to call EndDragDropTarget!
*/
@BindingMethod
public static native boolean BeginDragDropTargetPlot();
/**
* Turns the current plot's X-axis into a drag and drop target.
* Don't forget to call EndDragDropTarget!
*/
@BindingMethod
public static native boolean BeginDragDropTargetAxis(int axis);
/**
* Turns the current plot's legend into a drag and drop target.
* Don't forget to call EndDragDropTarget!
*/
@BindingMethod
public static native boolean BeginDragDropTargetLegend();
/**
* Ends a drag and drop target (currently just an alias for ImGui::EndDragDropTarget).
*/
@BindingMethod
public static native void EndDragDropTarget();
// NB: By default, plot and axes drag and drop *sources* require holding the Ctrl modifier to initiate the drag.
// You can change the modifier if desired. If ImGuiKeyModFlags_None is provided, the axes will be locked from panning.
/**
* Turns the current plot's plotting area into a drag and drop source.
* You must hold Ctrl. Don't forget to call EndDragDropSource!
*/
@BindingMethod
public static native boolean BeginDragDropSourcePlot(@OptArg int flags);
/**
* Turns the current plot's X-axis into a drag and drop source.
* You must hold Ctrl. Don't forget to call EndDragDropSource!
*/
@BindingMethod
public static native boolean BeginDragDropSourceAxis(int axis, @OptArg int flags);
/**
* Turns an item in the current plot's legend into a drag and drop source.
* Don't forget to call EndDragDropSource!
*/
@BindingMethod
public static native boolean BeginDragDropSourceItem(String labelId, @OptArg int flags);
/**
* Ends a drag and drop source (currently just an alias for ImGui::EndDragDropSource).
*/
@BindingMethod
public static native void EndDragDropSource();
//-----------------------------------------------------------------------------
// [SECTION] Styling
//-----------------------------------------------------------------------------
// Styling colors in ImPlot works similarly to styling colors in ImGui, but
// with one important difference. Like ImGui, all style colors are stored in an
// indexable array in ImPlotStyle. You can permanently modify these values through
// GetStyle().Colors, or temporarily modify them with Push/Pop functions below.
// However, by default all style colors in ImPlot default to a special color
// IMPLOT_AUTO_COL. The behavior of this color depends upon the style color to
// which it as applied:
//
// 1) For style colors associated with plot items (e.g. ImPlotCol_Line),
// IMPLOT_AUTO_COL tells ImPlot to color the item with the next unused
// color in the current colormap. Thus, every item will have a different
// color up to the number of colors in the colormap, at which point the
// colormap will roll over. For most use cases, you should not need to
// set these style colors to anything but IMPLOT_COL_AUTO; you are
// probably better off changing the current colormap. However, if you
// need to explicitly color a particular item you may either Push/Pop
// the style color around the item in question, or use the SetNextXXXStyle
// API below. If you permanently set one of these style colors to a specific
// color, or forget to call Pop, then all subsequent items will be styled
// with the color you set.
//
// 2) For style colors associated with plot styling (e.g. ImPlotCol_PlotBg),
// IMPLOT_AUTO_COL tells ImPlot to set that color from color data in your
// **ImGuiStyle**. The ImGuiCol_ that these style colors default to are
// detailed above, and in general have been mapped to produce plots visually
// consistent with your current ImGui style. Of course, you are free to
// manually set these colors to whatever you like, and further can Push/Pop
// them around individual plots for plot-specific styling (e.g. coloring axes).
/**
* Provides access to plot style structure for permanant modifications to colors, sizes, etc.
*/
@BindingMethod
@ReturnValue(isStatic = true, callPrefix = "&")
public static native ImPlotStyle GetStyle();
/**
* Style plot colors for current ImGui style (default).
*/
@BindingMethod
public static native void StyleColorsAuto(@OptArg ImPlotStyle dst);
/**
* Style plot colors for ImGui "Classic".
*/
@BindingMethod
public static native void StyleColorsClassic(@OptArg ImPlotStyle dst);
/**
* Style plot colors for ImGui "Dark".
*/
@BindingMethod
public static native void StyleColorsDark(@OptArg ImPlotStyle dst);
/**
* Style plot colors for ImGui "Light".
*/
@BindingMethod
public static native void StyleColorsLight(@OptArg ImPlotStyle dst);
// 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.
/**
* Temporarily modify a style color. Don't forget to call PopStyleColor!
*/
public static native void pushStyleColor(int idx, long col); /*
ImPlot::PushStyleColor(idx, col);
*/
/**
* Temporarily modify a style color. Don't forget to call PopStyleColor!
*/
@BindingMethod
public static native void PushStyleColor(int idx, @ArgValue(staticCast = "ImU32") int col);
/**
* Temporarily modify a style color. Don't forget to call PopStyleColor!
*/
@BindingMethod
public static native void PushStyleColor(int idx, ImVec4 col);
@BindingMethod
public static native void PopStyleColor(@OptArg int count);
/**
* Temporarily modify a style variable of float type. Don't forget to call PopStyleVar!
*/
@BindingMethod
public static native void PushStyleVar(int idx, @ArgValue(staticCast = "float") float val);
/**
* Temporarily modify a style variable of int type. Don't forget to call PopStyleVar!
*/
@BindingMethod
public static native void PushStyleVar(int idx, @ArgValue(staticCast = "int") int val);
/**
* Temporarily modify a style variable of ImVec2 type. Don't forget to call PopStyleVar!
*/
@BindingMethod
public static native void PushStyleVar(int idx, ImVec2 val);
/**
* Undo temporary style variable modification(s). Undo multiple pushes at once by increasing count.
*/
@BindingMethod
public static native void PopStyleVar(@OptArg int count);
/**
* Set the line color and weight for the next item only.
*/
@BindingMethod
public static native void SetNextLineStyle(@OptArg(callValue = "IMPLOT_AUTO_COL") ImVec4 col, @OptArg float weight);
/**
* Set the fill color for the next item only.
*/
@BindingMethod
public static native void SetNextFillStyle(@OptArg(callValue = "IMPLOT_AUTO_COL") ImVec4 col, @OptArg float alphaMod);
/**
* Set the marker style for the next item only.
*/
@BindingMethod
public static native void SetNextMarkerStyle(@OptArg int marker, @OptArg float size, @OptArg ImVec4 fill, @OptArg(callValue = "IMPLOT_AUTO") float weight, @OptArg ImVec4 outline);
/**
* Set the error bar style for the next item only.
*/
@BindingMethod
public static native void SetNextErrorBarStyle(@OptArg(callValue = "IMPLOT_AUTO_COL") ImVec4 col, @OptArg float size, @OptArg float weight);
/**
* Gets the last item primary color (i.e. its legend icon color)
*/
@BindingMethod
public static native ImVec4 GetLastItemColor();
/**
* Returns the string name for an ImPlotCol.
*/
@BindingMethod
public static native String GetStyleColorName(int idx);
/**
* Returns the null terminated string name for an ImPlotMarker.
*/
@BindingMethod
public static native String GetMarkerName(int idx);
//-----------------------------------------------------------------------------
// [SECTION] Colormaps
//-----------------------------------------------------------------------------
// Item styling is based on colormaps when the relevant ImPlotCol_XXX is set to
// IMPLOT_AUTO_COL (default). Several built-in colormaps are available. You can
// add and then push/pop your own colormaps as well. To permanently set a colormap,
// modify the Colormap index member of your ImPlotStyle.
// Colormap data will be ignored and a custom color will be used if you have done one of the following:
// 1) Modified an item style color in your ImPlotStyle to anything other than IMPLOT_AUTO_COL.
// 2) Pushed an item style color using PushStyleColor().
// 3) Set the next item style with a SetNextXXXStyle function.
// Add a new colormap. The color data will be copied. The colormap can be used by pushing either the returned index or the
// string name with PushColormap. The colormap name must be unique and the size must be greater than 1. You will receive
// an assert otherwise! By default colormaps are considered to be qualitative (i.e. discrete). If you want to create a
// continuous colormap, set #qual=false. This will treat the colors you provide as keys, and ImPlot will build a linearly
// interpolated lookup table. The memory footprint of this table will be exactly ((size-1)*255+1)*4 bytes.
@BindingMethod
public static native int AddColormap(String name, ImVec4[] cols, @ArgValue(callValue = "env->GetArrayLength(obj_cols)") Void size, @OptArg boolean qual);
@BindingMethod
public static native int AddColormap(String name, @ArgValue(reinterpretCast = "ImU32*") int[] cols, @ArgValue(callValue = "env->GetArrayLength(obj_cols)") Void size, @OptArg boolean qual);
/**
* Returns the number of available colormaps (i.e. the built-in + user-added count).
*/
@BindingMethod
public static native int GetColormapCount();
/**
* Returns a string name for a colormap given an index.
*/
@BindingMethod
public static native String GetColormapName(int cmap);
/**
* Returns an index number for a colormap given a valid string name. Returns -1 if the name is invalid.
*/
@BindingMethod
public static native int GetColormapIndex(String name);
/**
* Temporarily switch to one of the built-in (i.e. ImPlotColormap_XXX) or user-added colormaps (i.e. a return value of AddColormap). Don't forget to call PopColormap!
*/
@BindingMethod
public static native void PushColormap(int cmap);
/**
* Push a colormap by string name. Use built-in names such as "Default", "Deep", "Jet", etc. or a string you provided to AddColormap. Don't forget to call PopColormap!
*/
@BindingMethod
public static native void PushColormap(String name);
/**
* Undo temporary colormap modification(s). Undo multiple pushes at once by increasing count.
*/
@BindingMethod
public static native void PopColormap(@OptArg int count);
/**
* Returns the next color from the current colormap and advances the colormap for the current plot.
* Can also be used with no return value to skip colors if desired. You need to call this between Begin/EndPlot!
*/
@BindingMethod
public static native ImVec4 NextColormapColor();
/**
* Returns the size of a colormap.
*/
@BindingMethod
public static native int GetColormapSize(@OptArg int cmap);
/**
* Returns a color from a colormap given an index {@code >=} 0 (modulo will be performed).
*/
@BindingMethod
public static native ImVec4 GetColormapColor(int idx, @OptArg int cmap);
/**
* Sample a color from a colormap given t between 0 and 1
*/
@BindingMethod
public static native ImVec4 SampleColormap(float t, @OptArg int cmap);
/**
* Shows a vertical color scale with linear spaced ticks using the specified color map. Use double hashes to hide label (e.g. "##NoLabel").
*/
@BindingMethod
public static native void ColormapScale(String label,
double scaleMin,
double scaleMax,
@OptArg(callValue = "ImVec2(0,0)") ImVec2 size,
@OptArg(callValue = "\"%g\"") String format,
@OptArg int flags,
@OptArg int cmap);
/**
* Shows a horizontal slider with a colormap gradient background.
* TODO: support our argument
*/
@BindingMethod
public static native boolean ColormapSlider(String label, ImFloat t, Void NULL, @OptArg(callValue = "\"\"") String format, @OptArg int cmap);
/**
* Shows a button with a colormap gradient brackground.
*/
@BindingMethod
public static native boolean ColormapButton(String label, @OptArg(callValue = "ImVec2(0,0)") ImVec2 size, @OptArg int cmap);
/**
* When items in a plot sample their color from a colormap, the color is cached and does not change
* unless explicitly overriden. Therefore, if you change the colormap after the item has already been plotted,
* item colors will NOT update. If you need item colors to resample the new colormap, then use this
* function to bust the cached colors. If #plot_title_id is NULL, then every item in EVERY existing plot
* will be cache busted. Otherwise only the plot specified by #plot_title_id will be busted. For the
* latter, this function must be called in the same ImGui ID scope that the plot is in. You should rarely if ever
* need this function, but it is available for applications that require runtime colormap swaps (e.g. Heatmaps demo).
*/
@BindingMethod
public static native void BustColorCache(@OptArg String plotTitleId);
//-----------------------------------------------------------------------------
// [SECTION] Input Mapping
//-----------------------------------------------------------------------------
/**
* Provides access to the input mapping structure for permanent modifications to controls for pan, select, etc.
*/
@BindingMethod
@ReturnValue(callPrefix = "&", isStatic = true)
public static native ImPlotInputMap GetInputMap();
/**
* Default input mapping: pan = LMB drag, box select = RMB drag,
* fit = LMB double click, context menu = RMB click, zoom = scroll.
*/
@BindingMethod
public static native void MapInputDefault(@OptArg ImPlotInputMap dst);
/**
* Reverse input mapping: pan = RMB drag, box select = LMB drag,
* fit = LMB double click, context menu = RMB click, zoom = scroll.
*/
@BindingMethod
public static native void MapInputReverse(@OptArg ImPlotInputMap dst);
//-----------------------------------------------------------------------------
// [SECTION] Miscellaneous
//-----------------------------------------------------------------------------
// Render icons similar to those that appear in legends (nifty for data lists).
@BindingMethod
public static native void ItemIcon(ImVec4 col);
@BindingMethod
public static native void ItemIcon(@ArgValue(staticCast = "ImU32") int col);
@BindingMethod
public static native void ColormapIcon(int cmap);
/**
* Get the plot draw list for custom rendering to the current plot area. Call between Begin/EndPlot.
*/
@BindingMethod
public static native ImDrawList GetPlotDrawList();
/**
* Push clip rect for rendering to current plot area. The rect can be expanded or contracted by #expand pixels. Call between Begin/EndPlot.
*/
@BindingMethod
public static native void PushPlotClipRect(@OptArg float expand);
/**
* Pop plot clip rect. Call between Begin/EndPlot.
*/
@BindingMethod
public static native void PopPlotClipRect();
/**
* Shows ImPlot style selector dropdown menu.
*/
@BindingMethod
public static native boolean ShowStyleSelector(String label);
/**
* Shows ImPlot colormap selector dropdown menu.
*/
@BindingMethod
public static native boolean ShowColormapSelector(String label);
/**
* Shows ImPlot input map selector dropdown menu.
*/
@BindingMethod
public static native boolean ShowInputMapSelector(String label);
/**
* Shows ImPlot style editor block (not a window).
*/
@BindingMethod
public static native void ShowStyleEditor(@OptArg ImPlotStyle ref);
/**
* Add basic help/info block for end users (not a window).
*/
@BindingMethod
public static native void ShowUserGuide();
/**
* Shows ImPlot metrics/debug information window.
*/
@BindingMethod
public static native void ShowMetricsWindow(@OptArg ImBoolean pOpen);
//-----------------------------------------------------------------------------
// [SECTION] Demo
//-----------------------------------------------------------------------------
/**
* Shows the ImPlot demo window.
*/
@BindingMethod
public static native void ShowDemoWindow(@OptArg ImBoolean pOpen);
}