Struct nalgebra::Point2

pub struct Point2<N> {
    pub x: N,
    pub y: N,
}

[−] Expand description

Point of dimension 2.

The main differance between a point and a vector is that a vector is not affected by translations.

Fields

x: N

[−] Expand description

First component of the point.

y: N

[−] Expand description

Second component of the point.

Methods

impl<N> Point2<N>

fn new(x: N, y: N) -> Point2<N>[−]

Creates a new vector.

impl<N: Copy> Point2<N>

unsafe fn at_fast(&self, i: usize) -> N[−]

Unsafe read access to a vector element by index.

unsafe fn set_fast(&mut self, i: usize, val: N)[−]

Unsafe write access to a vector element by index.

impl<N> Point2<N>

fn len(&self) -> usize[−]

The dimension of this entity.

impl<N> Point2<N>

fn to_vector(self) -> Vector2<N>[−]

Converts this point to its associated vector.

fn as_vector<'a>(&'a self) -> &'a Vector2<N>[−]

Converts a reference to this point to a reference to its associated vector.

Trait Implementations

impl<N, O: Copy> Rotate<O> for Point2<N>

fn rotate(&self, other: &O) -> O[−]

Applies a rotation to v.

fn inverse_rotate(&self, other: &O) -> O[−]

Applies an inverse rotation to v.

impl<N: Eq> Eq for Point2<N>

impl<N: PartialEq> PartialEq for Point2<N>

fn eq(&self, __arg_0: &Point2<N>) -> bool[−]

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

fn ne(&self, __arg_0: &Point2<N>) -> bool[−]

This method tests for !=.

impl<N: Encodable> Encodable for Point2<N>

fn encode<__SN: Encoder>(&self, __arg_0: &mut __SN) -> Result<(), __SN::Error>

impl<N: Decodable> Decodable for Point2<N>

fn decode<__DN: Decoder>(__arg_0: &mut __DN) -> Result<Point2<N>, __DN::Error>

impl<N: Clone> Clone for Point2<N>

fn clone(&self) -> Point2<N>[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<N: Hash> Hash for Point2<N>

fn hash<__HN: Hasher>(&self, __arg_0: &mut __HN)[−]

Feeds this value into the state given, updating the hasher as necessary.

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

Feeds a slice of this type into the state provided.

impl<N: Debug> Debug for Point2<N>

fn fmt(&self, __arg_0: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<N: Copy> Copy for Point2<N>

impl<N: Zero> Origin for Point2<N>

fn origin() -> Point2<N>[−]

The trivial origin.

fn is_origin(&self) -> bool[−]

Returns true if this points is exactly the trivial origin.

impl<N: BaseFloat> PartialOrder for Point2<N>

fn inf(&self, other: &Point2<N>) -> Point2<N>[−]

Returns the infimum of this value and another

fn sup(&self, other: &Point2<N>) -> Point2<N>[−]

Returns the supremum of this value and another

fn partial_cmp(&self, other: &Point2<N>) -> PartialOrdering[−]

Compare self and other using a partial ordering relation.

fn partial_lt(&self, other: &Point2<N>) -> bool[−]

Returns true iff self and other are comparable and self < other.

fn partial_le(&self, other: &Point2<N>) -> bool[−]

Returns true iff self and other are comparable and self <= other.

fn partial_gt(&self, other: &Point2<N>) -> bool[−]

Returns true iff self and other are comparable and self > other.

fn partial_ge(&self, other: &Point2<N>) -> bool[−]

Returns true iff self and other are comparable and self >= other.

fn partial_min<'a>(&'a self, other: &'a Self) -> Option<&'a Self>[−]

Return the minimum of self and other if they are comparable.

fn partial_max<'a>(&'a self, other: &'a Self) -> Option<&'a Self>[−]

Return the maximum of self and other if they are comparable.

fn partial_clamp<'a>(&'a self, min: &'a Self, max: &'a Self) -> Option<&'a Self>[−]

Clamp value between min and max. Returns None if value is not comparable to min or max.

impl<N: Copy + Mul<N, Output=N>> Mul<N> for Point2<N>

type Output = Point2<N>

The resulting type after applying the * operator

fn mul(self, right: N) -> Point2<N>[−]

The method for the * operator

impl<N: Copy + MulAssign<N>> MulAssign<N> for Point2<N>

fn mul_assign(&mut self, right: N)[−]

The method for the *= operator

impl<N: Copy + Div<N, Output=N>> Div<N> for Point2<N>

type Output = Point2<N>

The resulting type after applying the / operator

fn div(self, right: N) -> Point2<N>[−]

The method for the / operator

impl<N: Copy + DivAssign<N>> DivAssign<N> for Point2<N>

fn div_assign(&mut self, right: N)[−]

The method for the /= operator

impl<N: Copy + Add<N, Output=N>> Add<N> for Point2<N>

type Output = Point2<N>

The resulting type after applying the + operator

fn add(self, right: N) -> Point2<N>[−]

The method for the + operator

impl<N: Copy + AddAssign<N>> AddAssign<N> for Point2<N>

fn add_assign(&mut self, right: N)[−]

The method for the += operator

impl<N: Copy + Sub<N, Output=N>> Sub<N> for Point2<N>

type Output = Point2<N>

The resulting type after applying the - operator

fn sub(self, right: N) -> Point2<N>[−]

The method for the - operator

impl<N: Copy + SubAssign<N>> SubAssign<N> for Point2<N>

fn sub_assign(&mut self, right: N)[−]

The method for the -= operator

impl<Nin: Copy, Nout: Copy + Cast<Nin>> Cast<Point2<Nin>> for Point2<Nout>

fn from(v: Point2<Nin>) -> Point2<Nout>[−]

Converts an element of type T to an element of type Self.

impl<N> AsRef<[N; 2]> for Point2<N>

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

Performs the conversion.

impl<N> AsMut<[N; 2]> for Point2<N>

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

Performs the conversion.

impl<'a, N> From<&'a [N; 2]> for &'a Point2<N>

fn from(arr: &'a [N; 2]) -> &'a Point2<N>[−]

Performs the conversion.

impl<'a, N> From<&'a mut [N; 2]> for &'a mut Point2<N>

fn from(arr: &'a mut [N; 2]) -> &'a mut Point2<N>[−]

Performs the conversion.

impl<'a, N: Clone> From<&'a [N; 2]> for Point2<N>

fn from(arr: &'a [N; 2]) -> Point2<N>[−]

Performs the conversion.

impl<N, T> Index<T> for Point2<N> where [N]: Index<T>

type Output = [N]::Output

The returned type after indexing

fn index(&self, i: T) -> &[N]::Output[−]

The method for the indexing (Foo[Bar]) operation

impl<N, T> IndexMut<T> for Point2<N> where [N]: IndexMut<T>

fn index_mut(&mut self, i: T) -> &mut [N]::Output[−]

The method for the indexing (Foo[Bar]) operation

impl<N> Shape<usize> for Point2<N>

fn shape(&self) -> usize[−]

Returns the shape of an indexable object.

impl<N: Copy> Indexable<usize, N> for Point2<N>

fn swap(&mut self, i1: usize, i2: usize)[−]

Swaps the i-th element of self with its j-th element.

unsafe fn unsafe_at(&self, i: usize) -> N[−]

Reads the i-th element of self.

unsafe fn unsafe_set(&mut self, i: usize, val: N)[−]

Writes to the i-th element of self.

impl<N: Copy> Repeat<N> for Point2<N>

fn repeat(val: N) -> Point2<N>[−]

Creates a new vector with all its components equal to a given value.

impl<N> Dimension for Point2<N>

fn dimension(_: Option<Point2<N>>) -> usize[−]

The dimension of the object.

impl<N> PointAsVector for Point2<N>

type Vector = Vector2<N>

The vector type of the vector space associated to this point's affine space.

fn to_vector(self) -> Vector2<N>[−]

Converts this point to its associated vector.

fn as_vector<'a>(&'a self) -> &'a Vector2<N>[−]

Converts a reference to this point to a reference to its associated vector.

fn set_coords(&mut self, v: Vector2<N>)[−]

Sets the coordinates of this point to match those of a given vector.

impl<N: Copy + Sub<N, Output=N>> Sub<Point2<N>> for Point2<N>

type Output = Vector2<N>

The resulting type after applying the - operator

fn sub(self, right: Point2<N>) -> Vector2<N>[−]

The method for the - operator

impl<N: Neg<Output=N> + Copy> Neg for Point2<N>

type Output = Point2<N>

The resulting type after applying the - operator

fn neg(self) -> Point2<N>[−]

The method for the unary - operator

impl<N: Copy + Add<N, Output=N>> Add<Vector2<N>> for Point2<N>

type Output = Point2<N>

The resulting type after applying the + operator

fn add(self, right: Vector2<N>) -> Point2<N>[−]

The method for the + operator

impl<N: Copy + AddAssign<N>> AddAssign<Vector2<N>> for Point2<N>

fn add_assign(&mut self, right: Vector2<N>)[−]

The method for the += operator

impl<N: Copy + Sub<N, Output=N>> Sub<Vector2<N>> for Point2<N>

type Output = Point2<N>

The resulting type after applying the - operator

fn sub(self, right: Vector2<N>) -> Point2<N>[−]

The method for the - operator

impl<N: Copy + SubAssign<N>> SubAssign<Vector2<N>> for Point2<N>

fn sub_assign(&mut self, right: Vector2<N>)[−]

The method for the -= operator

impl<N: ApproxEq<N>> ApproxEq<N> for Point2<N>

fn approx_epsilon(_: Option<Point2<N>>) -> N[−]

Default epsilon for approximation.

fn approx_ulps(_: Option<Point2<N>>) -> u32[−]

Default ULPs for approximation.

fn approx_eq(&self, other: &Point2<N>) -> bool[−]

Tests approximate equality.

fn approx_eq_eps(&self, other: &Point2<N>, eps: &N) -> bool[−]

Tests approximate equality using a custom epsilon.

fn approx_eq_ulps(&self, other: &Point2<N>, ulps: u32) -> bool[−]

Tests approximate equality using units in the last place (ULPs)

impl<N> FromIterator<N> for Point2<N>

fn from_iter<I: IntoIterator<Item=N>>(iterator: I) -> Point2<N>[−]

Creates a value from an iterator.

impl<N: Bounded> Bounded for Point2<N>

fn max_value() -> Point2<N>[−]

The maximum value.

fn min_value() -> Point2<N>[−]

The minimum value.

impl<N: Axpy<N>> Axpy<N> for Point2<N>

fn axpy(&mut self, a: &N, x: &Point2<N>)[−]

Adds $$a * x$$ to self.

impl<N> Iterable<N> for Point2<N>

fn iter<'l>(&'l self) -> Iter<'l, N>[−]

Gets a vector-like read-only iterator.

impl<N> IterableMut<N> for Point2<N>

fn iter_mut<'l>(&'l mut self) -> IterMut<'l, N>[−]

Gets a vector-like read-write iterator.

impl<N: Copy + One + Zero> ToHomogeneous<Point3<N>> for Point2<N>

fn to_homogeneous(&self) -> Point3<N>[−]

Gets the homogeneous coordinates form of this object.

impl<N: Copy + Div<N, Output=N> + One + Zero> FromHomogeneous<Point3<N>> for Point2<N>

fn from(v: &Point3<N>) -> Point2<N>[−]

Builds an object from its homogeneous coordinate form.

impl<N> NumPoint<N> for Point2<N> where N: BaseNum

impl<N> FloatPoint<N> for Point2<N> where N: BaseFloat + ApproxEq<N>

fn distance_squared(&self, other: &Self) -> N[−]

Computes the square distance between two points.

fn distance(&self, other: &Self) -> N[−]

Computes the distance between two points.

impl<N: Rand> Rand for Point2<N>

fn rand<R: Rng>(rng: &mut R) -> Point2<N>[−]

Generates a random instance of this type using the specified source of randomness.

impl<N: Display> Display for Point2<N>

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<N: BaseNum> Mul<Rotation2<N>> for Point2<N>

type Output = Point2<N>

The resulting type after applying the * operator

fn mul(self, right: Rotation2<N>) -> Point2<N>[−]

The method for the * operator

impl<N: Copy + BaseNum> MulAssign<Rotation2<N>> for Point2<N>

fn mul_assign(&mut self, right: Rotation2<N>)[−]

The method for the *= operator

impl<N: Copy + Mul<N, Output=N> + Add<N, Output=N>> Mul<Matrix2<N>> for Point2<N>

type Output = Point2<N>

The resulting type after applying the * operator

fn mul(self, right: Matrix2<N>) -> Point2<N>[−]

The method for the * operator

impl<N: Copy + Mul<N, Output=N> + Add<N, Output=N>> MulAssign<Matrix2<N>> for Point2<N>

fn mul_assign(&mut self, right: Matrix2<N>)[−]

The method for the *= operator