Struct euclid::TypedVector2D
source · #[repr(C)]pub struct TypedVector2D<T, U> {
pub x: T,
pub y: T,
/* private fields */
}
Expand description
A 2d Vector tagged with a unit.
Fields
x: T
y: T
Implementations
sourceimpl<T: Copy + Zero, U> TypedVector2D<T, U>
impl<T: Copy + Zero, U> TypedVector2D<T, U>
sourcepub fn to_3d(&self) -> TypedVector3D<T, U>
pub fn to_3d(&self) -> TypedVector3D<T, U>
Convert into a 3d vector.
sourceimpl<T, U> TypedVector2D<T, U>
impl<T, U> TypedVector2D<T, U>
sourceimpl<T: Copy, U> TypedVector2D<T, U>
impl<T: Copy, U> TypedVector2D<T, U>
sourcepub fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> Self
pub fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> Self
Constructor taking properly typed Lengths instead of scalar values.
sourcepub fn extend(&self, z: T) -> TypedVector3D<T, U>
pub fn extend(&self, z: T) -> TypedVector3D<T, U>
Create a 3d vector from this one, using the specified z value.
sourcepub fn to_point(&self) -> TypedPoint2D<T, U>
pub fn to_point(&self) -> TypedPoint2D<T, U>
Cast this vector into a point.
Equivalent to adding this vector to the origin.
sourcepub fn to_size(&self) -> TypedSize2D<T, U>
pub fn to_size(&self) -> TypedSize2D<T, U>
Cast this vector into a size.
sourcepub fn to_untyped(&self) -> Vector2D<T>
pub fn to_untyped(&self) -> Vector2D<T>
Drop the units, preserving only the numeric value.
sourcepub fn from_untyped(p: &Vector2D<T>) -> Self
pub fn from_untyped(p: &Vector2D<T>) -> Self
Tag a unit-less value with units.
pub fn to_array(&self) -> [T; 2]
sourceimpl<T, U> TypedVector2D<T, U>where
T: Trig + Copy + Sub<T, Output = T>,
impl<T, U> TypedVector2D<T, U>where
T: Trig + Copy + Sub<T, Output = T>,
sourcepub fn angle_from_x_axis(&self) -> Angle<T>
pub fn angle_from_x_axis(&self) -> Angle<T>
Returns the angle between this vector and the x axis between -PI and PI.
sourceimpl<T, U> TypedVector2D<T, U>where
T: Copy + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T>,
impl<T, U> TypedVector2D<T, U>where
T: Copy + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T>,
sourcepub fn cross(self, other: Self) -> T
pub fn cross(self, other: Self) -> T
Returns the norm of the cross product [self.x, self.y, 0] x [other.x, other.y, 0]..
pub fn normalize(self) -> Selfwhere
T: Float,
sourcepub fn robust_normalize(self) -> Selfwhere
T: Float,
pub fn robust_normalize(self) -> Selfwhere
T: Float,
Return the normalized vector even if the length is larger than the max value of Float.
pub fn square_length(&self) -> T
pub fn length(&self) -> Twhere
T: Float,
sourceimpl<T, U> TypedVector2D<T, U>where
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
impl<T, U> TypedVector2D<T, U>where
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
sourceimpl<T: Float, U> TypedVector2D<T, U>
impl<T: Float, U> TypedVector2D<T, U>
sourceimpl<T: Round, U> TypedVector2D<T, U>
impl<T: Round, U> TypedVector2D<T, U>
sourceimpl<T: Ceil, U> TypedVector2D<T, U>
impl<T: Ceil, U> TypedVector2D<T, U>
sourceimpl<T: Floor, U> TypedVector2D<T, U>
impl<T: Floor, U> TypedVector2D<T, U>
sourceimpl<T: NumCast + Copy, U> TypedVector2D<T, U>
impl<T: NumCast + Copy, U> TypedVector2D<T, U>
sourcepub fn cast<NewT: NumCast + Copy>(&self) -> TypedVector2D<NewT, U>
pub fn cast<NewT: NumCast + Copy>(&self) -> TypedVector2D<NewT, U>
Cast from one numeric representation to another, preserving the units.
When casting from floating vector to integer coordinates, the decimals are truncated
as one would expect from a simple cast, but this behavior does not always make sense
geometrically. Consider using round()
, ceil()
or floor()
before casting.
sourcepub fn try_cast<NewT: NumCast + Copy>(&self) -> Option<TypedVector2D<NewT, U>>
pub fn try_cast<NewT: NumCast + Copy>(&self) -> Option<TypedVector2D<NewT, U>>
Fallible cast from one numeric representation to another, preserving the units.
When casting from floating vector to integer coordinates, the decimals are truncated
as one would expect from a simple cast, but this behavior does not always make sense
geometrically. Consider using round()
, ceil()
or floor()
before casting.
sourcepub fn to_f32(&self) -> TypedVector2D<f32, U>
pub fn to_f32(&self) -> TypedVector2D<f32, U>
Cast into an f32
vector.
sourcepub fn to_f64(&self) -> TypedVector2D<f64, U>
pub fn to_f64(&self) -> TypedVector2D<f64, U>
Cast into an f64
vector.
sourcepub fn to_usize(&self) -> TypedVector2D<usize, U>
pub fn to_usize(&self) -> TypedVector2D<usize, U>
Cast into an usize
vector, truncating decimals if any.
When casting from floating vector vectors, it is worth considering whether
to round()
, ceil()
or floor()
before the cast in order to obtain
the desired conversion behavior.
sourcepub fn to_u32(&self) -> TypedVector2D<u32, U>
pub fn to_u32(&self) -> TypedVector2D<u32, U>
Cast into an u32
vector, truncating decimals if any.
When casting from floating vector vectors, it is worth considering whether
to round()
, ceil()
or floor()
before the cast in order to obtain
the desired conversion behavior.
sourcepub fn to_i32(&self) -> TypedVector2D<i32, U>
pub fn to_i32(&self) -> TypedVector2D<i32, U>
Cast into an i32 vector, truncating decimals if any.
When casting from floating vector vectors, it is worth considering whether
to round()
, ceil()
or floor()
before the cast in order to obtain
the desired conversion behavior.
sourcepub fn to_i64(&self) -> TypedVector2D<i64, U>
pub fn to_i64(&self) -> TypedVector2D<i64, U>
Cast into an i64 vector, truncating decimals if any.
When casting from floating vector vectors, it is worth considering whether
to round()
, ceil()
or floor()
before the cast in order to obtain
the desired conversion behavior.
sourceimpl<T, U> TypedVector2D<T, U>where
T: Signed,
impl<T, U> TypedVector2D<T, U>where
T: Signed,
sourceimpl<T: PartialOrd, U> TypedVector2D<T, U>
impl<T: PartialOrd, U> TypedVector2D<T, U>
pub fn greater_than(&self, other: &Self) -> BoolVector2D
pub fn lower_than(&self, other: &Self) -> BoolVector2D
sourceimpl<T: PartialEq, U> TypedVector2D<T, U>
impl<T: PartialEq, U> TypedVector2D<T, U>
pub fn equal(&self, other: &Self) -> BoolVector2D
pub fn not_equal(&self, other: &Self) -> BoolVector2D
Trait Implementations
sourceimpl<T: Copy + Add<T, Output = T>, U> Add<TypedVector2D<T, U>> for TypedPoint2D<T, U>
impl<T: Copy + Add<T, Output = T>, U> Add<TypedVector2D<T, U>> for TypedPoint2D<T, U>
type Output = TypedPoint2D<T, U>
type Output = TypedPoint2D<T, U>
+
operator.sourcefn add(self, other: TypedVector2D<T, U>) -> Self
fn add(self, other: TypedVector2D<T, U>) -> Self
+
operation. Read moresourceimpl<T: Copy + Add<T, Output = T>, U> Add<TypedVector2D<T, U>> for TypedVector2D<T, U>
impl<T: Copy + Add<T, Output = T>, U> Add<TypedVector2D<T, U>> for TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
+
operator.sourceimpl<T: Copy + Add<T, Output = T>, U> AddAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U>
impl<T: Copy + Add<T, Output = T>, U> AddAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U>
sourcefn add_assign(&mut self, other: TypedVector2D<T, U>)
fn add_assign(&mut self, other: TypedVector2D<T, U>)
+=
operation. Read moresourceimpl<T: Copy + Add<T, Output = T>, U> AddAssign<TypedVector2D<T, U>> for TypedVector2D<T, U>
impl<T: Copy + Add<T, Output = T>, U> AddAssign<TypedVector2D<T, U>> for TypedVector2D<T, U>
sourcefn add_assign(&mut self, other: Self)
fn add_assign(&mut self, other: Self)
+=
operation. Read moresourceimpl<T: Copy + ApproxEq<T>, U> ApproxEq<TypedVector2D<T, U>> for TypedVector2D<T, U>
impl<T: Copy + ApproxEq<T>, U> ApproxEq<TypedVector2D<T, U>> for TypedVector2D<T, U>
sourceimpl<T: Clone, U> Clone for TypedVector2D<T, U>
impl<T: Clone, U> Clone for TypedVector2D<T, U>
sourceimpl<T: Debug, U> Debug for TypedVector2D<T, U>
impl<T: Debug, U> Debug for TypedVector2D<T, U>
sourceimpl<T: Display, U> Display for TypedVector2D<T, U>
impl<T: Display, U> Display for TypedVector2D<T, U>
sourceimpl<T: Copy + Div<T, Output = T>, U> Div<T> for TypedVector2D<T, U>
impl<T: Copy + Div<T, Output = T>, U> Div<T> for TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
/
operator.sourceimpl<T: Copy + Div<T, Output = T>, U1, U2> Div<TypedScale<T, U1, U2>> for TypedVector2D<T, U2>
impl<T: Copy + Div<T, Output = T>, U1, U2> Div<TypedScale<T, U1, U2>> for TypedVector2D<T, U2>
type Output = TypedVector2D<T, U1>
type Output = TypedVector2D<T, U1>
/
operator.sourcefn div(self, scale: TypedScale<T, U1, U2>) -> Self::Output
fn div(self, scale: TypedScale<T, U1, U2>) -> Self::Output
/
operation. Read moresourceimpl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for TypedVector2D<T, U>
impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for TypedVector2D<T, U>
sourcefn div_assign(&mut self, scale: T)
fn div_assign(&mut self, scale: T)
/=
operation. Read moresourceimpl<T: Copy, U> From<[T; 2]> for TypedVector2D<T, U>
impl<T: Copy, U> From<[T; 2]> for TypedVector2D<T, U>
sourceimpl<T, Src, Dst> From<TypedVector2D<T, Src>> for TypedTranslation2D<T, Src, Dst>where
T: Copy,
impl<T, Src, Dst> From<TypedVector2D<T, Src>> for TypedTranslation2D<T, Src, Dst>where
T: Copy,
sourcefn from(v: TypedVector2D<T, Src>) -> Self
fn from(v: TypedVector2D<T, Src>) -> Self
sourceimpl<T: Zero, U> From<TypedVector2D<T, U>> for HomogeneousVector<T, U>
impl<T: Zero, U> From<TypedVector2D<T, U>> for HomogeneousVector<T, U>
sourcefn from(v: TypedVector2D<T, U>) -> Self
fn from(v: TypedVector2D<T, U>) -> Self
sourceimpl<T, U> Hash for TypedVector2D<T, U>where
T: Hash,
impl<T, U> Hash for TypedVector2D<T, U>where
T: Hash,
sourceimpl<T: Copy, U> Into<[T; 2]> for TypedVector2D<T, U>
impl<T: Copy, U> Into<[T; 2]> for TypedVector2D<T, U>
sourceimpl<T, Src, Dst> Into<TypedVector2D<T, Src>> for TypedTranslation2D<T, Src, Dst>where
T: Copy,
impl<T, Src, Dst> Into<TypedVector2D<T, Src>> for TypedTranslation2D<T, Src, Dst>where
T: Copy,
sourcefn into(self) -> TypedVector2D<T, Src>
fn into(self) -> TypedVector2D<T, Src>
sourceimpl<T: Copy + Mul<T, Output = T>, U> Mul<T> for TypedVector2D<T, U>
impl<T: Copy + Mul<T, Output = T>, U> Mul<T> for TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
*
operator.sourceimpl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<TypedScale<T, U1, U2>> for TypedVector2D<T, U1>
impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<TypedScale<T, U1, U2>> for TypedVector2D<T, U1>
type Output = TypedVector2D<T, U2>
type Output = TypedVector2D<T, U2>
*
operator.sourcefn mul(self, scale: TypedScale<T, U1, U2>) -> Self::Output
fn mul(self, scale: TypedScale<T, U1, U2>) -> Self::Output
*
operation. Read moresourceimpl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for TypedVector2D<T, U>
impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for TypedVector2D<T, U>
sourcefn mul_assign(&mut self, scale: T)
fn mul_assign(&mut self, scale: T)
*=
operation. Read moresourceimpl<T: Copy + Neg<Output = T>, U> Neg for TypedVector2D<T, U>
impl<T: Copy + Neg<Output = T>, U> Neg for TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
-
operator.sourceimpl<T, U> PartialEq<TypedVector2D<T, U>> for TypedVector2D<T, U>where
T: PartialEq,
impl<T, U> PartialEq<TypedVector2D<T, U>> for TypedVector2D<T, U>where
T: PartialEq,
sourceimpl<T: Copy + Sub<T, Output = T>, U> Sub<TypedVector2D<T, U>> for TypedPoint2D<T, U>
impl<T: Copy + Sub<T, Output = T>, U> Sub<TypedVector2D<T, U>> for TypedPoint2D<T, U>
type Output = TypedPoint2D<T, U>
type Output = TypedPoint2D<T, U>
-
operator.sourcefn sub(self, other: TypedVector2D<T, U>) -> Self
fn sub(self, other: TypedVector2D<T, U>) -> Self
-
operation. Read moresourceimpl<T: Copy + Sub<T, Output = T>, U> Sub<TypedVector2D<T, U>> for TypedVector2D<T, U>
impl<T: Copy + Sub<T, Output = T>, U> Sub<TypedVector2D<T, U>> for TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
type Output = TypedVector2D<T, U>
-
operator.sourceimpl<T: Copy + Sub<T, Output = T>, U> SubAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U>
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U>
sourcefn sub_assign(&mut self, other: TypedVector2D<T, U>)
fn sub_assign(&mut self, other: TypedVector2D<T, U>)
-=
operation. Read moresourceimpl<T: Copy + Sub<T, Output = T>, U> SubAssign<TypedVector2D<T, U>> for TypedVector2D<T, U>
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<TypedVector2D<T, U>> for TypedVector2D<T, U>
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
-=
operation. Read more