Struct Capsule 

pub struct Capsule<const N: usize> {
    pub radius: PositiveReal,
    pub height: PositiveReal,
}

All points less than or equal to a distance r from a line segment of length h.

This line is oriented along the [0 0 ... 1] direction, and has extents +h/2, -h/2 along that axis.

Examples

Construction and basic methods:

use approxim::assert_relative_eq;
use hoomd_geometry::{BoundingSphereRadius, Volume, shape::Capsule};
use hoomd_vector::Cartesian;
use std::f64::consts::PI;

let capsule = Capsule::<2> {
    radius: 1.0.try_into()?,
    height: 8.0.try_into()?,
};
let bounding_radius = capsule.bounding_sphere_radius();
let volume = capsule.volume();

assert_eq!(bounding_radius.get(), 5.0);
assert_relative_eq!(volume, 16.0 + PI);

Intersection test:

use hoomd_geometry::{Convex, IntersectsAt, shape::Capsule};
use hoomd_vector::{Angle, Cartesian, Rotation};
use std::f64::consts::PI;

let capsule = Capsule::<2> {
    radius: 1.0.try_into()?,
    height: 8.0.try_into()?,
};

assert!(capsule.intersects_at(
    &capsule,
    &[1.75, 0.0].into(),
    &Angle::identity()
));
assert!(!capsule.intersects_at(
    &capsule,
    &[4.0, 2.0].into(),
    &Angle::identity()
),);
assert!(capsule.intersects_at(
    &capsule,
    &[4.0, -2.0].into(),
    &Angle::from(PI / 2.0)
));

Fields

radius: PositiveReal

Radius of points that are considered enclosed in the shape.

height: PositiveReal

Length of the line segment.

Trait Implementations

impl<const N: usize> BoundingSphereRadius for Capsule<N>

fn bounding_sphere_radius(&self) -> PositiveReal

Get the bounding radius.

impl<const N: usize> Clone for Capsule<N>

fn clone(&self) -> Capsule<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Capsule<N>

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

Formats the value using the given formatter.

impl<'de, const N: usize> Deserialize<'de> for Capsule<N>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize, R> IntersectsAt<Capsule<N>, Cartesian<N>, R> for Capsule<N>

where R: Rotate<Cartesian<N>> + Rotation, Cartesian<N>: From<[f64; N]>,

fn intersects_at( &self, other: &Capsule<N>, v_ij: &Cartesian<N>, o_ij: &R, ) -> bool

Test whether the set of points in one shape intersects with the set of another (in the local frame).

fn approximate_separation_distance( &self, other: &S, v_ij: &V, o_ij: &R, resolution: PositiveReal, ) -> f64

where V: InnerProduct,

Approximate the amount of overlap between two shapes.

impl<const N: usize, R> IntersectsAtGlobal<Capsule<N>, Cartesian<N>, R> for Capsule<N>

where R: Rotation + Rotate<Cartesian<N>>,

fn intersects_at_global( &self, other: &Capsule<N>, r_self: &Cartesian<N>, o_self: &R, r_other: &Cartesian<N>, o_other: &R, ) -> bool

Test whether the set of points in one shape intersects with the set of another (in the global frame).

impl<const N: usize> PartialEq for Capsule<N>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> SupportMapping<Cartesian<N>> for Capsule<N>

fn support_mapping(&self, n: &Cartesian<N>) -> Cartesian<N>

Return the furthest extent of a shape in the direction of n.

impl<const N: usize> Volume for Capsule<N>

fn volume(&self) -> f64

The N-hypervolume of a geometry.

impl<const N: usize> StructuralPartialEq for Capsule<N>