ncollide3d/shape/
plane.rs

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
//! Support mapping based Plane shape.
use crate::math::Vector;
use na::{RealField, Unit};

/// SupportMap description of a plane.
#[derive(PartialEq, Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Plane<N: RealField + Copy> {
    /// The plane normal.
    pub normal: Unit<Vector<N>>,
}

impl<N: RealField + Copy> Plane<N> {
    /// Builds a new plane from its center and its normal.
    #[inline]
    pub fn new(normal: Unit<Vector<N>>) -> Plane<N> {
        Plane { normal }
    }

    /// The plane normal.
    #[inline]
    #[deprecated(note = "use the `self.normal` public field directly.")]
    pub fn normal(&self) -> &Unit<Vector<N>> {
        &self.normal
    }
}