waymark 0.1.0

Pathfinding and spatial queries on navigation meshes
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

//! Mathematical utilities for Detour navigation mesh operations
//!
//!
//! These are simple wrappers around standard math functions for consistency
//! with the C++ API naming conventions.

/// Returns the absolute value of a floating point number
#[inline]
pub fn dt_math_fabsf(x: f32) -> f32 {
    x.abs()
}

/// Returns the square root of a floating point number
#[inline]
pub fn dt_math_sqrtf(x: f32) -> f32 {
    x.sqrt()
}

/// Returns the largest integer less than or equal to a floating point number
#[inline]
pub fn dt_math_floorf(x: f32) -> f32 {
    x.floor()
}

/// Returns the smallest integer greater than or equal to a floating point number
#[inline]
pub fn dt_math_ceilf(x: f32) -> f32 {
    x.ceil()
}

/// Returns the cosine of an angle in radians
#[inline]
pub fn dt_math_cosf(x: f32) -> f32 {
    x.cos()
}

/// Returns the sine of an angle in radians
#[inline]
pub fn dt_math_sinf(x: f32) -> f32 {
    x.sin()
}

/// Returns the arctangent of y/x in radians
#[inline]
pub fn dt_math_atan2f(y: f32, x: f32) -> f32 {
    y.atan2(x)
}

/// Checks if a floating point value is finite (not NaN or infinity)
#[inline]
pub fn dt_math_isfinite(x: f32) -> bool {
    x.is_finite()
}

/// Additional math utilities not in original DetourMath.h but useful
/// Returns the minimum of two f32 values
#[inline]
pub fn dt_math_minf(a: f32, b: f32) -> f32 {
    a.min(b)
}

/// Returns the maximum of two f32 values
#[inline]
pub fn dt_math_maxf(a: f32, b: f32) -> f32 {
    a.max(b)
}

/// Clamps a f32 value between min and max
#[inline]
pub fn dt_math_clampf(x: f32, min: f32, max: f32) -> f32 {
    x.clamp(min, max)
}

/// Linear interpolation between two f32 values
#[inline]
pub fn dt_math_lerpf(a: f32, b: f32, t: f32) -> f32 {
    a + (b - a) * t
}

/// Returns the fractional part of a floating point number
#[inline]
pub fn dt_math_fractf(x: f32) -> f32 {
    x.fract()
}

/// Converts degrees to radians
#[inline]
pub fn dt_math_deg_to_rad(deg: f32) -> f32 {
    deg.to_radians()
}

/// Converts radians to degrees
#[inline]
pub fn dt_math_rad_to_deg(rad: f32) -> f32 {
    rad.to_degrees()
}

/// Returns the sign of a floating point number (-1.0, 0.0, or 1.0)
#[inline]
pub fn dt_math_signf(x: f32) -> f32 {
    if x > 0.0 {
        1.0
    } else if x < 0.0 {
        -1.0
    } else {
        0.0
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_basic_math() {
        assert_eq!(dt_math_fabsf(-5.0), 5.0);
        assert_eq!(dt_math_fabsf(5.0), 5.0);

        assert_eq!(dt_math_sqrtf(4.0), 2.0);
        assert_eq!(dt_math_sqrtf(9.0), 3.0);

        assert_eq!(dt_math_floorf(3.7), 3.0);
        assert_eq!(dt_math_floorf(-3.7), -4.0);

        assert_eq!(dt_math_ceilf(3.3), 4.0);
        assert_eq!(dt_math_ceilf(-3.3), -3.0);
    }

    #[test]
    fn test_trig() {
        let pi = std::f32::consts::PI;

        assert!((dt_math_cosf(0.0) - 1.0).abs() < 0.0001);
        assert!((dt_math_sinf(0.0) - 0.0).abs() < 0.0001);

        assert!((dt_math_cosf(pi / 2.0) - 0.0).abs() < 0.0001);
        assert!((dt_math_sinf(pi / 2.0) - 1.0).abs() < 0.0001);

        assert_eq!(dt_math_atan2f(0.0, 1.0), 0.0);
        assert!((dt_math_atan2f(1.0, 0.0) - pi / 2.0).abs() < 0.0001);
    }

    #[test]
    fn test_finite() {
        assert!(dt_math_isfinite(0.0));
        assert!(dt_math_isfinite(1.0));
        assert!(dt_math_isfinite(-1.0));
        assert!(!dt_math_isfinite(f32::INFINITY));
        assert!(!dt_math_isfinite(f32::NEG_INFINITY));
        assert!(!dt_math_isfinite(f32::NAN));
    }

    #[test]
    fn test_additional_utils() {
        assert_eq!(dt_math_minf(3.0, 5.0), 3.0);
        assert_eq!(dt_math_maxf(3.0, 5.0), 5.0);

        assert_eq!(dt_math_clampf(5.0, 0.0, 10.0), 5.0);
        assert_eq!(dt_math_clampf(-5.0, 0.0, 10.0), 0.0);
        assert_eq!(dt_math_clampf(15.0, 0.0, 10.0), 10.0);

        assert_eq!(dt_math_lerpf(0.0, 10.0, 0.5), 5.0);
        assert_eq!(dt_math_lerpf(0.0, 10.0, 0.0), 0.0);
        assert_eq!(dt_math_lerpf(0.0, 10.0, 1.0), 10.0);

        assert!((dt_math_fractf(3.7) - 0.7).abs() < 0.0001);
        // Note: Rust's fract() preserves the sign, so -3.7.fract() = -0.7
        assert!((dt_math_fractf(-3.7) - (-0.7)).abs() < 0.0001);

        assert_eq!(dt_math_signf(5.0), 1.0);
        assert_eq!(dt_math_signf(-5.0), -1.0);
        assert_eq!(dt_math_signf(0.0), 0.0);
    }

    #[test]
    fn test_angle_conversion() {
        let pi = std::f32::consts::PI;

        assert!((dt_math_deg_to_rad(180.0) - pi).abs() < 0.0001);
        assert!((dt_math_deg_to_rad(90.0) - pi / 2.0).abs() < 0.0001);

        assert!((dt_math_rad_to_deg(pi) - 180.0).abs() < 0.0001);
        assert!((dt_math_rad_to_deg(pi / 2.0) - 90.0).abs() < 0.0001);
    }
}