flutter::DlDashPathEffect Class Reference

#include <dl_path_effect.h>

Inheritance diagram for flutter::DlDashPathEffect:

Public Member Functions
DlPathEffectType	type () const override
size_t	size () const override
std::shared_ptr< DlPathEffect >	shared () const override
const DlDashPathEffect *	asDash () const override
const SkScalar *	intervals () const
int	count () const
SkScalar	phase () const
std::optional< SkRect >	effect_bounds (SkRect &rect) const override
Public Member Functions inherited from flutter::DlAttribute< DlPathEffect, DlPathEffectType >
bool	operator== (DlPathEffect const &other) const
bool	operator!= (DlPathEffect const &other) const
virtual	~DlAttribute ()=default

Static Public Member Functions
static std::shared_ptr< DlPathEffect >	Make (const SkScalar intervals[], int count, SkScalar phase)

Protected Member Functions
bool	equals_ (DlPathEffect const &other) const override
Protected Member Functions inherited from flutter::DlPathEffect
	DlPathEffect ()=default

Friends
class	DisplayListBuilder
class	DlPathEffect

Detailed Description

The DashPathEffect which breaks a path up into dash segments, and it only affects stroked paths. intervals: array containing an even number of entries (>=2), with the even indices specifying the length of "on" intervals, and the odd indices specifying the length of "off" intervals. This array will be copied in Make, and can be disposed of freely after. count: number of elements in the intervals array. phase: initial distance into the intervals at which to start the dashing effect for the path.

For example: if intervals[] = {10, 20}, count = 2, and phase = 25, this will set up a dashed path like so: 5 pixels off 10 pixels on 20 pixels off 10 pixels on 20 pixels off ... A phase of -5, 25, 55, 85, etc. would all result in the same path, because the sum of all the intervals is 30.

Definition at line 61 of file dl_path_effect.h.

Member Function Documentation

asDash()

const DlDashPathEffect * flutter::DlDashPathEffect::asDash ( ) const

inlineoverridevirtual

Reimplemented from flutter::DlPathEffect.

Definition at line 76 of file dl_path_effect.h.

{ return this; }

count()

int flutter::DlDashPathEffect::count ( ) const

inline

Definition at line 81 of file dl_path_effect.h.

{ return count_; }

effect_bounds()

std::optional< SkRect > flutter::DlDashPathEffect::effect_bounds ( SkRect &  rect ) const

overridevirtual

Implements flutter::DlPathEffect.

Definition at line 30 of file dl_path_effect.cc.

                                                                      {
  // The dashed path will always be a subset of the original.
  return rect;
}

equals_()

bool flutter::DlDashPathEffect::equals_ ( DlPathEffect const &  other ) const

inlineoverrideprotectedvirtual

Implements flutter::DlAttribute< DlPathEffect, DlPathEffectType >.

Definition at line 87 of file dl_path_effect.h.

                                                         {
    FML_DCHECK(other.type() == DlPathEffectType::kDash);
    auto that = static_cast<DlDashPathEffect const*>(&other);
    return count_ == that->count_ && phase_ == that->phase_ &&
           memcmp(intervals(), that->intervals(), sizeof(SkScalar) * count_) ==
               0;
  }

intervals()

const SkScalar * flutter::DlDashPathEffect::intervals ( ) const

inline

Definition at line 78 of file dl_path_effect.h.

                                    {
    return reinterpret_cast<const SkScalar*>(this + 1);
  }

Make()

std::shared_ptr< DlPathEffect > flutter::DlDashPathEffect::Make ( const SkScalar  intervals[], int  count, SkScalar  phase  )

static

Definition at line 18 of file dl_path_effect.cc.

                                                                     {
  size_t needed = sizeof(DlDashPathEffect) + sizeof(SkScalar) * count;
  void* storage = ::operator new(needed);
 
  std::shared_ptr<DlDashPathEffect> ret;
  ret.reset(new (storage) DlDashPathEffect(intervals, count, phase),
            DlPathEffectDeleter);
  return std::move(ret);
}

phase()

SkScalar flutter::DlDashPathEffect::phase ( ) const

inline

Definition at line 82 of file dl_path_effect.h.

{ return phase_; }

shared()

std::shared_ptr< DlPathEffect > flutter::DlDashPathEffect::shared ( ) const

inlineoverridevirtual

Implements flutter::DlAttribute< DlPathEffect, DlPathEffectType >.

Definition at line 72 of file dl_path_effect.h.

                                                      {
    return Make(intervals(), count_, phase_);
  }

size()

size_t flutter::DlDashPathEffect::size ( ) const

inlineoverridevirtual

Implements flutter::DlAttribute< DlPathEffect, DlPathEffectType >.

Definition at line 68 of file dl_path_effect.h.

                               {
    return sizeof(*this) + sizeof(SkScalar) * count_;
  }

type()

DlPathEffectType flutter::DlDashPathEffect::type ( ) const

inlineoverridevirtual

Implements flutter::DlAttribute< DlPathEffect, DlPathEffectType >.

Definition at line 67 of file dl_path_effect.h.

{ return DlPathEffectType::kDash; }

Friends And Related Symbol Documentation

DisplayListBuilder

friend class DisplayListBuilder

friend

Definition at line 117 of file dl_path_effect.h.

DlPathEffect

friend class DlPathEffect

friend

Definition at line 118 of file dl_path_effect.h.

---

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

• display_list/effects/dl_path_effect.h
• display_list/effects/dl_path_effect.cc