Struct Circle 

#[repr(C)]
pub struct Circle<T> {
    pub center: Vec2<T>,
    pub radius: T,
}

A circle, represented by a center point and radius.

Fields

center: Vec2<T>

radius: T

Implementations

impl<T: Copy + AbsDiffEq<Epsilon = T>> Circle<T>

pub fn abs_diff_eq(&self, other: &Self) -> bool

Returns true if the two values are approximately equal according to the absolute difference between their components.

impl<T: Copy + RelativeEq<Epsilon = T>> Circle<T>

pub fn relative_eq(&self, other: &Self) -> bool

Returns true if the two values are approximately equal according to the absolute difference between their components, as well as relative-based comparisons.

impl<T: Copy + UlpsEq<Epsilon = T>> Circle<T>

pub fn ulps_eq(&self, other: &Self) -> bool

Returns true if the two values are approximately equal according to the absolute difference between their components, as well as ULPs (Units in Last Place).

impl<T> Circle<T>

pub const fn new(center: Vec2<T>, radius: T) -> Self

Create a new circle.

impl<T: Num> Circle<T>

pub const ZERO: Self

A circle at (0, 0) with radius 0.

pub const UNIT: Self

A unit circle at (0, 0) with radius 1.

pub fn with_radius(radius: T) -> Self

Create a circle at (0, 0) with the provided radius.

pub fn diameter(&self) -> T

Diameter of the circle.

pub fn overlaps(&self, other: &Circle<T>) -> bool

Returns true if the two circles overlap.

impl<T: Float> Circle<T>

pub fn area(&self) -> T

Area of the circle.

pub fn circumference(&self) -> T

Circumference of the circle.

pub fn contains_circ(&self, other: &Circle<T>) -> bool

Check if a circle is fully contained within this one.

pub fn hull_points_n( &self, count: T, angle: impl Angle<T>, plot: impl FnMut(Vec2<T>), )

Plot count points evenly distributed along the perimeter of the circle.

pub fn hull_points( &self, seg_len: T, angle: impl Angle<T>, plot: impl FnMut(Vec2<T>), )

Plot points along the perimeter of the circle, each seg_len apart.

pub fn iter_hull_points_n( &self, count: T, angle: impl Angle<T>, ) -> impl Iterator<Item = Vec2<T>> + '_

Iterate over count points evenly distributed along the perimeter of the circle.

pub fn iter_hull_points( &self, seg_len: T, angle: impl Angle<T>, ) -> impl Iterator<Item = Vec2<T>> + '_

Iterate over points along the perimeter of the circle, each seg_len apart.

pub fn hull_edges_n( &self, count: T, angle: impl Angle<T>, plot: impl FnMut(Line<T>), )

Plot count edges evenly distributed along the circle’s perimeter.

pub fn hull_edges( &self, seg_len: T, angle: impl Angle<T>, plot: impl FnMut(Line<T>), )

Get count edges evenly distributed along the circle’s perimeter.

pub fn iter_hull_edges_n( &self, count: T, angle: impl Angle<T>, ) -> impl Iterator<Item = Line<T>> + '_

Iterate over count edges evenly distributed along the circle’s perimeter.

pub fn iter_hull_edges( &self, seg_len: T, angle: impl Angle<T>, ) -> impl Iterator<Item = Line<T>> + '_

pub fn transform_by_into( &self, seg_len: T, angle: impl Angle<T>, into: &mut Polygon<T>, f: impl FnMut(Vec2<T>) -> Vec2<T>, )

pub fn transform_by_into_n( &self, seg_count: T, angle: impl Angle<T>, into: &mut Polygon<T>, f: impl FnMut(Vec2<T>) -> Vec2<T>, )

pub fn transform_by( &self, seg_len: T, angle: impl Angle<T>, f: impl FnMut(Vec2<T>) -> Vec2<T>, ) -> Polygon<T>

pub fn transform_by_n( &self, count: T, angle: impl Angle<T>, f: impl FnMut(Vec2<T>) -> Vec2<T>, ) -> Polygon<T>

pub fn transform_by_retain(&self, f: impl FnMut(Vec2<T>) -> Vec2<T>) -> Self

pub fn suggest_seg_count(&self) -> T

pub fn suggest_seg_count_f(&self, f: impl FnMut(Vec2<T>) -> Vec2<T>) -> T

Trait Implementations

impl<T> AbsDiffEq for Circle<T>

where T: AbsDiffEq, T::Epsilon: Copy,

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Copy + Add<T, Output = T>> Add<&Vec2<T>> for &Circle<T>

type Output = Circle<T>

The resulting type after applying the + operator.

fn add(self, rhs: &Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + Add<T, Output = T>> Add<&Vec2<T>> for Circle<T>

type Output = Circle<T>

The resulting type after applying the + operator.

fn add(self, rhs: &Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + Add<T, Output = T>> Add<Vec2<T>> for &Circle<T>

type Output = Circle<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Add<T, Output = T>> Add<Vec2<T>> for Circle<T>

type Output = Circle<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + AddAssign<T>> AddAssign<&Vec2<T>> for Circle<T>

fn add_assign(&mut self, rhs: &Vec2<T>)

Performs the += operation.

impl<T: AddAssign<T>> AddAssign<Vec2<T>> for Circle<T>

fn add_assign(&mut self, rhs: Vec2<T>)

Performs the += operation.

impl<T: Clone> Clone for Circle<T>

fn clone(&self) -> Circle<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Circle<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Circle<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<(T, T, T)> for Circle<T>

fn from((x, y, radius): (T, T, T)) -> Self

Converts to this type from the input type.

impl<T> From<(Vec2<T>, T)> for Circle<T>

fn from((center, radius): (Vec2<T>, T)) -> Self

Converts to this type from the input type.

impl<T> From<Circle<T>> for DynShape<T>

fn from(value: Circle<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Circle<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Numeric<AsU8 = u8, AsU16 = u16, AsU32 = u32, AsU64 = u64, AsU128 = u128, AsUSize = usize, AsI8 = i8, AsI16 = i16, AsI32 = i32, AsI64 = i64, AsI128 = i128, AsISize = isize, AsF32 = f32, AsF64 = f64>> Numeric for Circle<T>

type AsU8 = Circle<u8>

type AsU16 = Circle<u16>

type AsU32 = Circle<u32>

type AsU64 = Circle<u64>

type AsU128 = Circle<u128>

type AsUSize = Circle<usize>

type AsI8 = Circle<i8>

type AsI16 = Circle<i16>

type AsI32 = Circle<i32>

type AsI64 = Circle<i64>

type AsI128 = Circle<i128>

type AsISize = Circle<isize>

type AsF32 = Circle<f32>

type AsF64 = Circle<f64>

fn to_u8(self) -> Circle<u8>

fn to_u16(self) -> Circle<u16>

fn to_u32(self) -> Circle<u32>

fn to_u64(self) -> Circle<u64>

fn to_u128(self) -> Circle<u128>

fn to_usize(self) -> Circle<usize>

fn to_i8(self) -> Circle<i8>

fn to_i16(self) -> Circle<i16>

fn to_i32(self) -> Circle<i32>

fn to_i64(self) -> Circle<i64>

fn to_i128(self) -> Circle<i128>

fn to_isize(self) -> Circle<isize>

fn to_f32(self) -> Circle<f32>

fn to_f64(self) -> Circle<f64>

impl<T: Ord> Ord for Circle<T>

fn cmp(&self, other: &Circle<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Circle<T>

fn eq(&self, other: &Circle<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd> PartialOrd for Circle<T>

fn partial_cmp(&self, other: &Circle<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> RelativeEq for Circle<T>

where T: RelativeEq, T::Epsilon: Copy,

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T> Serialize for Circle<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Float> Shape<T> for Circle<T>

fn centroid(&self) -> Vec2<T>

Centroid of the shape.

fn contains(&self, p: Vec2<T>) -> bool

If the point is contained within the shape.

fn bounds(&self) -> Rect<T>

Rectangular bounds of the shape.

fn project_onto_axis(&self, axis: Vec2<T>) -> Projection<T>

Project the shape onto the axis.

fn project_point(&self, p: Vec2<T>) -> Vec2<T>

Project a point onto the outside surface of the shape.

fn rayhit(&self, ray: &Ray<T>) -> bool

Check if a ray intersects this shape.

fn raycast(&self, ray: &Ray<T>) -> Option<RayHit<T>>

Raycast against the shape.

fn overlaps_rect(&self, rect: &Rect<T>) -> bool

If this shape overlaps the rectangle.

fn overlaps_circ(&self, circ: &Circle<T>) -> bool

If this shape overlaps the circle.

fn overlaps_poly<P: Polygonal<T>>(&self, poly: &P) -> bool

If this shape overlaps the polygon.

fn extract_from_circ(&self, circ: &Circle<T>) -> Option<Vec2<T>>

If this shape and the circle overlap, return a push-out vector that can be used to extract them from each other.

fn extract_from_poly<P: Polygonal<T>>(&self, poly: &P) -> Option<Vec2<T>>

If this shape and the polygon overlap, return a push-out vector that can be used to extract them from each other.

fn is_convex(&self) -> bool

If this shape is convex.

impl<T: Copy + Sub<T, Output = T>> Sub<&Vec2<T>> for &Circle<T>

type Output = Circle<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>> Sub<&Vec2<T>> for Circle<T>

type Output = Circle<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>> Sub<Vec2<T>> for &Circle<T>

type Output = Circle<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Sub<T, Output = T>> Sub<Vec2<T>> for Circle<T>

type Output = Circle<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + SubAssign<T>> SubAssign<&Vec2<T>> for Circle<T>

fn sub_assign(&mut self, rhs: &Vec2<T>)

Performs the -= operation.

impl<T: Copy + SubAssign<T>> SubAssign<Vec2<T>> for Circle<T>

fn sub_assign(&mut self, rhs: Vec2<T>)

Performs the -= operation.

impl<T> UlpsEq for Circle<T>

where T: UlpsEq, T::Epsilon: Copy,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T: Copy> Copy for Circle<T>

impl<T: Eq> Eq for Circle<T>

impl<T> StructuralPartialEq for Circle<T>