Flutter Engine Uber Docs
Docs for the entire Flutter Engine repo.
 
Loading...
Searching...
No Matches
impeller::StrokeSegmentsGeometry Class Referenceabstract

An abstract Geometry base class that produces fillable vertices representing the stroked outline of the segments provided by the subclass in the virtual |Dispatch| method. More...

#include <stroke_path_geometry.h>

Inheritance diagram for impeller::StrokeSegmentsGeometry:
impeller::Geometry impeller::ArcStrokeGeometry impeller::StrokePathSourceGeometry impeller::StrokeDashedLineGeometry impeller::StrokeDiffRoundRectGeometry impeller::StrokeEllipseGeometry impeller::StrokePathGeometry impeller::StrokeRoundRectGeometry impeller::StrokeRoundSuperellipseGeometry

Public Member Functions

 ~StrokeSegmentsGeometry () override
 
Scalar GetStrokeWidth () const
 
Scalar GetMiterLimit () const
 
Cap GetStrokeCap () const
 
Join GetStrokeJoin () const
 
Scalar ComputeAlphaCoverage (const Matrix &transform) const override
 
- Public Member Functions inherited from impeller::Geometry
virtual ~Geometry ()
 
virtual std::optional< RectGetCoverage (const Matrix &transform) const =0
 
virtual bool CoversArea (const Matrix &transform, const Rect &rect) const
 Determines if this geometry, transformed by the given transform, will completely cover all surface area of the given rect.
 
virtual bool IsAxisAlignedRect () const
 
virtual bool CanApplyMaskFilter () const
 

Protected Member Functions

 StrokeSegmentsGeometry (const StrokeParameters &parameters)
 
virtual void Dispatch (PathAndArcSegmentReceiver &receiver, Tessellator &tessellator, Scalar scale) const =0
 
std::optional< RectGetStrokeCoverage (const Matrix &transform, const Rect &segment_bounds) const
 

Friends

class ImpellerBenchmarkAccessor
 
class ImpellerEntityUnitTestAccessor
 

Additional Inherited Members

- Static Public Member Functions inherited from impeller::Geometry
static std::unique_ptr< GeometryMakeFillPath (const flutter::DlPath &path, std::optional< Rect > inner_rect=std::nullopt)
 
static std::unique_ptr< GeometryMakeStrokePath (const flutter::DlPath &path, const StrokeParameters &stroke={})
 
static std::unique_ptr< GeometryMakeCover ()
 
static std::unique_ptr< GeometryMakeRect (const Rect &rect)
 
static std::unique_ptr< GeometryMakeOval (const Rect &rect)
 
static std::unique_ptr< GeometryMakeLine (const Point &p0, const Point &p1, const StrokeParameters &stroke)
 
static std::unique_ptr< GeometryMakeCircle (const Point &center, Scalar radius)
 
static std::unique_ptr< GeometryMakeStrokedCircle (const Point &center, Scalar radius, Scalar stroke_width)
 
static std::unique_ptr< GeometryMakeFilledArc (const Rect &oval_bounds, Degrees start, Degrees sweep, bool include_center)
 
static std::unique_ptr< GeometryMakeStrokedArc (const Rect &oval_bounds, Degrees start, Degrees sweep, const StrokeParameters &stroke)
 
static std::unique_ptr< GeometryMakeRoundRect (const Rect &rect, const Size &radii)
 
static std::unique_ptr< GeometryMakeRoundSuperellipse (const Rect &rect, Scalar corner_radius)
 
static Scalar ComputeStrokeAlphaCoverage (const Matrix &entity, Scalar stroke_width)
 Compute an alpha value to simulate lower coverage of fractional pixel strokes.
 
static GeometryResult ComputePositionGeometry (const ContentContext &renderer, const Tessellator::VertexGenerator &generator, const Entity &entity, RenderPass &pass)
 

Detailed Description

An abstract Geometry base class that produces fillable vertices representing the stroked outline of the segments provided by the subclass in the virtual |Dispatch| method.

Most subclasses will be based on an instance of |PathSource| and use the |StrokePathSourceGeometry| subclass to feed the segments from that path source object, but some subclasses may be able to operate more optimally by talking directly to the |StrokePathSegmentReceiver| (mainly arcs).

Definition at line 35 of file stroke_path_geometry.h.

Constructor & Destructor Documentation

◆ ~StrokeSegmentsGeometry()

impeller::StrokeSegmentsGeometry::~StrokeSegmentsGeometry ( )
overridedefault

◆ StrokeSegmentsGeometry()

impeller::StrokeSegmentsGeometry::StrokeSegmentsGeometry ( const StrokeParameters parameters)
explicitprotected

Definition at line 727 of file stroke_path_geometry.cc.

728 : stroke_(stroke) {}

Member Function Documentation

◆ ComputeAlphaCoverage()

Scalar impeller::StrokeSegmentsGeometry::ComputeAlphaCoverage ( const Matrix transform) const
overridevirtual

Reimplemented from impeller::Geometry.

Definition at line 748 of file stroke_path_geometry.cc.

749 {
751}
static Scalar ComputeStrokeAlphaCoverage(const Matrix &entity, Scalar stroke_width)
Compute an alpha value to simulate lower coverage of fractional pixel strokes.
Definition geometry.cc:149

References impeller::Geometry::ComputeStrokeAlphaCoverage(), transform, and impeller::StrokeParameters::width.

◆ Dispatch()

virtual void impeller::StrokeSegmentsGeometry::Dispatch ( PathAndArcSegmentReceiver receiver,
Tessellator tessellator,
Scalar  scale 
) const
protectedpure virtual

Dispatch the path segments to the StrokePathSegmentReceiver for the provided transform scale.

Implemented in impeller::StrokePathSourceGeometry, and impeller::ArcStrokeGeometry.

◆ GetMiterLimit()

Scalar impeller::StrokeSegmentsGeometry::GetMiterLimit ( ) const

Definition at line 736 of file stroke_path_geometry.cc.

736 {
737 return stroke_.miter_limit;
738}

References impeller::StrokeParameters::miter_limit.

◆ GetStrokeCap()

Cap impeller::StrokeSegmentsGeometry::GetStrokeCap ( ) const

Definition at line 740 of file stroke_path_geometry.cc.

740 {
741 return stroke_.cap;
742}

References impeller::StrokeParameters::cap.

◆ GetStrokeCoverage()

std::optional< Rect > impeller::StrokeSegmentsGeometry::GetStrokeCoverage ( const Matrix transform,
const Rect segment_bounds 
) const
protected

Provide the stroke-padded bounds for the provided bounds of the segments themselves.

Definition at line 828 of file stroke_path_geometry.cc.

830 {
831 if (path_bounds.IsEmpty()) {
832 return std::nullopt;
833 }
834
835 Scalar max_radius = 0.5;
836 if (stroke_.cap == Cap::kSquare) {
837 max_radius = max_radius * kSqrt2;
838 }
839 if (stroke_.join == Join::kMiter) {
840 max_radius = std::max(max_radius, stroke_.miter_limit * 0.5f);
841 }
842 Scalar max_basis = transform.GetMaxBasisLengthXY();
843 if (max_basis == 0) {
844 return {};
845 }
846 // Use the most conervative coverage setting.
847 Scalar min_size = kMinStrokeSize / max_basis;
848 max_radius *= std::max(stroke_.width, min_size);
849 return path_bounds.Expand(max_radius).TransformBounds(transform);
850}
float Scalar
Definition scalar.h:19
constexpr float kSqrt2
Definition constants.h:47
static constexpr Scalar kMinStrokeSize
Definition geometry.h:19

References impeller::StrokeParameters::cap, impeller::TRect< T >::Expand(), impeller::TRect< T >::IsEmpty(), impeller::StrokeParameters::join, impeller::kMinStrokeSize, impeller::kMiter, impeller::kSqrt2, impeller::kSquare, impeller::StrokeParameters::miter_limit, transform, impeller::TRect< T >::TransformBounds(), and impeller::StrokeParameters::width.

Referenced by impeller::StrokePathSourceGeometry::GetCoverage(), and impeller::ArcStrokeGeometry::GetCoverage().

◆ GetStrokeJoin()

Join impeller::StrokeSegmentsGeometry::GetStrokeJoin ( ) const

Definition at line 744 of file stroke_path_geometry.cc.

744 {
745 return stroke_.join;
746}

References impeller::StrokeParameters::join.

◆ GetStrokeWidth()

Scalar impeller::StrokeSegmentsGeometry::GetStrokeWidth ( ) const

Definition at line 732 of file stroke_path_geometry.cc.

732 {
733 return stroke_.width;
734}

References impeller::StrokeParameters::width.

Friends And Related Symbol Documentation

◆ ImpellerBenchmarkAccessor

friend class ImpellerBenchmarkAccessor
friend

Definition at line 79 of file stroke_path_geometry.h.

◆ ImpellerEntityUnitTestAccessor

friend class ImpellerEntityUnitTestAccessor
friend

Definition at line 80 of file stroke_path_geometry.h.


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