Struct ncollide3d::shape::Capsule

pub struct Capsule<N> { /* fields omitted */ }

SupportMap description of a capsule shape with its principal axis aligned with the y axis.

Methods

impl<N: RealField> Capsule<N>

pub fn new(half_height: N, radius: N) -> Capsule<N>

Creates a new capsule.

Arguments:

• half_height - the half length of the capsule along the y axis.
• radius - radius of the rounded part of the capsule.

pub fn half_height(&self) -> N

The capsule half length along its local y axis.

pub fn height(&self) -> N

The capsule height along its local y axis.

pub fn radius(&self) -> N

The radius of the capsule's rounded part.

pub fn segment(&self) -> Segment<N>

The segment that, once dilated by self.radius yields this capsule.

pub fn contact_preprocessor(&self) -> impl ContactPreprocessor<N>

The contact preprocessor to be used for contact determination with this capsule.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<N: RealField> HasBoundingVolume<N, AABB<N>> for Capsule<N>

fn bounding_volume(&self, m: &Isometry<N>) -> AABB<N>

The bounding volume of self transformed by m.

fn local_bounding_volume(&self) -> AABB<N>

The bounding volume of self.

impl<N: RealField> HasBoundingVolume<N, BoundingSphere<N>> for Capsule<N>

fn bounding_volume(&self, m: &Isometry<N>) -> BoundingSphere<N>

The bounding volume of self transformed by m.

fn local_bounding_volume(&self) -> BoundingSphere<N>

The bounding volume of self.

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

fn eq(&self, other: &Capsule<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Capsule<N>) -> bool

This method tests for !=.

impl<N: RealField> PointQuery<N> for Capsule<N>

fn project_point(
    &self,
    m: &Isometry<N>,
    pt: &Point<N>,
    solid: bool
) -> PointProjection<N>

Projects a point on self transformed by m.

fn project_point_with_feature(
    &self,
    m: &Isometry<N>,
    pt: &Point<N>
) -> (PointProjection<N>, FeatureId)

Projects a point on the boundary of self transformed by m and retuns the id of the feature the point was projected on.

fn distance_to_point(&self, m: &Isometry<N>, pt: &Point<N>, solid: bool) -> N

Computes the minimal distance between a point and self transformed by m.

fn contains_point(&self, m: &Isometry<N>, pt: &Point<N>) -> bool

Tests if the given point is inside of self transformed by m.

impl<N: RealField> RayCast<N> for Capsule<N>

fn toi_and_normal_with_ray(
    &self,
    m: &Isometry<N>,
    ray: &Ray<N>,
    max_toi: N,
    solid: bool
) -> Option<RayIntersection<N>>

Computes the time of impact, and normal between this transformed shape and a ray.

fn toi_with_ray(
    &self,
    m: &Isometry<N>,
    ray: &Ray<N>,
    max_toi: N,
    solid: bool
) -> Option<N>

Computes the time of impact between this transform shape and a ray.

fn toi_and_normal_and_uv_with_ray(
    &self,
    m: &Isometry<N>,
    ray: &Ray<N>,
    max_toi: N,
    solid: bool
) -> Option<RayIntersection<N>>

Computes time of impact, normal, and texture coordinates (uv) between this transformed shape and a ray.

fn intersects_ray(&self, m: &Isometry<N>, ray: &Ray<N>, max_toi: N) -> bool

Tests whether a ray intersects this transformed shape.

impl<N: RealField> Shape<N> for Capsule<N>

fn aabb(&self, m: &Isometry<N>) -> AABB<N>

The AABB of self transformed by m.

fn local_aabb(&self) -> AABB<N>

The AABB of self.

fn bounding_sphere(&self, m: &Isometry<N>) -> BoundingSphere<N>

The bounding sphere of self transformed by m.

fn as_ray_cast(&self) -> Option<&dyn RayCast<N>>

The RayCast implementation of self.

fn as_point_query(&self) -> Option<&dyn PointQuery<N>>

The PointQuery implementation of self.

fn as_support_map(&self) -> Option<&dyn SupportMap<N>>

The support mapping of self if applicable.

fn is_support_map(&self) -> bool

Whether self uses a support-mapping based representation.

fn tangent_cone_contains_dir(
    &self,
    _: FeatureId,
    _: &Isometry<N>,
    _: Option<&[N]>,
    _: &Unit<Vector<N>>
) -> bool

Check if if the feature _feature of the i-th subshape of self transformed by m has a tangent cone that contains dir at the point pt.

fn local_bounding_sphere(&self) -> BoundingSphere<N>

The bounding sphere of self.

fn subshape_containing_feature(&self, _i: FeatureId) -> usize

Returns the id of the subshape containing the specified feature.

fn as_convex_polyhedron(&self) -> Option<&dyn ConvexPolyhedron<N>>

The convex polyhedron representation of self if applicable.

fn as_composite_shape(&self) -> Option<&dyn CompositeShape<N>>

The composite shape representation of self if applicable.

fn as_deformable_shape(&self) -> Option<&dyn DeformableShape<N>>

The deformable shape representation of self if applicable.

fn as_deformable_shape_mut(&mut self) -> Option<&mut dyn DeformableShape<N>>

The mutable deformable shape representation of self if applicable.

fn is_convex_polyhedron(&self) -> bool

Whether self uses a convex polyhedron representation.

fn is_composite_shape(&self) -> bool

Whether self uses a composite shape-based representation.

fn is_deformable_shape(&self) -> bool

Whether self uses a composite shape-based representation.

impl<N> StructuralPartialEq for Capsule<N>

impl<N: RealField> SupportMap<N> for Capsule<N>

fn support_point(&self, m: &Isometry<N>, dir: &Vector<N>) -> Point<N>

Evaluates the support function of the object.

fn support_point_toward(
    &self,
    m: &Isometry<N>,
    dir: &Unit<Vector<N>>
) -> Point<N>

Same as self.support_point except that dir is normalized.

impl<N: RealField> ToTriMesh<N> for Capsule<N>

type DiscretizationParameter = (u32, u32)

fn to_trimesh(&self, (ntheta_subdiv, nphi_subdiv): (u32, u32)) -> TriMesh<N>

Builds a triangle mesh from this shape.