Struct fj_math::Circle

pub struct Circle<const D: usize> { /* private fields */ }

An n-dimensional circle

The dimensionality of the circle is defined by the const generic D parameter.

Implementations

impl<const D: usize> Circle<D>

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 and b) must not be zero.
• a and b must be of equal length.
• a and b must be perpendicular to each other.

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

pub fn center(&self) -> Point<D>

Access the center point of the circle

pub fn radius(&self) -> Scalar

Access the radius of the circle

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.

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.

pub fn reverse(self) -> Self

Create a new instance that is reversed

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.

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

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

impl<const D: usize> AbsDiffEq<Circle<D>> for Circle<D>

type Epsilon = <Scalar as AbsDiffEq<Scalar>>::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<const D: usize> Clone for Circle<D>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for Circle<D>

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

Formats the value using the given formatter.

impl<const D: usize> Default for Circle<D>

fn default() -> Circle<D>

Returns the “default value” for a type.

impl<const D: usize> Hash for Circle<D>

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<const D: usize> Ord for Circle<D>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<const D: usize> PartialEq<Circle<D>> for Circle<D>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<const D: usize> PartialOrd<Circle<D>> for Circle<D>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<const D: usize> Copy for Circle<D>

impl<const D: usize> Eq for Circle<D>

impl<const D: usize> StructuralEq for Circle<D>

impl<const D: usize> StructuralPartialEq for Circle<D>