berkus
/
topola
mirror of https://codeberg.org/topola/topola.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(interactor): document activity.rs

This commit is contained in:
Szpachlarz 2024-11-15 19:21:43 +00:00 committed by mikolaj
parent 6f2e6bd70e
commit c528265f1a
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/interactor/activity.rs
View File

@ -18,11 +18,13 @@ use crate::{
stepper::{Abort, Step}, stepper::{Abort, Step},
}; };
/// Stores the interactive input data from the user
pub struct InteractiveInput { pub struct InteractiveInput {
pub pointer_pos: Point, pub pointer_pos: Point,
pub dt: f32, pub dt: f32,
} }
/// This is the execution context passed to the stepper on each step
pub struct ActivityContext<'a, M: AccessMesadata> { pub struct ActivityContext<'a, M: AccessMesadata> {
pub interactive_input: &'a InteractiveInput, pub interactive_input: &'a InteractiveInput,
pub invoker: &'a mut Invoker<M>, pub invoker: &'a mut Invoker<M>,
@ -36,6 +38,7 @@ pub enum ActivityError {
Invoker(#[from] InvokerError), Invoker(#[from] InvokerError),
} }
/// An activity is either an interaction or an execution
pub enum ActivityStepper { pub enum ActivityStepper {
Interaction(InteractionStepper), Interaction(InteractionStepper),
Execution(ExecutionStepper), Execution(ExecutionStepper),
@ -106,6 +109,7 @@ impl GetObstacles for ActivityStepper {
} }
} }
/// An ActivityStepper that preserves its status
pub struct ActivityStepperWithStatus { pub struct ActivityStepperWithStatus {
activity: ActivityStepper, activity: ActivityStepper,
maybe_status: Option<ControlFlow<String>>, maybe_status: Option<ControlFlow<String>>,