Struct euclid::TypedVector2D
[−]
[src]
#[repr(C)]pub struct TypedVector2D<T, U> { pub x: T, pub y: T, // some fields omitted }
A 2d Vector tagged with a unit.
Fields
x: T
y: T
Methods
impl<T: Copy + Zero, U> TypedVector2D<T, U>
[src]
fn zero() -> Self
Constructor, setting all components to zero.
fn to_3d(&self) -> TypedVector3D<T, U>
Convert into a 3d vector.
impl<T: Copy, U> TypedVector2D<T, U>
[src]
fn new(x: T, y: T) -> Self
Constructor taking scalar values directly.
fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> Self
Constructor taking properly typed Lengths instead of scalar values.
fn extend(&self, z: T) -> TypedVector3D<T, U>
Create a 3d vector from this one, using the specified z value.
fn to_point(&self) -> TypedPoint2D<T, U>
Cast this vector into a point.
Equivalent to adding this vector to the origin.
fn to_size(&self) -> TypedSize2D<T, U>
Cast this vector into a size.
fn x_typed(&self) -> Length<T, U>
Returns self.x as a Length carrying the unit.
fn y_typed(&self) -> Length<T, U>
Returns self.y as a Length carrying the unit.
fn to_untyped(&self) -> Vector2D<T>
Drop the units, preserving only the numeric value.
fn from_untyped(p: &Vector2D<T>) -> Self
Tag a unitless value with units.
fn to_array(&self) -> [T; 2]
impl<T, U> TypedVector2D<T, U> where
T: Copy + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T>,
[src]
T: Copy + Mul<T, Output = T> + Add<T, Output = T> + Sub<T, Output = T>,
fn dot(self, other: Self) -> T
Dot product.
fn cross(self, other: Self) -> T
Returns the norm of the cross product [self.x, self.y, 0] x [other.x, other.y, 0]..
fn normalize(self) -> Self where
T: Float + ApproxEq<T>,
T: Float + ApproxEq<T>,
fn square_length(&self) -> T
fn length(&self) -> T where
T: Float + ApproxEq<T>,
T: Float + ApproxEq<T>,
impl<T, U> TypedVector2D<T, U> where
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
[src]
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
fn lerp(&self, other: Self, t: T) -> Self
Linearly interpolate between this vector and another vector.
t
is expected to be between zero and one.
impl<T: Float, U> TypedVector2D<T, U>
[src]
impl<T: Round, U> TypedVector2D<T, U>
[src]
fn round(&self) -> Self
Rounds each component to the nearest integer value.
This behavior is preserved for negative values (unlike the basic cast).
For example { -0.1, -0.8 }.round() == { 0.0, -1.0 }
.
impl<T: Ceil, U> TypedVector2D<T, U>
[src]
fn ceil(&self) -> Self
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).
For example { -0.1, -0.8 }.ceil() == { 0.0, 0.0 }
.
impl<T: Floor, U> TypedVector2D<T, U>
[src]
fn floor(&self) -> Self
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).
For example { -0.1, -0.8 }.floor() == { -1.0, -1.0 }
.
impl<T: NumCast + Copy, U> TypedVector2D<T, U>
[src]
fn cast<NewT: NumCast + Copy>(&self) -> Option<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.
fn to_f32(&self) -> TypedVector2D<f32, U>
Cast into an f32
vector.
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.
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.
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.
Trait Implementations
impl<T: Clone, U> Clone for TypedVector2D<T, U>
[src]
fn clone(&self) -> Self
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl<T: Copy, U> Copy for TypedVector2D<T, U>
[src]
impl<T, U> HeapSizeOf for TypedVector2D<T, U> where
T: HeapSizeOf,
[src]
T: HeapSizeOf,
fn heap_size_of_children(&self) -> usize
Measure the size of any heap-allocated structures that hang off this value, but not the space taken up by the value itself (i.e. what size_of:: measures, more or less); that space is handled by the implementation of HeapSizeOf for Box below. Read more
impl<T, U> Deserialize for TypedVector2D<T, U> where
T: Deserialize,
[src]
T: Deserialize,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer,
D: Deserializer,
Deserialize this value from the given Serde deserializer. Read more
impl<T, U> Serialize for TypedVector2D<T, U> where
T: Serialize,
[src]
T: Serialize,
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<T, U> Eq for TypedVector2D<T, U> where
T: Eq,
[src]
T: Eq,
impl<T, U> PartialEq for TypedVector2D<T, U> where
T: PartialEq,
[src]
T: PartialEq,
fn eq(&self, other: &Self) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0
This method tests for !=
.
impl<T, U> Hash for TypedVector2D<T, U> where
T: Hash,
[src]
T: Hash,
fn hash<H: Hasher>(&self, h: &mut H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl<T: Debug, U> Debug for TypedVector2D<T, U>
[src]
impl<T: Display, U> Display for TypedVector2D<T, U>
[src]
fn fmt(&self, formatter: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<T: Copy + Add<T, Output = T>, U> Add for TypedVector2D<T, U>
[src]
type Output = Self
The resulting type after applying the +
operator
fn add(self, other: Self) -> Self
The method for the +
operator
impl<T: Copy + Add<T, Output = T>, U> AddAssign for TypedVector2D<T, U>
[src]
fn add_assign(&mut self, other: Self)
The method for the +=
operator
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Self> for TypedVector2D<T, U>
[src]
fn sub_assign(&mut self, other: Self)
The method for the -=
operator
impl<T: Copy + Sub<T, Output = T>, U> Sub for TypedVector2D<T, U>
[src]
type Output = Self
The resulting type after applying the -
operator
fn sub(self, other: Self) -> Self
The method for the -
operator
impl<T: Copy + Neg<Output = T>, U> Neg for TypedVector2D<T, U>
[src]
type Output = Self
The resulting type after applying the -
operator
fn neg(self) -> Self
The method for the unary -
operator
impl<T: Copy + Mul<T, Output = T>, U> Mul<T> for TypedVector2D<T, U>
[src]
type Output = Self
The resulting type after applying the *
operator
fn mul(self, scale: T) -> Self
The method for the *
operator
impl<T: Copy + Div<T, Output = T>, U> Div<T> for TypedVector2D<T, U>
[src]
type Output = Self
The resulting type after applying the /
operator
fn div(self, scale: T) -> Self
The method for the /
operator
impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for TypedVector2D<T, U>
[src]
fn mul_assign(&mut self, scale: T)
The method for the *=
operator
impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for TypedVector2D<T, U>
[src]
fn div_assign(&mut self, scale: T)
The method for the /=
operator
impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<ScaleFactor<T, U1, U2>> for TypedVector2D<T, U1>
[src]
type Output = TypedVector2D<T, U2>
The resulting type after applying the *
operator
fn mul(self, scale: ScaleFactor<T, U1, U2>) -> TypedVector2D<T, U2>
The method for the *
operator
impl<T: Copy + Div<T, Output = T>, U1, U2> Div<ScaleFactor<T, U1, U2>> for TypedVector2D<T, U2>
[src]
type Output = TypedVector2D<T, U1>
The resulting type after applying the /
operator
fn div(self, scale: ScaleFactor<T, U1, U2>) -> TypedVector2D<T, U1>
The method for the /
operator