Struct nannou::geom::ellipse::Ellipse

pub struct Ellipse<S = Default> {
    pub rect: Rect<S>,
    pub resolution: usize,
}

A simple ellipse type with helper methods around the ellipse module's functions.

Fields

rect: Rect<S>

The width and height off the Ellipse.

resolution: usize

The resolution (number of sides) of the Ellipse.

Methods

impl<S> Ellipse<S> where
    S: BaseNum + Neg<Output = S>, 

pub fn new(rect: Rect<S>, resolution: usize) -> Self

Construct a new ellipse from its bounding rect and resolution (number of sides).

pub fn section(self, offset_radians: S, section_radians: S) -> Section<S>

A section of the Ellipse.

offset_radians describes the angle at which the offset begins.

section_radians describes how large the section is as an angle.

Important traits for Circumference<S>

impl<S> Iterator for Circumference<S> where
    S: BaseFloat,  type Item = Point2<S>;

pub fn circumference(self) -> Circumference<S>

Produces an iterator yielding the points of the ellipse circumference.

impl<S> Ellipse<S> where
    S: BaseFloat, 

Important traits for Triangles<S>

impl<S> Iterator for Triangles<S> where
    S: BaseFloat,  type Item = Tri<Point2<S>>;

pub fn triangles(self) -> Triangles<S>

Produces an iterator yielding the triangles that describe the ellipse.

TODO: Describe the order.

pub fn triangle_indices(&self) -> (TriangleVertices<S>, TriangleIndices)

The same as Triangles, but produces the indices of each triangle into the returned TriangleVertices iterator rather than the vertices for each corner.

Trait Implementations

impl<S: PartialEq> PartialEq<Ellipse<S>> for Ellipse<S>

fn eq(&self, other: &Ellipse<S>) -> bool

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

fn ne(&self, other: &Ellipse<S>) -> bool

This method tests for !=.

impl<S: Clone> Clone for Ellipse<S>

fn clone(&self) -> Ellipse<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for Ellipse<S>

impl<S: PartialOrd> PartialOrd<Ellipse<S>> for Ellipse<S>

fn partial_cmp(&self, other: &Ellipse<S>) -> Option<Ordering>

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

fn lt(&self, other: &Ellipse<S>) -> bool

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

fn le(&self, other: &Ellipse<S>) -> bool

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

fn gt(&self, other: &Ellipse<S>) -> bool

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

fn ge(&self, other: &Ellipse<S>) -> bool

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

impl<S: Debug> Debug for Ellipse<S>

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

Formats the value using the given formatter.