Skip to main content

Plane

Struct Plane 

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

Plane encoding position with signed bias along unit normal.

Realizes plane equation a*x+b*y+c*z+d=0 with unit normal [x, y, z] and signed bias d.

Fields§

§normal: Vec3

Plane unit normal.

§bias: f32

Signed bias along unit normal.

Implementations§

Source§

impl Plane

Source

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

Plane from unit normal and signed distance from the origin.

use trackball::{Plane, glam::Vec3};

// Plane intersecting y-axis at `5.0`.
let plane = Plane::new(Vec3::Y, 5.0);

// Origin projected onto plane where plane intersects y-axis.
let point = plane.project_point(Vec3::ZERO);
assert_eq!(point, Vec3::new(0.0, 5.0, 0.0));

// Bias is negated distance.
assert_eq!(plane.distance(), 5.0);
assert_eq!(plane.bias, -5.0);

// Plane intersecting y-axis at `-5.0`.
let plane = Plane::new(Vec3::Y, -5.0);

// Origin projected onto plane where plane intersects y-axis.
let point = plane.project_point(Vec3::ZERO);
assert_eq!(point, Vec3::new(0.0, -5.0, 0.0));

// Bias is negated distance.
assert_eq!(plane.distance(), -5.0);
assert_eq!(plane.bias, 5.0);
Source

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

Plane from unit normal with point in plane.

Source

pub const fn distance(&self) -> f32

Signed orthogonal distance from the origin.

Source

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

Signed orthogonal distance from point.

Source

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

Projects point onto plane.

Source

pub fn project_axis(&self, axis: Vec3) -> Vec3

Projects axis onto plane regardless of bias.

Source

pub fn project_vector(&self, vector: Vec3) -> Vec3

Projects vector onto plane regardless of bias.

Source

pub fn angle_between(&self, a: Vec3, b: Vec3) -> f32

Signed angle from a to b where both vectors are in the plane.

Unlike Vec3::angle_between(), small and nearly opposite angles are precise.

Source

pub fn rotate_by(self, rot: Quat) -> Self

Rotates plane.

Source

pub fn translate_by(self, vec: Vec3) -> Self

Translates plane.

Source

pub fn transform_by(self, rigid: Rigid) -> Self

Transforms plane by direct isometry, i.e., rotation followed by translation.

use core::f32::consts::FRAC_PI_2;
use trackball::{
    Plane, Rigid,
    glam::{Quat, Vec3},
};

// Plane intersecting y-axis at `5.0`.
let plane = Plane::new(Vec3::Y, 5.0).transform_by(Rigid::from_rotation_translation(
    // Rotation by 90 degrees before translation.
    Quat::from_rotation_z(FRAC_PI_2),
    // Translation after rotation.
    Vec3::new(-5.0, 0.0, 0.0),
));
// Plane intersecting x-axis at `-10.0`.
assert!(plane.abs_diff_eq(Plane::new(-Vec3::X, 10.0), 1e-6));
Source

pub fn abs_diff_eq(&self, other: Self, max_abs_diff: f32) -> bool

Whether all components are approximately equal within absolute difference max_abs_diff.

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<'de> Deserialize<'de> for Plane

Source§

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

Deserialize this value from the given Serde deserializer. 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 Serialize for Plane

Source§

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

Serialize this value into the given Serde serializer. Read more
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, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,