FastUIDraw
Public Member Functions | List of all members
fastuidraw::PathDashEffect Class Reference

#include <path_dash_effect.hpp>

Inheritance diagram for fastuidraw::PathDashEffect:
Inheritance graph
[legend]

Public Member Functions

PathDashEffectadd_dash (float draw, float skip)
 
PathDashEffectclear (void)
 
PathDashEffectdash_offset (float v)
 
virtual void process_cap (const TessellatedPath::cap &cap, Storage &dst) const override
 
virtual void process_chain (const segment_chain &chain, Storage &dst) const override
 
virtual void process_join (const TessellatedPath::join &join, Storage &dst) const override
 
- Public Member Functions inherited from fastuidraw::PathEffect
template<typename iterator >
void process_caps (iterator begin, iterator end, Storage &dst) const
 
template<typename iterator >
void process_chains (iterator begin, iterator end, Storage &dst) const
 
template<typename iterator >
void process_joins (iterator begin, iterator end, Storage &dst) const
 

Additional Inherited Members

- Public Types inherited from fastuidraw::PathEffect
typedef TessellatedPath::cap cap
 
typedef TessellatedPath::join join
 
typedef TessellatedPath::segment segment
 
typedef TessellatedPath::segment_chain segment_chain
 

Detailed Description

A PathDashEffect implemented PathEffect to apply a dash pattern to a path. The output data of a PathDashEffect -keeps- the distance values of how far along an ege or countour, i.e. the values of TessellatedPath::cap::m_contour_length, TessellatedPath::cap::m_edge_length, TessellatedPath::cap::m_distance_from_edge_start, TessellatedPath::cap::m_distance_from_contour_start, TessellatedPath::join::m_distance_from_previous_join, TessellatedPath::join::m_distance_from_contour_start, TessellatedPath::join::m_contour_length, TessellatedPath::segment::m_distance_from_edge_start, TessellatedPath::segment::m_distance_from_contour_start, TessellatedPath::segment::m_contour_length and TessellatedPath::segment::m_edge_length are copied directly from the source data. Only the value TessellatedPath::segment::m_length is adjusted (because a given segment might be split into multiple segments).

Definition at line 50 of file path_dash_effect.hpp.

Member Function Documentation

◆ add_dash()

PathDashEffect& fastuidraw::PathDashEffect::add_dash ( float  draw,
float  skip 
)

Add an element to the dash pattern. An element in the dash pattern is a length to draw following by a length to skip.

Parameters
drawlength of draw in element
skiplength of skip in element

◆ clear()

PathDashEffect& fastuidraw::PathDashEffect::clear ( void  )

Clear the dash pattern.

◆ dash_offset()

PathDashEffect& fastuidraw::PathDashEffect::dash_offset ( float  v)

Distance values from the elements of the path have this value added to them before having the dash-pattern applied.

◆ process_cap()

virtual void fastuidraw::PathDashEffect::process_cap ( const TessellatedPath::cap cap,
Storage dst 
) const
overridevirtual

To be implemented by a derived class to process a TessellatedPath::cap value placing the results onto a PathEffect::Storage

Parameters
capTessellatedPath::cap value to process
dstPathEffect::Storage on which to place values

Implements fastuidraw::PathEffect.

◆ process_chain()

virtual void fastuidraw::PathDashEffect::process_chain ( const segment_chain chain,
Storage dst 
) const
overridevirtual

To be implemented by a derived class to process a segment_chain value placing the results onto a PathEffect::Storage

Parameters
chainsegment_chain value to process
dstPathEffect::Storage on which to place values

Implements fastuidraw::PathEffect.

◆ process_join()

virtual void fastuidraw::PathDashEffect::process_join ( const TessellatedPath::join join,
Storage dst 
) const
overridevirtual

To be implemented by a derived class to process a TessellatedPath::join value placing the results onto a PathEffect::Storage

Parameters
joinTessellatedPath::join value to process
dstPathEffect::Storage on which to place values

Implements fastuidraw::PathEffect.


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