Struct bevy_math::primitives::CircularSegment

pub struct CircularSegment {
    pub arc: Arc2d,
}

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π].

Fields

arc: Arc2d

The arc defining the segment

Implementations

impl CircularSegment

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

Create a new CircularSegment from a radius, and an angle

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

Create a new CircularSegment from a radius and an angle in radians.

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

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

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

Create a new CircularSegment from a radius and a number of turns of a circle.

For instance, 0.5 turns is a semicircle.

pub fn half_angle(&self) -> f32

Get the half-angle of the segment

pub fn angle(&self) -> f32

Get the angle of the segment

pub fn radius(&self) -> f32

Get the radius of the segment

pub fn arc_length(&self) -> f32

Get the length of the arc defining the segment

pub fn half_chord_length(&self) -> f32

Get half the length of the segment’s base, also known as its chord

pub fn chord_length(&self) -> f32

Get the length of the segment’s base, also known as its chord

pub fn chord_midpoint(&self) -> Vec2

Get the midpoint of the segment’s base, also known as its chord

pub fn apothem(&self) -> f32

Get the length of the apothem of this segment, which is the signed distance between the segment and the center of its circle

See Arc2d::apothem

pub fn sagitta(&self) -> f32

Get the length of the sagitta of this segment, also known as its height

See Arc2d::sagitta

pub fn area(&self) -> f32

Returns the area of this segment

Trait Implementations

impl Bounded2d for CircularSegment

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 CircularSegment

fn clone(&self) -> CircularSegment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CircularSegment

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

Formats the value using the given formatter.

impl Default for CircularSegment

fn default() -> Self

Returns the default CircularSegment with radius 0.5 and covering a third of a circle

impl<'de> Deserialize<'de> for CircularSegment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Arc2d> for CircularSegment

fn from(arc: Arc2d) -> Self

Converts to this type from the input type.

impl FromReflect for CircularSegment

where Self: Any + Send + Sync, Arc2d: 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 CircularSegment

where Self: Any + Send + Sync, Arc2d: 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 CircularSegment

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

where Self: Any + Send + Sync, Arc2d: 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 Serialize for CircularSegment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for CircularSegment

where Self: Any + Send + Sync, Arc2d: 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 CircularSegment

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 CircularSegment

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for CircularSegment

impl Primitive2d for CircularSegment

impl StructuralPartialEq for CircularSegment