dear-implot 0.15.0

High-level Rust bindings to ImPlot with dear-imgui-rs integration
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
//! Bar groups plot implementation

use super::{
    PlotData, PlotDataLayout, PlotError, PlotItemStyle, plot_spec_with_style, with_plot_str_slice,
};
use crate::{BarGroupsFlags, ItemFlags, sys};

/// Builder for bar groups plots with extensive customization options
pub struct BarGroupsPlot<'a> {
    label_ids: Vec<&'a str>,
    values: &'a [f64],
    style: PlotItemStyle,
    item_count: usize,
    group_count: usize,
    group_size: f64,
    shift: f64,
    flags: BarGroupsFlags,
    item_flags: ItemFlags,
}

impl<'a> super::PlotItemStyled for BarGroupsPlot<'a> {
    fn style_mut(&mut self) -> &mut PlotItemStyle {
        &mut self.style
    }
}

impl<'a> BarGroupsPlot<'a> {
    /// Create a new bar groups plot
    ///
    /// # Arguments
    /// * `label_ids` - Labels for each item in the group
    /// * `values` - Values in row-major order (item_count rows, group_count cols)
    /// * `item_count` - Number of items (series) in each group
    /// * `group_count` - Number of groups
    pub fn new(
        label_ids: Vec<&'a str>,
        values: &'a [f64],
        item_count: usize,
        group_count: usize,
    ) -> Self {
        Self {
            label_ids,
            values,
            style: PlotItemStyle::default(),
            item_count,
            group_count,
            group_size: 0.67,
            shift: 0.0,
            flags: BarGroupsFlags::NONE,
            item_flags: ItemFlags::NONE,
        }
    }

    /// Set the group size (width of each group)
    pub fn with_group_size(mut self, group_size: f64) -> Self {
        self.group_size = group_size;
        self
    }

    /// Set ImPlotSpec-backed style overrides for this bar groups plot.
    pub fn with_style(mut self, style: PlotItemStyle) -> Self {
        self.style = style;
        self
    }

    /// Set the shift (horizontal offset)
    pub fn with_shift(mut self, shift: f64) -> Self {
        self.shift = shift;
        self
    }

    /// Set bar groups flags for customization
    pub fn with_flags(mut self, flags: BarGroupsFlags) -> Self {
        self.flags = flags;
        self
    }

    /// Set common item flags for this plot item (applies to all plot types)
    pub fn with_item_flags(mut self, flags: ItemFlags) -> Self {
        self.item_flags = flags;
        self
    }

    /// Make bars horizontal instead of vertical
    pub fn horizontal(mut self) -> Self {
        self.flags |= BarGroupsFlags::HORIZONTAL;
        self
    }

    /// Stack bars instead of grouping them side by side
    pub fn stacked(mut self) -> Self {
        self.flags |= BarGroupsFlags::STACKED;
        self
    }

    /// Validate the plot data
    pub fn validate(&self) -> Result<(), PlotError> {
        if self.label_ids.len() != self.item_count {
            return Err(PlotError::InvalidData(format!(
                "Label count ({}) must match item count ({})",
                self.label_ids.len(),
                self.item_count
            )));
        }

        let expected_values = self
            .item_count
            .checked_mul(self.group_count)
            .ok_or_else(|| {
                PlotError::InvalidData("item_count * group_count overflowed usize".to_string())
            })?;
        if self.values.len() != expected_values {
            return Err(PlotError::InvalidData(format!(
                "Values length ({}) must equal item_count * group_count ({})",
                self.values.len(),
                expected_values
            )));
        }

        if self.item_count == 0 || self.group_count == 0 {
            return Err(PlotError::EmptyData);
        }

        let _ = i32::try_from(self.item_count).map_err(|_| {
            PlotError::InvalidData("item_count exceeded ImPlot's i32 range".to_string())
        })?;
        let _ = i32::try_from(self.group_count).map_err(|_| {
            PlotError::InvalidData("group_count exceeded ImPlot's i32 range".to_string())
        })?;

        Ok(())
    }

    /// Plot the bar groups
    pub fn plot(self, plot_ui: &crate::PlotUi<'_>) {
        if self.validate().is_err() {
            return;
        }
        let Ok(item_count) = i32::try_from(self.item_count) else {
            return;
        };
        let Ok(group_count) = i32::try_from(self.group_count) else {
            return;
        };
        let _guard = plot_ui.bind();
        with_plot_str_slice(&self.label_ids, |label_ptrs| unsafe {
            let spec = plot_spec_with_style(
                self.style,
                self.flags.bits() | self.item_flags.bits(),
                PlotDataLayout::DEFAULT,
            );
            sys::ImPlot_PlotBarGroups_doublePtr(
                label_ptrs.as_ptr(),
                self.values.as_ptr(),
                item_count,
                group_count,
                self.group_size,
                self.shift,
                spec,
            );
        })
    }
}

impl<'a> PlotData for BarGroupsPlot<'a> {
    fn label(&self) -> &str {
        "BarGroups" // Generic label for groups
    }

    fn data_len(&self) -> usize {
        self.values.len()
    }
}

/// Bar groups plot for f32 data
pub struct BarGroupsPlotF32<'a> {
    label_ids: Vec<&'a str>,
    values: &'a [f32],
    style: PlotItemStyle,
    item_count: usize,
    group_count: usize,
    group_size: f64,
    shift: f64,
    flags: BarGroupsFlags,
    item_flags: ItemFlags,
}

impl<'a> super::PlotItemStyled for BarGroupsPlotF32<'a> {
    fn style_mut(&mut self) -> &mut PlotItemStyle {
        &mut self.style
    }
}

impl<'a> BarGroupsPlotF32<'a> {
    /// Create a new bar groups plot with f32 data
    pub fn new(
        label_ids: Vec<&'a str>,
        values: &'a [f32],
        item_count: usize,
        group_count: usize,
    ) -> Self {
        Self {
            label_ids,
            values,
            style: PlotItemStyle::default(),
            item_count,
            group_count,
            group_size: 0.67,
            shift: 0.0,
            flags: BarGroupsFlags::NONE,
            item_flags: ItemFlags::NONE,
        }
    }

    /// Set the group size
    pub fn with_group_size(mut self, group_size: f64) -> Self {
        self.group_size = group_size;
        self
    }

    /// Set ImPlotSpec-backed style overrides for this bar groups plot.
    pub fn with_style(mut self, style: PlotItemStyle) -> Self {
        self.style = style;
        self
    }

    /// Set the shift
    pub fn with_shift(mut self, shift: f64) -> Self {
        self.shift = shift;
        self
    }

    /// Set flags
    pub fn with_flags(mut self, flags: BarGroupsFlags) -> Self {
        self.flags = flags;
        self
    }

    /// Set common item flags for this plot item (applies to all plot types)
    pub fn with_item_flags(mut self, flags: ItemFlags) -> Self {
        self.item_flags = flags;
        self
    }

    /// Make bars horizontal
    pub fn horizontal(mut self) -> Self {
        self.flags |= BarGroupsFlags::HORIZONTAL;
        self
    }

    /// Stack bars
    pub fn stacked(mut self) -> Self {
        self.flags |= BarGroupsFlags::STACKED;
        self
    }

    /// Validate the plot data
    pub fn validate(&self) -> Result<(), PlotError> {
        if self.label_ids.len() != self.item_count {
            return Err(PlotError::InvalidData(format!(
                "Label count ({}) must match item count ({})",
                self.label_ids.len(),
                self.item_count
            )));
        }

        let expected_values = self
            .item_count
            .checked_mul(self.group_count)
            .ok_or_else(|| {
                PlotError::InvalidData("item_count * group_count overflowed usize".to_string())
            })?;
        if self.values.len() != expected_values {
            return Err(PlotError::InvalidData(format!(
                "Values length ({}) must equal item_count * group_count ({})",
                self.values.len(),
                expected_values
            )));
        }

        if self.item_count == 0 || self.group_count == 0 {
            return Err(PlotError::EmptyData);
        }

        let _ = i32::try_from(self.item_count).map_err(|_| {
            PlotError::InvalidData("item_count exceeded ImPlot's i32 range".to_string())
        })?;
        let _ = i32::try_from(self.group_count).map_err(|_| {
            PlotError::InvalidData("group_count exceeded ImPlot's i32 range".to_string())
        })?;

        Ok(())
    }

    /// Plot the bar groups
    pub fn plot(self, plot_ui: &crate::PlotUi<'_>) {
        if self.validate().is_err() {
            return;
        }
        let Ok(item_count) = i32::try_from(self.item_count) else {
            return;
        };
        let Ok(group_count) = i32::try_from(self.group_count) else {
            return;
        };
        let _guard = plot_ui.bind();
        with_plot_str_slice(&self.label_ids, |label_ptrs| unsafe {
            let spec = plot_spec_with_style(
                self.style,
                self.flags.bits() | self.item_flags.bits(),
                PlotDataLayout::DEFAULT,
            );
            sys::ImPlot_PlotBarGroups_FloatPtr(
                label_ptrs.as_ptr(),
                self.values.as_ptr(),
                item_count,
                group_count,
                self.group_size,
                self.shift,
                spec,
            );
        })
    }
}

impl<'a> PlotData for BarGroupsPlotF32<'a> {
    fn label(&self) -> &str {
        "BarGroups" // Generic label for groups
    }

    fn data_len(&self) -> usize {
        self.values.len()
    }
}

/// Simple bar groups plot with automatic layout
pub struct SimpleBarGroupsPlot<'a> {
    labels: Vec<&'a str>,
    data: Vec<Vec<f64>>,
    style: PlotItemStyle,
    group_size: f64,
    flags: BarGroupsFlags,
    item_flags: ItemFlags,
}

impl<'a> super::PlotItemStyled for SimpleBarGroupsPlot<'a> {
    fn style_mut(&mut self) -> &mut PlotItemStyle {
        &mut self.style
    }
}

impl<'a> SimpleBarGroupsPlot<'a> {
    /// Create a simple bar groups plot from a 2D data structure
    ///
    /// # Arguments
    /// * `labels` - Labels for each series
    /// * `data` - Vector of vectors, where each inner vector is a series
    pub fn new(labels: Vec<&'a str>, data: Vec<Vec<f64>>) -> Self {
        Self {
            labels,
            data,
            style: PlotItemStyle::default(),
            group_size: 0.67,
            flags: BarGroupsFlags::NONE,
            item_flags: ItemFlags::NONE,
        }
    }

    /// Set ImPlotSpec-backed style overrides for this bar groups plot.
    pub fn with_style(mut self, style: PlotItemStyle) -> Self {
        self.style = style;
        self
    }

    /// Set the group size
    pub fn with_group_size(mut self, group_size: f64) -> Self {
        self.group_size = group_size;
        self
    }

    /// Set flags
    pub fn with_flags(mut self, flags: BarGroupsFlags) -> Self {
        self.flags = flags;
        self
    }

    /// Set common item flags for this plot item (applies to all plot types)
    pub fn with_item_flags(mut self, flags: ItemFlags) -> Self {
        self.item_flags = flags;
        self
    }

    /// Make bars horizontal
    pub fn horizontal(mut self) -> Self {
        self.flags |= BarGroupsFlags::HORIZONTAL;
        self
    }

    /// Stack bars
    pub fn stacked(mut self) -> Self {
        self.flags |= BarGroupsFlags::STACKED;
        self
    }

    /// Plot the bar groups
    pub fn plot(self, plot_ui: &crate::PlotUi<'_>) {
        if self.data.is_empty() || self.labels.is_empty() {
            return;
        }

        let item_count = self.data.len();
        let group_count = self.data[0].len();

        // Flatten data into row-major order
        let mut flattened_data = Vec::with_capacity(item_count * group_count);
        for group_idx in 0..group_count {
            for item_idx in 0..item_count {
                if group_idx < self.data[item_idx].len() {
                    flattened_data.push(self.data[item_idx][group_idx]);
                } else {
                    flattened_data.push(0.0); // Fill missing data with zeros
                }
            }
        }

        let plot = BarGroupsPlot::new(self.labels, &flattened_data, item_count, group_count)
            .with_style(self.style)
            .with_group_size(self.group_size)
            .with_flags(self.flags)
            .with_item_flags(self.item_flags);

        plot.plot(plot_ui);
    }
}