2013-09-03 03:54:03 +00:00
|
|
|
// Copyright 2013 The CGMath 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-10-19 14:00:44 +00:00
|
|
|
use std::fmt;
|
2013-09-04 05:29:53 +00:00
|
|
|
use std::num::{Zero, zero, One, one, sqrt};
|
2014-02-15 22:22:21 +00:00
|
|
|
use std::cmp::{max, min};
|
2013-09-03 03:54:03 +00:00
|
|
|
|
2013-09-06 06:39:15 +00:00
|
|
|
use angle::{Rad, atan2, acos};
|
2014-01-09 00:26:50 +00:00
|
|
|
use approx::ApproxEq;
|
2013-09-14 01:58:19 +00:00
|
|
|
use array::{Array, build};
|
2013-09-03 03:54:03 +00:00
|
|
|
|
2013-09-03 06:37:06 +00:00
|
|
|
/// A trait that specifies a range of numeric operations for vectors. Not all
|
|
|
|
/// of these make sense from a linear algebra point of view, but are included
|
|
|
|
/// for pragmatic reasons.
|
2013-09-03 03:54:03 +00:00
|
|
|
pub trait Vector
|
|
|
|
<
|
2013-09-17 08:50:42 +00:00
|
|
|
S: Primitive,
|
2013-09-03 03:54:03 +00:00
|
|
|
Slice
|
|
|
|
>
|
|
|
|
: Array<S, Slice>
|
2013-09-03 05:43:27 +00:00
|
|
|
+ Neg<Self>
|
2013-09-03 13:35:06 +00:00
|
|
|
+ Zero + One
|
2013-09-03 03:54:03 +00:00
|
|
|
{
|
2013-09-14 01:58:19 +00:00
|
|
|
#[inline] fn add_s(&self, s: S) -> Self { build(|i| self.i(i).add(&s)) }
|
|
|
|
#[inline] fn sub_s(&self, s: S) -> Self { build(|i| self.i(i).sub(&s)) }
|
|
|
|
#[inline] fn mul_s(&self, s: S) -> Self { build(|i| self.i(i).mul(&s)) }
|
|
|
|
#[inline] fn div_s(&self, s: S) -> Self { build(|i| self.i(i).div(&s)) }
|
|
|
|
#[inline] fn rem_s(&self, s: S) -> Self { build(|i| self.i(i).rem(&s)) }
|
|
|
|
|
|
|
|
#[inline] fn add_v(&self, other: &Self) -> Self { build(|i| self.i(i).add(other.i(i))) }
|
|
|
|
#[inline] fn sub_v(&self, other: &Self) -> Self { build(|i| self.i(i).sub(other.i(i))) }
|
|
|
|
#[inline] fn mul_v(&self, other: &Self) -> Self { build(|i| self.i(i).mul(other.i(i))) }
|
|
|
|
#[inline] fn div_v(&self, other: &Self) -> Self { build(|i| self.i(i).div(other.i(i))) }
|
|
|
|
#[inline] fn rem_v(&self, other: &Self) -> Self { build(|i| self.i(i).rem(other.i(i))) }
|
2013-09-06 06:53:37 +00:00
|
|
|
|
2013-09-14 03:40:38 +00:00
|
|
|
#[inline] fn neg_self(&mut self) { self.each_mut(|_, x| *x = x.neg()) }
|
2013-09-06 06:53:37 +00:00
|
|
|
|
2013-09-14 03:40:38 +00:00
|
|
|
#[inline] fn add_self_s(&mut self, s: S) { self.each_mut(|_, x| *x = x.add(&s)) }
|
|
|
|
#[inline] fn sub_self_s(&mut self, s: S) { self.each_mut(|_, x| *x = x.sub(&s)) }
|
|
|
|
#[inline] fn mul_self_s(&mut self, s: S) { self.each_mut(|_, x| *x = x.mul(&s)) }
|
|
|
|
#[inline] fn div_self_s(&mut self, s: S) { self.each_mut(|_, x| *x = x.div(&s)) }
|
|
|
|
#[inline] fn rem_self_s(&mut self, s: S) { self.each_mut(|_, x| *x = x.rem(&s)) }
|
2013-09-06 06:53:37 +00:00
|
|
|
|
2013-09-14 03:40:38 +00:00
|
|
|
#[inline] fn add_self_v(&mut self, other: &Self) { self.each_mut(|i, x| *x = x.add(other.i(i))) }
|
|
|
|
#[inline] fn sub_self_v(&mut self, other: &Self) { self.each_mut(|i, x| *x = x.sub(other.i(i))) }
|
|
|
|
#[inline] fn mul_self_v(&mut self, other: &Self) { self.each_mut(|i, x| *x = x.mul(other.i(i))) }
|
|
|
|
#[inline] fn div_self_v(&mut self, other: &Self) { self.each_mut(|i, x| *x = x.div(other.i(i))) }
|
|
|
|
#[inline] fn rem_self_v(&mut self, other: &Self) { self.each_mut(|i, x| *x = x.rem(other.i(i))) }
|
2013-09-03 06:37:06 +00:00
|
|
|
|
|
|
|
/// The sum of each component of the vector.
|
2013-09-14 02:05:50 +00:00
|
|
|
#[inline] fn comp_add(&self) -> S { self.fold(|a, b| a.add(b)) }
|
2013-09-03 06:37:06 +00:00
|
|
|
|
|
|
|
/// The product of each component of the vector.
|
2013-09-14 02:05:50 +00:00
|
|
|
#[inline] fn comp_mul(&self) -> S { self.fold(|a, b| a.mul(b)) }
|
2013-09-06 06:53:37 +00:00
|
|
|
|
|
|
|
/// Vector dot product.
|
|
|
|
#[inline] fn dot(&self, other: &Self) -> S { self.mul_v(other).comp_add() }
|
2013-09-06 02:32:07 +00:00
|
|
|
|
|
|
|
/// The minimum component of the vector.
|
2014-02-15 22:22:21 +00:00
|
|
|
#[inline] fn comp_min(&self) -> S { self.fold(|a, b| min(a.clone(), b.clone())) }
|
2013-09-06 02:32:07 +00:00
|
|
|
|
|
|
|
/// The maximum component of the vector.
|
2014-02-15 22:22:21 +00:00
|
|
|
#[inline] fn comp_max(&self) -> S { self.fold(|a, b| max(a.clone(), b.clone())) }
|
2013-09-03 03:54:03 +00:00
|
|
|
}
|
|
|
|
|
2013-12-18 01:44:28 +00:00
|
|
|
#[inline] pub fn dot<S: Primitive, Slice, V: Vector<S, Slice>>(a: V, b: V) -> S { a.dot(&b) }
|
2013-09-14 01:53:12 +00:00
|
|
|
|
2014-01-23 16:13:53 +00:00
|
|
|
// Utility macro for generating associated functions for the vectors
|
|
|
|
macro_rules! vec(
|
|
|
|
($Self:ident <$S:ident> { $($field:ident),+ }, $n:expr) => (
|
2014-02-24 06:33:31 +00:00
|
|
|
#[deriving(Eq, Clone, Hash)]
|
2014-01-23 16:13:53 +00:00
|
|
|
pub struct $Self<S> { $($field: S),+ }
|
|
|
|
|
|
|
|
impl<$S: Primitive> $Self<$S> {
|
|
|
|
#[inline]
|
|
|
|
pub fn new($($field: $S),+) -> $Self<$S> {
|
|
|
|
$Self { $($field: $field),+ }
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Construct a vector from a single value.
|
|
|
|
#[inline]
|
|
|
|
pub fn from_value(value: $S) -> $Self<$S> {
|
|
|
|
$Self { $($field: value.clone()),+ }
|
|
|
|
}
|
|
|
|
|
|
|
|
/// The additive identity of the vector.
|
|
|
|
#[inline]
|
|
|
|
pub fn zero() -> $Self<$S> { $Self::from_value(zero()) }
|
|
|
|
|
|
|
|
/// The multiplicative identity of the vector.
|
|
|
|
#[inline]
|
|
|
|
pub fn ident() -> $Self<$S> { $Self::from_value(one()) }
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<S: Primitive> Add<$Self<S>, $Self<S>> for $Self<S> {
|
|
|
|
#[inline] fn add(&self, other: &$Self<S>) -> $Self<S> { self.add_v(other) }
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<S: Primitive> Sub<$Self<S>, $Self<S>> for $Self<S> {
|
|
|
|
#[inline] fn sub(&self, other: &$Self<S>) -> $Self<S> { self.sub_v(other) }
|
|
|
|
}
|
2014-01-23 16:00:24 +00:00
|
|
|
|
2014-01-23 16:13:53 +00:00
|
|
|
impl<S: Primitive> Zero for $Self<S> {
|
|
|
|
#[inline] fn zero() -> $Self<S> { $Self::from_value(zero()) }
|
|
|
|
#[inline] fn is_zero(&self) -> bool { *self == zero() }
|
|
|
|
}
|
2014-01-23 16:00:24 +00:00
|
|
|
|
2014-01-23 16:13:53 +00:00
|
|
|
impl<S: Primitive> Neg<$Self<S>> for $Self<S> {
|
|
|
|
#[inline] fn neg(&self) -> $Self<S> { build(|i| self.i(i).neg()) }
|
|
|
|
}
|
2013-09-06 06:53:37 +00:00
|
|
|
|
2014-01-23 16:13:53 +00:00
|
|
|
impl<S: Primitive> Mul<$Self<S>, $Self<S>> for $Self<S> {
|
|
|
|
#[inline] fn mul(&self, other: &$Self<S>) -> $Self<S> { self.mul_v(other) }
|
|
|
|
}
|
2013-09-06 06:39:15 +00:00
|
|
|
|
2014-01-23 16:13:53 +00:00
|
|
|
impl<S: Primitive> One for $Self<S> {
|
|
|
|
#[inline] fn one() -> $Self<S> { $Self::from_value(one()) }
|
|
|
|
}
|
2014-01-23 16:00:24 +00:00
|
|
|
|
2014-01-23 16:13:53 +00:00
|
|
|
impl<S: Primitive> Vector<S, [S, ..$n]> for $Self<S> {}
|
|
|
|
)
|
|
|
|
)
|
2014-01-23 16:00:24 +00:00
|
|
|
|
2014-01-23 16:13:53 +00:00
|
|
|
vec!(Vec2<S> { x, y }, 2)
|
|
|
|
vec!(Vec3<S> { x, y, z }, 3)
|
|
|
|
vec!(Vec4<S> { x, y, z, w }, 4)
|
|
|
|
|
|
|
|
array!(impl<S> Vec2<S> -> [S, ..2] _2)
|
|
|
|
array!(impl<S> Vec3<S> -> [S, ..3] _3)
|
|
|
|
array!(impl<S> Vec4<S> -> [S, ..4] _4)
|
2013-09-03 03:54:03 +00:00
|
|
|
|
|
|
|
/// Operations specific to numeric two-dimensional vectors.
|
2013-09-17 08:50:42 +00:00
|
|
|
impl<S: Primitive> Vec2<S> {
|
2014-01-23 16:13:53 +00:00
|
|
|
#[inline] pub fn unit_x() -> Vec2<S> { Vec2::new(one(), zero()) }
|
|
|
|
#[inline] pub fn unit_y() -> Vec2<S> { Vec2::new(zero(), one()) }
|
|
|
|
|
2013-09-03 03:54:03 +00:00
|
|
|
/// The perpendicular dot product of the vector and `other`.
|
|
|
|
#[inline]
|
|
|
|
pub fn perp_dot(&self, other: &Vec2<S>) -> S {
|
|
|
|
(self.x * other.y) - (self.y * other.x)
|
|
|
|
}
|
2014-01-23 16:13:53 +00:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn extend(&self, z: S)-> Vec3<S> {
|
|
|
|
Vec3::new(self.x.clone(), self.y.clone(), z)
|
|
|
|
}
|
2013-09-03 03:54:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Operations specific to numeric three-dimensional vectors.
|
2013-09-17 08:50:42 +00:00
|
|
|
impl<S: Primitive> Vec3<S> {
|
2014-01-23 16:13:53 +00:00
|
|
|
#[inline] pub fn unit_x() -> Vec3<S> { Vec3::new(one(), zero(), zero()) }
|
|
|
|
#[inline] pub fn unit_y() -> Vec3<S> { Vec3::new(zero(), one(), zero()) }
|
|
|
|
#[inline] pub fn unit_z() -> Vec3<S> { Vec3::new(zero(), zero(), one()) }
|
|
|
|
|
2013-09-03 03:54:03 +00:00
|
|
|
/// Returns the cross product of the vector and `other`.
|
|
|
|
#[inline]
|
|
|
|
pub fn cross(&self, other: &Vec3<S>) -> Vec3<S> {
|
|
|
|
Vec3::new((self.y * other.z) - (self.z * other.y),
|
|
|
|
(self.z * other.x) - (self.x * other.z),
|
|
|
|
(self.x * other.y) - (self.y * other.x))
|
|
|
|
}
|
2013-09-06 02:32:07 +00:00
|
|
|
|
|
|
|
/// Calculates the cross product of the vector and `other`, then stores the
|
|
|
|
/// result in `self`.
|
|
|
|
#[inline]
|
|
|
|
pub fn cross_self(&mut self, other: &Vec3<S>) {
|
|
|
|
*self = self.cross(other)
|
|
|
|
}
|
2014-01-23 16:13:53 +00:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn extend(&self, w: S)-> Vec4<S> {
|
|
|
|
Vec4::new(self.x.clone(), self.y.clone(), self.z.clone(), w)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn truncate(&self)-> Vec2<S> {
|
|
|
|
Vec2::new(self.x.clone(), self.y.clone()) //ignore Z
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Operations specific to numeric four-dimensional vectors.
|
|
|
|
impl<S: Primitive> Vec4<S> {
|
|
|
|
#[inline] pub fn unit_x() -> Vec4<S> { Vec4::new(one(), zero(), zero(), zero()) }
|
|
|
|
#[inline] pub fn unit_y() -> Vec4<S> { Vec4::new(zero(), one(), zero(), zero()) }
|
|
|
|
#[inline] pub fn unit_z() -> Vec4<S> { Vec4::new(zero(), zero(), one(), zero()) }
|
|
|
|
#[inline] pub fn unit_w() -> Vec4<S> { Vec4::new(zero(), zero(), zero(), one()) }
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
pub fn truncate(&self)-> Vec3<S> {
|
|
|
|
Vec3::new(self.x.clone(), self.y.clone(), self.z.clone()) //ignore W
|
|
|
|
}
|
2013-09-03 03:54:03 +00:00
|
|
|
}
|
|
|
|
|
2013-09-03 06:37:06 +00:00
|
|
|
/// Specifies geometric operations for vectors. This is only implemented for
|
|
|
|
/// 2-dimensional and 3-dimensional vectors.
|
2013-09-03 03:54:03 +00:00
|
|
|
pub trait EuclideanVector
|
|
|
|
<
|
2014-01-09 00:26:50 +00:00
|
|
|
S: Float + ApproxEq<S>,
|
2013-09-03 03:54:03 +00:00
|
|
|
Slice
|
|
|
|
>
|
|
|
|
: Vector<S, Slice>
|
2013-09-03 13:36:03 +00:00
|
|
|
+ ApproxEq<S>
|
2013-09-03 03:54:03 +00:00
|
|
|
{
|
|
|
|
/// Returns `true` if the vector is perpendicular (at right angles to)
|
|
|
|
/// the other vector.
|
|
|
|
fn is_perpendicular(&self, other: &Self) -> bool {
|
|
|
|
self.dot(other).approx_eq(&zero())
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the squared length of the vector. This does not perform an
|
|
|
|
/// expensive square root operation like in the `length` method and can
|
|
|
|
/// therefore be more efficient for comparing the lengths of two vectors.
|
|
|
|
#[inline]
|
|
|
|
fn length2(&self) -> S {
|
|
|
|
self.dot(self)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// The norm of the vector.
|
|
|
|
#[inline]
|
|
|
|
fn length(&self) -> S {
|
|
|
|
sqrt(self.dot(self))
|
|
|
|
}
|
|
|
|
|
|
|
|
/// The angle between the vector and `other`.
|
2013-09-04 05:29:53 +00:00
|
|
|
fn angle(&self, other: &Self) -> Rad<S>;
|
2013-09-03 03:54:03 +00:00
|
|
|
|
|
|
|
/// Returns a vector with the same direction, but with a `length` (or
|
|
|
|
/// `norm`) of `1`.
|
|
|
|
#[inline]
|
|
|
|
fn normalize(&self) -> Self {
|
|
|
|
self.normalize_to(one::<S>())
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns a vector with the same direction and a given `length`.
|
|
|
|
#[inline]
|
|
|
|
fn normalize_to(&self, length: S) -> Self {
|
|
|
|
self.mul_s(length / self.length())
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the result of linarly interpolating the length of the vector
|
2013-09-03 12:12:54 +00:00
|
|
|
/// towards the length of `other` by the specified amount.
|
2013-09-03 03:54:03 +00:00
|
|
|
#[inline]
|
|
|
|
fn lerp(&self, other: &Self, amount: S) -> Self {
|
|
|
|
self.add_v(&other.sub_v(self).mul_s(amount))
|
|
|
|
}
|
2013-09-03 12:12:54 +00:00
|
|
|
|
|
|
|
/// Normalises the vector to a length of `1`.
|
|
|
|
#[inline]
|
|
|
|
fn normalize_self(&mut self) {
|
|
|
|
let rlen = self.length().recip();
|
|
|
|
self.mul_self_s(rlen);
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Normalizes the vector to `length`.
|
|
|
|
#[inline]
|
|
|
|
fn normalize_self_to(&mut self, length: S) {
|
|
|
|
let n = length / self.length();
|
|
|
|
self.mul_self_s(n);
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Linearly interpolates the length of the vector towards the length of
|
|
|
|
/// `other` by the specified amount.
|
|
|
|
fn lerp_self(&mut self, other: &Self, amount: S) {
|
|
|
|
let v = other.sub_v(self).mul_s(amount);
|
|
|
|
self.add_self_v(&v);
|
|
|
|
}
|
2013-09-03 03:54:03 +00:00
|
|
|
}
|
|
|
|
|
2014-01-09 00:26:50 +00:00
|
|
|
impl<S: Float + ApproxEq<S>>
|
|
|
|
EuclideanVector<S, [S, ..2]> for Vec2<S> {
|
2013-09-03 03:54:03 +00:00
|
|
|
#[inline]
|
2013-09-04 05:29:53 +00:00
|
|
|
fn angle(&self, other: &Vec2<S>) -> Rad<S> {
|
2013-09-03 03:54:03 +00:00
|
|
|
atan2(self.perp_dot(other), self.dot(other))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-01-09 00:26:50 +00:00
|
|
|
impl<S: Float + ApproxEq<S>>
|
|
|
|
EuclideanVector<S, [S, ..3]> for Vec3<S> {
|
2013-09-03 03:54:03 +00:00
|
|
|
#[inline]
|
2013-09-04 05:29:53 +00:00
|
|
|
fn angle(&self, other: &Vec3<S>) -> Rad<S> {
|
2013-09-03 03:54:03 +00:00
|
|
|
atan2(self.cross(other).length(), self.dot(other))
|
|
|
|
}
|
|
|
|
}
|
2013-09-03 07:33:33 +00:00
|
|
|
|
2014-01-09 00:26:50 +00:00
|
|
|
impl<S: Float + ApproxEq<S>>
|
|
|
|
EuclideanVector<S, [S, ..4]> for Vec4<S> {
|
2013-09-06 06:39:15 +00:00
|
|
|
#[inline]
|
|
|
|
fn angle(&self, other: &Vec4<S>) -> Rad<S> {
|
|
|
|
acos(self.dot(other) / (self.length() * other.length()))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-02-03 04:44:15 +00:00
|
|
|
impl<S: fmt::Show> ToStr for Vec2<S> {
|
2013-09-03 07:33:33 +00:00
|
|
|
fn to_str(&self) -> ~str {
|
2013-10-19 14:00:44 +00:00
|
|
|
format!("[{}, {}]", self.x, self.y)
|
2013-09-03 07:33:33 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-02-03 04:44:15 +00:00
|
|
|
impl<S: fmt::Show> ToStr for Vec3<S> {
|
2013-09-03 07:33:33 +00:00
|
|
|
fn to_str(&self) -> ~str {
|
2013-10-19 14:00:44 +00:00
|
|
|
format!("[{}, {}, {}]", self.x, self.y, self.z)
|
2013-09-03 07:33:33 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-02-03 04:44:15 +00:00
|
|
|
impl<S: fmt::Show> ToStr for Vec4<S> {
|
2013-09-03 07:33:33 +00:00
|
|
|
fn to_str(&self) -> ~str {
|
2013-10-19 14:00:44 +00:00
|
|
|
format!("[{}, {}, {}, {}]", self.x, self.y, self.z, self.w)
|
2013-09-03 07:33:33 +00:00
|
|
|
}
|
|
|
|
}
|