Struct CompositeShapeRef

pub struct CompositeShapeRef<'a, S: ?Sized>(pub &'a S);

A helper struct that implements scene queries on any composite shapes.

For example, the RayCast implementation of a composite shape can use this wrapper or provide its own implementation. This is for working around the lack of specialization in (stable) rust. If we did have specialization, this would just be a blanket implementation of all the geometric query traits for all S: CompositeShape.

Tuple Fields

0: &'a S

Implementations

impl<S: ?Sized + TypedCompositeShape> CompositeShapeRef<'_, S>

pub fn closest_points_to_shape<D: ?Sized + QueryDispatcher>( &self, dispatcher: &D, pose12: &Isometry<f32>, shape2: &dyn Shape, margin: f32, ) -> Option<(u32, ClosestPoints)>

Returns the closest points between self and the given shape2 positioned at pose12 relative to self.

Returns the index of the sub-shape of self involved in the contact as well as the closest points information.

Returns ClosestPoints::Disjoint if self and shape2 are separated by a distance larger than margin.

Returns None if no closest point could be calculated (e.g. if the dispatcher doesn’t support the involved shapes at all, or if self is empty).

impl<S: ?Sized + CompositeShape> CompositeShapeRef<'_, S>

pub fn contact_with_shape<D: ?Sized + QueryDispatcher>( &self, dispatcher: &D, pose12: &Isometry<f32>, shape2: &dyn Shape, prediction: f32, ) -> Option<(u32, Contact)>

Returns the closest/deepest contact between self and the given shape2 positioned at pose12 relative to self.

Returns None if self and shape2 are separated by a distance larger than prediction. Otherwise, returns the index of the sub-shape of self involved in the contact as well as the contact information.

impl<S: ?Sized + TypedCompositeShape> CompositeShapeRef<'_, S>

pub fn distance_to_shape<D: ?Sized + QueryDispatcher>( &self, dispatcher: &D, pose12: &Isometry<f32>, shape2: &dyn Shape, ) -> Option<(u32, f32)>

Calculates the closest distance between self and the given shape2 positioned at pose12 relative to self.

Returns the distance and the index of the sub-shape of self that is closest to shape2.

impl<S: ?Sized + TypedCompositeShape> CompositeShapeRef<'_, S>

pub fn intersects_shape<D: ?Sized + QueryDispatcher>( &self, dispatcher: &D, pose12: &Isometry<f32>, shape: &dyn Shape, ) -> Option<u32>

Returns the index of the shape in self that intersects the given other shape positioned at pose12 relative to self.

Returns None if no intersection is found.

impl<S: ?Sized + TypedCompositeShape> CompositeShapeRef<'_, S>

pub fn cast_shape_nonlinear<D: ?Sized + QueryDispatcher>( &self, dispatcher: &D, motion1: &NonlinearRigidMotion, motion2: &NonlinearRigidMotion, shape2: &dyn Shape, start_time: f32, end_time: f32, stop_at_penetration: bool, ) -> Option<(u32, ShapeCastHit)>

Performs a non-linear shape-cast between self animated subject to the motion1 and the shape2 subject to the motion2.

Returns the shape-cast hit (if any) as well as the index of the sub-shape of self involved in the hit.

impl<S: TypedCompositeShape> CompositeShapeRef<'_, S>

pub fn project_local_point_and_get_location( &self, point: &Point<f32>, max_dist: f32, solid: bool, ) -> Option<(u32, (PointProjection, <S::PartShape as PointQueryWithLocation>::Location))>

where S::PartShape: PointQueryWithLocation,

Project a point on this composite shape.

Returns the projected point as well as the index of the sub-shape of self that was hit. The third tuple element contains some shape-specific information about the projected point.

pub fn project_local_point( &self, point: &Point<f32>, solid: bool, ) -> (u32, PointProjection)

Project a point on this composite shape.

Returns the projected point as well as the index of the sub-shape of self that was hit. If solid is false then the point will be projected to the closest boundary of self even if it is contained by one of its sub-shapes.

pub fn project_local_point_and_get_feature( &self, point: &Point<f32>, ) -> (u32, (PointProjection, FeatureId))

Project a point on this composite shape.

Returns the projected point as well as the index of the sub-shape of self that was hit. The third tuple element contains some shape-specific information about the shape feature hit by the projection.

pub fn contains_local_point(&self, point: &Point<f32>) -> Option<u32>

Returns the index of any sub-shape of self that contains the given point.

impl<S: TypedCompositeShape> CompositeShapeRef<'_, S>

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

Casts a ray on this composite shape.

The ray is effectively limited to a segment that starts at Ray::origin and ends at Ray::origin + Ray::direction * max_time_of_impact. Set max_time_of_impact to Real::MAX for an unbounded ray.

If solid is false, then the sub-shapes of self are seen as hollow and the ray won’t immediately stop until it reaches a boundary even if it started inside a shape.

Returns the ray’s time of impact and the index of the sub-shape of self that was hit. The hit point can be retrieved with ray.point_at(t) where t is the value returned by this function.

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

Same as Self::cast_local_ray but also computes the normal at the hit location.

impl<S: ?Sized + TypedCompositeShape> CompositeShapeRef<'_, S>

pub fn cast_shape<D: ?Sized + QueryDispatcher>( &self, dispatcher: &D, pose12: &Isometry<f32>, vel12: &Vector<f32>, g2: &dyn Shape, options: ShapeCastOptions, ) -> Option<(u32, ShapeCastHit)>

Performs a shape-cast between self and a shape2 positioned at pose12 and subject to a linear velocity vel12, relative to self.

Returns the shape-cast hit (if any) as well as the index of the sub-shape of self involved in the hit.