Struct Ellipse

pub struct Ellipse { /* private fields */ }

An ellipse.

Implementations

impl Ellipse

pub fn new( center: impl Into<Point>, radii: impl Into<Vec2>, x_rotation: f64, ) -> Ellipse

Create A new ellipse with a given center, radii, and rotation.

The returned ellipse will be the result of taking a circle, stretching it by the radii along the x and y axes, then rotating it from the x axis by rotation radians, before finally translating the center to center.

Rotation is clockwise in a y-down coordinate system. For more on rotation, see Affine::rotate.

pub fn from_rect(rect: Rect) -> Self

Returns the largest ellipse that can be bounded by this Rect.

This uses the absolute width and height of the rectangle.

This ellipse is always axis-aligned; to apply rotation you can call with_rotation with the result.

pub fn from_affine(affine: Affine) -> Self

Create an ellipse from an affine transformation of the unit circle.

pub fn with_center(self, new_center: Point) -> Ellipse

Create a new Ellipse centered on the provided point.

pub fn with_radii(self, new_radii: Vec2) -> Ellipse

Create a new Ellipse with the provided radii.

pub fn with_rotation(self, rotation: f64) -> Ellipse

Create a new Ellipse, with the rotation replaced by rotation radians.

The rotation is clockwise, for a y-down coordinate system. For more on rotation, See Affine::rotate.

pub fn center(&self) -> Point

Returns the center of this ellipse.

pub fn radii(&self) -> Vec2

Returns the two radii of this ellipse.

The first number is the horizontal radius and the second is the vertical radius, before rotation.

pub fn rotation(&self) -> f64

The ellipse’s rotation, in radians.

This allows all possible ellipses to be drawn by always starting with an ellipse with the two radii on the x and y axes.

pub fn radii_and_rotation(&self) -> (Vec2, f64)

Returns the radii and the rotation of this ellipse.

Equivalent to (self.radii(), self.rotation()) but more efficient.

pub fn is_finite(&self) -> bool

Is this ellipse finite?

pub fn is_nan(&self) -> bool

Is this ellipse NaN?

Trait Implementations

impl Add<Vec2> for Ellipse

fn add(self, v: Vec2) -> Ellipse

In this context adding a Vec2 applies the corresponding translation to the ellipse.

type Output = Ellipse

The resulting type after applying the + operator.

impl Clone for Ellipse

fn clone(&self) -> Ellipse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ellipse

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

Formats the value using the given formatter.

impl Default for Ellipse

fn default() -> Ellipse

Returns the “default value” for a type.

impl From<Circle> for Ellipse

fn from(circle: Circle) -> Self

Converts to this type from the input type.

impl Mul<Ellipse> for Affine

type Output = Ellipse

The resulting type after applying the * operator.

fn mul(self, other: Ellipse) -> Self::Output

Performs the * operation.

impl PartialEq for Ellipse

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Shape for Ellipse

type PathElementsIter<'iter> = Chain<Once<PathEl>, ArcAppendIter>

The iterator returned by the path_elements method.

fn path_elements(&self, tolerance: f64) -> Self::PathElementsIter<'_>

Returns an iterator over this shape expressed as PathEls; that is, as Bézier path elements.

fn area(&self) -> f64

Signed area.

fn perimeter(&self, accuracy: f64) -> f64

Total length of perimeter.

fn winding(&self, pt: Point) -> i32

The winding number of a point.

fn bounding_box(&self) -> Rect

The smallest rectangle that encloses the shape.

fn to_path(&self, tolerance: f64) -> BezPath

Convert to a Bézier path.

fn into_path(self, tolerance: f64) -> BezPath

where Self: Sized,

Convert into a Bézier path.

fn path_segments(&self, tolerance: f64) -> Segments<Self::PathElementsIter<'_>>

Returns an iterator over this shape expressed as Bézier path segments (PathSegs).

fn contains(&self, pt: Point) -> bool

Returns true if the Point is inside this shape.

fn as_line(&self) -> Option<Line>

If the shape is a line, make it available.

fn as_rect(&self) -> Option<Rect>

If the shape is a rectangle, make it available.

fn as_rounded_rect(&self) -> Option<RoundedRect>

If the shape is a rounded rectangle, make it available.

fn as_circle(&self) -> Option<Circle>

If the shape is a circle, make it available.

fn as_path_slice(&self) -> Option<&[PathEl]>

If the shape is stored as a slice of path elements, make that available.

impl Sub<Vec2> for Ellipse

fn sub(self, v: Vec2) -> Ellipse

In this context subtracting a Vec2 applies the corresponding translation to the ellipse.

type Output = Ellipse

The resulting type after applying the - operator.

impl Copy for Ellipse

impl StructuralPartialEq for Ellipse