Struct Circle 

pub struct Circle { /* private fields */ }

A circle in 2D Euclidean space.

Circle stores a center point and a radius. Construction validates the radius so downstream methods can stay simple.

Examples

use use_geometry::{Circle, Point2};

let circle = Circle::try_new(Point2::new(1.0, 2.0), 3.0)?;

assert_eq!(circle.center(), Point2::new(1.0, 2.0));
assert_eq!(circle.radius(), 3.0);
assert_eq!(circle.diameter(), 6.0);

Implementations

impl Circle

pub fn try_new(center: Point2, radius: f64) -> Result<Circle, GeometryError>

Creates a circle from a center point and a finite, non-negative radius.

A radius of 0.0 is valid and represents a degenerate circle centered at center.

Errors

Returns GeometryError::NonFiniteComponent when center contains a non-finite coordinate.

Returns GeometryError::NonFiniteRadius when radius is NaN or infinite.

Returns GeometryError::NegativeRadius when radius is negative.

Examples

use use_geometry::{Circle, Point2};

let circle = Circle::try_new(Point2::new(0.0, 0.0), 2.5)?;

assert_eq!(circle.center(), Point2::new(0.0, 0.0));
assert_eq!(circle.radius(), 2.5);

pub const fn center(&self) -> Point2

Returns the circle center.

pub const fn radius(&self) -> f64

Returns the circle radius.

pub fn diameter(&self) -> f64

Returns the circle diameter.

pub fn area(&self) -> f64

Returns the circle area.

pub fn circumference(&self) -> f64

Returns the circle circumference.

pub fn contains_point(&self, point: Point2) -> bool

Returns true when point lies inside or on the circle boundary.

pub fn contains_point_with_tolerance( &self, point: Point2, tolerance: f64, ) -> Result<bool, GeometryError>

Returns true when point lies inside the circle expanded by tolerance.

Errors

Returns GeometryError::NonFiniteTolerance when tolerance is NaN or infinite.

Returns GeometryError::NegativeTolerance when tolerance is negative.

pub fn aabb(&self) -> Aabb2

Returns the circle bounding box.

Trait Implementations

impl Clone for Circle

fn clone(&self) -> Circle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Circle

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

Formats the value using the given formatter.

impl PartialEq for Circle

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

impl StructuralPartialEq for Circle