Skip to main content

Plane3D

Struct Plane3D 

Source
pub struct Plane3D { /* private fields */ }
Expand description

A plane in 3D space, represented as normal · point = offset.

Implementations§

Source§

impl Plane3D

Source

pub fn new(normal: Vector3<f32>, offset: f32) -> Self

Creates a new plane from a normal vector and offset. The normal will be normalized automatically.

§Panics

Panics if the normal vector has zero length.

Source

pub fn from_point_and_normal(point: Point3<f32>, normal: Vector3<f32>) -> Self

Creates a plane from a point on the plane and a normal vector. The normal will be normalized automatically.

§Panics

Panics if the normal vector has zero length.

Source

pub fn from_three_points(a: Point3<f32>, b: Point3<f32>, c: Point3<f32>) -> Self

Creates a plane from three non-collinear points. The normal direction follows the right-hand rule: (b - a) × (c - a).

§Panics

Panics if the points are collinear (or nearly so).

Source

pub fn normal(&self) -> Vector3<f32>

Returns the unit normal vector of the plane.

Source

pub fn offset(&self) -> f32

Returns the signed distance from the origin to the plane along the normal.

Source

pub fn signed_distance(&self, point: Point3<f32>) -> f32

Computes the signed distance from a point to the plane.

  • Positive: point is in front (same side as normal)
  • Negative: point is behind (opposite side from normal)
  • Zero: point is on the plane
Source

pub fn classify_point(&self, point: Point3<f32>) -> PlaneSide

Classifies which side of the plane a point lies on. Uses the default PLANE_EPSILON tolerance.

Source

pub fn classify_point_with_epsilon( &self, point: Point3<f32>, epsilon: f32, ) -> PlaneSide

Classifies which side of the plane a point lies on, with a custom epsilon.

Source

pub fn flipped(&self) -> Self

Returns a new plane with the normal flipped (facing the opposite direction).

Source

pub fn project_point(&self, point: Point3<f32>) -> Point3<f32>

Projects a point onto the plane (finds the closest point on the plane).

Source

pub fn intersect_segment( &self, start: Point3<f32>, end: Point3<f32>, ) -> Option<(f32, Point3<f32>)>

Computes the intersection of a line segment with the plane.

Returns Some((t, point)) where:

  • t is the interpolation parameter (0.0 = start, 1.0 = end)
  • point is the intersection point

Returns None if the segment is parallel to the plane or doesn’t intersect.

Trait Implementations§

Source§

impl Clone for Plane3D

Source§

fn clone(&self) -> Plane3D

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Plane3D

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&Polygon> for Plane3D

Source§

fn from(polygon: &Polygon) -> Self

Converts to this type from the input type.
Source§

impl From<&Rectangle> for Plane3D

Source§

fn from(rectangle: &Rectangle) -> Self

Converts to this type from the input type.
Source§

impl From<&Triangle> for Plane3D

Source§

fn from(triangle: &Triangle) -> Self

Converts to this type from the input type.
Source§

impl From<Polygon> for Plane3D

Source§

fn from(polygon: Polygon) -> Self

Converts to this type from the input type.
Source§

impl From<Rectangle> for Plane3D

Source§

fn from(rectangle: Rectangle) -> Self

Converts to this type from the input type.
Source§

impl From<Triangle> for Plane3D

Source§

fn from(triangle: Triangle) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Plane3D

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Plane3D

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.