openphys 0.1.3

OpenPhys is a simple physics engine library written in 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

#[derive(Debug, Clone)]
pub struct Object {
    /// The object's mass in kilograms (kg).
    pub mass: f64,
    /// The object's temperature in kelvin (K).
    pub temperature: f64,
    /// Specifies if the object's temperature is in Celsius or not (˚C).
    pub is_celsius: bool,
    /// The object's specific heat capacity in [joule per kilogram kelvin](https://metricsystem.net/derived-units/units-whose-names-include-special-names/joule-per-kilogram-kelvin/) (J/kg K).
    pub specific_heat_capacity: f64,
    /// The object's density in grams per milliliter (g/ml).
    pub density: f64,
    /// The object's kinetic energy in joules (J).
    pub kinetic_energy: f64,
    /// The object's velocity in a three-dimensional in meter per second (m/s).
    pub velocity: [f64; 3],
    /// The object's acceleration in a three-dimensional space in meter per second (m/s).
    pub acceleration: [f64; 3],
    /// The position of the object's center in a three-dimensional space (x, y, z).
    pub position: [f64; 3],
}

/// You can create a new object inside a variable.
///
/// # Examples
/// ```
/// use openphys::utils::object::Object;
///
/// let obj1 = Object {
///     mass: 14.4,
///     ..Object::default()
/// };
/// ```
impl Object {
    /// You can create a new empty object using the `Object::new()` function.
    ///
    /// # Examples
    /// ```
    /// use openphys::utils::object::Object;
    ///
    /// let obj1 = Object::new();
    /// ```
    pub fn new() -> Self {
        Self {
            mass: 0.0,
            temperature: 0.0,
            is_celsius: false,
            specific_heat_capacity: 0.0,
            density: 0.0,
            kinetic_energy: 0.0,
            velocity: [0.0, 0.0, 0.0],
            acceleration: [0.0, 0.0, 0.0],
            position: [0.0, 0.0, 0.0],
        }
    }

    /// You can create an object with some reasonable defaults with the `Object::default()`
    /// function.
    ///
    /// # Examples
    /// ```
    /// use openphys::utils::object::Object;
    ///
    /// let obj1 = Object::default();
    /// ```
    /// Also, you can create an object with some changed values and some default values, like this:
    /// ```
    /// use openphys::utils::object::Object;
    ///
    /// let obj1 = Object {
    ///     mass: 1.0,
    ///     temperature: 20.0,
    ///     is_celsius: true,
    ///     ..Object::default()
    /// };
    /// ```
    pub fn default() -> Self {
        Self {
            mass: 1.0,
            temperature: 293.15,
            is_celsius: false,
            specific_heat_capacity: 4186.0,
            density: 1.0,
            kinetic_energy: 0.0,
            velocity: [0.0, 0.0, 0.0],
            acceleration: [0.0, 0.0, 0.0],
            position: [0.0, 0.0, 0.0],
        }
    }
}