ruviz 0.4.12

High-performance 2D plotting library for Rust
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

//! Unified record! macro for animation recording
//!
//! This module provides the `record!` macro which unifies all animation
//! recording patterns into a single, ergonomic API.
//!
//! # Patterns
//!
//! ```rust,ignore
//! use ruviz::record;
//!
//! // Frame count
//! record!("out.gif", 60, |t| Plot::new().line(&x, &y))?;
//!
//! // Duration in seconds
//! record!("out.gif", 2 secs, |t| Plot::new().scatter(&x, &y))?;
//!
//! // Duration in milliseconds
//! record!("out.gif", 500 ms, |t| Plot::new().bar(&x, &y))?;
//!
//! // Custom framerate
//! record!("out.gif", 2 secs @ 60 fps, |t| Plot::new().line(&x, &y))?;
//!
//! // With configuration
//! let config = RecordConfig::new().dimensions(1920, 1080);
//! record!("out.gif", 60, config: config, |t| Plot::new().line(&x, &y))?;
//!
//! // Reactive plot (no closure needed)
//! record!("out.gif", &reactive_plot, 2 secs)?;
//! record!("out.gif", &reactive_plot, 2 secs @ 30 fps)?;
//! ```

/// Unified macro for animation recording.
///
/// This macro provides a single entry point for all animation recording patterns,
/// replacing the multiple `record_*` functions with a cleaner, more consistent API.
///
/// # Patterns
///
/// ## Closure-based (Plot created per frame)
///
/// ```rust,ignore
/// // Frame count (60 frames at default 30fps)
/// record!("out.gif", 60, |t| Plot::new().line(&x, &y))?;
///
/// // Duration in seconds (default 30fps)
/// record!("out.gif", 2 secs, |t| Plot::new().scatter(&x, &y))?;
///
/// // Duration in milliseconds
/// record!("out.gif", 500 ms, |t| Plot::new().bar(&x, &y))?;
///
/// // Custom framerate
/// record!("out.gif", 2 secs @ 60 fps, |t| Plot::new().line(&x, &y))?;
///
/// // With configuration
/// let config = RecordConfig::new().dimensions(1920, 1080);
/// record!("out.gif", 60, config: config, |t| Plot::new().line(&x, &y))?;
/// ```
///
/// ## Reactive (Plot created once)
///
/// ```rust,ignore
/// let y_signal = signal::of(|t| compute_y(t));
/// let plot = Plot::new().line(&x, y_signal);
///
/// // Reactive with duration
/// record!("out.gif", &plot, 2 secs)?;
///
/// // Reactive with custom fps
/// record!("out.gif", &plot, 2 secs @ 30 fps)?;
///
/// // Reactive with config
/// let config = RecordConfig::new().dimensions(1920, 1080);
/// record!("out.gif", &plot, 2 secs, config: config)?;
/// ```
#[macro_export]
macro_rules! record {
    // =========== Closure-based (creates Plot per frame) ===========

    // Frame count: record!("out.gif", 60, |t| plot)
    ($path:expr, $frames:expr, $closure:expr) => {
        $crate::animation::_record_frames($path, $frames, $closure)
    };

    // Duration literal (seconds): record!("out.gif", 2 secs, |t| plot)
    ($path:expr, $duration:tt secs, $closure:expr) => {
        $crate::animation::_record_duration($path, $duration as f64, $closure)
    };

    // Duration literal (milliseconds): record!("out.gif", 500 ms, |t| plot)
    ($path:expr, $duration:tt ms, $closure:expr) => {
        $crate::animation::_record_duration($path, ($duration as f64) / 1000.0, $closure)
    };

    // With fps: record!("out.gif", 2 secs @ 60 fps, |t| plot)
    ($path:expr, $duration:tt secs @ $fps:tt fps, $closure:expr) => {
        $crate::animation::_record_duration_fps($path, $duration as f64, $fps, $closure)
    };

    // With config (frames): record!("out.gif", 60, config: $cfg, |t| plot)
    ($path:expr, $frames:expr, config: $config:expr, $closure:expr) => {
        $crate::animation::_record_frames_config($path, $frames, $config, $closure)
    };

    // With config (duration): record!("out.gif", 2 secs, config: $cfg, |t| plot)
    ($path:expr, $duration:tt secs, config: $config:expr, $closure:expr) => {{
        let cfg: $crate::animation::RecordConfig = $config;
        let frames = ($duration as f64 * cfg.framerate as f64).ceil() as usize;
        $crate::animation::_record_frames_config($path, frames, cfg, $closure)
    }};

    // =========== Reactive plot (Plot created once) ===========

    // Reactive with duration: record!("out.gif", &plot, 2 secs)
    ($path:expr, & $plot:expr, $duration:tt secs) => {
        $crate::animation::_record_reactive($path, &$plot, $duration as f64, 30)
    };

    // Reactive with fps: record!("out.gif", &plot, 2 secs @ 30 fps)
    ($path:expr, & $plot:expr, $duration:tt secs @ $fps:tt fps) => {
        $crate::animation::_record_reactive($path, &$plot, $duration as f64, $fps)
    };

    // Reactive with config: record!("out.gif", &plot, 2 secs, config: $cfg)
    ($path:expr, & $plot:expr, $duration:tt secs, config: $config:expr) => {
        $crate::animation::_record_reactive_config($path, &$plot, $duration as f64, $config)
    };
}

#[cfg(test)]
mod tests {
    // Tests will use the macro from the crate root
    // For now, just verify the internal functions are accessible
    #[allow(unused)]
    use crate::animation::*;

    #[test]
    fn test_internal_functions_accessible() {
        // Just verify these exist and are accessible via type assertions
        // The reactive functions only need the path type parameter
        fn assert_reactive_exists<P: AsRef<std::path::Path>>() {
            let _ = _record_reactive::<P>
                as fn(P, &crate::core::Plot, f64, u32) -> crate::core::Result<()>;
            let _ = _record_reactive_config::<P>
                as fn(P, &crate::core::Plot, f64, RecordConfig) -> crate::core::Result<()>;
        }
        assert_reactive_exists::<&str>();
    }
}