Struct euclid::Vector2D [−][src]
#[repr(C)]pub struct Vector2D<T, U> { pub x: T, pub y: T, // some fields omitted }
Expand description
A 2d Vector tagged with a unit.
Fields
x: T
The x
(traditionally, horizontal) coordinate.
y: T
The y
(traditionally, vertical) coordinate.
Implementations
impl<T, U> Vector2D<T, U>
[src]
impl<T, U> Vector2D<T, U>
[src]pub fn splat(v: T) -> Self where
T: Clone,
[src]
pub fn splat(v: T) -> Self where
T: Clone,
[src]Constructor setting all components to the same value.
pub fn from_angle_and_length(angle: Angle<T>, length: T) -> Self where
T: Trig + Mul<Output = T> + Copy,
[src]
pub fn from_angle_and_length(angle: Angle<T>, length: T) -> Self where
T: Trig + Mul<Output = T> + Copy,
[src]Constructor taking angle and length
pub fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> Self
[src]
pub fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> Self
[src]Constructor taking properly Lengths instead of scalar values.
pub fn from_untyped(p: Vector2D<T, UnknownUnit>) -> Self
[src]
pub fn from_untyped(p: Vector2D<T, UnknownUnit>) -> Self
[src]Tag a unit-less value with units.
pub fn abs(self) -> Self where
T: Signed,
[src]
pub fn abs(self) -> Self where
T: Signed,
[src]Computes the vector with absolute values of each component.
Example
enum U {} assert_eq!(vec2::<_, U>(-1, 2).abs(), vec2(1, 2)); let vec = vec2::<_, U>(f32::NAN, -f32::MAX).abs(); assert!(vec.x.is_nan()); assert_eq!(vec.y, f32::MAX);
Panics
The behavior for each component follows the scalar type’s implementation of
num_traits::Signed::abs
.
pub fn cross(self, other: Self) -> T where
T: Sub<Output = T> + Mul<Output = T>,
[src]
pub fn cross(self, other: Self) -> T where
T: Sub<Output = T> + Mul<Output = T>,
[src]Returns the norm of the cross product [self.x, self.y, 0] x [other.x, other.y, 0].
pub fn component_mul(self, other: Self) -> Self where
T: Mul<Output = T>,
[src]
pub fn component_mul(self, other: Self) -> Self where
T: Mul<Output = T>,
[src]Returns the component-wise multiplication of the two vectors.
pub fn component_div(self, other: Self) -> Self where
T: Div<Output = T>,
[src]
pub fn component_div(self, other: Self) -> Self where
T: Div<Output = T>,
[src]Returns the component-wise division of the two vectors.
impl<T: Copy, U> Vector2D<T, U>
[src]
impl<T: Copy, U> Vector2D<T, U>
[src]pub fn extend(self, z: T) -> Vector3D<T, U>
[src]
pub fn extend(self, z: T) -> Vector3D<T, U>
[src]Create a 3d vector from this one, using the specified z value.
pub fn to_point(self) -> Point2D<T, U>
[src]
pub fn to_point(self) -> Point2D<T, U>
[src]Cast this vector into a point.
Equivalent to adding this vector to the origin.
pub fn to_untyped(self) -> Vector2D<T, UnknownUnit>
[src]
pub fn to_untyped(self) -> Vector2D<T, UnknownUnit>
[src]Drop the units, preserving only the numeric value.
pub fn to_3d(self) -> Vector3D<T, U> where
T: Zero,
[src]
pub fn to_3d(self) -> Vector3D<T, U> where
T: Zero,
[src]Convert into a 3d vector with z
coordinate equals to T::zero()
.
#[must_use]pub fn round(self) -> Self where
T: Round,
[src]
#[must_use]pub fn round(self) -> Self where
T: Round,
[src]Rounds each component to the nearest integer value.
This behavior is preserved for negative values (unlike the basic cast).
enum Mm {} assert_eq!(vec2::<_, Mm>(-0.1, -0.8).round(), vec2::<_, Mm>(0.0, -1.0))
#[must_use]pub fn ceil(self) -> Self where
T: Ceil,
[src]
#[must_use]pub fn ceil(self) -> Self where
T: Ceil,
[src]Rounds each component to the smallest integer equal or greater than the original value.
This behavior is preserved for negative values (unlike the basic cast).
enum Mm {} assert_eq!(vec2::<_, Mm>(-0.1, -0.8).ceil(), vec2::<_, Mm>(0.0, 0.0))
#[must_use]pub fn floor(self) -> Self where
T: Floor,
[src]
#[must_use]pub fn floor(self) -> Self where
T: Floor,
[src]Rounds each component to the biggest integer equal or lower than the original value.
This behavior is preserved for negative values (unlike the basic cast).
enum Mm {} assert_eq!(vec2::<_, Mm>(-0.1, -0.8).floor(), vec2::<_, Mm>(-1.0, -1.0))
pub fn angle_from_x_axis(self) -> Angle<T> where
T: Trig,
[src]
pub fn angle_from_x_axis(self) -> Angle<T> where
T: Trig,
[src]Returns the signed angle between this vector and the x axis.
Positive values counted counterclockwise, where 0 is +x
axis, PI/2
is +y
axis.
The returned angle is between -PI and PI.
pub fn to_transform(self) -> Transform2D<T, U, U> where
T: Zero + One,
[src]
pub fn to_transform(self) -> Transform2D<T, U, U> where
T: Zero + One,
[src]Creates translation by this vector in vector units.
impl<T, U> Vector2D<T, U> where
T: Copy + Mul<T, Output = T> + Add<T, Output = T>,
[src]
impl<T, U> Vector2D<T, U> where
T: Copy + Mul<T, Output = T> + Add<T, Output = T>,
[src]pub fn square_length(self) -> T
[src]
pub fn square_length(self) -> T
[src]Returns the vector’s length squared.
pub fn project_onto_vector(self, onto: Self) -> Self where
T: Sub<T, Output = T> + Div<T, Output = T>,
[src]
pub fn project_onto_vector(self, onto: Self) -> Self where
T: Sub<T, Output = T> + Div<T, Output = T>,
[src]Returns this vector projected onto another one.
Projecting onto a nil vector will cause a division by zero.
impl<T: Float, U> Vector2D<T, U>
[src]
impl<T: Float, U> Vector2D<T, U>
[src]#[must_use]pub fn try_normalize(self) -> Option<Self>
[src]
#[must_use]pub fn try_normalize(self) -> Option<Self>
[src]Returns the vector with length of one unit.
Unlike Vector2D::normalize
, this returns None in the case that the
length of the vector is zero.
#[must_use]pub fn robust_normalize(self) -> Self
[src]
#[must_use]pub fn robust_normalize(self) -> Self
[src]Return the normalized vector even if the length is larger than the max value of Float.
pub fn with_max_length(self, max_length: T) -> Self
[src]
pub fn with_max_length(self, max_length: T) -> Self
[src]Return this vector capped to a maximum length.
pub fn with_min_length(self, min_length: T) -> Self
[src]
pub fn with_min_length(self, min_length: T) -> Self
[src]Return this vector with a minimum length applied.
pub fn clamp_length(self, min: T, max: T) -> Self
[src]
pub fn clamp_length(self, min: T, max: T) -> Self
[src]Return this vector with minimum and maximum lengths applied.
impl<T, U> Vector2D<T, U> where
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
[src]
impl<T, U> Vector2D<T, U> where
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
[src]pub fn lerp(self, other: Self, t: T) -> Self
[src]
pub fn lerp(self, other: Self, t: T) -> Self
[src]Linearly interpolate each component between this vector and another vector.
Example
use euclid::vec2; use euclid::default::Vector2D; let from: Vector2D<_> = vec2(0.0, 10.0); let to: Vector2D<_> = vec2(8.0, -4.0); assert_eq!(from.lerp(to, -1.0), vec2(-8.0, 24.0)); assert_eq!(from.lerp(to, 0.0), vec2( 0.0, 10.0)); assert_eq!(from.lerp(to, 0.5), vec2( 4.0, 3.0)); assert_eq!(from.lerp(to, 1.0), vec2( 8.0, -4.0)); assert_eq!(from.lerp(to, 2.0), vec2(16.0, -18.0));
impl<T: PartialOrd, U> Vector2D<T, U>
[src]
impl<T: PartialOrd, U> Vector2D<T, U>
[src]pub fn min(self, other: Self) -> Self
[src]
pub fn min(self, other: Self) -> Self
[src]Returns the vector each component of which are minimum of this vector and another.
pub fn max(self, other: Self) -> Self
[src]
pub fn max(self, other: Self) -> Self
[src]Returns the vector each component of which are maximum of this vector and another.
pub fn clamp(self, start: Self, end: Self) -> Self where
T: Copy,
[src]
pub fn clamp(self, start: Self, end: Self) -> Self where
T: Copy,
[src]Returns the vector each component of which is clamped by corresponding
components of start
and end
.
Shortcut for self.max(start).min(end)
.
pub fn greater_than(self, other: Self) -> BoolVector2D
[src]
pub fn greater_than(self, other: Self) -> BoolVector2D
[src]Returns vector with results of “greater than” operation on each component.
pub fn lower_than(self, other: Self) -> BoolVector2D
[src]
pub fn lower_than(self, other: Self) -> BoolVector2D
[src]Returns vector with results of “lower than” operation on each component.
impl<T: PartialEq, U> Vector2D<T, U>
[src]
impl<T: PartialEq, U> Vector2D<T, U>
[src]pub fn equal(self, other: Self) -> BoolVector2D
[src]
pub fn equal(self, other: Self) -> BoolVector2D
[src]Returns vector with results of “equal” operation on each component.
pub fn not_equal(self, other: Self) -> BoolVector2D
[src]
pub fn not_equal(self, other: Self) -> BoolVector2D
[src]Returns vector with results of “not equal” operation on each component.
impl<T: NumCast + Copy, U> Vector2D<T, U>
[src]
impl<T: NumCast + Copy, U> Vector2D<T, U>
[src]pub fn cast<NewT: NumCast>(self) -> Vector2D<NewT, U>
[src]
pub fn cast<NewT: NumCast>(self) -> Vector2D<NewT, U>
[src]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.
pub fn try_cast<NewT: NumCast>(self) -> Option<Vector2D<NewT, U>>
[src]
pub fn try_cast<NewT: NumCast>(self) -> Option<Vector2D<NewT, U>>
[src]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.
pub fn to_usize(self) -> Vector2D<usize, U>
[src]
pub fn to_usize(self) -> Vector2D<usize, U>
[src]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.
pub fn to_u32(self) -> Vector2D<u32, U>
[src]
pub fn to_u32(self) -> Vector2D<u32, U>
[src]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.
Trait Implementations
impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector2D<T, U>> for Point2D<T, U>
[src]
impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector2D<T, U>> for Point2D<T, U>
[src]fn add_assign(&mut self, other: Vector2D<T, U>)
[src]
fn add_assign(&mut self, other: Vector2D<T, U>)
[src]Performs the +=
operation. Read more
impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector2D<T, U>> for Vector2D<T, U>
[src]
impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector2D<T, U>> for Vector2D<T, U>
[src]fn add_assign(&mut self, other: Self)
[src]
fn add_assign(&mut self, other: Self)
[src]Performs the +=
operation. Read more
impl<T: ApproxEq<T>, U> ApproxEq<Vector2D<T, U>> for Vector2D<T, U>
[src]
impl<T: ApproxEq<T>, U> ApproxEq<Vector2D<T, U>> for Vector2D<T, U>
[src]fn approx_epsilon() -> Self
[src]
fn approx_epsilon() -> Self
[src]Default epsilon value
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Vector2D<T, U>
[src]
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Vector2D<T, U>
[src]fn div_assign(&mut self, scale: Scale<T, U, U>)
[src]
fn div_assign(&mut self, scale: Scale<T, U, U>)
[src]Performs the /=
operation. Read more
impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Vector2D<T, U>
[src]
impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Vector2D<T, U>
[src]fn div_assign(&mut self, scale: T)
[src]
fn div_assign(&mut self, scale: T)
[src]Performs the /=
operation. Read more
impl<T, Src, Dst> From<Vector2D<T, Src>> for Translation2D<T, Src, Dst>
[src]
impl<T, Src, Dst> From<Vector2D<T, Src>> for Translation2D<T, Src, Dst>
[src]impl<T: Zero, U> From<Vector2D<T, U>> for HomogeneousVector<T, U>
[src]
impl<T: Zero, U> From<Vector2D<T, U>> for HomogeneousVector<T, U>
[src]impl<T, Src, Dst> Into<Vector2D<T, Src>> for Translation2D<T, Src, Dst>
[src]
impl<T, Src, Dst> Into<Vector2D<T, Src>> for Translation2D<T, Src, Dst>
[src]impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Vector2D<T, U>
[src]
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Vector2D<T, U>
[src]fn mul_assign(&mut self, scale: Scale<T, U, U>)
[src]
fn mul_assign(&mut self, scale: Scale<T, U, U>)
[src]Performs the *=
operation. Read more
impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Vector2D<T, U>
[src]
impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Vector2D<T, U>
[src]fn mul_assign(&mut self, scale: T)
[src]
fn mul_assign(&mut self, scale: T)
[src]Performs the *=
operation. Read more
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector2D<T, U>> for Point2D<T, U>
[src]
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector2D<T, U>> for Point2D<T, U>
[src]fn sub_assign(&mut self, other: Vector2D<T, U>)
[src]
fn sub_assign(&mut self, other: Vector2D<T, U>)
[src]Performs the -=
operation. Read more
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector2D<T, U>> for Vector2D<T, U>
[src]
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector2D<T, U>> for Vector2D<T, U>
[src]fn sub_assign(&mut self, other: Self)
[src]
fn sub_assign(&mut self, other: Self)
[src]Performs the -=
operation. Read more
impl<'a, T: 'a + Add<Output = T> + Copy + Zero, U: 'a> Sum<&'a Vector2D<T, U>> for Vector2D<T, U>
[src]
impl<'a, T: 'a + Add<Output = T> + Copy + Zero, U: 'a> Sum<&'a Vector2D<T, U>> for Vector2D<T, U>
[src]impl<T: Copy, U> Copy for Vector2D<T, U>
[src]
impl<T: Eq, U> Eq for Vector2D<T, U>
[src]
Auto Trait Implementations
impl<T, U> RefUnwindSafe for Vector2D<T, U> where
T: RefUnwindSafe,
U: RefUnwindSafe,
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Vector2D<T, U> where
T: Send,
U: Send,
T: Send,
U: Send,
impl<T, U> Sync for Vector2D<T, U> where
T: Sync,
U: Sync,
T: Sync,
U: Sync,
impl<T, U> Unpin for Vector2D<T, U> where
T: Unpin,
U: Unpin,
T: Unpin,
U: Unpin,
impl<T, U> UnwindSafe for Vector2D<T, U> where
T: UnwindSafe,
U: UnwindSafe,
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more