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::{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]
T: CoordinateType + ToPrimitive,
pub fn new(x: T, y: T) -> Point<T>
[src]
Creates a new point.
use geo::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::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::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::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::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::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::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::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::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::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]
T: Float,
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::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: PartialEq> PartialEq for Point<T> where
T: CoordinateType,
[src]
T: CoordinateType,
fn eq(&self, __arg_0: &Point<T>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Point<T>) -> bool
[src]
This method tests for !=
.
impl<T: Clone> Clone for Point<T> where
T: CoordinateType,
[src]
T: CoordinateType,
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: Copy> Copy for Point<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T: Debug> Debug for Point<T> where
T: CoordinateType,
[src]
T: CoordinateType,
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<T: CoordinateType> From<Coordinate<T>> for Point<T>
[src]
fn from(x: Coordinate<T>) -> Point<T>
[src]
Performs the conversion.
impl<T: CoordinateType> From<(T, T)> for Point<T>
[src]
impl<T> Neg for Point<T> where
T: CoordinateType + Neg<Output = T> + ToPrimitive,
[src]
T: CoordinateType + Neg<Output = T> + ToPrimitive,
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::Point; let p = -Point::new(-1.25, 2.5); assert_eq!(p.x(), 1.25); assert_eq!(p.y(), -2.5);
impl<T> Add for Point<T> where
T: CoordinateType + ToPrimitive,
[src]
T: CoordinateType + ToPrimitive,
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::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> Sub for Point<T> where
T: CoordinateType + ToPrimitive,
[src]
T: CoordinateType + ToPrimitive,
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::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> PointN for Point<T> where
T: Float + SpadeNum + Debug,
[src]
T: Float + SpadeNum + Debug,
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: Self::Scalar) -> Self
[src]
Creates a new point with all components set to a certain value.
fn nth(&self, index: usize) -> &Self::Scalar
[src]
Returns the nth element of this point.
fn nth_mut(&mut self, index: usize) -> &mut Self::Scalar
[src]
Returns a mutable reference to the nth element of this point.
impl<T> TwoDimensional for Point<T> where
T: Float + SpadeNum + Debug,
[src]
T: Float + SpadeNum + Debug,
impl<T: CoordinateType> From<Point<T>> for Geometry<T>
[src]
impl<T> Centroid<T> for Point<T> where
T: Float,
[src]
T: Float,
type Output = Point<T>
fn centroid(&self) -> Self::Output
[src]
See: https://en.wikipedia.org/wiki/Centroid Read more
impl<T> Contains<Point<T>> for Point<T> where
T: Float + ToPrimitive,
[src]
T: Float + ToPrimitive,
fn contains(&self, p: &Point<T>) -> bool
[src]
Checks if the geometry A is completely inside the B geometry. Read more
impl<T> Contains<Point<T>> for LineString<T> where
T: Float,
[src]
T: Float,
fn contains(&self, p: &Point<T>) -> bool
[src]
Checks if the geometry A is completely inside the B geometry. Read more
impl<T> Contains<Point<T>> for Line<T> where
T: Float,
[src]
T: Float,
fn contains(&self, p: &Point<T>) -> bool
[src]
Checks if the geometry A is completely inside the B geometry. Read more
impl<T> Contains<Point<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
fn contains(&self, p: &Point<T>) -> bool
[src]
Checks if the geometry A is completely inside the B geometry. Read more
impl<T> Contains<Point<T>> for MultiPolygon<T> where
T: Float,
[src]
T: Float,
fn contains(&self, p: &Point<T>) -> bool
[src]
Checks if the geometry A is completely inside the B geometry. Read more
impl<T> Contains<Point<T>> for Bbox<T> where
T: CoordinateType,
[src]
T: CoordinateType,
fn contains(&self, p: &Point<T>) -> bool
[src]
Checks if the geometry A is completely inside the B geometry. Read more
impl<T> Intersects<Point<T>> for Line<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, p: &Point<T>) -> bool
[src]
Checks if the geometry A intersects the geometry B. Read more
impl<T> Intersects<Line<T>> for Point<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, line: &Line<T>) -> bool
[src]
Checks if the geometry A intersects the geometry B. Read more
impl<T> Bearing<T> for Point<T> where
T: Float + FromPrimitive,
[src]
T: Float + FromPrimitive,
fn bearing(&self, point: Point<T>) -> T
[src]
Returns the bearing to another Point in degrees, where North is 0° and East is 45°. Read more
impl<T> Distance<T, Point<T>> for Point<T> where
T: Float,
[src]
T: Float,
impl<T> Distance<T, MultiPoint<T>> for Point<T> where
T: Float,
[src]
T: Float,
fn distance(&self, points: &MultiPoint<T>) -> T
[src]
Minimum distance from a Point to a MultiPoint
impl<T> Distance<T, Point<T>> for MultiPoint<T> where
T: Float,
[src]
T: Float,
impl<T> Distance<T, Polygon<T>> for Point<T> where
T: Float,
[src]
T: Float,
impl<T> Distance<T, Point<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
impl<T> Distance<T, MultiPolygon<T>> for Point<T> where
T: Float,
[src]
T: Float,
fn distance(&self, mpolygon: &MultiPolygon<T>) -> T
[src]
Minimum distance from a Point to a MultiPolygon
impl<T> Distance<T, Point<T>> for MultiPolygon<T> where
T: Float,
[src]
T: Float,
impl<T> Distance<T, MultiLineString<T>> for Point<T> where
T: Float,
[src]
T: Float,
fn distance(&self, mls: &MultiLineString<T>) -> T
[src]
Minimum distance from a Point to a MultiLineString
impl<T> Distance<T, Point<T>> for MultiLineString<T> where
T: Float,
[src]
T: Float,
impl<T> Distance<T, LineString<T>> for Point<T> where
T: Float,
[src]
T: Float,
fn distance(&self, linestring: &LineString<T>) -> T
[src]
Minimum distance from a Point to a LineString
impl<T> Distance<T, Point<T>> for LineString<T> where
T: Float,
[src]
T: Float,
impl<T> Distance<T, Point<T>> for Line<T> where
T: Float,
[src]
T: Float,
impl<T> Distance<T, Line<T>> for Point<T> where
T: Float,
[src]
T: Float,
impl<T> HaversineDestination<T> for Point<T> where
T: Float + FromPrimitive,
[src]
T: Float + FromPrimitive,
fn haversine_destination(&self, bearing: T, distance: T) -> Point<T>
[src]
Returns a new Point using distance to the existing Point and a bearing for the direction Read more
impl<T> HaversineDistance<T, Point<T>> for Point<T> where
T: Float + FromPrimitive,
[src]
T: Float + FromPrimitive,
fn haversine_distance(&self, rhs: &Point<T>) -> T
[src]
Returns the Haversine distance between two points: Read more
impl<T> Rotate<T> for Point<T> where
T: Float,
[src]
T: Float,
fn rotate(&self, angle: T) -> Self
[src]
Rotate the Point about itself by the given number of degrees This operation leaves the point coordinates unchanged
impl<T: CoordinateType, NT: CoordinateType> MapCoords<T, NT> for Point<T>
[src]
type Output = Point<NT>
fn map_coords(&self, func: &Fn(&(T, T)) -> (NT, NT)) -> Self::Output
[src]
Apply a function to all the coordinates in a geometric object, returning a new object. Read more
impl<T: CoordinateType> MapCoordsInplace<T> for Point<T>
[src]
fn map_coords_inplace(&mut self, func: &Fn(&(T, T)) -> (T, T))
[src]
Apply a function to all the coordinates in a geometric object, in place Read more
impl<F: Float> ClosestPoint<F> for Point<F>
[src]
fn closest_point(&self, p: &Self) -> Closest<F>
[src]
Find the closest point between self
and p
.
impl<'a, T> FromPostgis<&'a T> for Point<f64> where
T: Point,
[src]
T: Point,
fn from_postgis(pt: &'a T) -> Self
[src]
impl ToPostgis<Point> for Point<f64>
[src]
fn to_postgis_with_srid(&self, srid: Option<i32>) -> Point
[src]
Converts this geometry to a PostGIS type, using the supplied SRID.
fn to_postgis_wgs84(&self) -> T
[src]
Converts this WGS84 geometry to a PostGIS type.