Trait vector2math::circle::Circle

pub trait Circle: Copywhere
    Scalar<Self>: FloatingScalar,{
    type Vector: FloatingVector2;

    // Required methods
    fn new(center: Self::Vector, radius: Scalar<Self>) -> Self;
    fn center(self) -> Self::Vector;
    fn radius(self) -> Scalar<Self>;

    // Provided methods
    fn map_into<C>(self) -> C
       where C: Circle,
             Scalar<C>: FloatingScalar + From<Scalar<Self>> { ... }
    fn map_with<C, F>(self, f: F) -> C
       where C: Circle,
             Scalar<C>: FloatingScalar,
             F: FnMut(Scalar<Self>) -> <<C as Circle>::Vector as Vector2>::Scalar { ... }
    fn with_center(self, center: Self::Vector) -> Self { ... }
    fn with_radius(self, radius: Scalar<Self>) -> Self { ... }
    fn diameter(self) -> Scalar<Self> { ... }
    fn circumference(self) -> Scalar<Self> { ... }
    fn area(self) -> Scalar<Self> { ... }
    fn translated(self, offset: Self::Vector) -> Self { ... }
    fn scaled(self, scale: Scalar<Self>) -> Self { ... }
    fn to_square(self) -> [Scalar<Self>; 4] { ... }
    fn contains(self, point: Self::Vector) -> bool { ... }
    fn cntains(self, point: Self::Vector) -> bool { ... }
    fn contains_all<I>(self, points: I) -> bool
       where I: IntoIterator<Item = Self::Vector> { ... }
    fn contains_any<I>(self, points: I) -> bool
       where I: IntoIterator<Item = Self::Vector> { ... }
}

Trait for manipulating circles

Required Associated Types

type Vector: FloatingVector2

The vector type

Required Methods

fn new(center: Self::Vector, radius: Scalar<Self>) -> Self

Create a new circle from a center coordinate and a radius

fn center(self) -> Self::Vector

Get the circle’s center

fn radius(self) -> Scalar<Self>

Get the circle’s radius

Provided Methods

fn map_into<C>(self) -> Cwhere C: Circle, Scalar<C>: FloatingScalar + From<Scalar<Self>>,

Map this circle to a circle of another type

fn map_with<C, F>(self, f: F) -> Cwhere C: Circle, Scalar<C>: FloatingScalar, F: FnMut(Scalar<Self>) -> <<C as Circle>::Vector as Vector2>::Scalar,

Map this circle to a circle of another type using a function

fn with_center(self, center: Self::Vector) -> Self

Transform the circle into one with a different top-left corner position

fn with_radius(self, radius: Scalar<Self>) -> Self

Transform the circle into one with a different size

fn diameter(self) -> Scalar<Self>

Get the circle’s diameter

fn circumference(self) -> Scalar<Self>

Get the circle’s circumference

fn area(self) -> Scalar<Self>

Get the circle’s area

fn translated(self, offset: Self::Vector) -> Self

Get the circle that is this one translated by some vector

fn scaled(self, scale: Scalar<Self>) -> Self

Get the circle that is this one with a scalar-scaled size

fn to_square(self) -> [Scalar<Self>; 4]

Get the smallest square that this circle fits inside

fn contains(self, point: Self::Vector) -> bool

Check that the circle contains the given point

fn cntains(self, point: Self::Vector) -> bool

Alias for Rectangle::contains

Useful when contains is ambiguous

fn contains_all<I>(self, points: I) -> boolwhere I: IntoIterator<Item = Self::Vector>,

Check that the circle contains all points

fn contains_any<I>(self, points: I) -> boolwhere I: IntoIterator<Item = Self::Vector>,

Check that the circle contains any point

Implementations on Foreign Types

impl<S, V> Circle for (V, S)where S: FloatingScalar, V: FloatingVector2<Scalar = S>,

type Vector = V

fn new(center: Self::Vector, radius: Scalar<Self>) -> Self

fn center(self) -> Self::Vector

fn radius(self) -> Scalar<Self>

Implementors