linear-sim 0.7.0

Minimal linear 3D simulation library
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
#![warn(unused_extern_crates)]

use std;
use env_logger;
use log;

use macro_machines;

use gl_utils;
use gl_utils::*;

use linear_sim;
use linear_sim::*;

pub mod program;          // program state machine

pub mod bounding_volume;  // bounding volume demos
pub mod penetration;      // penetration resolution demos
pub mod simulation;       // simulation demos

const LOG_LEVEL    : log::LevelFilter = log::LevelFilter::Info;
const LOG_FILENAME : &str             = "testbed.log";

const INITIAL_2D_ZOOM     : f32      = 1.0;
const INITIAL_3D_POSITION : [f32; 3] = [0.0, 0.0, 2.0];
const INITIAL_CLEAR_COLOR : [f32; 4] = [0.0, 0.0, 0.0, 1.0];

/// Halt simulation after this step
//const DEBUG_MAX_STEP : Option <u64> = Some (60);
const DEBUG_MAX_STEP : Option <u64> = None;

#[derive(Debug)]
enum ModeGroup {
  Simulation,
  Penetration,
  BoundingVolume
}

impl ModeGroup {
  pub(crate) fn states (&self) -> Vec <program::StateId> {
    match self {
      ModeGroup::Simulation => vec![
        program::StateId::SimulationDropTest,
        program::StateId::SimulationCollideCapsuleCapsule,
        program::StateId::SimulationStackTest,
        program::StateId::SimulationBallPitTest,
        program::StateId::SimulationHullPitTest
      ],
      ModeGroup::Penetration => vec![
        program::StateId::PenetrationCapsuleCapsule,
        program::StateId::PenetrationCapsuleCuboid,
        program::StateId::PenetrationCuboidCuboid,
        program::StateId::PenetrationTriangleTriangle,
        program::StateId::PenetrationHullHull
      ],
      ModeGroup::BoundingVolume => vec![
        program::StateId::BoundingVolumeObb
      ]
    }
  }
  pub(crate) const fn from_state (state : program::StateId) -> Self {
    match state {
      program::StateId::SimulationDropTest |
      program::StateId::SimulationCollideCapsuleCapsule |
      program::StateId::SimulationStackTest |
      program::StateId::SimulationBallPitTest |
      program::StateId::SimulationHullPitTest
        => ModeGroup::Simulation,
      program::StateId::PenetrationCapsuleCapsule |
      program::StateId::PenetrationCapsuleCuboid |
      program::StateId::PenetrationCuboidCuboid |
      program::StateId::PenetrationTriangleTriangle |
      program::StateId::PenetrationHullHull
        => ModeGroup::Penetration,
      program::StateId::BoundingVolumeObb
        => ModeGroup::BoundingVolume
    }
  }
}

impl winit::application::ApplicationHandler for program::Testbed {
  fn resumed (&mut self, _event_loop : &winit::event_loop::ActiveEventLoop) { }
  // TODO: review
  // - window events includes input events received by the window
  // - device events are received independent of window focus
  // there may be differences in the events received depending on platform:
  // - on Linux keyboard input is received as both a device and window event
  // - on Windows only mouse motion device events are received, all other input is
  //   received as window events
  // here we just handle input contained in window events
  fn window_event (&mut self,
    _event_loop : &winit::event_loop::ActiveEventLoop,
    _window_id  : winit::window::WindowId,
    event       : winit::event::WindowEvent
  ) {
    use winit::{event, keyboard};
    //
    // program handle event
    //
    let modifiers = Render::modifiers();
    if let Some (program_event) = match event {
      event::WindowEvent::KeyboardInput {
        event: event::KeyEvent {
          state: event::ElementState::Pressed, physical_key, ..
        },
        ..
      } => match physical_key {
        keyboard::PhysicalKey::Code (key_code) => if modifiers.shift_key() {
          match key_code {
            // shift + 0-9: switch to mode
            keyboard::KeyCode::Digit1 =>
              (!ModeGroup::Simulation.states().contains (&self.state_id()))
                .then_some (program::EventParams::ToSimulationDropTest{}.into()),
            keyboard::KeyCode::Digit2 =>
              (!ModeGroup::Penetration.states().contains (&self.state_id()))
                .then_some (program::EventParams::ToPenetrationCapsuleCapsule{}.into()),
            keyboard::KeyCode::Digit3 =>
              (!ModeGroup::BoundingVolume.states().contains (&self.state_id()))
                .then_some (program::EventParams::ToBoundingVolumeObb{}.into()),
            _ => None
          }
        } else {
          let change_state = |
            to_state : program::StateId,
            event    : program::EventParams <'static>
          | -> Option <program::Event <'static>> {
            let current_state = self.state_id();
            let to_group = ModeGroup::from_state (to_state.clone());
            (to_group.states().contains (&current_state) && current_state != to_state)
              .then (|| event.into())
          };
          match key_code {
            // C: print camera state
            keyboard::KeyCode::KeyC => {
              println!("current camera: {:?}",
                self.as_mut().render_context
                  .viewports()[render::resource::MAIN_VIEWPORT].camera3d()
                  .unwrap());
              None
            }
            keyboard::KeyCode::Digit1 => change_state (
                program::StateId::SimulationDropTest,
                program::EventParams::ToSimulationDropTest{}
              ).or_else (|| change_state (
                program::StateId::PenetrationCapsuleCapsule,
                program::EventParams::ToPenetrationCapsuleCapsule{}
              )).or_else (|| change_state (
                program::StateId::BoundingVolumeObb,
                program::EventParams::ToBoundingVolumeObb{}
              )),
            keyboard::KeyCode::Digit2 => change_state (
                program::StateId::SimulationCollideCapsuleCapsule,
                program::EventParams::ToSimulationCollideCapsuleCapsule{}
              ).or_else (|| change_state (
                program::StateId::PenetrationCapsuleCuboid,
                program::EventParams::ToPenetrationCapsuleCuboid{}
              )),
            keyboard::KeyCode::Digit3 => change_state (
                program::StateId::SimulationStackTest,
                program::EventParams::ToSimulationStackTest{}
              ).or_else (|| change_state (
                program::StateId::PenetrationCuboidCuboid,
                program::EventParams::ToPenetrationCuboidCuboid{}
              )),
            keyboard::KeyCode::Digit4 => change_state (
                program::StateId::SimulationBallPitTest,
                program::EventParams::ToSimulationBallPitTest{}
              ).or_else (|| change_state (
                program::StateId::PenetrationTriangleTriangle,
                program::EventParams::ToPenetrationTriangleTriangle{}
              )),
            keyboard::KeyCode::Digit5 => change_state (
                program::StateId::SimulationHullPitTest,
                program::EventParams::ToSimulationHullPitTest{}
              ).or_else (|| change_state (
                program::StateId::PenetrationHullHull,
                program::EventParams::ToPenetrationHullHull{}
              )),
            // Tab key generate new collision or penetration examples
            keyboard::KeyCode::Tab => match self.state_id() {
              program::StateId::PenetrationCapsuleCapsule =>
                Some (program::EventParams::NextPenetrationCapsuleCapsule{}.into()),
              program::StateId::PenetrationCuboidCuboid =>
                Some (program::EventParams::NextPenetrationCuboidCuboid{}.into()),
              program::StateId::PenetrationCapsuleCuboid =>
                Some (program::EventParams::NextPenetrationCapsuleCuboid{}.into()),
              program::StateId::PenetrationTriangleTriangle =>
                Some (program::EventParams::NextPenetrationTriangleTriangle{}.into()),
              program::StateId::PenetrationHullHull =>
                Some (program::EventParams::NextPenetrationHullHull{}.into()),
              program::StateId::SimulationCollideCapsuleCapsule =>
                Some (program::EventParams::NextSimulationCollideCapsuleCapsule{}.into()),
              program::StateId::SimulationBallPitTest =>
                Some (program::EventParams::NextSimulationBallPitTest{}.into()),
              program::StateId::SimulationHullPitTest =>
                Some (program::EventParams::NextSimulationHullPitTest{}.into()),
              program::StateId::BoundingVolumeObb =>
                Some (program::EventParams::NextBoundingVolumeObb{}.into()),
              _ => None
            }
            // P: toggle simulation pause/resume
            keyboard::KeyCode::KeyP => match self.state_data() {
              program::StateData::SimulationDropTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::ResumeSimulationDropTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationDropTest{}.into())
                }
              program::StateData::SimulationCollideCapsuleCapsule {
                playback, ..
              } => if playback.paused {
                Some (program::EventParams::ResumeSimulationCollideCapsuleCapsule{}.into())
              } else {
                Some (program::EventParams::PauseSimulationCollideCapsuleCapsule{}.into())
              }
              program::StateData::SimulationStackTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::ResumeSimulationStackTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationStackTest{}.into())
                }
              program::StateData::SimulationBallPitTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::ResumeSimulationBallPitTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationBallPitTest{}.into())
                }
              _ => None
            }
            // step (or pause if not paused)
            keyboard::KeyCode::Period => match self.state_data() {
              program::StateData::SimulationDropTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::StepSimulationDropTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationDropTest{}.into())
                }
              program::StateData::SimulationCollideCapsuleCapsule {
                playback, ..
              } => if playback.paused {
                Some (program::EventParams::StepSimulationCollideCapsuleCapsule{}.into())
              } else {
                Some (program::EventParams::PauseSimulationCollideCapsuleCapsule{}.into())
              }
              program::StateData::SimulationStackTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::StepSimulationStackTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationStackTest{}.into())
                }
              program::StateData::SimulationBallPitTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::StepSimulationBallPitTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationBallPitTest{}.into())
                }
              _ => None
            }
            // reverse step (or pause if not paused)
            keyboard::KeyCode::Comma => match self.state_data() {
              program::StateData::SimulationDropTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::StepReverseSimulationDropTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationDropTest{}.into())
                }
              program::StateData::SimulationCollideCapsuleCapsule {
                playback, ..
              } => if playback.paused {
                Some (program::EventParams::StepReverseSimulationCollideCapsuleCapsule{}
                  .into())
              } else {
                Some (program::EventParams::PauseSimulationCollideCapsuleCapsule{}.into())
              }
              program::StateData::SimulationStackTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::StepReverseSimulationStackTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationStackTest{}.into())
                }
              program::StateData::SimulationBallPitTest { playback, ..  } =>
                if playback.paused {
                  Some (program::EventParams::StepReverseSimulationBallPitTest{}.into())
                } else {
                  Some (program::EventParams::PauseSimulationBallPitTest{}.into())
                }
              _ => None
            }
            // restart simulation
            keyboard::KeyCode::Backspace => match self.state_id() {
              program::StateId::SimulationDropTest =>
                Some (program::EventParams::RestartSimulationDropTest{}.into()),
              program::StateId::SimulationCollideCapsuleCapsule =>
                Some (program::EventParams::RestartSimulationCollideCapsuleCapsule{}
                  .into()),
              program::StateId::SimulationStackTest =>
                Some (program::EventParams::RestartSimulationStackTest{}.into()),
              program::StateId::SimulationBallPitTest =>
                Some (program::EventParams::RestartSimulationBallPitTest{}.into()),
              program::StateId::SimulationHullPitTest =>
                Some (program::EventParams::RestartSimulationHullPitTest{}.into()),
              _ => None
            }
            _ => None   // unhandled key codes
          }
        }
        keyboard::PhysicalKey::Unidentified (native_key_code) => {
          log::warn!("keyboard input: unidentified physical keycode: \
            {native_key_code:?}");
          None
        }
      }
      _ => None
    } {
      self.handle_event (program_event).unwrap();
    } else {
      // if not handled, forward to the default demo handler
      let mut mouse_button_event = None;
      let mut mouse_position = (0.0, 0.0);
      let mut running = true;
      self.as_mut().render_context.demo_handle_winit_window_event (
        event, &mut running, &mut mouse_position, &mut mouse_button_event);
      self.as_mut().running = running;
    }
  }
}

fn main() {
  println!("linear-sim testbed...");

  // initialize logger
  let log_file = Box::new (std::fs::File::create (LOG_FILENAME).unwrap());
  env_logger::Builder::new()
    .filter_level (LOG_LEVEL)
    .parse_default_env()
    .target (env_logger::Target::Pipe (log_file))
    .init();

  // initialize glium
  log::info!("initializing glium...");
  let (mut event_loop, window, _gl_config, glium_display) =
    init::glium_init_gl33core ("linear-sim testbed window");

  // output some diagnostics
  { // print glium opengl context info
    use glium::backend::Facade;
    let context = glium_display.get_context();
    log::info!("opengl version: {:?}", context.get_opengl_version());
    log::info!("opengl profile: {:?}", context.get_opengl_profile());
    log::info!("supported glsl version: {:?}", context.get_supported_glsl_version());
    log::info!("free video memory: {}MB",
      context.get_free_video_memory().unwrap()/1_000_000);
  }
  // report size information
  program::Testbed::report_sizes();
  { // create dotfile with testbed state machine
    use std::io::Write;
    use macro_machines::MachineDotfile;
    let mut f = std::fs::File::create ("testbed.dot").unwrap();
    f.write_all (program::Testbed::dotfile_hide_actions().as_bytes()).unwrap();
  }
  object::report_sizes();
  system::report_sizes();
  collision::report_sizes();

  // create testbed state machine
  let mut testbed = {
    // acquire and setup render context
    let render_context = Render::new (glium_display, window);
    program::Testbed::new (
      program::ExtendedState::new (Some (render_context), None, Some (true)).unwrap())
  };

  // welcome
  println!("Welcome");
  println!("  Press 'C' to show current camera state");

  // main loop
  let mut fps    = 0;
  let mut last_t = std::time::Instant::now();
  while testbed.as_ref().running {
    use winit::platform::pump_events::EventLoopExtPumpEvents;
    // pump winit events
    event_loop.pump_app_events (Some (std::time::Duration::ZERO), &mut testbed);
    // updates
    let debug_break_max_step = |testbed : &mut program::Testbed| {
      let system = match testbed.state_data() {
        program::StateData::SimulationDropTest { simulation, .. }  |
        program::StateData::SimulationStackTest { simulation, .. } |
        program::StateData::SimulationBallPitTest {
          simulation_generation: (simulation, _), ..
        } |
        program::StateData::SimulationHullPitTest {
          simulation_generation: (simulation, _), ..
        } |
        program::StateData::SimulationCollideCapsuleCapsule {
          simulation_generation: (simulation, _), ..
        } => &simulation.system,
        _ => unreachable!("state id should be checked prior to this match")
      };
      if let Some (max_step) = DEBUG_MAX_STEP && system.step() >= max_step {
        if system.step() > max_step {
          log::warn!("system step ({}) > max_step ({})", system.step(), max_step);
        }
        testbed.as_mut().running = false;
      }
    };
    match testbed.state_id() {
      program::StateId::SimulationDropTest => {
        testbed.handle_event (program::EventParams::UpdateSimulationDropTest{}.into())
          .unwrap();

        // DEBUG: break main loop if max step is specified
        if cfg!(debug_assertions) {
          debug_break_max_step (&mut testbed);
        }
      }
      program::StateId::SimulationCollideCapsuleCapsule => {
        testbed.handle_event (
          program::EventParams::UpdateSimulationCollideCapsuleCapsule{}.into()
        ).unwrap();

        // DEBUG: break main loop if max step is specified
        if cfg!(debug_assertions) {
          debug_break_max_step (&mut testbed);
        }
      }
      program::StateId::SimulationStackTest => {
        testbed.handle_event (program::EventParams::UpdateSimulationStackTest{}.into())
          .unwrap();

        // DEBUG: break main loop if max step is specified
        if cfg!(debug_assertions) {
          debug_break_max_step (&mut testbed);
        }
      }
      program::StateId::SimulationBallPitTest => {
        testbed.handle_event (program::EventParams::UpdateSimulationBallPitTest{}.into())
          .unwrap();

        // DEBUG: break main loop if max step is specified
        if cfg!(debug_assertions) {
          debug_break_max_step (&mut testbed);
        }
      }
      program::StateId::SimulationHullPitTest => {
        testbed.handle_event (program::EventParams::UpdateSimulationHullPitTest{}.into())
          .unwrap();

        // DEBUG: break main loop if max step is specified
        if cfg!(debug_assertions) {
          debug_break_max_step (&mut testbed);
        }
      }
      _ => {}
    }

    // draw frame
    use glium::Surface;
    let mut glium_frame = testbed.as_mut().render_context.glium_display.draw();
    // clear frame
    glium_frame.clear_all (
      ( testbed.as_mut().render_context.clear_color[0],
        testbed.as_mut().render_context.clear_color[1],
        testbed.as_mut().render_context.clear_color[2],
        testbed.as_mut().render_context.clear_color[3]
      ),
      1.0, 0
    );

    // draw 3d
    match testbed.state_id() {
      program::StateId::PenetrationCapsuleCapsule => {
        let e = program::EventParams::DrawPenetrationCapsuleCapsule {
          glium_frame: &mut glium_frame
        }.into();
        testbed.handle_event (e).unwrap();
      }
      program::StateId::PenetrationCuboidCuboid => {
        let e = program::EventParams::DrawPenetrationCuboidCuboid {
          glium_frame: &mut glium_frame
        }.into();
        testbed.handle_event (e).unwrap();
      }
      program::StateId::PenetrationCapsuleCuboid => {
        let e = program::EventParams::DrawPenetrationCapsuleCuboid {
          glium_frame: &mut glium_frame
        }.into();
        testbed.handle_event (e).unwrap();
      }
      _ => render::Resource::draw_3d (&testbed.as_mut().render_context, &mut glium_frame)
    }

    // draw 2d
    render::Resource::draw_2d (&testbed.as_ref().render_context, &mut glium_frame);

    // swap buffers
    glium_frame.finish().unwrap();

    // fps
    let t = std::time::Instant::now();
    if (t - last_t).as_secs() >= 1 {
      //log::info!("fps: {}", fps);
      let render = &mut testbed.as_mut().render_context;
      let (_width, height) : (u32, u32) = render.window.inner_size().into();
      let [_tile_width, tile_height] = render.resource.tile_dimensions (
        render::resource::DefaultTilesetId::EasciiAcorn128);
      let tile_range = render.resource.draw2d
        .viewport_resources_get (render::resource::OVERLAY_VIEWPORT).unwrap()
        .draw_indices[0].draw_tiles.as_ref().unwrap().vertex_range.clone();
      let fps_row = ((height / tile_height) - 1) as i32;
      let tiles = tile::vertices (&format!("FPS: {fps:<6}"), (fps_row, 1));
      render.resource.draw2d.tile_2d_vertices
        .slice (tile_range.start as usize .. tile_range.end as usize).unwrap()
        .write (&tiles);
      last_t = t;
      fps = 0;
    } else {
      fps += 1;
    }

  } // end main loop

  println!("...linear-sim testbed");
}