Struct RegularPolygonColliderShape

pub struct RegularPolygonColliderShape(pub RegularPolygon);

A regular polygon shape that can be stored in a SharedShape for a regular polygon Collider.

This wrapper is required to allow implementing the necessary traits from parry for Bevy’s RegularPolygon type.

Tuple Fields

0: RegularPolygon

Methods from Deref<Target = RegularPolygon>

pub fn circumradius(&self) -> f32

Get the radius of the circumcircle on which all vertices of the regular polygon lie

pub fn inradius(&self) -> f32

Get the inradius or apothem of the regular polygon. This is the radius of the largest circle that can be drawn within the polygon

pub fn side_length(&self) -> f32

Get the length of one side of the regular polygon

pub fn internal_angle_degrees(&self) -> f32

Get the internal angle of the regular polygon in degrees.

This is the angle formed by two adjacent sides with points within the angle being in the interior of the polygon

pub fn internal_angle_radians(&self) -> f32

Get the internal angle of the regular polygon in radians.

This is the angle formed by two adjacent sides with points within the angle being in the interior of the polygon

pub fn external_angle_degrees(&self) -> f32

Get the external angle of the regular polygon in degrees.

This is the angle formed by two adjacent sides with points within the angle being in the exterior of the polygon

pub fn external_angle_radians(&self) -> f32

Get the external angle of the regular polygon in radians.

This is the angle formed by two adjacent sides with points within the angle being in the exterior of the polygon

Trait Implementations

impl Clone for RegularPolygonColliderShape

fn clone(&self) -> RegularPolygonColliderShape

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegularPolygonColliderShape

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

Formats the value using the given formatter.

impl Deref for RegularPolygonColliderShape

type Target = RegularPolygon

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for RegularPolygonColliderShape

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl PointQuery for RegularPolygonColliderShape

fn project_local_point( &self, pt: &Point<Scalar>, solid: bool, ) -> PointProjection

Projects a point on self.

fn project_local_point_and_get_feature( &self, pt: &Point<Scalar>, ) -> (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<2>>, 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<Complex<f32>>, 2>, pt: &OPoint<f32, Const<2>>, 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<2>>, solid: bool, ) -> f32

Computes the minimal distance between a point and self.

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

Tests if the given point is inside of self.

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

Projects a point on self transformed by m.

fn distance_to_point( &self, m: &Isometry<f32, Unit<Complex<f32>>, 2>, pt: &OPoint<f32, Const<2>>, 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<Complex<f32>>, 2>, pt: &OPoint<f32, Const<2>>, ) -> (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<Complex<f32>>, 2>, pt: &OPoint<f32, Const<2>>, ) -> bool

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

impl PolygonalFeatureMap for RegularPolygonColliderShape

fn local_support_feature( &self, direction: &UnitVector2<Scalar>, out_feature: &mut PolygonalFeature, )

Compute the support polygonal face of self towards the dir.

fn is_convex_polyhedron(&self) -> bool

Is this shape a ConvexPolyhedron?

impl RayCast for RegularPolygonColliderShape

fn cast_local_ray_and_get_normal( &self, ray: &Ray, max_toi: Scalar, 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_time_of_impact: 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_time_of_impact: f32) -> bool

Tests whether a ray intersects this transformed shape.

fn cast_ray( &self, m: &Isometry<f32, Unit<Complex<f32>>, 2>, ray: &Ray, max_time_of_impact: 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<Complex<f32>>, 2>, ray: &Ray, max_time_of_impact: 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<Complex<f32>>, 2>, ray: &Ray, max_time_of_impact: f32, ) -> bool

Tests whether a ray intersects this transformed shape.

impl Shape for RegularPolygonColliderShape

fn clone_dyn(&self) -> Box<dyn Shape>

Clones this shape into a boxed trait-object.

fn scale_dyn( &self, scale: &Vector<Scalar>, _num_subdivisions: u32, ) -> Option<Box<dyn Shape>>

Scales this shape by scale into a boxed trait-object.

fn compute_local_aabb(&self) -> Aabb

Computes the Aabb of this shape.

fn compute_aabb(&self, position: &Isometry<Scalar>) -> Aabb

Computes the Aabb of this shape with the given position.

fn compute_local_bounding_sphere(&self) -> BoundingSphere

Computes the bounding-sphere of this shape.

fn compute_bounding_sphere(&self, position: &Isometry<Scalar>) -> BoundingSphere

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

fn clone_box(&self) -> Box<dyn Shape>

👎Deprecated: renamed to clone_dyn

Clones this shape into a boxed trait-object.

fn mass_properties(&self, density: Scalar) -> 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) -> Scalar

fn ccd_angular_thickness(&self) -> Scalar

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

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

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

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

fn feature_normal_at_point( &self, feature: FeatureId, _point: &Point2<Scalar>, ) -> Option<UnitVector2<Scalar>>

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

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

fn compute_swept_aabb( &self, start_pos: &Isometry<f32, Unit<Complex<f32>>, 2>, end_pos: &Isometry<f32, Unit<Complex<f32>>, 2>, ) -> 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 RegularPolygonColliderShape

fn local_support_point(&self, direction: &Vector2<Scalar>) -> Point2<Scalar>

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

Same as self.local_support_point except that dir is normalized.

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

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

Same as self.support_point except that dir is normalized.

impl Copy for RegularPolygonColliderShape