Struct ultraviolet::geometry::Planei

#[repr(C)]pub struct Planei {
    pub normal: Vec3i,
    pub bias: i32,
}

A plane which can be intersected by a ray.

Fields

normal: Vec3i

plane described as x,y,z normal

bias: i32

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

Methods

impl Planei

pub fn new(normal: Vec3i, bias: i32) -> Self

Create a new Plane.

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

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

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

Create a new Plane from a point normal representation

pub fn with_x(x: i32) -> Self

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

pub fn with_y(y: i32) -> Self

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

pub fn with_z(z: i32) -> Self

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

pub fn normal(&self) -> Vec3i

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: Vec3i) -> i32

Returns the dot product of this Plane and a provided Vec3

pub fn dot(&self, point: Vec3i) -> i32

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: Planei) -> i32

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

pub fn intersect_line(&self, point: Vec3i, direction: Vec3i) -> Option<i32>

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: Rayi) -> Option<i32>

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 Planei

fn clone(&self) -> Planei

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Planei

impl Debug for Planei

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

Formats the value using the given formatter.

impl Eq for Planei

impl Hash for Planei

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Planei> for Planei

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Planei

impl StructuralPartialEq for Planei