Vector conversion functions between 2D and 3D

Author: Bromeon

godot-core/src/builtin/vectors/vector2.rs

@@ -11,7 +11,7 @@ use sys::{ffi_methods, GodotFfi};
 
 use crate::builtin::math::{FloatExt, GlamConv, GlamType};
 use crate::builtin::vectors::Vector2Axis;
-use crate::builtin::{inner, real, RAffine2, RVec2, Vector2i};
+use crate::builtin::{inner, real, RAffine2, RVec2, Vector2i, Vector3};
 
 use std::fmt;
 
@@ -165,7 +165,7 @@ impl Vector2 {
 }
 
 impl_float_vector_fns!(Vector2, (x, y));
-impl_vector2x_fns!(Vector2, real);
+impl_vector2x_fns!(Vector2, Vector3, real);
 impl_vector2_vector3_fns!(Vector2, (x, y));
 
 impl_vector_operators!(Vector2, real, (x, y));

godot-core/src/builtin/vectors/vector2i.rs

@@ -10,7 +10,7 @@ use std::cmp::Ordering;
 use sys::{ffi_methods, GodotFfi};
 
 use crate::builtin::math::{GlamConv, GlamType};
-use crate::builtin::{inner, real, RVec2, Vector2, Vector2Axis};
+use crate::builtin::{inner, real, RVec2, Vector2, Vector2Axis, Vector3i};
 
 use std::fmt;
 
@@ -91,7 +91,7 @@ impl Vector2i {
 }
 
 impl_vector_fns!(Vector2i, glam::IVec2, i32, (x, y));
-impl_vector2x_fns!(Vector2i, i32);
+impl_vector2x_fns!(Vector2i, Vector3i, i32);
 
 impl_vector_operators!(Vector2i, i32, (x, y));
 

godot-core/src/builtin/vectors/vector3.rs

@@ -232,7 +232,7 @@ impl Vector3 {
 }
 
 impl_float_vector_fns!(Vector3, (x, y, z));
-impl_vector3x_fns!(Vector3, real);
+impl_vector3x_fns!(Vector3, Vector2, real);
 impl_vector2_vector3_fns!(Vector3, (x, y, z));
 impl_vector3_vector4_fns!(Vector3, (x, y, z));
 

godot-core/src/builtin/vectors/vector3i.rs

@@ -12,7 +12,7 @@ use godot_ffi as sys;
 use sys::{ffi_methods, GodotFfi};
 
 use crate::builtin::math::{GlamConv, GlamType};
-use crate::builtin::{inner, real, RVec3, Vector3, Vector3Axis};
+use crate::builtin::{inner, real, RVec3, Vector2i, Vector3, Vector3Axis};
 
 /// Vector used for 3D math using integer coordinates.
 ///
@@ -96,7 +96,7 @@ impl Vector3i {
     }
 }
 
-impl_vector3x_fns!(Vector3i, i32);
+impl_vector3x_fns!(Vector3i, Vector2i, i32);
 
 impl_vector_operators!(Vector3i, i32, (x, y, z));
 

godot-core/src/builtin/vectors/vector_macros.rs

@@ -766,12 +766,20 @@ macro_rules! impl_vector2x_fns {
     (
         // Name of the vector type.
         $Vector:ty,
+        // Name of the 3D-equivalent vector type.
+        $Vector3D:ty,
         // Type of target component, for example `real`.
         $Scalar:ty
     ) => {
         /// # 2D functions
         /// The following methods are only available on 2D vectors (for both float and int).
         impl $Vector {
+            /// Increases dimension to 3D, accepting a new value for the Z component.
+            #[inline]
+            pub fn to_3d(self, z: $Scalar) -> $Vector3D {
+                <$Vector3D>::new(self.x, self.y, z)
+            }
+
             /// Returns the aspect ratio of this vector, the ratio of [`Self::x`] to [`Self::y`].
             #[inline]
             pub fn aspect(self) -> real {
@@ -820,12 +828,23 @@ macro_rules! impl_vector3x_fns {
     (
         // Name of the vector type.
         $Vector:ty,
+        // Name of the vector type.
+        $Vector2D:ty,
         // Type of target component, for example `real`.
         $Scalar:ty
     ) => {
         /// # 3D functions
         /// The following methods are only available on 3D vectors (for both float and int).
         impl $Vector {
+            /// Reduces dimension to 2D, discarding the Z component.
+            ///
+            /// See also [`swizzle!`][crate::builtin::swizzle] for a more general way to extract components.
+            /// `self.to_2d()` is equivalent to `swizzle!(self => x, y)`.
+            #[inline]
+            pub fn to_2d(self) -> $Vector2D {
+                <$Vector2D>::new(self.x, self.y)
+            }
+
             /// Returns the axis of the vector's highest value. See [`Vector3Axis`] enum. If all components are equal, this method returns [`None`].
             ///
             /// To mimic Godot's behavior, unwrap this function's result with `unwrap_or(Vector3Axis::X)`.