#include <round_superellipse.h>

Public Member Functions
	RoundSuperellipse ()=default

constexpr const Rect &	GetBounds () const

constexpr const RoundingRadii &	GetRadii () const

constexpr bool	IsFinite () const

constexpr bool	IsEmpty () const

constexpr bool	IsRect () const

constexpr bool	IsOval () const

bool	Contains (const Point &p) const
	Returns true iff the provided point \|p\| is inside the half-open interior of this rectangle. More...

constexpr RoundSuperellipse	Shift (Scalar dx, Scalar dy) const
	Returns a new round rectangle translated by the given offset. More...

constexpr RoundSuperellipse	Expand (Scalar left, Scalar top, Scalar right, Scalar bottom) const
	Returns a round rectangle with expanded edges. Negative expansion results in shrinking. More...

constexpr RoundSuperellipse	Expand (Scalar horizontal, Scalar vertical) const
	Returns a round rectangle with expanded edges. Negative expansion results in shrinking. More...

constexpr RoundSuperellipse	Expand (Scalar amount) const
	Returns a round rectangle with expanded edges. Negative expansion results in shrinking. More...

constexpr bool	operator== (const RoundSuperellipse &rr) const

constexpr bool	operator!= (const RoundSuperellipse &r) const

RoundRect	ToApproximateRoundRect () const

Static Public Member Functions
constexpr static RoundSuperellipse	MakeRect (const Rect &rect)

constexpr static RoundSuperellipse	MakeOval (const Rect &rect)

constexpr static RoundSuperellipse	MakeRectRadius (const Rect &rect, Scalar radius)

constexpr static RoundSuperellipse	MakeRectXY (const Rect &rect, Scalar x_radius, Scalar y_radius)

constexpr static RoundSuperellipse	MakeRectXY (const Rect &rect, Size corner_radii)

static RoundSuperellipse	MakeRectRadii (const Rect &rect, const RoundingRadii &radii)

Detailed Description

Definition at line 17 of file round_superellipse.h.

Constructor & Destructor Documentation

◆ RoundSuperellipse()

impeller::RoundSuperellipse::RoundSuperellipse ( )

default

Referenced by MakeRectRadii().

Member Function Documentation

◆ Contains()

bool impeller::RoundSuperellipse::Contains ( const Point & p ) const

Returns true iff the provided point |p| is inside the half-open interior of this rectangle.

For purposes of containment, a rectangle contains points along the top and left edges but not points along the right and bottom edges so that a point is only ever considered inside one of two abutting rectangles.

Definition at line 26 of file round_superellipse.cc.

                                                                    {
   if (!bounds_.Contains(p)) {
     return false;
   }
   auto param = RoundSuperellipseParam::MakeBoundsRadii(bounds_, radii_);
   return param.Contains(p);
 }

References impeller::TRect< T >::Contains(), and impeller::RoundSuperellipseParam::MakeBoundsRadii().

◆ Expand() [1/3]

constexpr RoundSuperellipse impeller::RoundSuperellipse::Expand ( Scalar amount ) const

inlineconstexpr

Returns a round rectangle with expanded edges. Negative expansion results in shrinking.

Definition at line 114 of file round_superellipse.h.

                                                                         {
     // Use the factory rather than the internal constructor as the changing
     // size of the rectangle requires that we re-validate the radii to the
     // newly sized rectangle.
     return MakeRectRadii(bounds_.Expand(amount), radii_);
   }

References impeller::TRect< T >::Expand(), and MakeRectRadii().

◆ Expand() [2/3]

constexpr RoundSuperellipse impeller::RoundSuperellipse::Expand	(	Scalar	horizontal,
		Scalar	vertical
	)		const

inlineconstexpr

Returns a round rectangle with expanded edges. Negative expansion results in shrinking.

Definition at line 104 of file round_superellipse.h.

                                                                           {
     // Use the factory rather than the internal constructor as the changing
     // size of the rectangle requires that we re-validate the radii to the
     // newly sized rectangle.
     return MakeRectRadii(bounds_.Expand(horizontal, vertical), radii_);
   }

References impeller::TRect< T >::Expand(), and MakeRectRadii().

◆ Expand() [3/3]

constexpr RoundSuperellipse impeller::RoundSuperellipse::Expand	(	Scalar	left,
		Scalar	top,
		Scalar	right,
		Scalar	bottom
	)		const

inlineconstexpr

Returns a round rectangle with expanded edges. Negative expansion results in shrinking.

Definition at line 92 of file round_superellipse.h.

                                                                         {
     // Use the factory rather than the internal constructor as the changing
     // size of the rectangle requires that we re-validate the radii to the
     // newly sized rectangle.
     return MakeRectRadii(bounds_.Expand(left, top, right, bottom), radii_);
   }

References impeller::TRect< T >::Expand(), and MakeRectRadii().

Referenced by impeller::testing::TEST().

◆ GetBounds()

constexpr const Rect& impeller::RoundSuperellipse::GetBounds ( ) const

inlineconstexpr

Definition at line 48 of file round_superellipse.h.

48 { return bounds_; }

Referenced by impeller::PathBuilder::AddRoundSuperellipse(), impeller::Canvas::DrawRoundSuperellipse(), std::operator<<(), impeller::testing::TEST(), and ToApproximateRoundRect().

◆ GetRadii()

constexpr const RoundingRadii& impeller::RoundSuperellipse::GetRadii ( ) const

inlineconstexpr

Definition at line 49 of file round_superellipse.h.

49 { return radii_; }

Referenced by impeller::PathBuilder::AddRoundSuperellipse(), impeller::Canvas::DrawRoundSuperellipse(), std::operator<<(), impeller::testing::TEST(), and ToApproximateRoundRect().

◆ IsEmpty()

constexpr bool impeller::RoundSuperellipse::IsEmpty ( ) const

inlineconstexpr

Definition at line 59 of file round_superellipse.h.

59 { return bounds_.IsEmpty(); }

impeller::TRect::IsEmpty

constexpr bool IsEmpty() const

Returns true if either of the width or height are 0, negative, or NaN.

Definition: rect.h:301

References impeller::TRect< T >::IsEmpty().

Referenced by impeller::testing::TEST().

◆ IsFinite()

constexpr bool impeller::RoundSuperellipse::IsFinite ( ) const

inlineconstexpr

Definition at line 51 of file round_superellipse.h.

                                                 {
     return bounds_.IsFinite() &&             //
            radii_.top_left.IsFinite() &&     //
            radii_.top_right.IsFinite() &&    //
            radii_.bottom_left.IsFinite() &&  //
            radii_.bottom_right.IsFinite();
   }

References impeller::RoundingRadii::bottom_left, impeller::RoundingRadii::bottom_right, impeller::TRect< T >::IsFinite(), impeller::TSize< T >::IsFinite(), impeller::RoundingRadii::top_left, and impeller::RoundingRadii::top_right.

Referenced by impeller::testing::TEST().

◆ IsOval()

constexpr bool impeller::RoundSuperellipse::IsOval ( ) const

inlineconstexpr

Definition at line 65 of file round_superellipse.h.

                                               {
     return !bounds_.IsEmpty() && radii_.AreAllCornersSame() &&
            ScalarNearlyEqual(radii_.top_left.width,
                              bounds_.GetWidth() * 0.5f) &&
            ScalarNearlyEqual(radii_.top_left.height,
                              bounds_.GetHeight() * 0.5f);
   }

References impeller::RoundingRadii::AreAllCornersSame(), impeller::TRect< T >::GetHeight(), impeller::TRect< T >::GetWidth(), impeller::TSize< T >::height, impeller::TRect< T >::IsEmpty(), impeller::ScalarNearlyEqual(), impeller::RoundingRadii::top_left, and impeller::TSize< T >::width.

Referenced by impeller::PathBuilder::AddRoundSuperellipse(), and impeller::testing::TEST().

◆ IsRect()

constexpr bool impeller::RoundSuperellipse::IsRect ( ) const

inlineconstexpr

Definition at line 61 of file round_superellipse.h.

                                               {
     return !bounds_.IsEmpty() && radii_.AreAllCornersEmpty();
   }

References impeller::RoundingRadii::AreAllCornersEmpty(), and impeller::TRect< T >::IsEmpty().

Referenced by impeller::PathBuilder::AddRoundSuperellipse(), and impeller::testing::TEST().

◆ MakeOval()

constexpr static RoundSuperellipse impeller::RoundSuperellipse::MakeOval ( const Rect & rect )

inlinestaticconstexpr

Definition at line 24 of file round_superellipse.h.

                                                                 {
     return MakeRectRadii(rect, RoundingRadii::MakeRadii(rect.GetSize() * 0.5f));
   }

References impeller::TRect< T >::GetSize(), impeller::RoundingRadii::MakeRadii(), and MakeRectRadii().

Referenced by impeller::testing::TEST().

◆ MakeRect()

constexpr static RoundSuperellipse impeller::RoundSuperellipse::MakeRect ( const Rect & rect )

inlinestaticconstexpr

Definition at line 20 of file round_superellipse.h.

                                                                 {
     return MakeRectRadii(rect, RoundingRadii());
   }

References MakeRectRadii().

Referenced by impeller::testing::TEST().

◆ MakeRectRadii()

RoundSuperellipse impeller::RoundSuperellipse::MakeRectRadii	(	const Rect &	rect,
		const RoundingRadii &	radii
	)

static

Definition at line 12 of file round_superellipse.cc.

                                    {
   if (!in_bounds.IsFinite()) {
     return {};
   }
   Rect bounds = in_bounds.GetPositive();
   // RoundingRadii::Scaled might return an empty radii if bounds or in_radii is
   // empty, which is expected. Pass along the bounds even if the radii is empty
   // as it would still have a valid location and/or 1-dimensional size which
   // might appear when stroked
   return RoundSuperellipse(bounds, in_radii.Scaled(bounds));
 }

References impeller::TRect< T >::GetPositive(), impeller::TRect< T >::IsFinite(), RoundSuperellipse(), and impeller::RoundingRadii::Scaled().

Referenced by Expand(), MakeOval(), MakeRect(), MakeRectRadius(), MakeRectXY(), Shift(), impeller::testing::TEST(), and impeller::testing::TEST_P().

◆ MakeRectRadius()

constexpr static RoundSuperellipse impeller::RoundSuperellipse::MakeRectRadius	(	const Rect &	rect,
		Scalar	radius
	)

inlinestaticconstexpr

Definition at line 28 of file round_superellipse.h.

                                                                    {
     return MakeRectRadii(rect, RoundingRadii::MakeRadius(radius));
   }

References impeller::RoundingRadii::MakeRadius(), and MakeRectRadii().

Referenced by impeller::testing::TEST().

◆ MakeRectXY() [1/2]

constexpr static RoundSuperellipse impeller::RoundSuperellipse::MakeRectXY	(	const Rect &	rect,
		Scalar	x_radius,
		Scalar	y_radius
	)

inlinestaticconstexpr

Definition at line 33 of file round_superellipse.h.

                                                                  {
     return MakeRectRadii(rect,
                          RoundingRadii::MakeRadii(Size(x_radius, y_radius)));
   }

References impeller::RoundingRadii::MakeRadii(), and MakeRectRadii().

Referenced by impeller::testing::TEST().

◆ MakeRectXY() [2/2]

constexpr static RoundSuperellipse impeller::RoundSuperellipse::MakeRectXY	(	const Rect &	rect,
		Size	corner_radii
	)

inlinestaticconstexpr

Definition at line 40 of file round_superellipse.h.

                                                                    {
     return MakeRectRadii(rect, RoundingRadii::MakeRadii(corner_radii));
   }

References impeller::RoundingRadii::MakeRadii(), and MakeRectRadii().

◆ operator!=()

constexpr bool impeller::RoundSuperellipse::operator!= ( const RoundSuperellipse & r ) const

inlineconstexpr

Definition at line 125 of file round_superellipse.h.

                                                                             {
     return !(*this == r);
   }

◆ operator==()

constexpr bool impeller::RoundSuperellipse::operator== ( const RoundSuperellipse & rr ) const

inlineconstexpr

Definition at line 121 of file round_superellipse.h.

                                                                              {
     return bounds_ == rr.bounds_ && radii_ == rr.radii_;
   }

◆ Shift()

constexpr RoundSuperellipse impeller::RoundSuperellipse::Shift	(	Scalar	dx,
		Scalar	dy
	)		const

inlineconstexpr

Returns a new round rectangle translated by the given offset.

Definition at line 83 of file round_superellipse.h.

                                                                               {
     // Just in case, use the factory rather than the internal constructor
     // as shifting the rectangle may increase/decrease its bit precision
     // so we should re-validate the radii to the newly located rectangle.
     return MakeRectRadii(bounds_.Shift(dx, dy), radii_);
   }

References MakeRectRadii(), and impeller::TRect< T >::Shift().

Referenced by impeller::testing::TEST().

◆ ToApproximateRoundRect()

RoundRect impeller::RoundSuperellipse::ToApproximateRoundRect ( ) const

Definition at line 34 of file round_superellipse.cc.

                                                           {
   // Experiments have shown that using the same corner radii for the RRect
   // provides an approximation that is close to optimal, as achieving a perfect
   // match is not feasible.
   return RoundRect::MakeRectRadii(GetBounds(), GetRadii());
 }

References GetBounds(), GetRadii(), and impeller::RoundRect::MakeRectRadii().

The documentation for this struct was generated from the following files:

impeller/geometry/round_superellipse.h
impeller/geometry/round_superellipse.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RoundSuperellipse()

Member Function Documentation

◆ Contains()

◆ Expand() [1/3]

◆ Expand() [2/3]

◆ Expand() [3/3]

◆ GetBounds()

◆ GetRadii()

◆ IsEmpty()

◆ IsFinite()

◆ IsOval()

◆ IsRect()

◆ MakeOval()

◆ MakeRect()

◆ MakeRectRadii()

◆ MakeRectRadius()

◆ MakeRectXY() [1/2]

◆ MakeRectXY() [2/2]

◆ operator!=()

◆ operator==()

◆ Shift()

◆ ToApproximateRoundRect()