CircularSegment

CircularSegment

  • arc : bevy_math::primitives::dim2::Arc2d

Description

A primitive representing a circular segment: the area enclosed by the arc of a circle and its chord (the line between its endpoints).

The segment is drawn starting from [Vec2::Y], extending equally on either side. To orient the segment differently, apply a rotation. The segment is drawn with the center of its circle at the origin [Vec2::ZERO]. When positioning a segment, the apothem function may be particularly useful.

Warning: Circular segments with negative angle or radius, or with angle greater than an entire circle, are not officially supported. We recommend normalizing circular segments to have an angle in [0, 2π].

Functions

FunctionSummary
angle(_self) Get the angle of the segment
apothem(_self) Get the length of the apothem of this segment, which is the signed distance between the segment an
arc_length(_self) Get the length of the arc defining the segment
chord_length(_self) Get the length of the segment's base, also known as its chord
chord_midpoint(_self) Get the midpoint of the segment's base, also known as its chord
clone(_self)No Documentation 🚧
eq(_self, other)No Documentation 🚧
from_degrees(radius, angle) Create a new [`CircularSegment`] from a `radius` and an `angle` in degrees.
from_radians(radius, angle) Create a new [`CircularSegment`] from a `radius` and an `angle` in radians.
from_turns(radius, fraction) Create a new [`CircularSegment`] from a `radius` and a number of `turns` of a circle. For instance, `0.5` turns is a semicircle.
half_angle(_self) Get the half-angle of the segment
half_chord_length(_self) Get half the length of the segment's base, also known as its chord
new(radius, angle) Create a new [`CircularSegment`] from a `radius`, and an `angle`
radius(_self) Get the radius of the segment
sagitta(_self) Get the length of the sagitta of this segment, also known as its height See [`Arc2d::sagitta`]