Struct Plane

#[repr(C)]
pub struct Plane<T> {
    pub normal: Vec3<T>,
    pub distance: T,
}

Plane structure.

Fields

normal: Vec3<T>

The normal of the plane.

distance: T

The distance from the origin.

Implementations

impl<T> Plane<T>

pub const fn new(normal: Vec3<T>, distance: T) -> Plane<T>

Constructs a new plane.

pub fn from_point(normal: Vec3<T>, pt: Point3<T>) -> Plane<T>

where T: Float,

Constructs a new plane from a normal and a point.

pub fn from_points(pt1: Point3<T>, pt2: Point3<T>, pt3: Point3<T>) -> Plane<T>

where T: Float,

Constructs a new plane from three points.

If the points are collinear, the plane normal is zero.

impl<T: Float> Plane<T>

pub fn project_point(&self, pt: Point3<T>) -> Point3<T>

Returns the projection of a point onto the plane.

use cvmath::{Plane, Point3, Vec3};

let plane = Plane(Vec3(0.0, 0.0, 1.0), 0.0);
let pt = Point3(20.0, 10.0, 4.0);
assert_eq!(plane.project_point(pt), Point3(20.0, 10.0, 0.0));

pub fn distance_to_point(&self, pt: Point3<T>) -> T

Returns the distance from the plane to a point.

use cvmath::{Plane, Point3, Vec3};

let plane = Plane(Vec3(0.0, 0.0, 1.0), 0.0);
let pt = Point3(20.0, 10.0, 4.0);
assert_eq!(plane.distance_to_point(pt), 4.0);

Trait Implementations

impl<T: Clone> Clone for Plane<T>

fn clone(&self) -> Plane<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Plane<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Plane<T>

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

fn inside(&self, ray: &Ray<T>) -> bool

Returns if the ray starts inside the shape.

fn trace(&self, ray: &Ray<T>, hits: &mut [TraceHit<T>]) -> usize

Trace the ray against a shape.

impl<T: Copy> Copy for Plane<T>

impl<T: Eq> Eq for Plane<T>

impl<T> StructuralPartialEq for Plane<T>