Struct heron::rapier_plugin::rapier3d::parry::shape::Capsule

pub struct Capsule {
    pub segment: Segment,
    pub radius: f32,
}

A capsule shape defined as a round segment.

Fields

segment: Segment

The axis and endpoint of the capsule.

radius: f32

The radius of the capsule.

Implementations

impl Capsule

pub fn aabb(&self, pos: &Isometry<f32, Unit<Quaternion<f32>>, 3>) -> AABB

The axis-aligned bounding box of this capsule.

pub fn local_aabb(&self) -> AABB

The axis-aligned bounding box of this capsule.

impl Capsule

pub fn bounding_sphere(
    &self,
    pos: &Isometry<f32, Unit<Quaternion<f32>>, 3>
) -> BoundingSphere

Computes the world-space bounding sphere of this capsule, transformed by pos.

pub fn local_bounding_sphere(&self) -> BoundingSphere

Computes the world-space bounding sphere of this capsule.

impl Capsule

pub fn new_x(half_height: f32, radius: f32) -> Capsule

Creates a new capsule aligned with the x axis and with the given half-height an radius.

pub fn new_y(half_height: f32, radius: f32) -> Capsule

Creates a new capsule aligned with the y axis and with the given half-height an radius.

pub fn new_z(half_height: f32, radius: f32) -> Capsule

Creates a new capsule aligned with the z axis and with the given half-height an radius.

pub fn new(
    a: OPoint<f32, Const<3>>,
    b: OPoint<f32, Const<3>>,
    radius: f32
) -> Capsule

Creates a new capsule defined as the segment between a and b and with the given radius.

pub fn height(&self) -> f32

The height of this capsule.

pub fn half_height(&self) -> f32

The half-height of this capsule.

pub fn center(&self) -> OPoint<f32, Const<3>>

The center of this capsule.

pub fn transform_by(
    &self,
    pos: &Isometry<f32, Unit<Quaternion<f32>>, 3>
) -> Capsule

Creates a new capsule equal to self with all its endpoints transformed by pos.

pub fn canonical_transform(&self) -> Isometry<f32, Unit<Quaternion<f32>>, 3>

The transformation such that t * Y is collinear with b - a and t * origin equals the capsule’s center.

pub fn rotation_wrt_y(&self) -> Unit<Quaternion<f32>>

The rotation r such that r * Y is collinear with b - a.

pub fn transform_wrt_y(&self) -> Isometry<f32, Unit<Quaternion<f32>>, 3>

The transform t such that t * Y is collinear with b - a and such that t * origin = (b + a) / 2.0.

pub fn scaled(
    self,
    scale: &Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>,
    nsubdivs: u32
) -> Option<Either<Capsule, ConvexPolyhedron>>

Computes a scaled version of this capsule.

If the scaling factor is non-uniform, then it can’t be represented as capsule. Instead, a convex polygon approximation (with nsubdivs subdivisions) is returned. Returns None if that approximation had degenerate normals (for example if the scaling factor along one axis is zero).

impl Capsule

pub fn to_outline(
    &self,
    nsubdiv: u32
) -> (Vec<OPoint<f32, Const<3>>, Global>, Vec<[u32; 2], Global>)

Outlines this capsule’s shape using polylines.

impl Capsule

pub fn to_trimesh(
    &self,
    ntheta_subdiv: u32,
    nphi_subdiv: u32
) -> (Vec<OPoint<f32, Const<3>>, Global>, Vec<[u32; 3], Global>)

Discretize the boundary of this capsule as a triangle-mesh.

Trait Implementations

impl Clone for Capsule

fn clone(&self) -> Capsule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Capsule

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

Formats the value using the given formatter.

impl PointQuery for Capsule

fn project_local_point(
    &self,
    pt: &OPoint<f32, Const<3>>,
    solid: bool
) -> PointProjection

Projects a point on self.

fn project_local_point_and_get_feature(
    &self,
    pt: &OPoint<f32, Const<3>>
) -> (PointProjection, FeatureId)

Projects a point on the boundary of self and returns the id of the feature the point was projected on.

fn project_local_point_with_max_dist(
    &self,
    pt: &OPoint<f32, Const<3>>,
    solid: bool,
    max_dist: f32
) -> Option<PointProjection>

Projects a point on self, unless the projection lies further than the given max distance.

fn project_point_with_max_dist(
    &self,
    m: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    pt: &OPoint<f32, Const<3>>,
    solid: bool,
    max_dist: f32
) -> Option<PointProjection>

Projects a point on self transformed by m, unless the projection lies further than the given max distance.

fn distance_to_local_point(&self, pt: &OPoint<f32, Const<3>>, solid: bool) -> f32

Computes the minimal distance between a point and self.

fn contains_local_point(&self, pt: &OPoint<f32, Const<3>>) -> bool

Tests if the given point is inside of self.

fn project_point(
    &self,
    m: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    pt: &OPoint<f32, Const<3>>,
    solid: bool
) -> PointProjection

Projects a point on self transformed by m.

fn distance_to_point(
    &self,
    m: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    pt: &OPoint<f32, Const<3>>,
    solid: bool
) -> f32

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

fn project_point_and_get_feature(
    &self,
    m: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    pt: &OPoint<f32, Const<3>>
) -> (PointProjection, FeatureId)

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

fn contains_point(
    &self,
    m: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    pt: &OPoint<f32, Const<3>>
) -> bool

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

impl RayCast for Capsule

fn cast_local_ray_and_get_normal(
    &self,
    ray: &Ray,
    max_toi: f32,
    solid: bool
) -> Option<RayIntersection>

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

fn cast_local_ray(&self, ray: &Ray, max_toi: f32, solid: bool) -> Option<f32>

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

fn intersects_local_ray(&self, ray: &Ray, max_toi: f32) -> bool

Tests whether a ray intersects this transformed shape.

fn cast_ray(
    &self,
    m: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    ray: &Ray,
    max_toi: f32,
    solid: bool
) -> Option<f32>

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

fn cast_ray_and_get_normal(
    &self,
    m: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    ray: &Ray,
    max_toi: f32,
    solid: bool
) -> Option<RayIntersection>

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

fn intersects_ray(
    &self,
    m: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    ray: &Ray,
    max_toi: f32
) -> bool

Tests whether a ray intersects this transformed shape.

impl Shape for Capsule

fn clone_box(&self) -> Box<dyn Shape + 'static, Global>

Clones this shape into a boxed trait-object.

fn compute_local_aabb(&self) -> AABB

Computes the AABB of this shape.

fn compute_local_bounding_sphere(&self) -> BoundingSphere

Computes the bounding-sphere of this shape.

fn compute_aabb(
    &self,
    position: &Isometry<f32, Unit<Quaternion<f32>>, 3>
) -> AABB

Computes the AABB of this shape with the given position.

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

Compute the mass-properties of this shape given its uniform density.

fn is_convex(&self) -> bool

Is this shape known to be convex?

fn shape_type(&self) -> ShapeType

Gets the type tag of this shape.

fn as_typed_shape(&self) -> TypedShape<'_>

Gets the underlying shape as an enum.

fn ccd_thickness(&self) -> f32

fn ccd_angular_thickness(&self) -> f32

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

Convents this shape into its support mapping, if it has one.

fn as_polygonal_feature_map(&self) -> Option<(&dyn PolygonalFeatureMap, f32)>

Converts this shape to a polygonal feature-map, if it is one.

fn compute_bounding_sphere(
    &self,
    position: &Isometry<f32, Unit<Quaternion<f32>>, 3>
) -> BoundingSphere

Computes the bounding-sphere of this shape with the given position.

fn as_composite_shape(&self) -> Option<&dyn SimdCompositeShape>

fn feature_normal_at_point(
    &self,
    _feature: FeatureId,
    _point: &OPoint<f32, Const<3>>
) -> Option<Unit<Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>>>

The shape’s normal at the given point located on a specific feature.

fn compute_swept_aabb(
    &self,
    start_pos: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    end_pos: &Isometry<f32, Unit<Quaternion<f32>>, 3>
) -> AABB

Computes the swept AABB of this shape, i.e., the space it would occupy by moving from the given start position to the given end position.

impl SupportMap for Capsule

fn local_support_point(
    &self,
    dir: &Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>
) -> OPoint<f32, Const<3>>

fn local_support_point_toward(
    &self,
    dir: &Unit<Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>>
) -> OPoint<f32, Const<3>>

Same as self.local_support_point except that dir is normalized.

fn support_point(
    &self,
    transform: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    dir: &Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>
) -> OPoint<f32, Const<3>>

fn support_point_toward(
    &self,
    transform: &Isometry<f32, Unit<Quaternion<f32>>, 3>,
    dir: &Unit<Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>>
) -> OPoint<f32, Const<3>>

Same as self.support_point except that dir is normalized.

impl Copy for Capsule