dacho 0.2.0

ECS Game Engine
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

// dacho/src/prelude/types.rs

// core
use core::ops::{Add, Mul, Neg, Sub};

// crates
use glam::f32::{Vec2, Vec3};

#[allow(clippy::exhaustive_structs)]
#[derive(Copy, Clone, PartialEq)]
pub struct V2 {
    pub x: f32,
    pub y: f32
}

impl V2 {
    pub const ZERO: Self = Self { x: 0.0, y: 0.0 };
    pub const ONE:  Self = Self { x: 1.0, y: 1.0 };

    pub const X:    Self = Self { x: 1.0, y: 0.0 };
    pub const Y:    Self = Self { x: 0.0, y: 1.0 };

    #[inline]
    #[must_use]
    pub const fn new(x: f32, y: f32) -> Self {
        Self { x, y }
    }

    #[inline]
    #[must_use]
    pub const fn extend(&self) -> V3 {
        V3 { x: self.x, y: self.y, z: 0.0 }
    }

    #[must_use]
    pub fn normalize(&self) -> Self {
        let n = Vec2 { x: self.x, y: self.y }.normalize();

        Self { x: n.x, y: n.y }
    }

    #[inline]
    #[must_use]
    pub fn normalise(&self) -> Self {
        self.normalize()
    }

    #[inline]
    #[must_use]
    pub fn reverse_y(&self) -> Self {
        Self { x: self.x, y: -self.y }
    }

    #[inline]
    #[must_use]
    pub const fn to_array(&self) -> [f32; 2] {
        [self.x, self.y]
    }

    #[inline]
    #[must_use]
    pub const fn to_glam(&self) -> Vec2 {
        Vec2 { x: self.x, y: self.y }
    }

    #[inline]
    #[must_use]
    pub fn is_zero(&self) -> bool {
        *self == Self::ZERO
    }
}

impl Mul<f32> for V2 {
    type Output = Self;

    #[inline]
    #[must_use]
    fn mul(self, rhs: f32) -> Self::Output {
        Self { x: self.x * rhs, y: self.y * rhs }
    }
}

#[allow(clippy::exhaustive_structs)]
#[derive(Copy, Clone, PartialEq)]
pub struct V3 {
    pub x: f32,
    pub y: f32,
    pub z: f32
}

impl V3 {
    pub const ZERO: Self = Self { x: 0.0, y: 0.0, z: 0.0 };
    pub const ONE:  Self = Self { x: 1.0, y: 1.0, z: 1.0 };

    pub const X:    Self = Self { x: 1.0, y: 0.0, z: 0.0 };
    pub const Y:    Self = Self { x: 0.0, y: 1.0, z: 0.0 };
    pub const Z:    Self = Self { x: 0.0, y: 0.0, z: 1.0 };

    pub const XY:   Self = Self { x: 1.0, y: 1.0, z: 0.0 };
    pub const XZ:   Self = Self { x: 1.0, y: 0.0, z: 1.0 };
    pub const YZ:   Self = Self { x: 0.0, y: 1.0, z: 1.0 };

    #[must_use]
    pub const fn new(x: f32, y: f32, z: f32) -> Self {
        Self { x, y, z }
    }

    #[must_use]
    pub fn normalize(&self) -> Self {
        let n = Vec3 { x: self.x, y: self.y, z: self.z }.normalize();

        Self { x: n.x, y: n.y, z: n.z }
    }

    #[inline]
    #[must_use]
    pub fn normalise(&self) -> Self {
        self.normalize()
    }

    #[inline]
    #[must_use]
    pub fn reverse_y(&self) -> Self {
        Self { x: self.x, y: -self.y, z: self.z }
    }

    #[inline]
    #[must_use]
    pub const fn from_tuple(tuple: (f32, f32, f32)) -> Self {
        Self { x: tuple.0, y: tuple.1, z: tuple.2 }
    }

    #[inline]
    #[must_use]
    pub const fn to_array(&self) -> [f32; 3] {
        [self.x, self.y, self.z]
    }

    #[inline]
    #[must_use]
    pub const fn to_glam(&self) -> Vec3 {
        Vec3 { x: self.x, y: self.y, z: self.z }
    }

    #[inline]
    #[must_use]
    pub fn is_zero(&self) -> bool {
        *self == Self::ZERO
    }
}

impl Add for V3 {
    type Output = Self;

    #[inline]
    #[must_use]
    fn add(self, rhs: Self) -> Self::Output {
        Self { x: self.x + rhs.x, y: self.y + rhs.y, z: self.z + rhs.z }
    }
}

impl Sub for V3 {
    type Output = Self;

    #[inline]
    #[must_use]
    fn sub(self, rhs: Self) -> Self::Output {
        Self { x: self.x - rhs.x, y: self.y - rhs.y, z: self.z - rhs.z }
    }
}

impl Mul<f32> for V3 {
    type Output = Self;

    #[inline]
    #[must_use]
    fn mul(self, rhs: f32) -> Self::Output {
        Self { x: self.x * rhs, y: self.y * rhs, z: self.z * rhs }
    }
}

impl Mul<i16> for V3 {
    type Output = Self;

    #[inline]
    #[must_use]
    fn mul(self, rhs: i16) -> Self::Output {
        Self { x: self.x * f32::from(rhs), y: self.y * f32::from(rhs), z: self.z * f32::from(rhs) }
    }
}

impl Neg for V3 {
    type Output = Self;

    fn neg(self) -> Self::Output {
        Self { x: -self.x, y: -self.y, z: -self.z }
    }
}