Struct plane_split::Plane

pub struct Plane {
    pub normal: Vector3D<f64>,
    pub offset: f64,
}

An infinite plane in 3D space, defined by equation: dot(v, normal) + offset = 0 When used for plane splitting, it’s defining a hemisphere with equation “dot(v, normal) + offset > 0”.

Fields

normal: Vector3D<f64>

Normalized vector perpendicular to the plane.

offset: f64

Constant offset from the normal plane, specified in the direction opposite to the normal.

Implementations

impl Plane

pub fn from_unnormalized(
    normal: Vector3D<f64>,
    offset: f64
) -> Result<Option<Self>, NegativeHemisphereError>

Construct a new plane from unnormalized equation.

pub fn contains(&self, other: &Self) -> bool

Check if this plane contains another one.

pub fn signed_distance_to(&self, point: &Point3D<f64>) -> f64

Return the signed distance from this plane to a point. The distance is negative if the point is on the other side of the plane from the direction of the normal.

pub fn distance_to_line(&self, line: &Line) -> f64

Compute the distance across the line to the plane plane, starting from the line origin.

pub fn signed_distance_sum_to<A>(&self, poly: &Polygon<A>) -> f64

Compute the sum of signed distances to each of the points of another plane. Useful to know the relation of a plane that is a product of a split, and we know it doesn’t intersect self.

pub fn are_outside(&self, points: &[Point3D<f64>]) -> bool

Check if a convex shape defined by a set of points is completely outside of this plane. Merely touching the surface is not considered an intersection.

pub fn intersect(&self, other: &Self) -> Option<Line>

Compute the line of intersection with another plane.

Trait Implementations

impl Clone for Plane

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Plane

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

Formats the value using the given formatter.

impl PartialEq<Plane> for Plane

fn eq(&self, other: &Plane) -> 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 StructuralPartialEq for Plane