dear-implot 0.12.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
//! Line plot implementation

use super::{
    Plot, PlotError, PlotItemStyle, plot_spec_with_style, validate_data_lengths,
    with_plot_str_or_empty,
};
use crate::{ItemFlags, LineFlags, Marker, sys};

/// Builder for line plots with extensive customization options
pub struct LinePlot<'a> {
    label: &'a str,
    x_data: &'a [f64],
    y_data: &'a [f64],
    style: PlotItemStyle,
    flags: LineFlags,
    item_flags: ItemFlags,
    offset: i32,
    stride: i32,
}

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

impl<'a> LinePlot<'a> {
    /// Create a new line plot with the given label and data
    pub fn new(label: &'a str, x_data: &'a [f64], y_data: &'a [f64]) -> Self {
        Self {
            label,
            x_data,
            y_data,
            style: PlotItemStyle::default(),
            flags: LineFlags::NONE,
            item_flags: ItemFlags::NONE,
            offset: 0,
            stride: std::mem::size_of::<f64>() as i32,
        }
    }

    /// Replace the entire item style override for this line plot.
    pub fn with_style(mut self, style: PlotItemStyle) -> Self {
        self.style = style;
        self
    }

    /// Set the line color. Use the alpha channel to control line transparency.
    pub fn with_line_color(mut self, color: [f32; 4]) -> Self {
        self.style = self.style.with_line_color(color);
        self
    }

    /// Set the line width in pixels.
    pub fn with_line_weight(mut self, weight: f32) -> Self {
        self.style = self.style.with_line_weight(weight);
        self
    }

    /// Set the fill color used when the line is rendered with shaded fill.
    pub fn with_fill_color(mut self, color: [f32; 4]) -> Self {
        self.style = self.style.with_fill_color(color);
        self
    }

    /// Set the fill alpha multiplier used for shaded regions and marker faces.
    pub fn with_fill_alpha(mut self, alpha: f32) -> Self {
        self.style = self.style.with_fill_alpha(alpha);
        self
    }

    /// Set the marker type for the line plot.
    pub fn with_marker(mut self, marker: Marker) -> Self {
        self.style = self.style.with_marker(marker);
        self
    }

    /// Set the marker size in pixels.
    pub fn with_marker_size(mut self, size: f32) -> Self {
        self.style = self.style.with_marker_size(size);
        self
    }

    /// Set the marker outline color.
    pub fn with_marker_line_color(mut self, color: [f32; 4]) -> Self {
        self.style = self.style.with_marker_line_color(color);
        self
    }

    /// Set the marker fill color.
    pub fn with_marker_fill_color(mut self, color: [f32; 4]) -> Self {
        self.style = self.style.with_marker_fill_color(color);
        self
    }

    /// Set line flags for customization
    pub fn with_flags(mut self, flags: LineFlags) -> 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
    }

    /// Set data offset for partial plotting
    pub fn with_offset(mut self, offset: i32) -> Self {
        self.offset = offset;
        self
    }

    /// Set data stride for non-contiguous data
    pub fn with_stride(mut self, stride: i32) -> Self {
        self.stride = stride;
        self
    }

    /// Validate the plot data
    pub fn validate(&self) -> Result<(), PlotError> {
        validate_data_lengths(self.x_data, self.y_data)
    }
}

impl<'a> Plot for LinePlot<'a> {
    fn plot(&self) {
        if self.validate().is_err() {
            return; // Skip plotting if data is invalid
        }
        let Ok(count) = i32::try_from(self.x_data.len()) else {
            return;
        };

        with_plot_str_or_empty(self.label, |label_ptr| unsafe {
            let spec = plot_spec_with_style(
                self.style,
                self.flags.bits() | self.item_flags.bits(),
                self.offset,
                self.stride,
            );
            sys::ImPlot_PlotLine_doublePtrdoublePtr(
                label_ptr,
                self.x_data.as_ptr(),
                self.y_data.as_ptr(),
                count,
                spec,
            );
        })
    }

    fn label(&self) -> &str {
        self.label
    }
}

/// Simple line plot for quick plotting without builder pattern
pub struct SimpleLinePlot<'a> {
    label: &'a str,
    values: &'a [f64],
    style: PlotItemStyle,
    flags: LineFlags,
    item_flags: ItemFlags,
    x_scale: f64,
    x_start: f64,
}

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

impl<'a> SimpleLinePlot<'a> {
    /// Create a simple line plot with Y values only (X will be indices)
    pub fn new(label: &'a str, values: &'a [f64]) -> Self {
        Self {
            label,
            values,
            style: PlotItemStyle::default(),
            flags: LineFlags::NONE,
            item_flags: ItemFlags::NONE,
            x_scale: 1.0,
            x_start: 0.0,
        }
    }

    /// Replace the entire item style override for this line plot.
    pub fn with_style(mut self, style: PlotItemStyle) -> Self {
        self.style = style;
        self
    }

    /// Set the line color. Use the alpha channel to control line transparency.
    pub fn with_line_color(mut self, color: [f32; 4]) -> Self {
        self.style = self.style.with_line_color(color);
        self
    }

    /// Set the line width in pixels.
    pub fn with_line_weight(mut self, weight: f32) -> Self {
        self.style = self.style.with_line_weight(weight);
        self
    }

    /// Set the fill color used when the line is rendered with shaded fill.
    pub fn with_fill_color(mut self, color: [f32; 4]) -> Self {
        self.style = self.style.with_fill_color(color);
        self
    }

    /// Set the fill alpha multiplier used for shaded regions and marker faces.
    pub fn with_fill_alpha(mut self, alpha: f32) -> Self {
        self.style = self.style.with_fill_alpha(alpha);
        self
    }

    /// Set the marker type for the line plot.
    pub fn with_marker(mut self, marker: Marker) -> Self {
        self.style = self.style.with_marker(marker);
        self
    }

    /// Set the marker size in pixels.
    pub fn with_marker_size(mut self, size: f32) -> Self {
        self.style = self.style.with_marker_size(size);
        self
    }

    /// Set the marker outline color.
    pub fn with_marker_line_color(mut self, color: [f32; 4]) -> Self {
        self.style = self.style.with_marker_line_color(color);
        self
    }

    /// Set the marker fill color.
    pub fn with_marker_fill_color(mut self, color: [f32; 4]) -> Self {
        self.style = self.style.with_marker_fill_color(color);
        self
    }

    /// Set line flags for customization
    pub fn with_flags(mut self, flags: LineFlags) -> 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
    }

    /// Set X scale factor
    pub fn with_x_scale(mut self, scale: f64) -> Self {
        self.x_scale = scale;
        self
    }

    /// Set X start value
    pub fn with_x_start(mut self, start: f64) -> Self {
        self.x_start = start;
        self
    }
}

impl<'a> Plot for SimpleLinePlot<'a> {
    fn plot(&self) {
        if self.values.is_empty() {
            return;
        }
        let Ok(count) = i32::try_from(self.values.len()) else {
            return;
        };

        with_plot_str_or_empty(self.label, |label_ptr| unsafe {
            let spec = plot_spec_with_style(
                self.style,
                self.flags.bits() | self.item_flags.bits(),
                0,
                std::mem::size_of::<f64>() as i32,
            );
            sys::ImPlot_PlotLine_doublePtrInt(
                label_ptr,
                self.values.as_ptr(),
                count,
                self.x_scale,
                self.x_start,
                spec,
            );
        })
    }

    fn label(&self) -> &str {
        self.label
    }
}

/// Convenience functions for quick line plotting
impl<'ui> crate::PlotUi<'ui> {
    /// Plot a line with X and Y data
    pub fn line_plot(&self, label: &str, x_data: &[f64], y_data: &[f64]) -> Result<(), PlotError> {
        let plot = LinePlot::new(label, x_data, y_data);
        plot.validate()?;
        plot.plot();
        Ok(())
    }

    /// Plot a simple line with Y values only (X will be indices)
    pub fn simple_line_plot(&self, label: &str, values: &[f64]) -> Result<(), PlotError> {
        if values.is_empty() {
            return Err(PlotError::EmptyData);
        }
        let plot = SimpleLinePlot::new(label, values);
        plot.plot();
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_line_plot_creation() {
        let x_data = [1.0, 2.0, 3.0, 4.0];
        let y_data = [1.0, 4.0, 2.0, 3.0];

        let plot = LinePlot::new("test", &x_data, &y_data);
        assert_eq!(plot.label(), "test");
        assert!(plot.validate().is_ok());
    }

    #[test]
    fn test_line_plot_validation() {
        let x_data = [1.0, 2.0, 3.0];
        let y_data = [1.0, 4.0]; // Different length

        let plot = LinePlot::new("test", &x_data, &y_data);
        assert!(plot.validate().is_err());
    }

    #[test]
    fn test_simple_line_plot() {
        let values = [1.0, 2.0, 3.0, 4.0];
        let plot = SimpleLinePlot::new("test", &values)
            .with_flags(LineFlags::LOOP)
            .with_item_flags(ItemFlags::NO_LEGEND);
        assert_eq!(plot.label(), "test");
        assert_eq!(plot.flags.bits(), LineFlags::LOOP.bits());
        assert_eq!(plot.item_flags, ItemFlags::NO_LEGEND);
    }

    #[test]
    fn test_line_plot_style_builders() {
        let x_data = [1.0, 2.0, 3.0, 4.0];
        let y_data = [1.0, 4.0, 2.0, 3.0];

        let plot = LinePlot::new("styled", &x_data, &y_data)
            .with_line_color([0.1, 0.2, 0.3, 0.4])
            .with_line_weight(2.5)
            .with_fill_color([0.4, 0.3, 0.2, 0.1])
            .with_fill_alpha(0.6)
            .with_marker(Marker::Circle)
            .with_marker_size(7.0)
            .with_marker_line_color([0.9, 0.8, 0.7, 0.6])
            .with_marker_fill_color([0.6, 0.7, 0.8, 0.9]);

        assert_eq!(
            plot.style.line_color,
            Some(sys::ImVec4_c {
                x: 0.1,
                y: 0.2,
                z: 0.3,
                w: 0.4,
            })
        );
        assert_eq!(plot.style.line_weight, Some(2.5));
        assert_eq!(
            plot.style.fill_color,
            Some(sys::ImVec4_c {
                x: 0.4,
                y: 0.3,
                z: 0.2,
                w: 0.1,
            })
        );
        assert_eq!(plot.style.fill_alpha, Some(0.6));
        assert_eq!(plot.style.marker, Some(Marker::Circle as sys::ImPlotMarker));
        assert_eq!(plot.style.marker_size, Some(7.0));
        assert_eq!(
            plot.style.marker_line_color,
            Some(sys::ImVec4_c {
                x: 0.9,
                y: 0.8,
                z: 0.7,
                w: 0.6,
            })
        );
        assert_eq!(
            plot.style.marker_fill_color,
            Some(sys::ImVec4_c {
                x: 0.6,
                y: 0.7,
                z: 0.8,
                w: 0.9,
            })
        );
    }
}