Struct lyon_core::math::TypedPoint2D
[−]
[src]
#[repr(C)]pub struct TypedPoint2D<T, U> { pub x: T, pub y: T, // some fields omitted }
A 2d Point tagged with a unit.
Fields
x: T
y: T
Methods
impl<T, U> TypedPoint2D<T, U> where
T: Zero + Copy,
[src]
T: Zero + Copy,
fn origin() -> TypedPoint2D<T, U>
[src]
Constructor, setting all components to zero.
fn zero() -> TypedPoint2D<T, U>
[src]
fn to_3d(&self) -> TypedPoint3D<T, U>
[src]
Convert into a 3d point.
impl<T, U> TypedPoint2D<T, U> where
T: Copy,
[src]
T: Copy,
fn new(x: T, y: T) -> TypedPoint2D<T, U>
[src]
Constructor taking scalar values directly.
fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> TypedPoint2D<T, U>
[src]
Constructor taking properly typed Lengths instead of scalar values.
fn extend(&self, z: T) -> TypedPoint3D<T, U>
[src]
Create a 3d point from this one, using the specified z value.
fn to_vector(&self) -> TypedVector2D<T, U>
[src]
Cast this point into a vector.
Equivalent to subtracting the origin from this point.
fn yx(&self) -> TypedPoint2D<T, U>
[src]
Swap x and y.
fn x_typed(&self) -> Length<T, U>
[src]
Returns self.x as a Length carrying the unit.
fn y_typed(&self) -> Length<T, U>
[src]
Returns self.y as a Length carrying the unit.
fn to_untyped(&self) -> TypedPoint2D<T, UnknownUnit>
[src]
Drop the units, preserving only the numeric value.
fn from_untyped(p: &TypedPoint2D<T, UnknownUnit>) -> TypedPoint2D<T, U>
[src]
Tag a unitless value with units.
fn to_array(&self) -> [T; 2]
[src]
impl<T, U> TypedPoint2D<T, U> where
T: Copy + Add<T, Output = T>,
[src]
T: Copy + Add<T, Output = T>,
fn add_size(&self, other: &TypedSize2D<T, U>) -> TypedPoint2D<T, U>
[src]
impl<T, U> TypedPoint2D<T, U> where
T: Float,
[src]
T: Float,
fn min(self, other: TypedPoint2D<T, U>) -> TypedPoint2D<T, U>
[src]
fn max(self, other: TypedPoint2D<T, U>) -> TypedPoint2D<T, U>
[src]
impl<T, U> TypedPoint2D<T, U> where
T: Round,
[src]
T: Round,
fn round(&self) -> TypedPoint2D<T, U>
[src]
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, U> TypedPoint2D<T, U> where
T: Ceil,
[src]
T: Ceil,
fn ceil(&self) -> TypedPoint2D<T, U>
[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).
For example { -0.1, -0.8 }.ceil() == { 0.0, 0.0 }
.
impl<T, U> TypedPoint2D<T, U> where
T: Floor,
[src]
T: Floor,
fn floor(&self) -> TypedPoint2D<T, U>
[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).
For example { -0.1, -0.8 }.floor() == { -1.0, -1.0 }
.
impl<T, U> TypedPoint2D<T, U> where
T: Copy + NumCast,
[src]
T: Copy + NumCast,
fn cast<NewT>(&self) -> Option<TypedPoint2D<NewT, U>> where
NewT: Copy + NumCast,
[src]
NewT: Copy + NumCast,
Cast from one numeric representation to another, preserving the units.
When casting from floating point 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) -> TypedPoint2D<f32, U>
[src]
Cast into an f32
point.
fn to_usize(&self) -> TypedPoint2D<usize, U>
[src]
Cast into an usize
point, truncating decimals if any.
When casting from floating point points, 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) -> TypedPoint2D<i32, U>
[src]
Cast into an i32 point, truncating decimals if any.
When casting from floating point points, 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) -> TypedPoint2D<i64, U>
[src]
Cast into an i64 point, truncating decimals if any.
When casting from floating point points, it is worth considering whether
to round()
, ceil()
or floor()
before the cast in order to obtain
the desired conversion behavior.
impl<T, U> TypedPoint2D<T, U> where
T: One + Add<T, Output = T> + Sub<T, Output = T> + Mul<T, Output = T> + Copy,
[src]
T: One + Add<T, Output = T> + Sub<T, Output = T> + Mul<T, Output = T> + Copy,
fn lerp(&self, other: TypedPoint2D<T, U>, t: T) -> TypedPoint2D<T, U>
[src]
Linearly interpolate between this point and another point.
t
is expected to be between zero and one.
Trait Implementations
impl<T, U> HeapSizeOf for TypedPoint2D<T, U> where
T: HeapSizeOf,
[src]
T: HeapSizeOf,
fn heap_size_of_children(&self) -> usize
[src]
impl<T, U> Hash for TypedPoint2D<T, U> where
T: Hash,
[src]
T: Hash,
fn hash<H>(&self, h: &mut H) where
H: Hasher,
[src]
H: Hasher,
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl<T, U> Copy for TypedPoint2D<T, U> where
T: Copy,
[src]
T: Copy,
impl<T, U> Clone for TypedPoint2D<T, U> where
T: Clone,
[src]
T: Clone,
fn clone(&self) -> TypedPoint2D<T, U>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<T, U> From<[T; 2]> for TypedPoint2D<T, U> where
T: Copy,
[src]
T: Copy,
fn from(array: [T; 2]) -> TypedPoint2D<T, U>
[src]
Performs the conversion.
impl<T, U> Add<TypedVector2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Add<T, Output = T>,
[src]
T: Copy + Add<T, Output = T>,
type Output = TypedPoint2D<T, U>
The resulting type after applying the +
operator.
fn add(self, other: TypedVector2D<T, U>) -> TypedPoint2D<T, U>
[src]
Performs the +
operation.
impl<T, U> Add<TypedSize2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Add<T, Output = T>,
[src]
T: Copy + Add<T, Output = T>,
type Output = TypedPoint2D<T, U>
The resulting type after applying the +
operator.
fn add(self, other: TypedSize2D<T, U>) -> TypedPoint2D<T, U>
[src]
Performs the +
operation.
impl<T, U> PartialEq<TypedPoint2D<T, U>> for TypedPoint2D<T, U> where
T: PartialEq<T>,
[src]
T: PartialEq<T>,
fn eq(&self, other: &TypedPoint2D<T, U>) -> bool
[src]
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[src]
This method tests for !=
.
impl<T, U> Debug for TypedPoint2D<T, U> where
T: Debug,
[src]
T: Debug,
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter.
impl<T, U> AddAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Add<T, Output = T>,
[src]
T: Copy + Add<T, Output = T>,
fn add_assign(&mut self, other: TypedVector2D<T, U>)
[src]
Performs the +=
operation.
impl<T, U> Into<[T; 2]> for TypedPoint2D<T, U> where
T: Copy,
[src]
T: Copy,
impl<T, U> SubAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Sub<T, Output = T>,
[src]
T: Copy + Sub<T, Output = T>,
fn sub_assign(&mut self, other: TypedVector2D<T, U>)
[src]
Performs the -=
operation.
impl<T, U> Serialize for TypedPoint2D<T, U> where
T: Serialize,
[src]
T: Serialize,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
[src]
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
impl<T, U> Div<T> for TypedPoint2D<T, U> where
T: Copy + Div<T, Output = T>,
[src]
T: Copy + Div<T, Output = T>,
type Output = TypedPoint2D<T, U>
The resulting type after applying the /
operator.
fn div(self, scale: T) -> TypedPoint2D<T, U>
[src]
Performs the /
operation.
impl<T, U1, U2> Div<ScaleFactor<T, U1, U2>> for TypedPoint2D<T, U2> where
T: Copy + Div<T, Output = T>,
[src]
T: Copy + Div<T, Output = T>,
type Output = TypedPoint2D<T, U1>
The resulting type after applying the /
operator.
fn div(self, scale: ScaleFactor<T, U1, U2>) -> TypedPoint2D<T, U1>
[src]
Performs the /
operation.
impl<'de, T, U> Deserialize<'de> for TypedPoint2D<T, U> where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<TypedPoint2D<T, U>, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
[src]
deserializer: D
) -> Result<TypedPoint2D<T, U>, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
impl<T, U> Eq for TypedPoint2D<T, U> where
T: Eq,
[src]
T: Eq,
impl<T, U> DivAssign<T> for TypedPoint2D<T, U> where
T: Copy + Div<T, Output = T>,
[src]
T: Copy + Div<T, Output = T>,
fn div_assign(&mut self, scale: T)
[src]
impl<T, U> MulAssign<T> for TypedPoint2D<T, U> where
T: Copy + Mul<T, Output = T>,
[src]
T: Copy + Mul<T, Output = T>,
fn mul_assign(&mut self, scale: T)
[src]
impl<T, U> ApproxEq<TypedPoint2D<T, U>> for TypedPoint2D<T, U> where
T: ApproxEq<T> + Copy,
[src]
T: ApproxEq<T> + Copy,
fn approx_epsilon() -> TypedPoint2D<T, U>
[src]
fn approx_eq(&self, other: &TypedPoint2D<T, U>) -> bool
[src]
fn approx_eq_eps(
&self,
other: &TypedPoint2D<T, U>,
eps: &TypedPoint2D<T, U>
) -> bool
[src]
&self,
other: &TypedPoint2D<T, U>,
eps: &TypedPoint2D<T, U>
) -> bool
impl<T, U> Mul<T> for TypedPoint2D<T, U> where
T: Copy + Mul<T, Output = T>,
[src]
T: Copy + Mul<T, Output = T>,
type Output = TypedPoint2D<T, U>
The resulting type after applying the *
operator.
fn mul(self, scale: T) -> TypedPoint2D<T, U>
[src]
Performs the *
operation.
impl<T, U1, U2> Mul<ScaleFactor<T, U1, U2>> for TypedPoint2D<T, U1> where
T: Copy + Mul<T, Output = T>,
[src]
T: Copy + Mul<T, Output = T>,
type Output = TypedPoint2D<T, U2>
The resulting type after applying the *
operator.
fn mul(self, scale: ScaleFactor<T, U1, U2>) -> TypedPoint2D<T, U2>
[src]
Performs the *
operation.
impl<T, U> Display for TypedPoint2D<T, U> where
T: Display,
[src]
T: Display,
fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter. Read more
impl<T, U> Sub<TypedVector2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Sub<T, Output = T>,
[src]
T: Copy + Sub<T, Output = T>,
type Output = TypedPoint2D<T, U>
The resulting type after applying the -
operator.
fn sub(self, other: TypedVector2D<T, U>) -> TypedPoint2D<T, U>
[src]
Performs the -
operation.
impl<T, U> Sub<TypedPoint2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Sub<T, Output = T>,
[src]
T: Copy + Sub<T, Output = T>,
type Output = TypedVector2D<T, U>
The resulting type after applying the -
operator.
fn sub(self, other: TypedPoint2D<T, U>) -> TypedVector2D<T, U>
[src]
Performs the -
operation.