vec3 0.2.1

vec3
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

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

use num_traits::{One, Zero};

/// # Example
/// ```
/// let mut v = vec3::new_zero();
/// vec3::transform_mat2(&mut v, &vec3::new_one(), &[1_f32, 0_f32, 0_f32, 1_f32]);
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat2<'out, T>(out: &'out mut [T; 3], v: &[T; 3], m: &[T; 4]) -> &'out mut [T; 3]
where
    T: Clone + Add<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    out[0] = &v[0] * &m[0] + &v[1] * &m[2];
    out[1] = &v[0] * &m[1] + &v[1] * &m[3];
    out[2] = v[2].clone();
    out
}
/// # Example
/// ```
/// let mut v = vec3::new_one();
/// vec3::transform_mat2_mut(&mut v, &[1_f32, 0_f32, 0_f32, 1_f32]);
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat2_mut<'out, T>(out: &'out mut [T; 3], m: &[T; 4]) -> &'out mut [T; 3]
where
    T: Clone + Add<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    let tmp = out.clone();
    transform_mat2(out, &tmp, m)
}
/// # Example
/// ```
/// let mut v = vec3::new_zero();
/// vec3::transform_mat3(&mut v, &vec3::new_one(),
///     &[1_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 1_f32],
/// );
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat3<'out, T>(out: &'out mut [T; 3], v: &[T; 3], m: &[T; 9]) -> &'out mut [T; 3]
where
    T: Add<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    out[0] = &v[0] * &m[0] + &v[1] * &m[3] + &v[2] * &m[6];
    out[1] = &v[0] * &m[1] + &v[1] * &m[4] + &v[2] * &m[7];
    out[2] = &v[0] * &m[2] + &v[1] * &m[5] + &v[2] * &m[8];
    out
}
/// # Example
/// ```
/// let mut v = vec3::new_one();
/// vec3::transform_mat3_mut(&mut v,
///     &[1_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 1_f32],
/// );
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat3_mut<'out, T>(out: &'out mut [T; 3], m: &[T; 9]) -> &'out mut [T; 3]
where
    T: Clone + Add<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    let tmp = out.clone();
    transform_mat3(out, &tmp, m)
}
/// # Example
/// ```
/// let mut v = vec3::new_zero();
/// vec3::transform_mat4(&mut v, &vec3::new_one(),
///     &[1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32]
/// );
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat4<'out, T>(out: &'out mut [T; 3], v: &[T; 3], m: &[T; 16]) -> &'out mut [T; 3]
where
    T: Clone + Add<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    out[0] = &v[0] * &m[0] + &v[1] * &m[4] + &v[2] * &m[8] + m[12].clone();
    out[1] = &v[0] * &m[1] + &v[1] * &m[5] + &v[2] * &m[9] + m[13].clone();
    out[2] = &v[0] * &m[2] + &v[1] * &m[6] + &v[2] * &m[10] + m[14].clone();
    out
}
/// # Example
/// ```
/// let mut v = vec3::new_one();
/// vec3::transform_mat4_mut(&mut v,
///     &[1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32]
/// );
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat4_mut<'out, T>(out: &'out mut [T; 3], m: &[T; 16]) -> &'out mut [T; 3]
where
    T: Clone + Add<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    let tmp = out.clone();
    transform_mat4(out, &tmp, m)
}
/// # Example
/// ```
/// let mut v = vec3::new_zero();
/// vec3::transform_mat4_rotation(&mut v, &vec3::new_one(),
///     &[1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32]
/// );
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat4_rotation<'out, T>(
    out: &'out mut [T; 3],
    v: &[T; 3],
    m: &[T; 16],
) -> &'out mut [T; 3]
where
    T: Clone + Add<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    out[0] = &v[0] * &m[0] + &v[1] * &m[4] + &v[2] * &m[8];
    out[1] = &v[0] * &m[1] + &v[1] * &m[5] + &v[2] * &m[9];
    out[2] = &v[0] * &m[2] + &v[1] * &m[6] + &v[2] * &m[10];
    out
}
/// # Example
/// ```
/// let mut v = vec3::new_one();
/// vec3::transform_mat4_rotation_mut(&mut v,
///     &[1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32]
/// );
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat4_rotation_mut<'out, T>(out: &'out mut [T; 3], m: &[T; 16]) -> &'out mut [T; 3]
where
    T: Clone + Add<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    let tmp = out.clone();
    transform_mat4(out, &tmp, m)
}
/// # Example
/// ```
/// let mut v = vec3::new_zero();
/// vec3::transform_mat4_projection(&mut v, &vec3::new_one(),
///     &[1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32]
/// );
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat4_projection<'out, T>(
    out: &'out mut [T; 3],
    v: &[T; 3],
    m: &[T; 16],
) -> &'out mut [T; 3]
where
    T: Clone + One + Zero + Add<T, Output = T>,
    for<'a, 'b> &'a T: Div<&'b T, Output = T> + Mul<&'b T, Output = T>,
{
    let d = &v[0] * &m[3] + &v[1] * &m[7] + &v[2] * &m[11] + m[15].clone();
    let inv_d = if d.is_zero() { d } else { &T::one() / &d };

    out[0] = &(&v[0] * &m[0] + &v[1] * &m[4] + &v[2] * &m[8] + m[12].clone()) * &inv_d;
    out[1] = &(&v[0] * &m[1] + &v[1] * &m[5] + &v[2] * &m[9] + m[13].clone()) * &inv_d;
    out[2] = &(&v[0] * &m[2] + &v[1] * &m[6] + &v[2] * &m[10] + m[14].clone()) * &inv_d;
    out
}
/// # Example
/// ```
/// let mut v = vec3::new_one();
/// vec3::transform_mat4_projection_mut(&mut v,
///     &[1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32, 0_f32, 0_f32, 0_f32, 0_f32, 1_f32]
/// );
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_mat4_projection_mut<'out, T>(
    out: &'out mut [T; 3],
    m: &[T; 16],
) -> &'out mut [T; 3]
where
    T: Clone + One + Zero + Add<T, Output = T>,
    for<'a, 'b> &'a T: Div<&'b T, Output = T> + Mul<&'b T, Output = T>,
{
    let tmp = out.clone();
    transform_mat4_projection(out, &tmp, m)
}
/// # Example
/// ```
/// let mut v = vec3::new_zero();
/// vec3::transform_quat(&mut v, &vec3::new_one(), &[0_f32, 0_f32, 0_f32, 1_f32]);
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_quat<'out, T>(out: &'out mut [T; 3], v: &[T; 3], q: &[T; 4]) -> &'out mut [T; 3]
where
    T: Add<T, Output = T> + Sub<T, Output = T>,
    for<'a, 'b> &'a T: Neg<Output = T> + Mul<&'b T, Output = T>,
{
    let ix = &q[3] * &v[0] + &q[1] * &v[2] - &q[2] * &v[1];
    let iy = &q[3] * &v[1] + &q[2] * &v[0] - &q[0] * &v[2];
    let iz = &q[3] * &v[2] + &q[0] * &v[1] - &q[1] * &v[0];
    let iw = &-&q[0] * &v[0] - &q[1] * &v[1] - &q[2] * &v[2];

    out[0] = &ix * &q[3] + &iw * &-&q[0] + &iy * &-&q[2] - &iz * &-&q[1];
    out[1] = &iy * &q[3] + &iw * &-&q[1] + &iz * &-&q[0] - &ix * &-&q[2];
    out[2] = &iz * &q[3] + &iw * &-&q[2] + &ix * &-&q[1] - &iy * &-&q[0];
    out
}
/// # Example
/// ```
/// let mut v = vec3::new_one();
/// vec3::transform_quat_mut(&mut v, &[0_f32, 0_f32, 0_f32, 1_f32]);
/// assert_eq!(v, vec3::new_one());
/// ```
#[inline]
pub fn transform_quat_mut<'out, T>(out: &'out mut [T; 3], q: &[T; 4]) -> &'out mut [T; 3]
where
    T: Clone + Add<T, Output = T> + Sub<T, Output = T>,
    for<'a, 'b> &'a T: Neg<Output = T> + Mul<&'b T, Output = T>,
{
    let tmp = out.clone();
    transform_quat(out, &tmp, q)
}