Struct bevy_math::primitives::RegularPolygon

pub struct RegularPolygon {
    pub circumcircle: Circle,
    pub sides: usize,
}

A polygon where all vertices lie on a circle, equally far apart.

Fields

circumcircle: Circle

The circumcircle on which all vertices lie

sides: usize

The number of sides

Implementations

impl RegularPolygon

pub fn new(circumradius: f32, sides: usize) -> Self

Create a new RegularPolygon from the radius of the circumcircle and a number of sides

Panics

Panics if circumradius is non-positive

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 area(&self) -> f32

Get the area of the regular polygon

pub fn perimeter(&self) -> f32

Get the perimeter of the regular polygon. This is the sum of its sides

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

pub fn vertices(self, rotation: f32) -> impl IntoIterator<Item = Vec2>

Returns an iterator over the vertices of the regular polygon, rotated counterclockwise by the given angle in radians.

With a rotation of 0, a vertex will be placed at the top (0.0, circumradius).

Trait Implementations

impl Bounded2d for RegularPolygon

fn aabb_2d(&self, translation: Vec2, rotation: f32) -> Aabb2d

Get an axis-aligned bounding box for the shape with the given translation and rotation. The rotation is in radians, counterclockwise, with 0 meaning no rotation.

fn bounding_circle(&self, translation: Vec2, _rotation: f32) -> BoundingCircle

Get a bounding circle for the shape The rotation is in radians, counterclockwise, with 0 meaning no rotation.

impl Clone for RegularPolygon

fn clone(&self) -> RegularPolygon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegularPolygon

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

Formats the value using the given formatter.

impl Default for RegularPolygon

fn default() -> Self

Returns the default RegularPolygon with six sides (a hexagon) and a circumradius of 0.5.

impl PartialEq for RegularPolygon

fn eq(&self, other: &RegularPolygon) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RegularPolygon

impl Primitive2d for RegularPolygon

impl StructuralPartialEq for RegularPolygon