Struct Plane 

pub struct Plane { /* private fields */ }

An unbounded plane.

The frame’s z is the normal; x and y span the surface and fix its parameterization.

Implementations

impl Plane

pub const XY: Self

The xy plane.

pub const fn new(frame: Frame) -> Self

The plane of frame, with frame’s z as its normal.

pub fn through(origin: Point, normal: Direction) -> Self

The plane through origin with the given normal, parameterized arbitrarily but deterministically.

pub fn through_points( a: Point, b: Point, c: Point, tol: Tolerances, ) -> OgeomResult<Self>

The plane through three points, with the normal following the right-hand rule around a, b, c.

Errors

OgeomError::Construction if the points are collinear.

pub const fn frame(&self) -> Frame

The frame positioning this plane.

pub const fn origin(&self) -> Point

A point on the plane.

pub const fn normal(&self) -> Direction

The normal.

pub fn signed_distance_to(&self, p: Point) -> f64

The signed distance from p, positive on the side the normal points to.

pub fn distance_to(&self, p: Point) -> f64

The distance from p.

pub fn project(&self, p: Point) -> Point

The closest point on the plane to p.

pub fn contains(&self, p: Point, tol: Tolerances) -> bool

Whether p lies on the plane within tol.confusion().

pub const fn reversed(&self) -> Self

This plane with its normal reversed.

pub fn transformed(&self, t: &Transform, tol: Tolerances) -> OgeomResult<Self>

This plane moved by t.

Errors

OgeomError::Construction if the transformed frame is degenerate.

Trait Implementations

impl Clone for Plane

fn clone(&self) -> Plane

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Plane

impl Debug for Plane

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

Formats the value using the given formatter.

impl PartialEq for Plane

fn eq(&self, other: &Plane) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Plane