Struct three_d::core::math::Vector2

#[repr(C)]
pub struct Vector2<S> {
    pub x: S,
    pub y: S,
}

A 2-dimensional vector.

This type is marked as #[repr(C)].

Fields

x: S

The x component of the vector.

y: S

The y component of the vector.

Implementations

impl<S> Vector2<S> where
    S: BaseNum, 

pub fn unit_x() -> Vector2<S>

A unit vector in the x direction.

pub fn unit_y() -> Vector2<S>

A unit vector in the y direction.

pub fn perp_dot(self, other: Vector2<S>) -> S

The perpendicular dot product of the vector and other.

pub fn extend(self, z: S) -> Vector3<S>

Create a Vector3, using the x and y values from this vector, and the provided z.

impl<S> Vector2<S>

pub const fn new(x: S, y: S) -> Vector2<S>

Construct a new vector, using the provided values.

pub fn map<U, F>(self, f: F) -> Vector2<U> where
    F: FnMut(S) -> U, 

Perform the given operation on each field in the vector, returning a new point constructed from the operations.

pub fn zip<S2, S3, F>(self, v2: Vector2<S2>, f: F) -> Vector2<S3> where
    F: FnMut(S, S2) -> S3, 

Construct a new vector where each component is the result of applying the given operation to each pair of components of the given vectors.

impl<S> Vector2<S> where
    S: NumCast + Copy, 

pub fn cast<T>(&self) -> Option<Vector2<T>> where
    T: NumCast, 

Component-wise casting to another type.

Trait Implementations

impl<S> AbsDiffEq<Vector2<S>> for Vector2<S> where
    S: BaseFloat, 

type Epsilon = <S as AbsDiffEq<S>>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <S as AbsDiffEq<S>>::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(
    &self,
    other: &Vector2<S>,
    epsilon: <S as AbsDiffEq<S>>::Epsilon
) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of [AbsDiffEq::abs_diff_eq].

impl<'a, S> Add<&'a Vector2<S>> for Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the + operator.

fn add(self, other: &'a Vector2<S>) -> Vector2<S>

Performs the + operation.

impl<'a, 'b, S> Add<&'a Vector2<S>> for &'b Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the + operator.

fn add(self, other: &'a Vector2<S>) -> Vector2<S>

Performs the + operation.

impl<'a, S> Add<Vector2<S>> for &'a Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the + operator.

fn add(self, other: Vector2<S>) -> Vector2<S>

Performs the + operation.

impl<S> Add<Vector2<S>> for Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the + operator.

fn add(self, other: Vector2<S>) -> Vector2<S>

Performs the + operation.

impl<S> AddAssign<Vector2<S>> for Vector2<S> where
    S: BaseNum + AddAssign<S>, 

fn add_assign(&mut self, other: Vector2<S>)

Performs the += operation.

impl<S> Array for Vector2<S> where
    S: Copy, 

type Element = S

fn len() -> usize

Get the number of elements in the array type

fn from_value(scalar: S) -> Vector2<S>

Construct a vector from a single value, replicating it.

fn sum(self) -> S where
    S: Add<S, Output = S>, 

The sum of the elements of the array.

fn product(self) -> S where
    S: Mul<S, Output = S>, 

The product of the elements of the array.

fn is_finite(&self) -> bool where
    S: Float, 

Whether all elements of the array are finite

fn as_ptr(&self) -> *const Self::Element

Get the pointer to the first element of the array.

fn as_mut_ptr(&mut self) -> *mut Self::Element

Get a mutable pointer to the first element of the array.

fn swap_elements(&mut self, i: usize, j: usize)

Swap the elements at indices i and j in-place.

impl<S> AsMut<[S; 2]> for Vector2<S>

fn as_mut(&mut self) -> &mut [S; 2]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S> AsMut<(S, S)> for Vector2<S>

fn as_mut(&mut self) -> &mut (S, S)

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S> AsRef<[S; 2]> for Vector2<S>

fn as_ref(&self) -> &[S; 2]

Converts this type into a shared reference of the (usually inferred) input type.

impl<S> AsRef<(S, S)> for Vector2<S>

fn as_ref(&self) -> &(S, S)

Converts this type into a shared reference of the (usually inferred) input type.

impl<S> Bounded for Vector2<S> where
    S: Bounded, 

fn min_value() -> Vector2<S>

returns the smallest finite number this type can represent

fn max_value() -> Vector2<S>

returns the largest finite number this type can represent

impl<S> Clone for Vector2<S> where
    S: Clone, 

fn clone(&self) -> Vector2<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S> Debug for Vector2<S> where
    S: Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a, S> Div<S> for &'a Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the / operator.

fn div(self, other: S) -> Vector2<S>

Performs the / operation.

impl<S> Div<S> for Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the / operator.

fn div(self, other: S) -> Vector2<S>

Performs the / operation.

impl<S> DivAssign<S> for Vector2<S> where
    S: BaseNum + DivAssign<S>, 

fn div_assign(&mut self, scalar: S)

Performs the /= operation.

impl<S> ElementWise<S> for Vector2<S> where
    S: BaseNum, 

fn add_element_wise(self, rhs: S) -> Vector2<S>

fn sub_element_wise(self, rhs: S) -> Vector2<S>

fn mul_element_wise(self, rhs: S) -> Vector2<S>

fn div_element_wise(self, rhs: S) -> Vector2<S>

fn rem_element_wise(self, rhs: S) -> Vector2<S>

fn add_assign_element_wise(&mut self, rhs: S)

fn sub_assign_element_wise(&mut self, rhs: S)

fn mul_assign_element_wise(&mut self, rhs: S)

fn div_assign_element_wise(&mut self, rhs: S)

fn rem_assign_element_wise(&mut self, rhs: S)

impl<S> ElementWise<Vector2<S>> for Vector2<S> where
    S: BaseNum, 

fn add_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn sub_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn mul_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn div_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn rem_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn add_assign_element_wise(&mut self, rhs: Vector2<S>)

fn sub_assign_element_wise(&mut self, rhs: Vector2<S>)

fn mul_assign_element_wise(&mut self, rhs: Vector2<S>)

fn div_assign_element_wise(&mut self, rhs: Vector2<S>)

fn rem_assign_element_wise(&mut self, rhs: Vector2<S>)

impl<'a, S> From<&'a [S; 2]> for &'a Vector2<S>

fn from(v: &'a [S; 2]) -> &'a Vector2<S>

Converts to this type from the input type.

impl<'a, S> From<&'a (S, S)> for &'a Vector2<S>

fn from(v: &'a (S, S)) -> &'a Vector2<S>

Converts to this type from the input type.

impl<'a, S> From<&'a mut [S; 2]> for &'a mut Vector2<S>

fn from(v: &'a mut [S; 2]) -> &'a mut Vector2<S>

Converts to this type from the input type.

impl<'a, S> From<&'a mut (S, S)> for &'a mut Vector2<S>

fn from(v: &'a mut (S, S)) -> &'a mut Vector2<S>

Converts to this type from the input type.

impl<S> From<[S; 2]> for Vector2<S> where
    S: Clone, 

fn from(v: [S; 2]) -> Vector2<S>

Converts to this type from the input type.

impl<S> From<(S, S)> for Vector2<S>

fn from(v: (S, S)) -> Vector2<S>

Converts to this type from the input type.

impl<S> Hash for Vector2<S> where
    S: Hash, 

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<S> Index<Range<usize>> for Vector2<S>

type Output = [S]

The returned type after indexing.

fn index(&'a self, i: Range<usize>) -> &'a [S]

Performs the indexing (container[index]) operation.

impl<S> Index<RangeFrom<usize>> for Vector2<S>

type Output = [S]

The returned type after indexing.

fn index(&'a self, i: RangeFrom<usize>) -> &'a [S]

Performs the indexing (container[index]) operation.

impl<S> Index<RangeFull> for Vector2<S>

type Output = [S]

The returned type after indexing.

fn index(&'a self, i: RangeFull) -> &'a [S]

Performs the indexing (container[index]) operation.

impl<S> Index<RangeTo<usize>> for Vector2<S>

type Output = [S]

The returned type after indexing.

fn index(&'a self, i: RangeTo<usize>) -> &'a [S]

Performs the indexing (container[index]) operation.

impl<S> Index<usize> for Vector2<S>

type Output = S

The returned type after indexing.

fn index(&'a self, i: usize) -> &'a S

Performs the indexing (container[index]) operation.

impl<S> IndexMut<Range<usize>> for Vector2<S>

fn index_mut(&'a mut self, i: Range<usize>) -> &'a mut [S]

Performs the mutable indexing (container[index]) operation.

impl<S> IndexMut<RangeFrom<usize>> for Vector2<S>

fn index_mut(&'a mut self, i: RangeFrom<usize>) -> &'a mut [S]

Performs the mutable indexing (container[index]) operation.

impl<S> IndexMut<RangeFull> for Vector2<S>

fn index_mut(&'a mut self, i: RangeFull) -> &'a mut [S]

Performs the mutable indexing (container[index]) operation.

impl<S> IndexMut<RangeTo<usize>> for Vector2<S>

fn index_mut(&'a mut self, i: RangeTo<usize>) -> &'a mut [S]

Performs the mutable indexing (container[index]) operation.

impl<S> IndexMut<usize> for Vector2<S>

fn index_mut(&'a mut self, i: usize) -> &'a mut S

Performs the mutable indexing (container[index]) operation.

impl<S> InnerSpace for Vector2<S> where
    S: BaseNum, 

fn dot(self, other: Vector2<S>) -> S

Vector dot (or inner) product.

fn angle(self, other: Vector2<S>) -> Rad<S> where
    S: BaseFloat, 

Returns the angle between two vectors in radians.

fn is_perpendicular(self, other: Self) -> bool where
    Self::Scalar: UlpsEq<Self::Scalar>, 

Returns true if the vector is perpendicular (at right angles) to the other vector.

fn magnitude2(self) -> Self::Scalar

Returns the squared magnitude.

fn project_on(self, other: Self) -> Self

Returns the vector projection of the current inner space projected onto the supplied argument.

fn magnitude(self) -> Self::Scalar where
    Self::Scalar: Float, 

The distance from the tail to the tip of the vector.

fn normalize(self) -> Self where
    Self::Scalar: Float, 

Returns a vector with the same direction, but with a magnitude of 1.

fn normalize_to(self, magnitude: Self::Scalar) -> Self where
    Self::Scalar: Float, 

Returns a vector with the same direction and a given magnitude.

impl<S> Into<[S; 2]> for Vector2<S>

fn into(self) -> [S; 2]

Converts this type into the (usually inferred) input type.

impl<S> Into<(S, S)> for Vector2<S>

fn into(self) -> (S, S)

Converts this type into the (usually inferred) input type.

impl<S> MetricSpace for Vector2<S> where
    S: BaseNum, 

type Metric = S

The metric to be returned by the distance function.

fn distance2(self, other: Vector2<S>) -> S

Returns the squared distance.

fn distance(self, other: Self) -> Self::Metric where
    Self::Metric: Float, 

The distance between two values.

impl<'a, 'b, S> Mul<&'a Vector2<S>> for &'b Matrix2<S> where
    S: BaseFloat, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: &'a Vector2<S>) -> Vector2<S>

Performs the * operation.

impl<'a, S> Mul<&'a Vector2<S>> for Matrix2<S> where
    S: BaseFloat, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: &'a Vector2<S>) -> Vector2<S>

Performs the * operation.

impl<S> Mul<S> for Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: S) -> Vector2<S>

Performs the * operation.

impl<'a, S> Mul<S> for &'a Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: S) -> Vector2<S>

Performs the * operation.

impl<'a, S> Mul<Vector2<S>> for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: Vector2<S>) -> Vector2<S>

Performs the * operation.

impl<S> Mul<Vector2<S>> for Matrix2<S> where
    S: BaseFloat, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: Vector2<S>) -> Vector2<S>

Performs the * operation.

impl<S> MulAssign<S> for Vector2<S> where
    S: BaseNum + MulAssign<S>, 

fn mul_assign(&mut self, scalar: S)

Performs the *= operation.

impl<S> Neg for Vector2<S> where
    S: Neg<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the - operator.

fn neg(self) -> Vector2<S>

Performs the unary - operation.

impl<S> PartialEq<Vector2<S>> for Vector2<S> where
    S: PartialEq<S>, 

fn eq(&self, other: &Vector2<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Vector2<S>) -> bool

This method tests for !=.

impl<S> RelativeEq<Vector2<S>> for Vector2<S> where
    S: BaseFloat, 

fn default_max_relative() -> <S as AbsDiffEq<S>>::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Vector2<S>,
    epsilon: <S as AbsDiffEq<S>>::Epsilon,
    max_relative: <S as AbsDiffEq<S>>::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of [RelativeEq::relative_eq].

impl<S> Rem<S> for Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the % operator.

fn rem(self, other: S) -> Vector2<S>

Performs the % operation.

impl<'a, S> Rem<S> for &'a Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the % operator.

fn rem(self, other: S) -> Vector2<S>

Performs the % operation.

impl<S> RemAssign<S> for Vector2<S> where
    S: BaseNum + RemAssign<S>, 

fn rem_assign(&mut self, scalar: S)

Performs the %= operation.

impl<'a, S> Sub<&'a Vector2<S>> for Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the - operator.

fn sub(self, other: &'a Vector2<S>) -> Vector2<S>

Performs the - operation.

impl<'a, 'b, S> Sub<&'a Vector2<S>> for &'b Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the - operator.

fn sub(self, other: &'a Vector2<S>) -> Vector2<S>

Performs the - operation.

impl<S> Sub<Vector2<S>> for Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the - operator.

fn sub(self, other: Vector2<S>) -> Vector2<S>

Performs the - operation.

impl<'a, S> Sub<Vector2<S>> for &'a Vector2<S> where
    S: BaseNum, 

type Output = Vector2<S>

The resulting type after applying the - operator.

fn sub(self, other: Vector2<S>) -> Vector2<S>

Performs the - operation.

impl<S> SubAssign<Vector2<S>> for Vector2<S> where
    S: BaseNum + SubAssign<S>, 

fn sub_assign(&mut self, other: Vector2<S>)

Performs the -= operation.

impl<'a, S> Sum<&'a Vector2<S>> for Vector2<S> where
    S: 'a + BaseNum, 

fn sum<I>(iter: I) -> Vector2<S> where
    I: Iterator<Item = &'a Vector2<S>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<S> Sum<Vector2<S>> for Vector2<S> where
    S: BaseNum, 

fn sum<I>(iter: I) -> Vector2<S> where
    I: Iterator<Item = Vector2<S>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<S> UlpsEq<Vector2<S>> for Vector2<S> where
    S: BaseFloat, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(
    &self,
    other: &Vector2<S>,
    epsilon: <S as AbsDiffEq<S>>::Epsilon,
    max_ulps: u32
) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of [UlpsEq::ulps_eq].

impl<S> VectorSpace for Vector2<S> where
    S: BaseNum, 

type Scalar = S

The associated scalar.

fn lerp(self, other: Self, amount: Self::Scalar) -> Self

Returns the result of linearly interpolating the vector towards other by the specified amount.

impl<S> Zero for Vector2<S> where
    S: BaseNum, 

fn zero() -> Vector2<S>

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: BufferDataType + PrimitiveDataType> BufferDataType for Vector2<T>

impl<S> Copy for Vector2<S> where
    S: Copy, 

impl<S> Eq for Vector2<S> where
    S: Eq, 

impl<S> StructuralEq for Vector2<S>

impl<S> StructuralPartialEq for Vector2<S>

impl<T: TextureDataType + PrimitiveDataType> TextureDataType for Vector2<T>

impl<T: UniformDataType + PrimitiveDataType> UniformDataType for Vector2<T>