Struct fj_math::Circle

pub struct Circle<const D: usize> {
    pub center: Point<D>,
    pub a: Vector<D>,
    pub b: Vector<D>,
}

An n-dimensional circle

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

Fields

center: Point<D>

The center point of the circle

a: Vector<D>

A vector from the center to the starting point of the circle

The length of this vector defines the circle radius. Please also refer to the documentation of b.

b: Vector<D>

A second vector that defines the plane of the circle

The vector must be of equal length to a (the circle radius) and must be perpendicular to it. Code working with circles might assume that these conditions are met.

Implementations

impl<const D: usize> Circle<D>

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> 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> 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, 

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) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> 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: &Circle<D>) -> bool

This method tests for !=.

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>