[−]Struct gdnative_common::geom::euclid::TypedPoint2D
A 2d Point tagged with a unit.
Fields
x: T
y: T
Methods
impl<T, U> TypedPoint2D<T, U> where
T: Zero + Copy,
T: Zero + Copy,
pub fn origin() -> TypedPoint2D<T, U>
Constructor, setting all components to zero.
pub fn zero() -> TypedPoint2D<T, U>
pub fn to_3d(&self) -> TypedPoint3D<T, U>
Convert into a 3d point.
impl<T, U> TypedPoint2D<T, U>
pub fn new(x: T, y: T) -> TypedPoint2D<T, U>
Constructor taking scalar values directly.
impl<T, U> TypedPoint2D<T, U> where
T: Copy,
T: Copy,
pub fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> TypedPoint2D<T, U>
Constructor taking properly typed Lengths instead of scalar values.
pub fn extend(&self, z: T) -> TypedPoint3D<T, U>
Create a 3d point from this one, using the specified z value.
pub fn to_vector(&self) -> TypedVector2D<T, U>
Cast this point into a vector.
Equivalent to subtracting the origin from this point.
pub fn yx(&self) -> TypedPoint2D<T, U>
Swap x and y.
pub fn x_typed(&self) -> Length<T, U>
Returns self.x as a Length carrying the unit.
pub fn y_typed(&self) -> Length<T, U>
Returns self.y as a Length carrying the unit.
pub fn to_untyped(&self) -> TypedPoint2D<T, UnknownUnit>
Drop the units, preserving only the numeric value.
pub fn from_untyped(p: &TypedPoint2D<T, UnknownUnit>) -> TypedPoint2D<T, U>
Tag a unitless value with units.
pub fn to_array(&self) -> [T; 2]
pub fn to_tuple(&self) -> (T, T)
impl<T, U> TypedPoint2D<T, U> where
T: Copy + Add<T, Output = T>,
T: Copy + Add<T, Output = T>,
pub fn add_size(&self, other: &TypedSize2D<T, U>) -> TypedPoint2D<T, U>
impl<T, U> TypedPoint2D<T, U> where
T: Float,
T: Float,
pub fn min(self, other: TypedPoint2D<T, U>) -> TypedPoint2D<T, U>
pub fn max(self, other: TypedPoint2D<T, U>) -> TypedPoint2D<T, U>
pub fn clamp(
&self,
start: TypedPoint2D<T, U>,
end: TypedPoint2D<T, U>
) -> TypedPoint2D<T, U>
&self,
start: TypedPoint2D<T, U>,
end: TypedPoint2D<T, U>
) -> TypedPoint2D<T, U>
impl<T, U> TypedPoint2D<T, U> where
T: Round,
T: Round,
pub fn round(&self) -> TypedPoint2D<T, U>
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,
T: Ceil,
pub fn ceil(&self) -> TypedPoint2D<T, U>
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,
T: Floor,
pub fn floor(&self) -> TypedPoint2D<T, U>
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,
T: Copy + NumCast,
pub fn cast<NewT>(&self) -> TypedPoint2D<NewT, U> where
NewT: Copy + NumCast,
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.
pub fn try_cast<NewT>(&self) -> Option<TypedPoint2D<NewT, U>> where
NewT: Copy + NumCast,
NewT: Copy + NumCast,
Fallible 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.
pub fn to_f32(&self) -> TypedPoint2D<f32, U>
Cast into an f32
point.
pub fn to_f64(&self) -> TypedPoint2D<f64, U>
Cast into an f64
point.
pub fn to_usize(&self) -> TypedPoint2D<usize, U>
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.
pub fn to_u32(&self) -> TypedPoint2D<u32, U>
Cast into an u32
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.
pub fn to_i32(&self) -> TypedPoint2D<i32, U>
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.
pub fn to_i64(&self) -> TypedPoint2D<i64, U>
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,
T: One + Add<T, Output = T> + Sub<T, Output = T> + Mul<T, Output = T> + Copy,
pub fn lerp(&self, other: TypedPoint2D<T, U>, t: T) -> TypedPoint2D<T, U>
Linearly interpolate between this point and another point.
t
is expected to be between zero and one.
Trait Implementations
impl<T, U> Add<TypedSize2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Add<T, Output = T>,
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>
impl<T, U> Add<TypedVector2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Add<T, Output = T>,
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>
impl<T, U> AddAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Add<T, Output = T>,
T: Copy + Add<T, Output = T>,
fn add_assign(&mut self, other: TypedVector2D<T, U>)
impl<T, U> ApproxEq<TypedPoint2D<T, U>> for TypedPoint2D<T, U> where
T: ApproxEq<T> + Copy,
T: ApproxEq<T> + Copy,
fn approx_epsilon() -> TypedPoint2D<T, U>
fn approx_eq(&self, other: &TypedPoint2D<T, U>) -> bool
fn approx_eq_eps(
&self,
other: &TypedPoint2D<T, U>,
eps: &TypedPoint2D<T, U>
) -> bool
&self,
other: &TypedPoint2D<T, U>,
eps: &TypedPoint2D<T, U>
) -> bool
impl<T, U> Clone for TypedPoint2D<T, U> where
T: Clone,
T: Clone,
fn clone(&self) -> TypedPoint2D<T, U>
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T, U> Copy for TypedPoint2D<T, U> where
T: Copy,
T: Copy,
impl<T, U> Debug for TypedPoint2D<T, U> where
T: Debug,
T: Debug,
impl<T, U> Default for TypedPoint2D<T, U> where
T: Default,
T: Default,
fn default() -> TypedPoint2D<T, U>
impl<T, U> Display for TypedPoint2D<T, U> where
T: Display,
T: Display,
impl<T, U> Div<T> for TypedPoint2D<T, U> where
T: Copy + Div<T, Output = T>,
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>
impl<T, U1, U2> Div<TypedScale<T, U1, U2>> for TypedPoint2D<T, U2> where
T: Copy + Div<T, Output = T>,
T: Copy + Div<T, Output = T>,
type Output = TypedPoint2D<T, U1>
The resulting type after applying the /
operator.
fn div(self, scale: TypedScale<T, U1, U2>) -> TypedPoint2D<T, U1>
impl<T, U> DivAssign<T> for TypedPoint2D<T, U> where
T: Copy + Div<T, Output = T>,
T: Copy + Div<T, Output = T>,
fn div_assign(&mut self, scale: T)
impl<T, U> Eq for TypedPoint2D<T, U> where
T: Eq,
T: Eq,
impl<T, U> From<[T; 2]> for TypedPoint2D<T, U> where
T: Copy,
T: Copy,
fn from(array: [T; 2]) -> TypedPoint2D<T, U>
impl<T, U> From<(T, T)> for TypedPoint2D<T, U> where
T: Copy,
T: Copy,
fn from(tuple: (T, T)) -> TypedPoint2D<T, U>
impl<T, U> From<TypedPoint2D<T, U>> for HomogeneousVector<T, U> where
T: Zero + One,
T: Zero + One,
fn from(p: TypedPoint2D<T, U>) -> HomogeneousVector<T, U>
impl<T, U> Hash for TypedPoint2D<T, U> where
T: Hash,
T: Hash,
fn hash<H>(&self, h: &mut H) where
H: Hasher,
H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T, U> Into<[T; 2]> for TypedPoint2D<T, U> where
T: Copy,
T: Copy,
impl<T, U> Into<(T, T)> for TypedPoint2D<T, U> where
T: Copy,
T: Copy,
impl<T, U> Mul<T> for TypedPoint2D<T, U> where
T: Copy + Mul<T, Output = T>,
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>
impl<T, U1, U2> Mul<TypedScale<T, U1, U2>> for TypedPoint2D<T, U1> where
T: Copy + Mul<T, Output = T>,
T: Copy + Mul<T, Output = T>,
type Output = TypedPoint2D<T, U2>
The resulting type after applying the *
operator.
fn mul(self, scale: TypedScale<T, U1, U2>) -> TypedPoint2D<T, U2>
impl<T, U> MulAssign<T> for TypedPoint2D<T, U> where
T: Copy + Mul<T, Output = T>,
T: Copy + Mul<T, Output = T>,
fn mul_assign(&mut self, scale: T)
impl<T, U> PartialEq<TypedPoint2D<T, U>> for TypedPoint2D<T, U> where
T: PartialEq<T>,
T: PartialEq<T>,
fn eq(&self, other: &TypedPoint2D<T, U>) -> bool
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<T, U> Sub<TypedPoint2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Sub<T, Output = T>,
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>
impl<T, U> Sub<TypedVector2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Sub<T, Output = T>,
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>
impl<T, U> SubAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U> where
T: Copy + Sub<T, Output = T>,
T: Copy + Sub<T, Output = T>,
fn sub_assign(&mut self, other: TypedVector2D<T, U>)
Auto Trait Implementations
impl<T, U> RefUnwindSafe for TypedPoint2D<T, U> where
T: RefUnwindSafe,
U: RefUnwindSafe,
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for TypedPoint2D<T, U> where
T: Send,
U: Send,
T: Send,
U: Send,
impl<T, U> Sync for TypedPoint2D<T, U> where
T: Sync,
U: Sync,
T: Sync,
U: Sync,
impl<T, U> Unpin for TypedPoint2D<T, U> where
T: Unpin,
U: Unpin,
T: Unpin,
U: Unpin,
impl<T, U> UnwindSafe for TypedPoint2D<T, U> where
T: UnwindSafe,
U: UnwindSafe,
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,