Struct ultraviolet::geometry::Plane

#[repr(C)]pub struct Plane {
    pub normal: Vec3,
    pub bias: f32,
}

A plane which can be intersected by a ray.

Fields

normal: Vec3

plane described as x,y,z normal

bias: f32

dot product of the point and normal, representing the plane position

Methods

impl Plane

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

Create a new Plane.

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

Create a new Plane from a point normal representation. The normal parameter must already be normalized.

pub fn from_point_vectors(point: Vec3, v1: Vec3, v2: Vec3) -> Self

Create a new Plane from a point normal representation

pub fn with_x(x: f32) -> Self

Create a Plane which is facing along the X-Axis at the provided coordinate.

pub fn with_y(y: f32) -> Self

Create a Plane which is facing along the Y-Axis at the provided coordinate.

pub fn with_z(z: f32) -> Self

Create a Plane which is facing along the Z-Axis at the provided coordinate.

pub fn normal(&self) -> Vec3

f32his Plane normal

pub fn normalize(&mut self)

Normalized representation of this Plane

pub fn normalized(&self) -> Self

Normalized representation of this Plane

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

Returns the dot product of this Plane and a provided Vec3

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

Returns the dot product of this Plane and a provided Vec3, assumed to be a normal, computed with this planes normal.

pub fn dot_plane(&self, plane: Plane) -> f32

Returns the dot product of this Plane with another Plane. This is computed against the two plane normals.

pub fn intersect_line(&self, point: Vec3, direction: Vec3) -> Option<f32>

Returns the intersection distance of the provided line given a point and direction, or None if none occurs.

Warning: These intersection methods do not check for the ray never intersecting. This is up to the user to confirm.

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

Returns the intersection distance of the provided Ray, or None if none occurs.

Warning: These intersection methods do not check for the ray never intersecting. This is up to the user to confirm.

Trait Implementations

impl Clone for Plane

fn clone(&self) -> Plane

Returns a copy 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.