Struct fj_kernel::geometry::Circle

pub struct Circle {
    pub center: Point<3>,
    pub a: Vector<3>,
    pub b: Vector<3>,
}

A circle

Fields

center: Point<3>

The center point of the circle

a: Vector<3>

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

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 Circle

pub fn origin(&self) -> Point<3>

Access the origin of the curve’s coordinate system

pub fn reverse(self) -> Self

Create a new instance that is reversed

pub fn transform(self, transform: &Transform) -> Self

Create a new instance that is transformed by transform

pub fn point_model_to_curve(&self, point: &Point<3>) -> Point<1>

Convert a point in model coordinates to curve coordinates

Converts the provided point into curve coordinates between 0. (inclusive) and PI * 2. (exclusive).

Projects the point onto the circle before computing curve 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_curve_to_model(&self, point: &Point<1>) -> Point<3>

Convert a point on the curve into model coordinates

pub fn vector_curve_to_model(&self, vector: &Vector<1>) -> Vector<3>

Convert a vector on the curve into model coordinates

Trait Implementations

impl Clone for Circle

fn clone(&self) -> Circle

Returns a copy 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

Formats the value using the given formatter.

impl Hash for Circle

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 Ord for Circle

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

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

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

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

This method tests for !=.

impl PartialOrd<Circle> for Circle

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

impl Eq for Circle

impl StructuralEq for Circle

impl StructuralPartialEq for Circle