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

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

#include <ContourTrace.hpp>

Public Types

using iterator_category = std::forward_iterator_tag
 Standard category for a multi-pass forward iterator.
 
using value_type = PixelId
 Pixel identifier yielded by dereference.
 
using difference_type = std::ptrdiff_t
 Signed iterator-distance type.
 
using pointer = void
 No pointer type is exposed because dereference returns a value.
 
using reference = value_type
 Value-returning reference type.
 

Public Member Functions

 iterator (ContourEdgeRange::iterator edgeIterator)
 Creates a projection over an edge iterator.
 
value_type operator* () const
 Returns the support pixel of the current edge.
 
iteratoroperator++ ()
 Advances to the next edge pixel.
 
iterator operator++ (int)
 Advances while retaining the previous iterator position.
 

Friends

bool operator== (const iterator &, const iterator &)=default
 Compares the underlying edge positions.
 

Detailed Description

Forward iterator that returns the support pixel of each edge.

Definition at line 171 of file ContourTrace.hpp.

Member Typedef Documentation

◆ difference_type

Signed iterator-distance type.

Definition at line 178 of file ContourTrace.hpp.

◆ iterator_category

Standard category for a multi-pass forward iterator.

Definition at line 174 of file ContourTrace.hpp.

◆ pointer

No pointer type is exposed because dereference returns a value.

Definition at line 180 of file ContourTrace.hpp.

◆ reference

Value-returning reference type.

Definition at line 182 of file ContourTrace.hpp.

◆ value_type

Pixel identifier yielded by dereference.

Definition at line 176 of file ContourTrace.hpp.

Constructor & Destructor Documentation

◆ iterator()

mmcfilters::ContourPixelRange::iterator::iterator ( ContourEdgeRange::iterator  edgeIterator)
inlineexplicit

Creates a projection over an edge iterator.

Parameters
edgeIteratorCurrent edge position.

Definition at line 187 of file ContourTrace.hpp.

Member Function Documentation

◆ operator*()

value_type mmcfilters::ContourPixelRange::iterator::operator* ( ) const
inline

Returns the support pixel of the current edge.

Returns
Current support pixel.

Definition at line 190 of file ContourTrace.hpp.

◆ operator++() [1/2]

iterator & mmcfilters::ContourPixelRange::iterator::operator++ ( )
inline

Advances to the next edge pixel.

Returns
This iterator after advancing.

Definition at line 193 of file ContourTrace.hpp.

◆ operator++() [2/2]

iterator mmcfilters::ContourPixelRange::iterator::operator++ ( int  )
inline

Advances while retaining the previous iterator position.

Returns
Iterator at the position preceding the advance.

Definition at line 202 of file ContourTrace.hpp.


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