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

Immutable range over unpacked contour edges. More...

#include <ContourTrace.hpp>

Classes

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

Public Member Functions

 ContourEdgeRange (std::span< const int > packedEdges)
 Creates a view over packed contour edges.
 
iterator begin () const
 Returns an iterator to the first contour edge.
 
iterator end () const
 Returns the exclusive end iterator.
 
bool empty () const noexcept
 Returns whether the range contains no edges.
 
std::size_t size () const noexcept
 Returns the number of contour edges.
 

Detailed Description

Immutable range over unpacked contour edges.

Definition at line 77 of file ContourTrace.hpp.

Constructor & Destructor Documentation

◆ ContourEdgeRange()

mmcfilters::ContourEdgeRange::ContourEdgeRange ( std::span< const int packedEdges)
inlineexplicit

Creates a view over packed contour edges.

Parameters
packedEdgesPacked contour-edge span.

Definition at line 142 of file ContourTrace.hpp.

Member Function Documentation

◆ begin()

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

Returns an iterator to the first contour edge.

Returns
First edge position.

Definition at line 145 of file ContourTrace.hpp.

◆ empty()

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

Returns whether the range contains no edges.

Returns
True when the range is empty.

Definition at line 153 of file ContourTrace.hpp.

◆ end()

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

Returns the exclusive end iterator.

Returns
Position following the final edge.

Definition at line 148 of file ContourTrace.hpp.

◆ size()

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

Returns the number of contour edges.

Returns
Edge count.

Definition at line 156 of file ContourTrace.hpp.


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