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

Forward iterator that unpacks contour edges on dereference. More...

#include <ContourTrace.hpp>

Public Types

using iterator_category = std::forward_iterator_tag
 Standard category for a multi-pass forward iterator.
 
using value_type = ContourEdge
 Unpacked edge value 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 (const int *packedEdge)
 Creates an iterator at one packed-edge position.
 
value_type operator* () const
 Returns the unpacked current edge.
 
iteratoroperator++ ()
 Advances to the next packed edge.
 
iterator operator++ (int)
 Advances while retaining the previous iterator position.
 

Friends

bool operator== (const iterator &, const iterator &)=default
 Compares packed-edge positions.
 

Detailed Description

Forward iterator that unpacks contour edges on dereference.

Definition at line 82 of file ContourTrace.hpp.

Member Typedef Documentation

◆ difference_type

Signed iterator-distance type.

Definition at line 89 of file ContourTrace.hpp.

◆ iterator_category

Standard category for a multi-pass forward iterator.

Definition at line 85 of file ContourTrace.hpp.

◆ pointer

No pointer type is exposed because dereference returns a value.

Definition at line 91 of file ContourTrace.hpp.

◆ reference

Value-returning reference type.

Definition at line 93 of file ContourTrace.hpp.

◆ value_type

Unpacked edge value yielded by dereference.

Definition at line 87 of file ContourTrace.hpp.

Constructor & Destructor Documentation

◆ iterator()

mmcfilters::ContourEdgeRange::iterator::iterator ( const int packedEdge)
inlineexplicit

Creates an iterator at one packed-edge position.

Parameters
packedEdgeCurrent packed-edge address.

Definition at line 101 of file ContourTrace.hpp.

Member Function Documentation

◆ operator*()

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

Returns the unpacked current edge.

Returns
Current contour edge.

Definition at line 107 of file ContourTrace.hpp.

◆ operator++() [1/2]

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

Advances to the next packed edge.

Returns
This iterator after advancing.

Definition at line 113 of file ContourTrace.hpp.

◆ operator++() [2/2]

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

Advances while retaining the previous iterator position.

Returns
Iterator at the position preceding the advance.

Definition at line 122 of file ContourTrace.hpp.


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