Struct bevy_math::primitives::Arc2d

pub struct Arc2d {
    pub radius: f32,
    pub half_angle: f32,
}

A primitive representing an arc between two points on a circle.

An arc has no area. If you want to include the portion of a circle’s area swept out by the arc, use the pie-shaped CircularSector. If you want to include only the space inside the convex hull of the arc, use the bowl-shaped CircularSegment.

The arc is drawn starting from Vec2::Y, extending by half_angle radians on either side. The center of the circle is the origin Vec2::ZERO. Note that this means that the origin may not be within the Arc2d’s convex hull.

Warning: Arcs with negative angle or radius, or with angle greater than an entire circle, are not officially supported. It is recommended to normalize arcs to have an angle in [0, 2π].

Fields

radius: f32

The radius of the circle

half_angle: f32

Half the angle defining the arc

Implementations

impl Arc2d

pub fn new(radius: f32, half_angle: f32) -> Self

Create a new Arc2d from a radius and a half_angle

pub fn from_radians(radius: f32, angle: f32) -> Self

Create a new Arc2d from a radius and an angle in radians

pub fn from_degrees(radius: f32, angle: f32) -> Self

Create a new Arc2d from a radius and an angle in degrees.

pub fn from_turns(radius: f32, fraction: f32) -> Self

Create a new Arc2d from a radius and a fraction of a single turn.

For instance, 0.5 turns is a semicircle.

pub fn angle(&self) -> f32

Get the angle of the arc

pub fn length(&self) -> f32

Get the length of the arc

pub fn right_endpoint(&self) -> Vec2

Get the right-hand end point of the arc

pub fn left_endpoint(&self) -> Vec2

Get the left-hand end point of the arc

pub fn endpoints(&self) -> [Vec2; 2]

Get the endpoints of the arc

pub fn midpoint(&self) -> Vec2

Get the midpoint of the arc

pub fn half_chord_length(&self) -> f32

Get half the distance between the endpoints (half the length of the chord)

pub fn chord_length(&self) -> f32

Get the distance between the endpoints (the length of the chord)

pub fn chord_midpoint(&self) -> Vec2

Get the midpoint of the two endpoints (the midpoint of the chord)

pub fn apothem(&self) -> f32

Get the length of the apothem of this arc, that is, the distance from the center of the circle to the midpoint of the chord, in the direction of the midpoint of the arc. Equivalently, the radius minus the sagitta.

Note that for a major arc, the apothem will be negative.

pub fn sagitta(&self) -> f32

Get the length of the sagitta of this arc, that is, the length of the line between the midpoints of the arc and its chord. Equivalently, the height of the triangle whose base is the chord and whose apex is the midpoint of the arc.

The sagitta is also the sum of the radius and the apothem.

pub fn is_minor(&self) -> bool

Produces true if the arc is at most half a circle.

Note: This is not the negation of is_major: an exact semicircle is both major and minor.

pub fn is_major(&self) -> bool

Produces true if the arc is at least half a circle.

Note: This is not the negation of is_minor: an exact semicircle is both major and minor.

Trait Implementations

impl Bounded2d for Arc2d

fn aabb_2d(&self, translation: Vec2, rotation: impl Into<Rot2>) -> 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: impl Into<Rot2> ) -> BoundingCircle

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

impl Clone for Arc2d

fn clone(&self) -> Arc2d

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Arc2d

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

Formats the value using the given formatter.

impl Default for Arc2d

fn default() -> Self

Returns the default Arc2d with radius 0.5, covering one third of a circle

impl From<Arc2d> for CircularSector

fn from(arc: Arc2d) -> Self

Converts to this type from the input type.

impl From<Arc2d> for CircularSegment

fn from(arc: Arc2d) -> Self

Converts to this type from the input type.

impl FromReflect for Arc2d

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Arc2d

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for Arc2d

fn eq(&self, other: &Arc2d) -> 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 Reflect for Arc2d

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for Arc2d

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for Arc2d

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Arc2d

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Arc2d

impl Primitive2d for Arc2d

impl StructuralPartialEq for Arc2d