vector-traits 0.6.2

Rust traits for 2D and 3D vector types.
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

// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2023, 2025 lacklustr@protonmail.com https://github.com/eadf

// This file is part of vector-traits.

use crate::prelude::*;
use approx::ulps_eq;

#[allow(dead_code)] // this code is used by all the x_impls
/// Helper method for `From<Aabb2>` -> `Vec<GenericVector2>` and `Aabb2::convex_hull()`
/// creates a connected LineString2 from the outlines of the Aabb2
pub(super) fn aabb_to_vec<T>(aabb: T) -> Vec<T::Vector>
where
    T: Aabb2,
    T::Vector: GenericVector2,
{
    if !aabb.is_empty() {
        let min = aabb.min();
        let max = aabb.max();
        vec![
            min,
            T::Vector::new_2d(max.x(), min.y()),
            max,
            T::Vector::new_2d(min.x(), max.y()),
            min,
        ]
    } else {
        Vec::default()
    }
}

#[allow(dead_code)] // this code is used by all the x_impls
/// Helper method for `PartialEq<Aabb2>`
pub(super) fn aabb2_partial_eq<T>(aabb1: &T, aabb2: &T) -> bool
where
    T: Aabb2,
    T::Vector: GenericVector2,
{
    match (aabb1.is_empty(), aabb2.is_empty()) {
        (false, false) => {
            let min1 = aabb1.min();
            let min2 = aabb2.min();
            let max1 = aabb1.max();
            let max2 = aabb2.max();

            ulps_eq!(min1.x(), min2.x())
                && ulps_eq!(min1.y(), min2.y())
                && ulps_eq!(max1.x(), max2.x())
                && ulps_eq!(max1.y(), max2.y())
        }
        (true, true) => true,
        _ => false,
    }
}

#[allow(dead_code)] // this code is used by all the x_impls
/// Helper method for `PartialEq<Aabb3>`
pub(super) fn aabb3_partial_eq<T>(aabb1: &T, aabb2: &T) -> bool
where
    T: Aabb3,
    T::Vector: GenericVector3,
{
    match (aabb1.is_empty(), aabb2.is_empty()) {
        (false, false) => {
            let min1 = aabb1.min();
            let min2 = aabb2.min();
            let max1 = aabb1.max();
            let max2 = aabb2.max();

            ulps_eq!(min1.x(), min2.x())
                && ulps_eq!(min1.y(), min2.y())
                && ulps_eq!(min1.z(), min2.z())
                && ulps_eq!(max1.x(), max2.x())
                && ulps_eq!(max1.y(), max2.y())
                && ulps_eq!(max1.z(), max2.z())
        }
        (true, true) => true,
        _ => false,
    }
}

#[allow(dead_code)] // this code is used by all the x_impls
pub(super) fn from_plane_to_xy<T: GenericVector3>(
    source_plane: Plane,
) -> <T as GenericVector3>::Affine {
    match source_plane {
        Plane::XY => {
            // Identity matrix
            <T as GenericVector3>::Affine::identity()
        }
        Plane::XZ => {
            // Maps X->X, Z->Y, Y->Z
            // This transforms the XZ plane to the XY plane
            <T as GenericVector3>::Affine::from_cols_array(&[
                T::Scalar::ONE,
                T::Scalar::ZERO,
                T::Scalar::ZERO,
                T::Scalar::ZERO, // First column
                T::Scalar::ZERO,
                T::Scalar::ZERO,
                T::Scalar::ONE,
                T::Scalar::ZERO, // Second column
                T::Scalar::ZERO,
                T::Scalar::ONE,
                T::Scalar::ZERO,
                T::Scalar::ZERO, // Third column
                T::Scalar::ZERO,
                T::Scalar::ZERO,
                T::Scalar::ZERO,
                T::Scalar::ONE, // Fourth column
            ])
        }
        Plane::YZ => {
            // Maps Z->X, Y->Y, X->Z
            // This transforms the YZ plane to the YX plane
            <T as GenericVector3>::Affine::from_cols_array(&[
                T::Scalar::ZERO,
                T::Scalar::ZERO,
                T::Scalar::ONE,
                T::Scalar::ZERO, // First column
                T::Scalar::ZERO,
                T::Scalar::ONE,
                T::Scalar::ZERO,
                T::Scalar::ZERO, // Second column
                T::Scalar::ONE,
                T::Scalar::ZERO,
                T::Scalar::ZERO,
                T::Scalar::ZERO, // Third column
                T::Scalar::ZERO,
                T::Scalar::ZERO,
                T::Scalar::ZERO,
                T::Scalar::ONE, // Fourth column
            ])
        }
    }
}

#[allow(dead_code)] // this code is used by all the x_impls
pub(super) fn from_translation<T: GenericVector3>(translation: T) -> T::Affine {
    <T as GenericVector3>::Affine::from_cols_array(&[
        T::Scalar::ONE,
        T::Scalar::ZERO,
        T::Scalar::ZERO,
        T::Scalar::ZERO, // First column
        T::Scalar::ZERO,
        T::Scalar::ZERO,
        T::Scalar::ONE,
        T::Scalar::ZERO, // Second column
        T::Scalar::ZERO,
        T::Scalar::ONE,
        T::Scalar::ZERO,
        T::Scalar::ZERO, // Third column
        translation.x(),
        translation.y(),
        translation.z(),
        T::Scalar::ONE, // Fourth column
    ])
}