Struct Capsule 

pub struct Capsule { /* private fields */ }

A capsule shape centered at the origin, aligned along the Y-axis.

A capsule consists of a cylinder with hemispherical caps at both ends. It’s commonly used in physics engines for character controllers because it provides good collision detection while being easy to rotate.

The capsule is centered at the origin (0, 0, 0) and extends along the Y-axis.

Examples

use phys_geom::shape::Capsule;

// Create a capsule with half-height 2.0 and radius 0.5
let capsule = Capsule::new(2.0, 0.5);
assert_eq!(capsule.half_height(), 2.0);
assert_eq!(capsule.radius(), 0.5);
assert_eq!(capsule.height(), 4.0); // total height

Dimensions

• half_height: Height of the cylindrical portion (excluding caps)
• radius: Radius of both the cylinder and the hemispherical caps
• Total height = 2 * half_height + 2 * radius

Implementations

impl Capsule

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

Creates a new capsule with the given dimensions.

Arguments

• half_height - Half the height of the cylindrical portion (must be non-negative)
• radius - The radius of the capsule (must be positive)

Returns

A new Capsule instance.

Panics

Panics if:

• half_height is negative
• radius is not positive

Examples

use phys_geom::shape::Capsule;

// Create a capsule with cylindrical portion 3 units tall and 0.5 unit radius
let capsule = Capsule::new(1.5, 0.5);
assert_eq!(capsule.height(), 3.0);

pub fn height(&self) -> Real

Returns the height of the cylindrical portion of the capsule.

This is the height of just the cylindrical part, excluding the hemispherical caps. Height = 2 * half_height

Returns

The height of the cylindrical portion as a Real.

Examples

use phys_geom::shape::Capsule;

let capsule = Capsule::new(2.0, 0.5);
assert_eq!(capsule.height(), 4.0); // cylinder height = 2 * half_height

pub fn half_height(&self) -> Real

Returns the half height of the cylindrical portion.

This is the height of the cylindrical part excluding the hemispherical caps.

Returns

The half height as a Real.

Examples

use phys_geom::shape::Capsule;

let capsule = Capsule::new(2.0, 0.5);
assert_eq!(capsule.half_height(), 2.0);

pub fn radius(&self) -> Real

Returns the radius of the capsule.

This is the radius of both the cylindrical body and the hemispherical caps.

Returns

The radius as a Real.

Examples

use phys_geom::shape::Capsule;

let capsule = Capsule::new(2.0, 0.5);
assert_eq!(capsule.radius(), 0.5);

Trait Implementations

impl Clone for Capsule

fn clone(&self) -> Capsule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComputeAabb3 for Capsule

fn compute_aabb(&self) -> Aabb3

Compute the AABB in local space.

impl ComputeVolume for Capsule

fn compute_volume(&self) -> Real

Computes the volume of this shape.

impl Debug for Capsule

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

Formats the value using the given formatter.

impl Default for Capsule

fn default() -> Capsule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Capsule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Capsule

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Capsule

impl StructuralPartialEq for Capsule