Skip to main content

Ray3D

Struct Ray3D 

Source
pub struct Ray3D {
    pub origin: Point3D,
    pub dir_x: f64,
    pub dir_y: f64,
    pub dir_z: f64,
    pub max_distance: f64,
    /* private fields */
}
Expand description

Finite 3D ray segment used by raycast searches.

§Example

use packed_spatial_index::{Box3D, Point3D, Ray3D};

let ray = Ray3D::new(Point3D::new(-1.0, 0.5, 0.5), 1.0, 0.0, 0.0, 10.0);
assert!(ray.intersects_box(Box3D::new(0.0, 0.0, 0.0, 1.0, 1.0, 1.0)));

Fields§

§origin: Point3D

Ray origin.

§dir_x: f64

X component of the ray direction.

§dir_y: f64

Y component of the ray direction.

§dir_z: f64

Z component of the ray direction.

§max_distance: f64

Maximum ray parameter to consider.

Implementations§

Source§

impl Ray3D

Source

pub const fn new( origin: Point3D, dir_x: f64, dir_y: f64, dir_z: f64, max_distance: f64, ) -> Self

Create a finite ray segment covering origin + t * dir for t in [0, max_distance].

The direction does not need to be normalized. max_distance and every returned entry t are in units of the direction length, so the Euclidean distance to a hit is t * (dir_x.hypot(dir_y).hypot(dir_z)); normalize the direction (length 1) if you want t and max_distance in world units.

A fully zero direction (dir_x == dir_y == dir_z == 0.0) is a point probe: it hits only boxes that contain origin, all at t == 0.0. Direction components should be finite; a NaN direction produces unspecified results.

Source

pub fn intersects_box(self, bounds: Box3D) -> bool

true when the ray segment touches bounds (faces inclusive).

Source

pub fn enter_t(self, bounds: Box3D) -> Option<f64>

Entry parameter t where the ray segment first touches bounds (0.0 if the origin is inside), or None if the segment misses. Used by ordered closest-hit traversal.

Source

pub fn closest_triangle<T: Triangle3>( &self, triangles: &[T], ) -> Option<TriangleHit>

The closest triangle in triangles hit by this ray segment, as a TriangleHit (index into the slice and t in direction-length units), or None if the ray misses them all, by the Moller-Trumbore test.

Works over either record type: Triangle3D tests in f64, Triangle3DF32 in f32 (8 at a time with the simd feature). Pair this with a query that yields candidate triangles — an Index3DView’s triangles payload, or the items a raycast / search returns — for exact ray-mesh intersection.

Trait Implementations§

Source§

impl Clone for Ray3D

Source§

fn clone(&self) -> Ray3D

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 Copy for Ray3D

Source§

impl Debug for Ray3D

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Ray3D

Source§

fn eq(&self, other: &Ray3D) -> 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 StructuralPartialEq for Ray3D

Auto Trait Implementations§

§

impl Freeze for Ray3D

§

impl RefUnwindSafe for Ray3D

§

impl Send for Ray3D

§

impl Sync for Ray3D

§

impl Unpin for Ray3D

§

impl UnsafeUnpin for Ray3D

§

impl UnwindSafe for Ray3D

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.