Skip to main content

Plane

Struct Plane 

Source
pub struct Plane {
    pub normal: Vec3,
    pub distance: f32,
}
Expand description

A plane defined by a unit normal and signed distance from the origin.

Fields§

§normal: Vec3

Unit normal.

§distance: f32

Signed distance term in normal.dot(point) + distance = 0.

Implementations§

Source§

impl Plane

Source

pub fn new(normal: Vec3, distance: f32) -> Self

Creates a plane from a normal and signed distance.

Source

pub fn from_normal_and_point(normal: Vec3, point: Vec3) -> Self

Creates a plane through a point with the given normal.

Source

pub fn from_three_points(a: Vec3, b: Vec3, c: Vec3) -> Self

Creates a plane from three points.

Source

pub fn signed_distance(self, point: Vec3) -> f32

Returns the signed distance from a point to the plane.

Source

pub fn project_point(self, point: Vec3) -> Vec3

Projects a point onto the plane.

Source

pub fn intersect_ray(self, ray: Ray3) -> Option<f32>

Intersects a ray with the plane and returns non-negative t.

Source

pub fn intersect_line(self, a: Vec3, b: Vec3) -> Option<Vec3>

Intersects a finite line segment with the plane.

Trait Implementations§

Source§

impl Clone for Plane

Source§

fn clone(&self) -> Plane

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 Plane

Source§

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

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

impl Default for Plane

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Plane

Source§

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

Source§

impl StructuralPartialEq for Plane

Auto Trait Implementations§

§

impl Freeze for Plane

§

impl RefUnwindSafe for Plane

§

impl Send for Plane

§

impl Sync for Plane

§

impl Unpin for Plane

§

impl UnsafeUnpin for Plane

§

impl UnwindSafe for Plane

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> 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.