impeller::RoundSuperellipse Struct Reference

#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...
RoundSuperellipse	Shift (Scalar dx, Scalar dy) const
	Returns a new round rectangle translated by the given offset. More...
RoundSuperellipse	Expand (Scalar left, Scalar top, Scalar right, Scalar bottom) const
	Returns a round rectangle with expanded edges. Negative expansion results in shrinking. More...
RoundSuperellipse	Expand (Scalar horizontal, Scalar vertical) const
	Returns a round rectangle with expanded edges. Negative expansion results in shrinking. More...
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
RoundRect	ToApproximateRoundRect () const

Static Public Member Functions
static RoundSuperellipse	MakeRect (const Rect &rect)
static RoundSuperellipse	MakeOval (const Rect &rect)
static RoundSuperellipse	MakeRectRadius (const Rect &rect, Scalar radius)
static RoundSuperellipse	MakeRectXY (const Rect &rect, Scalar x_radius, Scalar y_radius)
static RoundSuperellipse	MakeRectXY (const Rect &rect, Size corner_radii)
static RoundSuperellipse	MakeRectRadii (const Rect &rect, const RoundingRadii &radii)

Detailed Description

Definition at line 18 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]

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

inline

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

Definition at line 115 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]

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

inline

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

Definition at line 105 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]

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

inline

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

Definition at line 93 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 49 of file round_superellipse.h.

{ return bounds_; }

Referenced by impeller::RoundSuperellipsePathSource::Dispatch(), impeller::Canvas::DrawRoundSuperellipse(), impeller::RoundSuperellipsePathSource::GetBounds(), std::operator<<(), impeller::testing::TEST(), and ToApproximateRoundRect().

GetRadii()

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

inlineconstexpr

Definition at line 50 of file round_superellipse.h.

{ return radii_; }

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

IsEmpty()

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

inlineconstexpr

Definition at line 60 of file round_superellipse.h.

{ return bounds_.IsEmpty(); }

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

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

IsFinite()

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

inlineconstexpr

Definition at line 52 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 66 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::testing::TEST().

IsRect()

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

inlineconstexpr

Definition at line 62 of file round_superellipse.h.

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

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

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

MakeOval()

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

inlinestatic

Definition at line 25 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()

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

inlinestatic

Definition at line 21 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()

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

inlinestatic

Definition at line 29 of file round_superellipse.h.

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

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

Referenced by impeller::testing::TEST(), and impeller::testing::TEST_P().

MakeRectXY() [1/2]

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

inlinestatic

Definition at line 34 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]

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

inlinestatic

Definition at line 41 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 &  rr ) const

inlineconstexpr

Definition at line 122 of file round_superellipse.h.

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

Shift()

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

inline

Returns a new round rectangle translated by the given offset.

Definition at line 84 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