Skip to main content

Ray3

Struct Ray3 

Source
#[repr(C)]
pub struct Ray3<T> { pub origin: Point3<T>, pub direction: Vec3<T>, pub distance: Interval<T>, }
Expand description

Ray3 structure.

Rays are typically used to trace shapes for intersection tests. See Ray3::trace for more information.

Fields§

§origin: Point3<T>

The origin point where the ray starts.

§direction: Vec3<T>

The direction in which the ray extends from its origin.

This vector should be normalized and non-zero; otherwise, results may be incorrect.

§distance: Interval<T>

Distance limit.

Implementations§

Source§

impl<T> Ray3<T>

Source

pub fn new( origin: Point3<T>, direction: Vec3<T>, distance: Interval<T>, ) -> Ray3<T>
where T: Float,

Constructs a new ray with normalized direction.

The direction is normalized. Zero directions may result in unexpected behavior.

Source§

impl<T: Float> Ray3<T>

Source

pub fn at(&self, distance: T) -> Point3<T>

Returns the point at a given distance along the ray’s direction.

Source

pub fn reflect(&self, hit: &Hit3<T>) -> Ray3<T>

Reflects the ray at the given hit point.

Source§

impl<T: Float> Ray3<T>

Source

pub fn inside<U: Trace3<T> + ?Sized>(&self, shape: &U) -> bool

Returns if the ray starts inside the shape.

Source

pub fn inside_collection<Shape: Trace3<T>, I: IntoIterator<Item = Shape>>( &self, shapes: I, ) -> bool

Returns if the ray starts inside any shape in the collection.

Source

pub fn trace<U: Trace3<T> + ?Sized>(&self, shape: &U) -> Option<Hit3<T>>

Trace the ray against a shape.

Source

pub fn trace_collection<Shape: Trace3<T>, I: IntoIterator<Item = Shape>>( &self, shapes: I, ) -> Option<Hit3<T>>

Trace the ray against a collection of shapes.

Trait Implementations§

Source§

impl<T: Clone> Clone for Ray3<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Ray3<T>

Source§

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

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

impl<T: Float> Mul<Ray3<T>> for Transform3<T>

Source§

type Output = Ray3<T>

The resulting type after applying the * operator.
Source§

fn mul(self, ray: Ray3<T>) -> Ray3<T>

Performs the * operation. Read more
Source§

impl<T: PartialEq> PartialEq for Ray3<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<T: Copy> Copy for Ray3<T>

Source§

impl<T> StructuralPartialEq for Ray3<T>

Auto Trait Implementations§

§

impl<T> Freeze for Ray3<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Ray3<T>
where T: RefUnwindSafe,

§

impl<T> Send for Ray3<T>
where T: Send,

§

impl<T> Sync for Ray3<T>
where T: Sync,

§

impl<T> Unpin for Ray3<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Ray3<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Ray3<T>
where T: UnwindSafe,

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> 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.