vectorama 0.1.1

Very simple linear algebra library for 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
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

use std::ops::{AddAssign, Deref, DerefMut, Mul, SubAssign};

use crate::{
    matrix::Matrix,
    translation::{from_homogeneous_matrix, to_homogeneous_matrix},
    vector::{Vector, vec2::Vec2},
};

/// A 2D translation represented by a vector.
///
/// `Translation2` encodes a translation in 2D space using a `Vec2`. It provides convenient methods
/// for constructing, combining, and applying translations, as well as conversion to and from
/// homogeneous transformation matrices.
///
/// # Example
/// ```
/// use vectorama::Translation2;
/// let t = Translation2::new(1.0, 2.0);
/// ```
#[derive(Default, Debug, Clone, Copy)]
pub struct Translation2 {
    vector: Vec2,
}

impl Translation2 {
    /// Creates a new translation from x, y components.
    ///
    /// # Parameters
    /// - `x`: Translation along the X axis.
    /// - `y`: Translation along the Y axis.
    ///
    /// # Returns
    /// A new `Translation2` representing the given translation.
    pub fn new(x: f32, y: f32) -> Self {
        Translation2 {
            vector: Vec2::new(x, y),
        }
    }

    /// Returns the 3x3 homogeneous transformation matrix for this translation.
    ///
    /// # Returns
    /// A 3x3 matrix representing the translation in homogeneous coordinates.
    pub fn homogeneous_matrix(&self) -> Matrix<3, 3> {
        to_homogeneous_matrix(self.vector)
    }

    /// Applies this translation to a vector.
    ///
    /// # Parameters
    /// - `vector`: The vector to translate.
    ///
    /// # Returns
    /// The translated vector.
    pub fn translate(&self, vector: &Vec2) -> Vec2 {
        vector + self.vector
    }
}

// From -------------------------------------------------------------------------------------------
impl From<Vec2> for Translation2 {
    fn from(vector: Vec2) -> Self {
        Translation2 { vector }
    }
}

impl From<Translation2> for Vec2 {
    fn from(translation: Translation2) -> Self {
        translation.vector
    }
}

impl From<[f32; 2]> for Translation2 {
    fn from(array: [f32; 2]) -> Self {
        Translation2::from(Vec2::from(array))
    }
}

impl From<Vector<2>> for Translation2 {
    fn from(vector: Vector<2>) -> Self {
        Translation2::from(Vec2::from(vector))
    }
}

impl From<&Matrix<3, 3>> for Translation2 {
    fn from(matrix: &Matrix<3, 3>) -> Self {
        from_homogeneous_matrix(matrix).into()
    }
}

impl From<Matrix<3, 3>> for Translation2 {
    fn from(matrix: Matrix<3, 3>) -> Self {
        Translation2::from(&matrix)
    }
}
// From -------------------------------------------------------------------------------------------

// Deref and DerefMut -----------------------------------------------------------------------------
impl Deref for Translation2 {
    type Target = Vec2;

    fn deref(&self) -> &Self::Target {
        &self.vector
    }
}

impl DerefMut for Translation2 {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.vector
    }
}
// Deref and DerefMut -----------------------------------------------------------------------------

// Mul Vector -------------------------------------------------------------------------------------
impl Mul<&Vec2> for &Translation2 {
    type Output = Vec2;

    fn mul(self, vector: &Vec2) -> Self::Output {
        self.translate(vector)
    }
}

#[allow(clippy::op_ref)]
impl Mul<Vec2> for &Translation2 {
    type Output = Vec2;

    fn mul(self, vector: Vec2) -> Self::Output {
        self * &vector
    }
}

#[allow(clippy::op_ref)]
impl Mul<&Vec2> for Translation2 {
    type Output = Vec2;
    fn mul(self, vector: &Vec2) -> Self::Output {
        &self * vector
    }
}

impl Mul<Vec2> for Translation2 {
    type Output = Vec2;

    fn mul(self, vector: Vec2) -> Self::Output {
        &self * &vector
    }
}
// Mul Vector -------------------------------------------------------------------------------------

// AddAssign Vector -------------------------------------------------------------------------------
impl AddAssign<&Vec2> for Translation2 {
    fn add_assign(&mut self, rhs: &Vec2) {
        self.vector += rhs;
    }
}
impl AddAssign<Vec2> for Translation2 {
    fn add_assign(&mut self, rhs: Vec2) {
        *self += &rhs;
    }
}
// AddAssign Vector -------------------------------------------------------------------------------

// SubAssign Vector -------------------------------------------------------------------------------
impl SubAssign<&Vec2> for Translation2 {
    fn sub_assign(&mut self, rhs: &Vec2) {
        self.vector -= rhs;
    }
}
impl SubAssign<Vec2> for Translation2 {
    fn sub_assign(&mut self, rhs: Vec2) {
        *self -= &rhs;
    }
}
// SubAssign Vector -------------------------------------------------------------------------------