linear-sim 0.8.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

//! Simulation events

use enumflags2;
use derive_more::From;
#[cfg(feature = "derive_serdes")]
use serde::{Deserialize, Serialize};
use strum::Display;

use crate::{collision, component, force, math, object};

/// An input event
#[derive(Debug, PartialEq, Display, From)]
pub enum Input {
  Step,
  CreateObject  (object::Variant, Option <object::Key>),
  ModifyObject  (ObjectModify),
  DestroyObject (object::Id),
  SetGravity    (force::Gravity),
  ClearGravity
}

/// An object modification event
#[derive(Debug, PartialEq, From)]
pub enum ObjectModify {
  Dynamic (object::Key, ObjectModifyDynamic),
  Static  (object::Key, ObjectModifyStatic)
}

#[derive(Debug, PartialEq)]
pub enum ObjectModifyDynamic {
  ApplyImpulse   (math::Vector3 <f64>),
  SetForceFlags  (enumflags2::BitFlags <force::Flag>),
  SetDrag        (f64),
  SetPosition    (component::Position)
}
#[derive(Debug, PartialEq)]
pub enum ObjectModifyStatic {
  Move (math::Vector3 <f64>)
}

/// An event that results from handling an input
#[derive(Debug, PartialEq, Display, From)]
pub enum Output {
  CollisionResolve   (CollisionResolve),
  CreateObjectResult (CreateObjectResult),
  Contact            (Contact),
  Overlap            (Overlap)
}

/// A TOI collision
#[cfg_attr(feature = "derive_serdes", derive(Deserialize, Serialize))]
#[derive(Clone, Debug, PartialEq)]
pub struct CollisionResolve {
  pub toi               : math::Normalized <f64>,
  pub object_id_a       : object::Id,
  pub object_id_b       : object::Id,
  pub contact           : collision::contact::Colliding,
  pub impulse_normal_a  : math::Vector3 <f64>,
  pub impulse_normal_b  : math::Vector3 <f64>,
  pub impulse_tangent_a : math::Vector3 <f64>,
  pub impulse_tangent_b : math::Vector3 <f64>,
  pub pseudo_impulse_a  : math::Vector3 <f64>,
  pub pseudo_impulse_b  : math::Vector3 <f64>
}

/// A no-collide intersection
#[cfg_attr(feature = "derive_serdes", derive(Deserialize, Serialize))]
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Overlap {
  pub object_id_a : object::Id,
  pub object_id_b : object::Id
}

/// A persistent contact
#[cfg_attr(feature = "derive_serdes", derive(Deserialize, Serialize))]
#[derive(Clone, Debug, PartialEq)]
pub struct Contact {
  pub object_id_a : object::Id,
  pub object_id_b : object::Id,
  pub contact     : collision::Contact
}

/// Events resulting from object creation
#[derive(Debug, PartialEq)]
pub enum CreateObjectResult {
  /// Success
  Created      (object::Id),
  /// Creating the object failed with an intersection.
  ///
  /// If intersections were found then the object was not successfully created.
  Intersection (Vec <(object::Id, collision::Intersection)>)
}