feat: laser tool

crates/rnote-compose/src/builders/arrowbuilder.rs

@@ -58,6 +58,7 @@ impl Buildable for ArrowBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/coordsystem2dbuilder.rs

@@ -56,6 +56,7 @@ impl Buildable for CoordSystem2DBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/coordsystem3dbuilder.rs

@@ -56,6 +56,7 @@ impl Buildable for CoordSystem3DBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/cubbezbuilder.rs

@@ -143,6 +143,7 @@ impl Buildable for CubBezBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/ellipsebuilder.rs

@@ -53,6 +53,7 @@ impl Buildable for EllipseBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/fociellipsebuilder.rs

@@ -114,6 +114,7 @@ impl Buildable for FociEllipseBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/gridbuilder.rs

@@ -103,6 +103,7 @@ impl Buildable for GridBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/linebuilder.rs

@@ -58,6 +58,7 @@ impl Buildable for LineBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/penpathcurvedbuilder.rs

@@ -75,7 +75,8 @@ impl Buildable for PenPathCurvedBuilder {
             }
             (_, PenEvent::Proximity { .. })
             | (_, PenEvent::KeyPressed { .. })
-            | (_, PenEvent::Text { .. }) => BuilderProgress::InProgress,
+            | (_, PenEvent::Text { .. })
+            | (_, PenEvent::AnimationFrame) => BuilderProgress::InProgress,
             (_, PenEvent::Cancel) => {
                 self.reset();
 
@@ -87,6 +88,7 @@ impl Buildable for PenPathCurvedBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/penpathmodeledbuilder.rs

@@ -86,16 +86,18 @@ impl Buildable for PenPathModeledBuilder {
 
                 BuilderProgress::Finished(segments)
             }
-            PenEvent::Proximity { .. } | PenEvent::KeyPressed { .. } | PenEvent::Text { .. } => {
-                BuilderProgress::InProgress
-            }
+            PenEvent::Proximity { .. }
+            | PenEvent::KeyPressed { .. }
+            | PenEvent::Text { .. }
+            | PenEvent::AnimationFrame => BuilderProgress::InProgress,
             PenEvent::Cancel => BuilderProgress::Finished(vec![]),
         };
 
         EventResult {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/penpathsimplebuilder.rs

@@ -49,9 +49,10 @@ impl Buildable for PenPathSimpleBuilder {
 
                 BuilderProgress::Finished(segments)
             }
-            PenEvent::Proximity { .. } | PenEvent::KeyPressed { .. } | PenEvent::Text { .. } => {
-                BuilderProgress::InProgress
-            }
+            PenEvent::Proximity { .. }
+            | PenEvent::KeyPressed { .. }
+            | PenEvent::Text { .. }
+            | PenEvent::AnimationFrame => BuilderProgress::InProgress,
             PenEvent::Cancel => {
                 self.reset();
                 BuilderProgress::Finished(vec![])
@@ -62,6 +63,7 @@ impl Buildable for PenPathSimpleBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/polygonbuilder.rs

@@ -91,7 +91,7 @@ impl Buildable for PolygonBuilder {
                 }
                 _ => BuilderProgress::InProgress,
             },
-            PenEvent::Text { .. } => BuilderProgress::InProgress,
+            PenEvent::Text { .. } | PenEvent::AnimationFrame => BuilderProgress::InProgress,
             PenEvent::Cancel => {
                 self.pen_state = PenState::Up;
                 self.finish = false;
@@ -103,6 +103,7 @@ impl Buildable for PolygonBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/polylinebuilder.rs

@@ -91,7 +91,7 @@ impl Buildable for PolylineBuilder {
                 }
                 _ => BuilderProgress::InProgress,
             },
-            PenEvent::Text { .. } => BuilderProgress::InProgress,
+            PenEvent::Text { .. } | PenEvent::AnimationFrame => BuilderProgress::InProgress,
             PenEvent::Cancel => {
                 self.pen_state = PenState::Up;
                 self.finish = false;
@@ -103,6 +103,7 @@ impl Buildable for PolylineBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/quadbezbuilder.rs

@@ -99,6 +99,7 @@ impl Buildable for QuadBezBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/quadrantcoordsystem2dbuilder.rs

@@ -56,6 +56,7 @@ impl Buildable for QuadrantCoordSystem2DBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/builders/rectanglebuilder.rs

@@ -54,6 +54,7 @@ impl Buildable for RectangleBuilder {
             handled: true,
             propagate: EventPropagation::Stop,
             progress,
+            request_animation_frame: false,
         }
     }
 

crates/rnote-compose/src/eventresult.rs

@@ -13,6 +13,8 @@ where
     pub propagate: EventPropagation,
     /// The pen progress.
     pub progress: T,
+    /// Whether an animated frame should be requested.
+    pub request_animation_frame: bool,
 }
 
 /// Whether the event should be propagated further.

crates/rnote-compose/src/penevent.rs

@@ -44,6 +44,8 @@ pub enum PenEvent {
         /// The committed text.
         text: String,
     },
+    /// Animation frame event.
+    AnimationFrame,
     /// Cancel event when the pen vanishes unexpected.
     ///
     /// Should finish all current actions and reset all state.

crates/rnote-engine/src/engine/mod.rs

@@ -34,7 +34,7 @@ use serde::{Deserialize, Serialize};
 use std::path::PathBuf;
 use std::sync::Arc;
 use std::time::Instant;
-use tracing::error;
+use tracing::{debug, error};
 
 /// An immutable view into the engine, excluding the penholder.
 #[derive(Debug)]
@@ -45,6 +45,7 @@ pub struct EngineView<'a> {
     pub store: &'a StrokeStore,
     pub camera: &'a Camera,
     pub audioplayer: &'a Option<AudioPlayer>,
+    pub animation: &'a Animation,
 }
 
 /// Constructs an `EngineView` from an identifier containing an `Engine` instance.
@@ -58,6 +59,7 @@ macro_rules! engine_view {
             store: &$engine.store,
             camera: &$engine.camera,
             audioplayer: &$engine.audioplayer,
+            animation: &$engine.animation,
         }
     };
 }
@@ -71,6 +73,7 @@ pub struct EngineViewMut<'a> {
     pub store: &'a mut StrokeStore,
     pub camera: &'a mut Camera,
     pub audioplayer: &'a mut Option<AudioPlayer>,
+    pub animation: &'a mut Animation,
 }
 
 /// Constructs an `EngineViewMut` from an identifier containing an `Engine` instance.
@@ -84,6 +87,7 @@ macro_rules! engine_view_mut {
             store: &mut $engine.store,
             camera: &mut $engine.camera,
             audioplayer: &mut $engine.audioplayer,
+            animation: &mut $engine.animation,
         }
     };
 }
@@ -98,6 +102,7 @@ impl<'a> EngineViewMut<'a> {
             store: self.store,
             camera: self.camera,
             audioplayer: self.audioplayer,
+            animation: self.animation,
         }
     }
 }
@@ -129,6 +134,8 @@ pub enum EngineTask {
     },
     /// Requests that the typewriter cursor should be blinked/toggled
     BlinkTypewriterCursor,
+    /// Emits an animation frame event.
+    // EmitAnimationFrame,
     /// Change the permanent zoom to the given value
     Zoom(f64),
     /// Indicates that the application is quitting. Sent to quit the handler which receives the tasks.
@@ -179,6 +186,27 @@ impl EngineTaskReceiver {
     }
 }
 
+#[derive(Debug, Clone, Default)]
+pub struct Animation {
+    frame_in_flight: bool,
+}
+
+impl Animation {
+    pub fn claim_frame(&mut self) -> bool {
+        if self.frame_in_flight {
+            debug!("Animation frame already in flight, skipping");
+            false
+        } else {
+            self.frame_in_flight = true;
+            true
+        }
+    }
+
+    pub fn reset(&mut self) {
+        self.frame_in_flight = false;
+    }
+}
+
 /// The engine.
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(default, rename = "engine")]
@@ -205,6 +233,8 @@ pub struct Engine {
     #[serde(skip)]
     audioplayer: Option<AudioPlayer>,
     #[serde(skip)]
+    pub animation: Animation,
+    #[serde(skip)]
     visual_debug: bool,
     // the task sender. Must not be modified, only cloned.
     #[serde(skip)]
@@ -241,6 +271,7 @@ impl Default for Engine {
             optimize_epd: false,
 
             audioplayer: None,
+            animation: Animation::default(),
             visual_debug: false,
             tasks_tx: EngineTaskSender(tasks_tx),
             tasks_rx: Some(EngineTaskReceiver(tasks_rx)),
@@ -457,6 +488,13 @@ impl Engine {
                     widget_flags.redraw = true;
                 }
             }
+            // EngineTask::EmitAnimationFrame => {
+            //     self.animation.reset();
+
+            //     widget_flags |= self
+            //         .handle_pen_event(PenEvent::AnimationFrame, None, Instant::now())
+            //         .1;
+            // }
             EngineTask::Zoom(zoom) => {
                 widget_flags |= self.camera.zoom_temporarily_to(1.0) | self.camera.zoom_to(zoom);
 
@@ -481,7 +519,7 @@ impl Engine {
         event: PenEvent,
         pen_mode: Option<PenMode>,
         now: Instant,
-    ) -> (EventPropagation, WidgetFlags) {
+    ) -> (EventPropagation, WidgetFlags, bool) {
         self.penholder
             .handle_pen_event(event, pen_mode, now, &mut engine_view_mut!(self))
     }

crates/rnote-engine/src/pens/brush.rs

@@ -118,19 +118,22 @@ impl PenBehaviour for Brush {
                         handled: true,
                         propagate: EventPropagation::Stop,
                         progress: PenProgress::InProgress,
+                        request_animation_frame: false,
                     }
                 } else {
                     EventResult {
                         handled: false,
                         propagate: EventPropagation::Proceed,
                         progress: PenProgress::Idle,
+                        request_animation_frame: false,
                     }
                 }
             }
             (BrushState::Idle, _) => EventResult {
                 handled: false,
                 propagate: EventPropagation::Proceed,
                 progress: PenProgress::Idle,
+                request_animation_frame: false,
             },
             (
                 BrushState::Drawing {
@@ -161,6 +164,7 @@ impl PenBehaviour for Brush {
                     handled: true,
                     propagate: EventPropagation::Stop,
                     progress: PenProgress::Finished,
+                    request_animation_frame: false,
                 }
             }
             (
@@ -256,6 +260,7 @@ impl PenBehaviour for Brush {
                     handled,
                     propagate,
                     progress,
+                    request_animation_frame: false,
                 }
             }
         };