Struct geo::Point[−][src]

pub struct Point<T>(pub Coordinate<T>)
 where
    T: CoordinateType;

A single Point in 2D space.

Points can be created using the new(x, y) constructor, or from a Coordinate or pair of points.

use geo_types::{Point, Coordinate};
let p1: Point<f64> = (0., 1.).into();
let c = Coordinate{ x: 10., y: 20.};
let p2: Point<f64> = c.into();

Methods

`impl<T> Point<T> where T: CoordinateType + ToPrimitive,`
[src]

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

Creates a new point.

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);
assert_eq!(p.y(), 2.345);

`pub fn x(&self) -> T`
[src]

Returns the x/horizontal component of the point.

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);

`pub fn set_x(&mut self, x: T) -> &mut Point<T>`
[src]

Sets the x/horizontal component of the point.

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
p.set_x(9.876);

assert_eq!(p.x(), 9.876);

`pub fn y(&self) -> T`
[src]

Returns the y/vertical component of the point.

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.y(), 2.345);

`pub fn set_y(&mut self, y: T) -> &mut Point<T>`
[src]

Sets the y/vertical component of the point.

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
p.set_y(9.876);

assert_eq!(p.y(), 9.876);

`pub fn lng(&self) -> T`
[src]

Returns the longitude/horizontal component of the point.

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.lng(), 1.234);

`pub fn set_lng(&mut self, lng: T) -> &mut Point<T>`
[src]

Sets the longitude/horizontal component of the point.

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
p.set_lng(9.876);

assert_eq!(p.lng(), 9.876);

`pub fn lat(&self) -> T`
[src]

Returns the latitude/vertical component of the point.

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.lat(), 2.345);

`pub fn set_lat(&mut self, lat: T) -> &mut Point<T>`
[src]

Sets the latitude/vertical component of the point.

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
p.set_lat(9.876);

assert_eq!(p.lat(), 9.876);

`pub fn dot(&self, point: &Point<T>) -> T`
[src]

Returns the dot product of the two points: dot = x1 * x2 + y1 * y2

use geo_types::Point;

let p = Point::new(1.5, 0.5);
let dot = p.dot(&Point::new(2.0, 4.5));

assert_eq!(dot, 5.25);

`pub fn cross_prod(&self, point_b: &Point<T>, point_c: &Point<T>) -> T where T: Float,`
[src]

Returns the cross product of 3 points. A positive value implies self → point_b → point_c is counter-clockwise, negative implies clockwise.

Examples

use geo_types::Point;

let p_a = Point::new(1.0, 2.0);
let p_b = Point::new(3.0,5.0);
let p_c = Point::new(7.0,12.0);

let cross = p_a.cross_prod(&p_b, &p_c);

assert_eq!(cross, 2.0)

Trait Implementations

`impl<T> Add<Point<T>> for Point<T> where T: CoordinateType + ToPrimitive,`
[src]

`type Output = Point<T>`

The resulting type after applying the + operator.

`fn add(self, rhs: Point<T>) -> Point<T>`
[src]

Add a point to the given point.

use geo_types::Point;

let p = Point::new(1.25, 2.5) + Point::new(1.5, 2.5);

assert_eq!(p.x(), 2.75);
assert_eq!(p.y(), 5.0);

`impl<T> TwoDimensional for Point<T> where T: Float + SpadeNum + Debug,`
[src]

`impl<T> Sub<Point<T>> for Point<T> where T: CoordinateType + ToPrimitive,`
[src]

`type Output = Point<T>`

The resulting type after applying the - operator.

`fn sub(self, rhs: Point<T>) -> Point<T>`
[src]

Subtract a point from the given point.

use geo_types::Point;

let p = Point::new(1.25, 3.0) - Point::new(1.5, 2.5);

assert_eq!(p.x(), -0.25);
assert_eq!(p.y(), 0.5);

`impl<T> Clone for Point<T> where T: Clone + CoordinateType,`
[src]

`fn clone(&self) -> Point<T>`
[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> Debug for Point<T> where T: Debug + CoordinateType,`
[src]

`fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`
[src]

Formats the value using the given formatter. Read more

`impl<T> Copy for Point<T> where T: Copy + CoordinateType,`
[src]

`impl<T> Neg for Point<T> where T: CoordinateType + Neg<Output = T> + ToPrimitive,`
[src]

`type Output = Point<T>`

The resulting type after applying the - operator.

`fn neg(self) -> Point<T>`
[src]

Returns a point with the x and y components negated.

use geo_types::Point;

let p = -Point::new(-1.25, 2.5);

assert_eq!(p.x(), 1.25);
assert_eq!(p.y(), -2.5);

`impl<T> PartialEq<Point<T>> for Point<T> where T: PartialEq<T> + CoordinateType,`
[src]

`fn eq(&self, other: &Point<T>) -> bool`
[src]

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

`fn ne(&self, other: &Point<T>) -> bool`
[src]

This method tests for !=.

`impl<T> PointN for Point<T> where T: Float + SpadeNum + Debug,`
[src]

`type Scalar = T`

The points's internal scalar type.

`fn dimensions() -> usize`
[src]

The (fixed) number of dimensions of this point type.

`fn from_value(value: <Point<T> as PointN>::Scalar) -> Point<T>`
[src]

Creates a new point with all components set to a certain value.

`fn nth(&self, index: usize) -> &<Point<T> as PointN>::Scalar`
[src]

Returns the nth element of this point.

`fn nth_mut(&mut self, index: usize) -> &mut <Point<T> as PointN>::Scalar`
[src]

Returns a mutable reference to the nth element of this point.

`impl<T> From<Point<T>> for Geometry<T> where T: CoordinateType,`
[src]

`fn from(x: Point<T>) -> Geometry<T>`
[src]

Performs the conversion.

`impl<T> From<(T, T)> for Point<T> where T: CoordinateType,`
[src]

`fn from(coords: (T, T)) -> Point<T>`
[src]

Performs the conversion.

`impl<T> From<Coordinate<T>> for Point<T> where T: CoordinateType,`
[src]

`fn from(x: Coordinate<T>) -> Point<T>`
[src]

Performs the conversion.

`impl<T> From<[T; 2]> for Point<T> where T: CoordinateType,`
[src]

`fn from(coords: [T; 2]) -> Point<T>`
[src]

Performs the conversion.

`impl<T> Centroid<T> for Point<T> where T: Float,`
[src]

`type Output = Point<T>`