Enum ShapeCastStatus

pub enum ShapeCastStatus {
    OutOfIterations,
    Converged,
    Failed,
    PenetratingOrWithinTargetDist,
}

The status of the time-of-impact computation algorithm.

Variants

OutOfIterations

The shape-casting algorithm ran out of iterations before achieving convergence.

The content of the ShapeCastHit will still be a conservative approximation of the actual result so it is often fine to interpret this case as a success.

Converged

The shape-casting algorithm converged successfully.

Failed

Something went wrong during the shape-casting, likely due to numerical instabilities.

The content of the ShapeCastHit will still be a conservative approximation of the actual result so it is often fine to interpret this case as a success.

PenetratingOrWithinTargetDist

The two shape already overlap, or are separated by a distance smaller than ShapeCastOptions::target_distance at the time 0.

The witness points and normals provided by the ShapeCastHit will have unreliable values unless ShapeCastOptions::compute_impact_geometry_on_penetration was set to true when calling the time-of-impact function.

Trait Implementations

impl Clone for ShapeCastStatus

fn clone(&self) -> ShapeCastStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeCastStatus

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

Formats the value using the given formatter.

impl PartialEq for ShapeCastStatus

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ShapeCastStatus

impl Eq for ShapeCastStatus

impl StructuralPartialEq for ShapeCastStatus