pub struct Circle<const D: usize> { /* private fields */ }
Expand description
An n-dimensional circle
The dimensionality of the circle is defined by the const generic D
parameter.
Implementations§
source§impl<const D: usize> Circle<D>
impl<const D: usize> Circle<D>
sourcepub fn new(
center: impl Into<Point<D>>,
a: impl Into<Vector<D>>,
b: impl Into<Vector<D>>
) -> Self
pub fn new( center: impl Into<Point<D>>, a: impl Into<Vector<D>>, b: impl Into<Vector<D>> ) -> Self
Construct a circle
§Panics
Panics, if any of the following requirements are not met:
- The circle radius (defined by the length of
a
andb
) must not be zero. a
andb
must be of equal length.a
andb
must be perpendicular to each other.
sourcepub fn from_center_and_radius(
center: impl Into<Point<D>>,
radius: impl Into<Scalar>
) -> Self
pub fn from_center_and_radius( center: impl Into<Point<D>>, radius: impl Into<Scalar> ) -> Self
Construct a Circle
from a center point and a radius
sourcepub fn a(&self) -> Vector<D>
pub fn a(&self) -> Vector<D>
Access the vector that defines the starting point of the circle
The point where this vector points from the circle center, is the zero coordinate of the circle’s coordinate system. The length of the vector defines the circle’s radius.
Please also refer to Self::b
.
sourcepub fn b(&self) -> Vector<D>
pub fn b(&self) -> Vector<D>
Access the vector that defines the plane of the circle
Also defines the direction of the circle’s coordinate system. The length
is equal to the circle’s radius, and this vector is perpendicular to
Self::a
.
sourcepub fn point_to_circle_coords(&self, point: impl Into<Point<D>>) -> Point<1>
pub fn point_to_circle_coords(&self, point: impl Into<Point<D>>) -> Point<1>
Convert a D
-dimensional point to circle coordinates
Converts the provided point into circle coordinates between 0.
(inclusive) and PI * 2.
(exclusive).
Projects the point onto the circle before computing circle coordinate, ignoring the radius. This is done to make this method robust against floating point accuracy issues.
Callers are advised to be careful about the points they pass, as the point not being on the curve, intentional or not, will not result in an error.
sourcepub fn point_from_circle_coords(&self, point: impl Into<Point<1>>) -> Point<D>
pub fn point_from_circle_coords(&self, point: impl Into<Point<1>>) -> Point<D>
Convert a point in circle coordinates into a D
-dimensional point
sourcepub fn vector_from_circle_coords(
&self,
vector: impl Into<Vector<1>>
) -> Vector<D>
pub fn vector_from_circle_coords( &self, vector: impl Into<Vector<1>> ) -> Vector<D>
Convert a vector in circle coordinates into a D
-dimensional point
Trait Implementations§
source§impl<const D: usize> AbsDiffEq for Circle<D>
impl<const D: usize> AbsDiffEq for Circle<D>
source§fn default_epsilon() -> Self::Epsilon
fn default_epsilon() -> Self::Epsilon
source§fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool
fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool
source§fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool
fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool
AbsDiffEq::abs_diff_eq
.source§impl<const D: usize> Ord for Circle<D>
impl<const D: usize> Ord for Circle<D>
source§impl<const D: usize> PartialEq for Circle<D>
impl<const D: usize> PartialEq for Circle<D>
source§impl<const D: usize> PartialOrd for Circle<D>
impl<const D: usize> PartialOrd for Circle<D>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl<const D: usize> Copy for Circle<D>
impl<const D: usize> Eq for Circle<D>
impl<const D: usize> StructuralPartialEq for Circle<D>
Auto Trait Implementations§
impl<const D: usize> Freeze for Circle<D>
impl<const D: usize> RefUnwindSafe for Circle<D>
impl<const D: usize> Send for Circle<D>
impl<const D: usize> Sync for Circle<D>
impl<const D: usize> Unpin for Circle<D>
impl<const D: usize> UnwindSafe for Circle<D>
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<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.