Struct fenris_geometry::HalfSpace

pub struct HalfSpace<T: Scalar, D: DimName = U3>where
    DefaultAllocator: Allocator<T, D>,{ /* private fields */ }

A $D$-dimensional half space.

A half space is defined by a point $\vec x$ and a normalized unit vector (normal) $\vec n$. The points belonging to the half space is then given by the points $\vec y$ that satisfy

$$ (\vec y - \vec x) \cdot \vec n \leq 0. $$

Implementations

impl<T, D> HalfSpace<T, D>where
    T: Real,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,

pub fn signed_distance_to_point(&self, point: &OPoint<T, D>) -> T

pub fn contains_point(&self, point: &OPoint<T, D>) -> bool

pub fn from_point_and_normal(
    point: OPoint<T, D>,
    normal: Unit<OVector<T, D>>
) -> Self

pub fn point(&self) -> &OPoint<T, D>

pub fn normal(&self) -> &OVector<T, D>

Returns the outwards-facing normal vector for the plane.

This vector is normalized.

pub fn complement(&self) -> Self

impl<T> HalfSpace<T>where
    T: Real,

pub fn plane(&self) -> Plane<T>

pub fn from_plane(plane: &Plane<T>) -> Self

impl<T> HalfSpace<T, Const<2>>where
    T: Real,

pub fn surface(&self) -> Line2d<T>

Returns a line representing the surface of the half plane

Trait Implementations

impl<T: Clone + Scalar, D: Clone + DimName> Clone for HalfSpace<T, D>where
    DefaultAllocator: Allocator<T, D>,

fn clone(&self) -> HalfSpace<T, D>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Scalar, D: Debug + DimName> Debug for HalfSpace<T, D>where
    DefaultAllocator: Allocator<T, D>,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: PartialEq + Scalar, D: PartialEq + DimName> PartialEq<HalfSpace<T, D>> for HalfSpace<T, D>where
    DefaultAllocator: Allocator<T, D>,

fn eq(&self, other: &HalfSpace<T, D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Scalar, D: DimName> StructuralPartialEq for HalfSpace<T, D>where
    DefaultAllocator: Allocator<T, D>,