Struct amethyst_core::geometry::Plane

pub struct Plane<T> where
    T: RealField,  { /* fields omitted */ }

A plane which can be intersected by a ray.

Methods

impl<T> Plane<T> where
    T: RealField, 

pub fn new(normal: Vector3<T>, bias: T) -> Self

Create a new Plane.

pub fn from_point_normal(point: &Point3<T>, normal: &Vector3<T>) -> Self

Create a new Plane from a point normal representation

pub fn from_point_vectors(
    point: &Point3<T>,
    v1: &Vector3<T>,
    v2: &Vector3<T>
) -> Self

Create a new Plane from a point normal representation

pub fn with_x(x: T) -> Self

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

pub fn with_y(y: T) -> Self

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

pub fn with_z(z: T) -> Self

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

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

This Plane normal

pub fn normalize(&self) -> Self

Normalized representation of this Plane

pub fn dot_point(&self, point: &Point3<T>) -> T

Returns the dot product of this Plane and a provided Point3

pub fn dot(&self, point: &Vector3<T>) -> T

Returns the dot product of this Plane and a provided Vector3

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

Returns the dot product of this Plane with another Plane

pub fn intersect_line(
    &self,
    point: &Point3<T>,
    direction: &Vector3<T>
) -> Option<T>

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

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

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

Trait Implementations

impl<T: Clone> Clone for Plane<T> where
    T: RealField, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq> PartialEq<Plane<T>> for Plane<T> where
    T: RealField, 

fn eq(&self, other: &Plane<T>) -> bool

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

fn ne(&self, other: &Plane<T>) -> bool

This method tests for !=.

impl<T: Copy> Copy for Plane<T> where
    T: RealField, 

impl<T: Debug> Debug for Plane<T> where
    T: RealField, 

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

Formats the value using the given formatter.

impl<T> Serialize for Plane<T> where
    T: RealField,
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, T> Deserialize<'de> for Plane<T> where
    T: RealField,
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.