Skip to main content

Capsule

Struct Capsule 

Source
pub struct Capsule {
    pub radius: Real,
    pub half_height: Real,
}
Expand description

A capsule defined by radius and half-height along the Y axis.

Fields§

§radius: Real

Radius of the capsule end-caps.

§half_height: Real

Half-height of the cylindrical segment.

Implementations§

Source§

impl Capsule

Source

pub fn new(radius: Real, half_height: Real) -> Self

Create a new capsule.

Source

pub fn volume_explicit(&self) -> Real

Volume: cylinder + two hemisphere caps = πr²h + (4/3)πr³.

Source

pub fn surface_area(&self) -> Real

Surface area: 2πrh (cylinder lateral) + 4πr² (two hemispheres).

Source

pub fn inertia_tensor_array(&self, mass: f64) -> [[f64; 3]; 3]

Inertia tensor as [[f64;3\];3] row-major.

Source

pub fn ray_cast_array( &self, origin: [f64; 3], direction: [f64; 3], max_toi: f64, ) -> Option<(f64, [f64; 3])>

Ray cast returning (t, normal) as plain arrays.

Source

pub fn support(&self, direction: [f64; 3]) -> [f64; 3]

GJK support function: farthest point in direction.

Source

pub fn closest_point(&self, p: [f64; 3]) -> [f64; 3]

Closest point on the capsule surface to point p.

Source

pub fn contains_point(&self, p: [f64; 3]) -> bool

Returns true if p is inside (or on) the capsule.

Source

pub fn signed_distance(&self, p: [f64; 3]) -> f64

Signed distance from a point to the capsule surface. Negative if inside, positive if outside.

Source

pub fn medial_axis_endpoints(&self) -> ([f64; 3], [f64; 3])

Medial axis endpoints: the two centers of the hemispherical caps.

Source

pub fn full_length(&self) -> f64

Full length of the capsule (tip to tip along Y).

Source

pub fn medial_axis_length(&self) -> f64

Medial axis length (just the cylindrical segment).

Source

pub fn segment_segment_distance( a0: [f64; 3], a1: [f64; 3], b0: [f64; 3], b1: [f64; 3], ) -> f64

Distance between two segments in 3D. Segment A: from a0 to a1, Segment B: from b0 to b1. Returns the minimum distance.

Source

pub fn capsule_capsule_distance( &self, center_a: [f64; 3], other: &Capsule, center_b: [f64; 3], ) -> f64

Capsule-capsule distance. Both capsules are centered at the origin with Y-axis alignment, but offset by given centers. Returns the minimum distance between the two capsule surfaces (0 if overlapping).

Source

pub fn capsule_capsule_overlap( &self, center_a: [f64; 3], other: &Capsule, center_b: [f64; 3], ) -> bool

Check if two capsules overlap.

Source

pub fn project_on_medial_axis(&self, p: [f64; 3]) -> f64

Project a point onto the medial axis (the Y-axis segment). Returns the clamped Y value.

Source

pub fn distance_to_medial_axis(&self, p: [f64; 3]) -> f64

Distance from a point to the medial axis.

Source

pub fn inertia_tensor_raw(&self, mass: f64) -> [[f64; 3]; 3]

Inertia tensor (mass-normalized) returned as [[f64;3\];3] (identical to inertia_tensor_array but accepts mass separately for the public array API).

Source

pub fn closest_points_capsule_vs_capsule( &self, center_a: [f64; 3], other: &Capsule, center_b: [f64; 3], ) -> ([f64; 3], [f64; 3], f64)

Closest points between two capsule medial axes (and thus capsule surfaces).

Returns (pa, pb, seg_dist) where pa and pb are the closest points on the respective medial axes and seg_dist is the axis-to-axis distance.

Source

pub fn segment_segment_closest( a0: [f64; 3], a1: [f64; 3], b0: [f64; 3], b1: [f64; 3], ) -> ([f64; 3], [f64; 3], f64)

Returns the closest points on two 3D segments and the distance between them.

Source

pub fn intersects_obb( &self, capsule_center: [f64; 3], obb_center: [f64; 3], obb_axes: [[f64; 3]; 3], obb_half: [f64; 3], ) -> bool

Capsule vs Oriented Bounding Box (OBB) intersection test.

obb_center: world-space center of the OBB. obb_axes: columns are the OBB’s local X, Y, Z axes (unit vectors). obb_half: half-extents along the OBB local axes.

Converts the query to OBB-local space and tests sphere-swept segment against the OBB using the separating-axis theorem (SAT) with slabs.

Source

pub fn sdf(&self, p: [f64; 3]) -> f64

Signed distance field (SDF) for the capsule.

Same as signed_distance but with a different name to match the naming convention used in shader / SDF contexts.

Source

pub fn swept_capsule_vs_sphere( &self, center_start: [f64; 3], center_end: [f64; 3], sphere_center: [f64; 3], sphere_radius: f64, ) -> Option<f64>

Continuous collision detection (swept capsule).

Given the capsule moving from center_start to center_end (linear motion, constant orientation), and a static sphere at sphere_center with sphere_radius, returns the first time of contact t ∈ [0,1] or None if no contact occurs.

This is a simple CCD sweep using the Minkowski-sum radius and a moving-segment vs static-point formulation.

Source

pub fn random_surface_points(&self, n: usize, seed: u64) -> Vec<[f64; 3]>

Generate n random points on the capsule surface using rejection sampling.

Returns a Vec of [f64;3] coordinates sampled uniformly on the surface. Uses a deterministic PRNG seed for reproducibility.

Source

pub fn capsule_triangle_contact( &self, center: [f64; 3], ta: [f64; 3], tb: [f64; 3], tc: [f64; 3], ) -> Option<(f64, [f64; 3])>

Test capsule vs a world-space triangle (ta, tb, tc).

The capsule is placed at center (Y-aligned). Returns Some((depth, normal)) if the capsule penetrates the triangle plane by at least depth > 0, where normal points from the triangle towards the capsule center.

Trait Implementations§

Source§

impl Clone for Capsule

Source§

fn clone(&self) -> Capsule

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 Capsule

Source§

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

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

impl Shape for Capsule

Source§

fn bounding_box(&self) -> Aabb

Compute the axis-aligned bounding box of this shape (in local space).
Source§

fn support_point(&self, direction: &Vec3) -> Vec3

Compute the support point in the given direction (for GJK).
Source§

fn volume(&self) -> Real

Compute the volume of this shape.
Source§

fn center_of_mass(&self) -> Vec3

Compute the center of mass in local space.
Source§

fn inertia_tensor(&self, mass: Real) -> Mat3

Compute the inertia tensor for the given mass.
Source§

fn ray_cast( &self, ray_origin: &Vec3, ray_direction: &Vec3, max_toi: Real, ) -> Option<RayHit>

Cast a ray against this shape (in local space). Returns the first intersection within max_toi.
Source§

fn mass_properties(&self, density: Real) -> MassProperties

Compute full mass properties for a given density.

Auto Trait Implementations§

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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.