Skip to main content

Circle2

ogeom_math::conic

Struct Circle2

pub struct Circle2 { /* private fields */ }

Expand description

A circle in the plane.

Implementations§

impl Circle2

pub fn new(frame: Frame2, radius: f64, tol: Tolerances) -> OgeomResult<Self>

A circle of radius centred on frame’s origin.

§Errors

OgeomError::Construction if radius is not finite and positive.

pub fn centred( centre: Point2, radius: f64, tol: Tolerances, ) -> OgeomResult<Self>

A circle from a centre and a radius, with the default orientation.

§Errors

As Circle2::new.

pub const fn frame(&self) -> Frame2

The frame positioning this circle.

pub const fn centre(&self) -> Point2

The centre.

pub const fn radius(&self) -> f64

The radius.

pub fn length(&self) -> f64

The circumference.

pub fn area(&self) -> f64

The area enclosed.

pub fn signed_distance_to(&self, p: Point2) -> f64

The signed distance from p to the circle, negative inside.

pub fn contains(&self, p: Point2, tol: Tolerances) -> bool

Whether p lies on the circle within tol.confusion().

pub fn encloses(&self, p: Point2, tol: Tolerances) -> bool

Whether p lies strictly inside.

pub fn transformed(&self, t: &Transform2, tol: Tolerances) -> OgeomResult<Self>

This circle moved by t.

The frame goes through the transform intact rather than being rebuilt from the centre. The frame fixes where the angular parameter starts, so discarding its orientation would keep the shape and silently renumber every point on it, invisible to a distance check, and wrong for anything holding a parameter.

§Errors

As Circle2::new.

Trait Implementations§

impl Clone for Circle2

fn clone(&self) -> Circle2

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for Circle2

impl Debug for Circle2

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

Formats the value using the given formatter. Read more

impl PartialEq for Circle2

fn eq(&self, other: &Circle2) -> bool

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

1.0.0 (const: unstable) · Source§

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 StructuralPartialEq for Circle2

Auto Trait Implementations§

impl Freeze for Circle2

impl RefUnwindSafe for Circle2

impl Send for Circle2

impl Sync for Circle2

impl Unpin for Circle2

impl UnsafeUnpin for Circle2

impl UnwindSafe for Circle2

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.