1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100

/*
Copyright 2016 Martin Buck

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall
be included all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

//! Is3D trait used for types which are positioned within the 3D space

use crate::*;

//------------------------------------------------------------------------------

/// Is3D is a trait used for types which are positioned within the 3D space
pub trait Is3D: IsND {
    /// Should return the x-coordinate
    fn x(&self) -> f64;
    /// Should return the y-coordinate
    fn y(&self) -> f64;
    /// Should return the z-coordinate
    fn z(&self) -> f64;

    /// Returns the position as x,y,z array
    #[inline(always)]
    fn xyz(&self) -> [f64; 3] {
        [self.x(), self.y(), self.z()]
    }
    /// Returns the components of the position as array
    #[inline(always)]
    fn xy(&self) -> [f64; 2] {
        [self.x(), self.y()]
    }
    /// Returns the components of the position as array
    #[inline(always)]
    fn xz(&self) -> [f64; 2] {
        [self.x(), self.z()]
    }
    /// Returns the components of the position as array
    #[inline(always)]
    fn yz(&self) -> [f64; 2] {
        [self.y(), self.z()]
    }
    /// Calculates the dot product with another Is3D
    #[inline(always)]
    fn dot(&self, other: &dyn Is3D) -> f64 {
        self.x() * other.x() + self.y() * other.y() + self.z() * other.z()
    }
    /// The absolute / length of this position
    #[inline(always)]
    fn abs(&self) -> NonNegative {
        NonNegative::new(((self.x()).powi(2) + (self.y()).powi(2) + (self.z()).powi(2)).sqrt())
            .unwrap()
    }
    /// Calculates the angle to the other Is3D in radians
    fn rad_to(&self, other: &dyn Is3D) -> Result<Rad> {
        if self.abs().get() == 0.0 || other.abs().get() == 0.0 {
            return Err(ErrorKind::CantCalculateAngleIfZeroLength);
        }
        Ok(Rad {
            val: (self.dot(other) / (self.abs() * other.abs()).get()).acos(),
        })
    }
    /// Transforms the position in a "x y z" string. E.g. "3.72 5.99 1.01"
    fn to_str(&self) -> String {
        let sx: String = self.x().to_string();
        let sy: String = self.y().to_string();
        let sz: String = self.z().to_string();

        sx + " " + &sy + " " + &sz
    }
}

impl<P> HasDistanceTo<P> for dyn Is3D
where
    P: Is3D,
{
    fn sqr_distance(&self, other: &P) -> NonNegative {
        NonNegative::new(
            (self.x() - other.x()).powi(2)
                + (self.y() - other.y()).powi(2)
                + (self.z() - other.z()).powi(2),
        )
        .unwrap()
    }
}