Struct bevy_math::primitives::CircularSegment
source · pub struct CircularSegment {
pub arc: Arc2d,
}
Expand 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π].
Fields§
§arc: Arc2d
The arc defining the segment
Implementations§
source§impl CircularSegment
impl CircularSegment
sourcepub fn new(radius: f32, angle: f32) -> Self
pub fn new(radius: f32, angle: f32) -> Self
Create a new CircularSegment
from a radius
, and an angle
sourcepub fn from_radians(radius: f32, angle: f32) -> Self
pub fn from_radians(radius: f32, angle: f32) -> Self
Create a new CircularSegment
from a radius
and an angle
in radians.
sourcepub fn from_degrees(radius: f32, angle: f32) -> Self
pub fn from_degrees(radius: f32, angle: f32) -> Self
Create a new CircularSegment
from a radius
and an angle
in degrees.
sourcepub fn from_turns(radius: f32, fraction: f32) -> Self
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.
sourcepub fn half_angle(&self) -> f32
pub fn half_angle(&self) -> f32
Get the half-angle of the segment
sourcepub fn arc_length(&self) -> f32
pub fn arc_length(&self) -> f32
Get the length of the arc defining the segment
sourcepub fn half_chord_length(&self) -> f32
pub fn half_chord_length(&self) -> f32
Get half the length of the segment’s base, also known as its chord
sourcepub fn chord_length(&self) -> f32
pub fn chord_length(&self) -> f32
Get the length of the segment’s base, also known as its chord
sourcepub fn chord_midpoint(&self) -> Vec2
pub fn chord_midpoint(&self) -> Vec2
Get the midpoint of the segment’s base, also known as its chord
sourcepub fn apothem(&self) -> f32
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
sourcepub fn sagitta(&self) -> f32
pub fn sagitta(&self) -> f32
Get the length of the sagitta of this segment, also known as its height
See Arc2d::sagitta
Trait Implementations§
source§impl Bounded2d for CircularSegment
impl Bounded2d for CircularSegment
source§fn aabb_2d(&self, translation: Vec2, rotation: impl Into<Rot2>) -> Aabb2d
fn aabb_2d(&self, translation: Vec2, rotation: impl Into<Rot2>) -> Aabb2d
source§fn bounding_circle(
&self,
translation: Vec2,
rotation: impl Into<Rot2>
) -> BoundingCircle
fn bounding_circle( &self, translation: Vec2, rotation: impl Into<Rot2> ) -> BoundingCircle
source§impl Clone for CircularSegment
impl Clone for CircularSegment
source§fn clone(&self) -> CircularSegment
fn clone(&self) -> CircularSegment
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CircularSegment
impl Debug for CircularSegment
source§impl Default for CircularSegment
impl Default for CircularSegment
source§fn default() -> Self
fn default() -> Self
Returns the default CircularSegment
with radius 0.5
and covering a third of a circle
source§impl<'de> Deserialize<'de> for CircularSegment
impl<'de> Deserialize<'de> for CircularSegment
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl From<Arc2d> for CircularSegment
impl From<Arc2d> for CircularSegment
source§impl FromReflect for CircularSegment
impl FromReflect for CircularSegment
source§fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
Self
from a reflected value.source§fn take_from_reflect(
reflect: Box<dyn Reflect>
) -> Result<Self, Box<dyn Reflect>>
fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>
Self
using,
constructing the value using from_reflect
if that fails. Read moresource§impl GetTypeRegistration for CircularSegment
impl GetTypeRegistration for CircularSegment
source§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.source§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
source§impl PartialEq for CircularSegment
impl PartialEq for CircularSegment
source§fn eq(&self, other: &CircularSegment) -> bool
fn eq(&self, other: &CircularSegment) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Reflect for CircularSegment
impl Reflect for CircularSegment
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl Serialize for CircularSegment
impl Serialize for CircularSegment
source§impl Struct for CircularSegment
impl Struct for CircularSegment
source§fn field(&self, name: &str) -> Option<&dyn Reflect>
fn field(&self, name: &str) -> Option<&dyn Reflect>
name
as a &dyn Reflect
.source§fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
name
as a
&mut dyn Reflect
.source§fn field_at(&self, index: usize) -> Option<&dyn Reflect>
fn field_at(&self, index: usize) -> Option<&dyn Reflect>
index
as a
&dyn Reflect
.source§fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
index
as a &mut dyn Reflect
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl TypePath for CircularSegment
impl TypePath for CircularSegment
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl Typed for CircularSegment
impl Typed for CircularSegment
impl Copy for CircularSegment
impl Primitive2d for CircularSegment
impl StructuralPartialEq for CircularSegment
Auto Trait Implementations§
impl Freeze for CircularSegment
impl RefUnwindSafe for CircularSegment
impl Send for CircularSegment
impl Sync for CircularSegment
impl Unpin for CircularSegment
impl UnwindSafe for CircularSegment
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
source§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
source§impl<T> GetPath for T
impl<T> GetPath for T
source§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more