mmcfilters
Public API documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
mmcfilters::ContourPixelRange Class Reference

Immutable projection of ordered contour edges onto support pixels. More...

#include <ContourTrace.hpp>

Classes

class  iterator
 Forward iterator that returns the support pixel of each edge. More...
 

Public Member Functions

 ContourPixelRange (ContourEdgeRange edges)
 Creates a support-pixel projection of an edge range.
 
iterator begin () const
 Returns an iterator to the first edge pixel.
 
iterator end () const
 Returns the exclusive end iterator.
 
bool empty () const noexcept
 Returns whether the range contains no pixels.
 
std::size_t size () const noexcept
 Returns the number of projected edge pixels, including repetitions.
 

Detailed Description

Immutable projection of ordered contour edges onto support pixels.

One pixel is yielded for each edge. A pixel can therefore occur more than once when different edges occupy different sides of that pixel.

Definition at line 168 of file ContourTrace.hpp.

Constructor & Destructor Documentation

◆ ContourPixelRange()

mmcfilters::ContourPixelRange::ContourPixelRange ( ContourEdgeRange  edges)
inlineexplicit

Creates a support-pixel projection of an edge range.

Parameters
edgesOrdered source edges.

Definition at line 218 of file ContourTrace.hpp.

Member Function Documentation

◆ begin()

iterator mmcfilters::ContourPixelRange::begin ( ) const
inline

Returns an iterator to the first edge pixel.

Returns
First pixel position.

Definition at line 221 of file ContourTrace.hpp.

◆ empty()

bool mmcfilters::ContourPixelRange::empty ( ) const
inlinenoexcept

Returns whether the range contains no pixels.

Returns
True when the range is empty.

Definition at line 227 of file ContourTrace.hpp.

◆ end()

iterator mmcfilters::ContourPixelRange::end ( ) const
inline

Returns the exclusive end iterator.

Returns
Position following the final pixel.

Definition at line 224 of file ContourTrace.hpp.

◆ size()

std::size_t mmcfilters::ContourPixelRange::size ( ) const
inlinenoexcept

Returns the number of projected edge pixels, including repetitions.

Returns
Projected pixel count.

Definition at line 230 of file ContourTrace.hpp.


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