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
//! Text plot implementation

use super::{
    PlotData, PlotError, PlotItemStyle, PlotItemStyled, plot_spec_with_style, with_plot_str,
};
use crate::{ItemFlags, TextFlags, sys};

/// Builder for text plots with extensive customization options
///
/// Text plots allow placing text labels at specific coordinates in the plot area.
pub struct TextPlot<'a> {
    text: &'a str,
    x: f64,
    y: f64,
    style: PlotItemStyle,
    pix_offset_x: f64,
    pix_offset_y: f64,
    flags: TextFlags,
    item_flags: ItemFlags,
}

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

impl<'a> TextPlot<'a> {
    /// Create a new text plot with the given text and position
    pub fn new(text: &'a str, x: f64, y: f64) -> Self {
        Self {
            text,
            x,
            y,
            style: PlotItemStyle::default(),
            pix_offset_x: 0.0,
            pix_offset_y: 0.0,
            flags: TextFlags::NONE,
            item_flags: ItemFlags::NONE,
        }
    }

    /// Set pixel offset for fine positioning
    pub fn with_pixel_offset(mut self, offset_x: f64, offset_y: f64) -> Self {
        self.pix_offset_x = offset_x;
        self.pix_offset_y = offset_y;
        self
    }

    /// Set text flags for customization
    pub fn with_flags(mut self, flags: TextFlags) -> 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 text vertical instead of horizontal
    pub fn vertical(mut self) -> Self {
        self.flags |= TextFlags::VERTICAL;
        self
    }

    /// Validate the plot data
    pub fn validate(&self) -> Result<(), PlotError> {
        if self.text.is_empty() {
            return Err(PlotError::InvalidData("Text cannot be empty".to_string()));
        }
        if self.text.contains('\0') {
            return Err(PlotError::StringConversion(
                "text contained null byte".to_string(),
            ));
        }
        Ok(())
    }

    /// Plot the text
    pub fn plot(self) {
        let pix_offset = sys::ImVec2_c {
            x: self.pix_offset_x as f32,
            y: self.pix_offset_y as f32,
        };
        let _ = with_plot_str(self.text, |text_ptr| unsafe {
            let spec = plot_spec_with_style(
                self.style,
                self.flags.bits() | self.item_flags.bits(),
                0,
                crate::IMPLOT_AUTO,
            );
            sys::ImPlot_PlotText(text_ptr, self.x, self.y, pix_offset, spec);
        });
    }
}

impl<'a> PlotData for TextPlot<'a> {
    fn label(&self) -> &str {
        self.text
    }

    fn data_len(&self) -> usize {
        1 // Text plot has one data point
    }
}

/// Multiple text labels plot
pub struct MultiTextPlot<'a> {
    texts: Vec<&'a str>,
    positions: Vec<(f64, f64)>,
    pixel_offsets: Vec<(f64, f64)>,
    style: PlotItemStyle,
    flags: TextFlags,
    item_flags: ItemFlags,
}

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

impl<'a> MultiTextPlot<'a> {
    /// Create a new multi-text plot
    pub fn new(texts: Vec<&'a str>, positions: Vec<(f64, f64)>) -> Self {
        let pixel_offsets = vec![(0.0, 0.0); texts.len()];
        Self {
            texts,
            positions,
            pixel_offsets,
            style: PlotItemStyle::default(),
            flags: TextFlags::NONE,
            item_flags: ItemFlags::NONE,
        }
    }

    /// Set pixel offsets for all texts
    pub fn with_pixel_offsets(mut self, offsets: Vec<(f64, f64)>) -> Self {
        self.pixel_offsets = offsets;
        self
    }

    /// Set text flags for all texts
    pub fn with_flags(mut self, flags: TextFlags) -> Self {
        self.flags = flags;
        self
    }

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

    /// Make all texts vertical
    pub fn vertical(mut self) -> Self {
        self.flags |= TextFlags::VERTICAL;
        self
    }

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

        if self.pixel_offsets.len() != self.texts.len() {
            return Err(PlotError::InvalidData(format!(
                "Pixel offset count ({}) must match text count ({})",
                self.pixel_offsets.len(),
                self.texts.len()
            )));
        }

        if self.texts.is_empty() {
            return Err(PlotError::EmptyData);
        }

        for (i, text) in self.texts.iter().enumerate() {
            if text.is_empty() {
                return Err(PlotError::InvalidData(format!(
                    "Text at index {} cannot be empty",
                    i
                )));
            }
        }

        Ok(())
    }

    /// Plot all texts
    pub fn plot(self) {
        for (i, &text) in self.texts.iter().enumerate() {
            let position = self.positions[i];
            let offset = self.pixel_offsets[i];

            let text_plot = TextPlot::new(text, position.0, position.1)
                .with_style(self.style)
                .with_pixel_offset(offset.0, offset.1)
                .with_flags(self.flags)
                .with_item_flags(self.item_flags);

            text_plot.plot();
        }
    }
}

impl<'a> PlotData for MultiTextPlot<'a> {
    fn label(&self) -> &str {
        "MultiText"
    }

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

/// Formatted text plot with dynamic content
pub struct FormattedTextPlot {
    text: String,
    x: f64,
    y: f64,
    style: PlotItemStyle,
    pix_offset_x: f64,
    pix_offset_y: f64,
    flags: TextFlags,
    item_flags: ItemFlags,
}

impl super::PlotItemStyled for FormattedTextPlot {
    fn style_mut(&mut self) -> &mut PlotItemStyle {
        &mut self.style
    }
}

impl FormattedTextPlot {
    /// Create a new formatted text plot
    pub fn new(text: String, x: f64, y: f64) -> Self {
        Self {
            text,
            x,
            y,
            style: PlotItemStyle::default(),
            pix_offset_x: 0.0,
            pix_offset_y: 0.0,
            flags: TextFlags::NONE,
            item_flags: ItemFlags::NONE,
        }
    }

    /// Create a formatted text plot from format arguments
    pub fn from_format(x: f64, y: f64, args: std::fmt::Arguments) -> Self {
        Self::new(format!("{}", args), x, y)
    }

    /// Set pixel offset for fine positioning
    pub fn with_pixel_offset(mut self, offset_x: f64, offset_y: f64) -> Self {
        self.pix_offset_x = offset_x;
        self.pix_offset_y = offset_y;
        self
    }

    /// Set text flags for customization
    pub fn with_flags(mut self, flags: TextFlags) -> 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 text vertical
    pub fn vertical(mut self) -> Self {
        self.flags |= TextFlags::VERTICAL;
        self
    }

    /// Validate the plot data
    pub fn validate(&self) -> Result<(), PlotError> {
        if self.text.is_empty() {
            return Err(PlotError::InvalidData("Text cannot be empty".to_string()));
        }
        if self.text.contains('\0') {
            return Err(PlotError::StringConversion(
                "text contained null byte".to_string(),
            ));
        }
        Ok(())
    }

    /// Plot the formatted text
    pub fn plot(self) {
        let pix_offset = sys::ImVec2_c {
            x: self.pix_offset_x as f32,
            y: self.pix_offset_y as f32,
        };
        let _ = with_plot_str(&self.text, |text_ptr| unsafe {
            let spec = plot_spec_with_style(
                self.style,
                self.flags.bits() | self.item_flags.bits(),
                0,
                crate::IMPLOT_AUTO,
            );
            sys::ImPlot_PlotText(text_ptr, self.x, self.y, pix_offset, spec);
        });
    }
}

impl PlotData for FormattedTextPlot {
    fn label(&self) -> &str {
        &self.text
    }

    fn data_len(&self) -> usize {
        1
    }
}

/// Convenience macro for creating formatted text plots
#[macro_export]
macro_rules! plot_text {
    ($x:expr, $y:expr, $($arg:tt)*) => {
        $crate::plots::text::FormattedTextPlot::from_format($x, $y, format_args!($($arg)*))
    };
}

/// Text annotation with automatic positioning
pub struct TextAnnotation<'a> {
    text: &'a str,
    x: f64,
    y: f64,
    style: PlotItemStyle,
    auto_offset: bool,
    flags: TextFlags,
    item_flags: ItemFlags,
}

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

impl<'a> TextAnnotation<'a> {
    /// Create a new text annotation
    pub fn new(text: &'a str, x: f64, y: f64) -> Self {
        Self {
            text,
            x,
            y,
            style: PlotItemStyle::default(),
            auto_offset: true,
            flags: TextFlags::NONE,
            item_flags: ItemFlags::NONE,
        }
    }

    /// Disable automatic offset calculation
    pub fn no_auto_offset(mut self) -> Self {
        self.auto_offset = false;
        self
    }

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

    /// Set common item flags for the annotation text
    pub fn with_item_flags(mut self, flags: ItemFlags) -> Self {
        self.item_flags = flags;
        self
    }

    /// Make text vertical
    pub fn vertical(mut self) -> Self {
        self.flags |= TextFlags::VERTICAL;
        self
    }

    /// Plot the annotation
    pub fn plot(self) {
        let offset = if self.auto_offset {
            // Simple auto-offset logic - could be enhanced
            (5.0, -5.0)
        } else {
            (0.0, 0.0)
        };

        let text_plot = TextPlot::new(self.text, self.x, self.y)
            .with_style(self.style)
            .with_pixel_offset(offset.0, offset.1)
            .with_flags(self.flags)
            .with_item_flags(self.item_flags);

        text_plot.plot();
    }
}