2013-06-16 07:34:09 +00:00
|
|
|
// Copyright 2013 The Lmath Developers. For a full listing of the authors,
|
|
|
|
// refer to the AUTHORS file at the top-level directory of this distribution.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
2013-07-11 04:59:18 +00:00
|
|
|
//! Coordinate vectors for positional data
|
|
|
|
//!
|
|
|
|
//! These types differ from the vector types implemented in `core::vec` because
|
|
|
|
//! they describe coordinates in geometric space and not a magnitude and a
|
|
|
|
//! direction. All positional data throughout the library uses these point
|
|
|
|
//! types, which allows for a clear, self-documenting API.
|
|
|
|
|
2013-07-08 08:17:36 +00:00
|
|
|
use std::cast;
|
|
|
|
|
2013-07-11 05:14:32 +00:00
|
|
|
use core::{Mat2, Mat3, Quat, Vec2, Vec3, Vec4};
|
2013-07-11 04:49:14 +00:00
|
|
|
|
2013-06-16 07:34:09 +00:00
|
|
|
/// A geometric point
|
2013-07-11 04:49:14 +00:00
|
|
|
pub trait Point<T, Vec>: Eq
|
|
|
|
+ Add<Vec, Self>
|
|
|
|
+ Sub<Self, Vec>
|
|
|
|
+ Mul<Vec, Self>
|
|
|
|
+ ApproxEq<T>
|
|
|
|
+ ToStr {
|
2013-07-11 01:45:21 +00:00
|
|
|
pub fn as_vec<'a>(&'a self) -> &'a Vec;
|
|
|
|
pub fn as_mut_vec<'a>(&'a mut self) -> &'a mut Vec;
|
2013-07-08 08:17:36 +00:00
|
|
|
|
2013-07-11 01:45:21 +00:00
|
|
|
pub fn translate(&self, offset: &Vec) -> Self;
|
2013-07-11 02:19:29 +00:00
|
|
|
pub fn scale(&self, factor: &Vec) -> Self;
|
|
|
|
pub fn distance2(&self, other: &Self) -> T;
|
2013-06-16 07:34:09 +00:00
|
|
|
pub fn distance(&self, other: &Self) -> T;
|
2013-07-11 02:19:29 +00:00
|
|
|
pub fn direction(&self, other: &Self) -> Vec;
|
2013-06-16 07:34:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// A two-dimensional point
|
2013-06-29 06:38:55 +00:00
|
|
|
#[deriving(Clone, Eq)]
|
2013-07-08 08:17:36 +00:00
|
|
|
pub struct Point2<T> { x: T, y: T }
|
2013-06-16 07:34:09 +00:00
|
|
|
|
2013-07-12 01:22:14 +00:00
|
|
|
impl_approx!(Point2 { x, y })
|
|
|
|
|
2013-07-11 04:49:14 +00:00
|
|
|
impl<T:Num> Point2<T> {
|
2013-07-08 08:17:36 +00:00
|
|
|
#[inline]
|
2013-06-16 07:34:09 +00:00
|
|
|
pub fn new(x: T, y: T) -> Point2<T> {
|
2013-07-08 08:17:36 +00:00
|
|
|
Point2 { x: x, y: y }
|
2013-06-16 07:34:09 +00:00
|
|
|
}
|
|
|
|
|
2013-07-08 08:17:36 +00:00
|
|
|
#[inline]
|
|
|
|
pub fn from_vec(vec: Vec2<T>) -> Point2<T> {
|
|
|
|
unsafe { cast::transmute(vec) }
|
|
|
|
}
|
2013-07-11 04:49:14 +00:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn origin() -> Point2<T> {
|
|
|
|
Point2::new(zero!(T), zero!(T))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-07-11 05:14:32 +00:00
|
|
|
impl<T:Clone + Num> Point2<T> {
|
|
|
|
/// Converts the point to a three-dimensional homogeneous vector:
|
|
|
|
/// `[x, y] -> [x, y, 1]`
|
|
|
|
#[inline]
|
|
|
|
pub fn to_vec3(&self) -> Vec3<T> {
|
|
|
|
Vec3::new((*self).x.clone(),
|
|
|
|
(*self).y.clone(),
|
|
|
|
one!(T))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-07-11 04:49:14 +00:00
|
|
|
impl<T:Clone + Float> Point2<T> {
|
|
|
|
#[inline]
|
|
|
|
pub fn rotate_t(&self, radians: &T) -> Point2<T> {
|
|
|
|
Point2::new((*self).x.cos() * (*radians),
|
|
|
|
(*self).y.sin() * (*radians))
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn rotate_m(&self, mat: &Mat2<T>) -> Point2<T> {
|
|
|
|
Point2::from_vec(mat.mul_v(self.as_vec()))
|
|
|
|
}
|
2013-07-11 01:45:21 +00:00
|
|
|
}
|
2013-07-08 08:17:36 +00:00
|
|
|
|
2013-07-11 04:49:14 +00:00
|
|
|
impl<T:Clone + Float> Point<T, Vec2<T>> for Point2<T> {
|
2013-07-08 08:17:36 +00:00
|
|
|
#[inline]
|
|
|
|
pub fn as_vec<'a>(&'a self) -> &'a Vec2<T> {
|
|
|
|
unsafe { cast::transmute(self) }
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn as_mut_vec<'a>(&'a mut self) -> &'a mut Vec2<T> {
|
|
|
|
unsafe { cast::transmute(self) }
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
2013-06-16 07:34:09 +00:00
|
|
|
pub fn translate(&self, offset: &Vec2<T>) -> Point2<T> {
|
2013-07-11 02:19:29 +00:00
|
|
|
(*self) + (*offset)
|
2013-07-11 01:45:21 +00:00
|
|
|
}
|
|
|
|
|
2013-07-11 02:19:29 +00:00
|
|
|
#[inline]
|
|
|
|
pub fn scale(&self, factor: &Vec2<T>) -> Point2<T> {
|
|
|
|
(*self) * (*factor)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn distance2(&self, other: &Point2<T>) -> T {
|
|
|
|
((*other) - (*self)).length2()
|
2013-06-16 07:34:09 +00:00
|
|
|
}
|
|
|
|
|
2013-07-11 23:18:05 +00:00
|
|
|
/// Returns the scalar distance to the other point
|
2013-07-08 08:17:36 +00:00
|
|
|
#[inline]
|
2013-06-16 07:34:09 +00:00
|
|
|
pub fn distance(&self, other: &Point2<T>) -> T {
|
2013-07-11 02:19:29 +00:00
|
|
|
other.distance2(self).sqrt()
|
|
|
|
}
|
|
|
|
|
2013-07-11 23:18:05 +00:00
|
|
|
/// Returns a normalized direction vector pointing to the other point
|
2013-07-11 02:19:29 +00:00
|
|
|
#[inline]
|
|
|
|
pub fn direction(&self, other: &Point2<T>) -> Vec2<T> {
|
|
|
|
((*other) - (*self)).normalize()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<T:Num> Add<Vec2<T>, Point2<T>> for Point2<T> {
|
|
|
|
fn add(&self, other: &Vec2<T>) -> Point2<T> {
|
|
|
|
Point2::new((*self).x + (*other).x,
|
|
|
|
(*self).y + (*other).y)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<T:Num> Sub<Point2<T>, Vec2<T>> for Point2<T> {
|
|
|
|
fn sub(&self, other: &Point2<T>) -> Vec2<T> {
|
|
|
|
Vec2::new((*self).x - (*other).x,
|
|
|
|
(*self).y - (*other).y)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<T:Num> Mul<Vec2<T>, Point2<T>> for Point2<T> {
|
|
|
|
fn mul(&self, scale: &Vec2<T>) -> Point2<T> {
|
|
|
|
Point2::new((*self).x * (*scale).x,
|
|
|
|
(*self).y * (*scale).y)
|
2013-06-16 07:34:09 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<T> ToStr for Point2<T> {
|
|
|
|
pub fn to_str(&self) -> ~str {
|
|
|
|
fmt!("[%?, %?]", self.x, self.y)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-07-08 07:00:38 +00:00
|
|
|
#[cfg(test)]
|
|
|
|
mod test_point2 {
|
|
|
|
use geom::point::*;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_to_str() {
|
|
|
|
assert_eq!(Point2::new(1, 2).to_str(), ~"[1, 2]");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-06-16 07:34:09 +00:00
|
|
|
/// A three-dimensional point
|
2013-06-29 06:38:55 +00:00
|
|
|
#[deriving(Clone, Eq)]
|
2013-07-08 08:17:36 +00:00
|
|
|
pub struct Point3<T> { x: T, y: T, z: T }
|
2013-06-16 07:34:09 +00:00
|
|
|
|
2013-07-12 01:22:14 +00:00
|
|
|
impl_approx!(Point3 { x, y, z })
|
|
|
|
|
2013-07-11 04:49:14 +00:00
|
|
|
impl<T:Num> Point3<T> {
|
2013-07-08 08:17:36 +00:00
|
|
|
#[inline]
|
2013-06-16 07:34:09 +00:00
|
|
|
pub fn new(x: T, y: T, z: T) -> Point3<T> {
|
2013-07-08 08:17:36 +00:00
|
|
|
Point3 { x: x, y: y, z: z }
|
2013-06-16 07:34:09 +00:00
|
|
|
}
|
|
|
|
|
2013-07-08 08:17:36 +00:00
|
|
|
#[inline]
|
|
|
|
pub fn from_vec(vec: Vec3<T>) -> Point3<T> {
|
|
|
|
unsafe { cast::transmute(vec) }
|
|
|
|
}
|
2013-07-11 04:49:14 +00:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn origin() -> Point3<T> {
|
|
|
|
Point3::new(zero!(T), zero!(T), zero!(T))
|
|
|
|
}
|
2013-07-11 01:45:21 +00:00
|
|
|
}
|
2013-07-08 08:17:36 +00:00
|
|
|
|
2013-07-11 05:14:32 +00:00
|
|
|
impl<T:Clone + Num> Point3<T> {
|
|
|
|
/// Converts the point to a four-dimensional homogeneous vector:
|
|
|
|
/// `[x, y, z] -> [x, y, z, 1]`
|
|
|
|
#[inline]
|
|
|
|
pub fn to_vec4(&self) -> Vec4<T> {
|
|
|
|
Vec4::new((*self).x.clone(),
|
|
|
|
(*self).y.clone(),
|
|
|
|
(*self).z.clone(),
|
|
|
|
one!(T))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-07-11 04:49:14 +00:00
|
|
|
impl<T:Clone + Float> Point3<T> {
|
|
|
|
#[inline]
|
|
|
|
pub fn rotate_q(&self, quat: &Quat<T>) -> Point3<T> {
|
|
|
|
Point3::from_vec(quat.mul_v(self.as_vec()))
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn rotate_m(&self, mat: &Mat3<T>) -> Point3<T> {
|
|
|
|
Point3::from_vec(mat.mul_v(self.as_vec()))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<T:Clone + Float> Point<T, Vec3<T>> for Point3<T> {
|
2013-07-08 08:17:36 +00:00
|
|
|
#[inline]
|
|
|
|
pub fn as_vec<'a>(&'a self) -> &'a Vec3<T> {
|
|
|
|
unsafe { cast::transmute(self) }
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn as_mut_vec<'a>(&'a mut self) -> &'a mut Vec3<T> {
|
|
|
|
unsafe { cast::transmute(self) }
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
2013-06-16 07:34:09 +00:00
|
|
|
pub fn translate(&self, offset: &Vec3<T>) -> Point3<T> {
|
2013-07-11 02:19:29 +00:00
|
|
|
(*self) + (*offset)
|
2013-07-11 01:45:21 +00:00
|
|
|
}
|
|
|
|
|
2013-07-11 02:19:29 +00:00
|
|
|
#[inline]
|
|
|
|
pub fn scale(&self, factor: &Vec3<T>) -> Point3<T> {
|
|
|
|
(*self) * (*factor)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn distance2(&self, other: &Point3<T>) -> T {
|
|
|
|
((*other) - (*self)).length2()
|
|
|
|
}
|
|
|
|
|
2013-07-11 23:18:05 +00:00
|
|
|
/// Returns the scalar distance to the other point
|
2013-07-08 08:17:36 +00:00
|
|
|
#[inline]
|
2013-06-16 07:34:09 +00:00
|
|
|
pub fn distance(&self, other: &Point3<T>) -> T {
|
2013-07-11 02:19:29 +00:00
|
|
|
other.distance2(self).sqrt()
|
|
|
|
}
|
|
|
|
|
2013-07-11 23:18:05 +00:00
|
|
|
/// Returns a normalized direction vector pointing to the other point
|
2013-07-11 02:19:29 +00:00
|
|
|
#[inline]
|
|
|
|
pub fn direction(&self, other: &Point3<T>) -> Vec3<T> {
|
|
|
|
((*other) - (*self)).normalize()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<T:Num> Add<Vec3<T>, Point3<T>> for Point3<T> {
|
|
|
|
fn add(&self, other: &Vec3<T>) -> Point3<T> {
|
|
|
|
Point3::new((*self).x + (*other).x,
|
|
|
|
(*self).y + (*other).y,
|
|
|
|
(*self).z + (*other).z)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<T:Num> Sub<Point3<T>, Vec3<T>> for Point3<T> {
|
|
|
|
fn sub(&self, other: &Point3<T>) -> Vec3<T> {
|
|
|
|
Vec3::new((*self).x - (*other).x,
|
|
|
|
(*self).y - (*other).y,
|
|
|
|
(*self).z - (*other).z)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<T:Num> Mul<Vec3<T>, Point3<T>> for Point3<T> {
|
|
|
|
fn mul(&self, scale: &Vec3<T>) -> Point3<T> {
|
|
|
|
Point3::new((*self).x * (*scale).x,
|
|
|
|
(*self).y * (*scale).y,
|
|
|
|
(*self).z * (*scale).z)
|
2013-06-16 07:34:09 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-07-08 07:00:38 +00:00
|
|
|
impl<T> ToStr for Point3<T> {
|
|
|
|
pub fn to_str(&self) -> ~str {
|
|
|
|
fmt!("[%?, %?, %?]", self.x, self.y, self.z)
|
2013-06-16 07:34:09 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod test_point3 {
|
2013-07-08 07:00:38 +00:00
|
|
|
use geom::point::*;
|
2013-06-16 07:34:09 +00:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_to_str() {
|
|
|
|
assert_eq!(Point3::new(1, 2, 3).to_str(), ~"[1, 2, 3]");
|
|
|
|
}
|
|
|
|
}
|