Struct rin::math::geometry::Point[−][src]

#[repr(C)]
pub struct Point<N, D> where
    N: Scalar,
    D: DimName,
    DefaultAllocator: Allocator<N, D, U1>,  {
    pub coords: Matrix<N, D, U1, <DefaultAllocator as Allocator<N, D, U1>>::Buffer>,
}

A point in an euclidean space.

The difference between a point and a vector is only semantic. See the user guide for details on the distinction. The most notable difference that vectors ignore translations. In particular, an Isometry2 or Isometry3 will transform points by applying a rotation and a translation on them. However, these isometries will only apply rotations to vectors (when doing isometry * vector, the translation part of the isometry is ignored).

Construction

From individual components new…
Swizzling xx, yxz…
Other construction methods origin, from_slice, from_homogeneous…

Transformation

Transforming a point by an Isometry, rotation, etc. can be achieved by multiplication, e.g., isometry * point or rotation * point. Some of these transformation may have some other methods, e.g., isometry.inverse_transform_point(&point). See the documentation of said transformations for details.

Fields

coords: Matrix<N, D, U1, <DefaultAllocator as Allocator<N, D, U1>>::Buffer>

The coordinates of this point, i.e., the shift from the origin.

Implementations

`impl<N, D> Point<N, D> where N: Scalar, D: DimName, DefaultAllocator: Allocator<N, D, U1>,` [src]

`pub fn map<N2, F>(&self, f: F) -> Point<N2, D> where F: FnMut(N) -> N2, N2: Scalar, DefaultAllocator: Allocator<N2, D, U1>,` [src]

Returns a point containing the result of f applied to each of its entries.

Example

let p = Point2::new(1.0, 2.0);
assert_eq!(p.map(|e| e * 10.0), Point2::new(10.0, 20.0));

// This works in any dimension.
let p = Point3::new(1.1, 2.1, 3.1);
assert_eq!(p.map(|e| e as u32), Point3::new(1, 2, 3));

`pub fn apply<F>(&mut self, f: F) where F: FnMut(N) -> N,` [src]

Replaces each component of self by the result of a closure f applied on it.

Example

let mut p = Point2::new(1.0, 2.0);
p.apply(|e| e * 10.0);
assert_eq!(p, Point2::new(10.0, 20.0));

// This works in any dimension.
let mut p = Point3::new(1.0, 2.0, 3.0);
p.apply(|e| e * 10.0);
assert_eq!(p, Point3::new(10.0, 20.0, 30.0));

`pub fn to_homogeneous( &self ) -> Matrix<N, <D as DimNameAdd<U1>>::Output, U1, <DefaultAllocator as Allocator<N, <D as DimNameAdd<U1>>::Output, U1>>::Buffer> where N: One, D: DimNameAdd<U1>, DefaultAllocator: Allocator<N, <D as DimNameAdd<U1>>::Output, U1>,` [src]

Converts this point into a vector in homogeneous coordinates, i.e., appends a 1 at the end of it.

This is the same as .into().

Example

let p = Point2::new(10.0, 20.0);
assert_eq!(p.to_homogeneous(), Vector3::new(10.0, 20.0, 1.0));

// This works in any dimension.
let p = Point3::new(10.0, 20.0, 30.0);
assert_eq!(p.to_homogeneous(), Vector4::new(10.0, 20.0, 30.0, 1.0));

`pub fn from_coordinates( coords: Matrix<N, D, U1, <DefaultAllocator as Allocator<N, D, U1>>::Buffer> ) -> Point<N, D>`[src]

👎 Deprecated:

Use Point::from(vector) instead.

Creates a new point with the given coordinates.

`pub fn len(&self) -> usize`[src]

The dimension of this point.

Example

let p = Point2::new(1.0, 2.0);
assert_eq!(p.len(), 2);

// This works in any dimension.
let p = Point3::new(10.0, 20.0, 30.0);
assert_eq!(p.len(), 3);

`pub fn is_empty(&self) -> bool`[src]

Returns true if the point contains no elements.

Example

let p = Point2::new(1.0, 2.0);
assert!(!p.is_empty());

`pub fn stride(&self) -> usize`[src]

👎 Deprecated:

This methods is no longer significant and will always return 1.

The stride of this point. This is the number of buffer element separating each component of this point.

`pub fn iter( &self ) -> MatrixIter<'_, N, D, U1, <DefaultAllocator as Allocator<N, D, U1>>::Buffer>ⓘNotable traits for MatrixIter<'a, N, R, C, S> impl<'a, N, R, C, S> Iterator for MatrixIter<'a, N, R, C, S> where C: Dim, N: Scalar, R: Dim, S: 'a + Storage<N, R, C>, type Item = &'a N;`[src]

Iterates through this point coordinates.

Example

let p = Point3::new(1.0, 2.0, 3.0);
let mut it = p.iter().cloned();

assert_eq!(it.next(), Some(1.0));
assert_eq!(it.next(), Some(2.0));
assert_eq!(it.next(), Some(3.0));
assert_eq!(it.next(), None);

`pub unsafe fn get_unchecked(&self, i: usize) -> &N`[src]

Gets a reference to i-th element of this point without bound-checking.

`pub fn iter_mut( &mut self ) -> MatrixIterMut<'_, N, D, U1, <DefaultAllocator as Allocator<N, D, U1>>::Buffer>ⓘNotable traits for MatrixIterMut<'a, N, R, C, S> impl<'a, N, R, C, S> Iterator for MatrixIterMut<'a, N, R, C, S> where C: Dim, N: Scalar, R: Dim, S: 'a + StorageMut<N, R, C>, type Item = &'a mut N;`[src]

Mutably iterates through this point coordinates.

Example

let mut p = Point3::new(1.0, 2.0, 3.0);

for e in p.iter_mut() {
    *e *= 10.0;
}

assert_eq!(p, Point3::new(10.0, 20.0, 30.0));

`pub unsafe fn get_unchecked_mut(&mut self, i: usize) -> &mut N`[src]

Gets a mutable reference to i-th element of this point without bound-checking.

`pub unsafe fn swap_unchecked(&mut self, i1: usize, i2: usize)`[src]

Swaps two entries without bound-checking.

`impl<N, D> Point<N, D> where N: Scalar + SimdPartialOrd, D: DimName, DefaultAllocator: Allocator<N, D, U1>,` [src]

`pub fn inf(&self, other: &Point<N, D>) -> Point<N, D>`[src]

Computes the infimum (aka. componentwise min) of two points.

`pub fn sup(&self, other: &Point<N, D>) -> Point<N, D>`[src]

Computes the supremum (aka. componentwise max) of two points.

`pub fn inf_sup(&self, other: &Point<N, D>) -> (Point<N, D>, Point<N, D>)`[src]

Computes the (infimum, supremum) of two points.

`impl<N, D> Point<N, D> where N: Scalar, D: DimName, DefaultAllocator: Allocator<N, D, U1>,` [src]

Other construction methods

`pub unsafe fn new_uninitialized() -> Point<N, D>`[src]

Creates a new point with uninitialized coordinates.

`pub fn origin() -> Point<N, D> where N: Zero,` [src]

Creates a new point with all coordinates equal to zero.

Example

// This works in any dimension.
// The explicit crate::<f32> type annotation may not always be needed,
// depending on the context of type inference.
let pt = Point2::<f32>::origin();
assert!(pt.x == 0.0 && pt.y == 0.0);

let pt = Point3::<f32>::origin();
assert!(pt.x == 0.0 && pt.y == 0.0 && pt.z == 0.0);

`pub fn from_slice(components: &[N]) -> Point<N, D>`[src]

Creates a new point from a slice.

Example

let data = [ 1.0, 2.0, 3.0 ];

let pt = Point2::from_slice(&data[..2]);
assert_eq!(pt, Point2::new(1.0, 2.0));

let pt = Point3::from_slice(&data);
assert_eq!(pt, Point3::new(1.0, 2.0, 3.0));

`pub fn from_homogeneous( v: Matrix<N, <D as DimNameAdd<U1>>::Output, U1, <DefaultAllocator as Allocator<N, <D as DimNameAdd<U1>>::Output, U1>>::Buffer> ) -> Option<Point<N, D>> where N: Scalar + Zero + One + ClosedDiv<N>, D: DimNameAdd<U1>, DefaultAllocator: Allocator<N, <D as DimNameAdd<U1>>::Output, U1>,` [src]

Creates a new point from its homogeneous vector representation.

In practice, this builds a D-dimensional points with the same first D component as v divided by the last component of v. Returns None if this divisor is zero.

Example


let coords = Vector4::new(1.0, 2.0, 3.0, 1.0);
let pt = Point3::from_homogeneous(coords);
assert_eq!(pt, Some(Point3::new(1.0, 2.0, 3.0)));

// All component of the result will be divided by the
// last component of the vector, here 2.0.
let coords = Vector4::new(1.0, 2.0, 3.0, 2.0);
let pt = Point3::from_homogeneous(coords);
assert_eq!(pt, Some(Point3::new(0.5, 1.0, 1.5)));

// Fails because the last component is zero.
let coords = Vector4::new(1.0, 2.0, 3.0, 0.0);
let pt = Point3::from_homogeneous(coords);
assert!(pt.is_none());

// Works also in other dimensions.
let coords = Vector3::new(1.0, 2.0, 1.0);
let pt = Point2::from_homogeneous(coords);
assert_eq!(pt, Some(Point2::new(1.0, 2.0)));

`impl<N> Point<N, U1> where N: Scalar,` [src]

Construction from individual components

`pub fn new(x: N) -> Point<N, U1>`[src]

Initializes this point from its components.

Example

let p = Point1::new(1.0);
assert_eq!(p.x, 1.0);