Struct Plot3DContext 

pub struct Plot3DContext { /* private fields */ }

Plot3D context wrapper

This manages the ImPlot3D context lifetime. Create one instance per application and keep it alive for the duration of your program.

Example

use dear_imgui_rs::*;
use dear_implot3d::*;

let mut imgui_ctx = Context::create();
let plot3d_ctx = Plot3DContext::create(&imgui_ctx);

// In your main loop:
let ui = imgui_ctx.frame();
let plot_ui = plot3d_ctx.get_plot_ui(&ui);

Implementations

impl Plot3DContext

pub fn try_create(imgui: &Context) -> ImGuiResult<Self>

Try to create a new ImPlot3D context.

This should be called once after creating your ImGui context.

pub fn create(imgui: &Context) -> Self

Create a new ImPlot3D context (panics on error).

pub unsafe fn raw(&self) -> *mut ImPlot3DContext

Set this context as the current ImPlot3D context. Get a raw pointer to the current ImPlot3D style

This is an advanced function for direct style manipulation. Prefer using the safe style functions in the style module. Get the raw ImPlot3D context pointer.

Safety

The caller must ensure the pointer is used safely and not stored beyond the lifetime of this context wrapper.

pub fn get_plot_ui<'ui>(&self, ui: &'ui Ui) -> Plot3DUi<'ui>

Get a per-frame plotting interface

Call this once per frame to get access to plotting functions. The returned Plot3DUi is tied to the lifetime of the Ui frame.

impl Plot3DContext

pub fn colormap_count(&self) -> usize

Return the number of available ImPlot3D colormaps.

pub fn colormap_name(&self, index: impl Into<ColormapIndex>) -> String

Return a colormap name, or an empty string if the index is invalid for this context.

pub fn colormap_size(&self, index: impl Into<ColormapIndex>) -> usize

Return the number of color entries in a colormap.

pub fn style_colormap_index(&self) -> Option<ColormapIndex>

Return the default colormap stored in this ImPlot3D context’s style.

pub fn style_colormap_name(&self) -> Option<String>

Return this context’s default colormap name.

pub fn set_style_colormap(&self, index: impl Into<ColormapIndex>)

Permanently set the default colormap used by this ImPlot3D context.

pub fn colormap_index_by_name(&self, name: &str) -> Option<ColormapIndex>

Look up a colormap index by its name.

pub fn set_style_colormap_by_name(&self, name: &str)

Permanently set the default colormap by name. Invalid names are ignored.

pub fn colormap_color(&self, index: ColormapColorIndex) -> [f32; 4]

Return a color from this context’s active colormap.

pub fn next_colormap_color(&self) -> [f32; 4]

Return the next color from this context’s current colormap and advance its color cursor.

impl Plot3DContext

pub fn style_colors_dark(&self)

Apply ImPlot3D’s dark style palette to this context.

pub fn style_colors_light(&self)

Apply ImPlot3D’s light style palette to this context.

pub fn style_colors_classic(&self)

Apply ImPlot3D’s classic style palette to this context.

pub fn style_colors_auto(&self)

Apply ImPlot3D’s auto style palette to this context.

Trait Implementations

impl Drop for Plot3DContext

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.