DGtal  1.0.0
Public Member Functions | Data Fields
DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc Struct Reference

#include <DGtal/topology/DigitalSurface.h>

Public Member Functions

 Arc ()
 
 Arc (const Vertex &theTail, Dimension aK, bool aEpsilon)
 
bool operator== (const Arc &other) const
 
bool operator< (const Arc &other) const
 
bool operator!= (const Arc &other) const
 

Data Fields

Vertex base
 base surfel More...
 
Dimension k
 direction toward the head surfel More...
 
bool epsilon
 orientation toward the head surfel More...
 

Detailed Description

template<typename TDigitalSurfaceContainer>
struct DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc

Defines an arc on the digital surface, i.e. an arrow between two adjacent surfels.

Definition at line 238 of file DigitalSurface.h.

Constructor & Destructor Documentation

◆ Arc() [1/2]

template<typename TDigitalSurfaceContainer>
DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::Arc ( )
inline

Default constructor. The arc is invalid.

Definition at line 245 of file DigitalSurface.h.

246  : base(), k( 0 ), epsilon( false ) {}
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel

◆ Arc() [2/2]

template<typename TDigitalSurfaceContainer>
DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::Arc ( const Vertex theTail,
Dimension  aK,
bool  aEpsilon 
)
inline

Definition at line 247 of file DigitalSurface.h.

248  : base( theTail ), k( aK ), epsilon( aEpsilon ) {}
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel

Member Function Documentation

◆ operator!=()

template<typename TDigitalSurfaceContainer>
bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::operator!= ( const Arc other) const
inline

Definition at line 262 of file DigitalSurface.h.

263  {
264  return ( base != other.base )
265  || ( k != other.k ) || ( epsilon != other.epsilon );
266  }
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::base, DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::epsilon, and DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::k.

◆ operator<()

template<typename TDigitalSurfaceContainer>
bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::operator< ( const Arc other) const
inline

Definition at line 254 of file DigitalSurface.h.

255  {
256  return ( base < other.base )
257  || ( ( base == other.base )
258  && ( ( k < other.k )
259  || ( ( k == other.k )
260  && ( epsilon < other.epsilon ) ) ) );
261  }
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::base, DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::epsilon, and DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::k.

◆ operator==()

template<typename TDigitalSurfaceContainer>
bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::operator== ( const Arc other) const
inline

Definition at line 249 of file DigitalSurface.h.

250  {
251  return ( base == other.base )
252  && ( k == other.k ) && ( epsilon == other.epsilon );
253  }
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::base, DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::epsilon, and DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::k.

Field Documentation

◆ base

template<typename TDigitalSurfaceContainer>
Vertex DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::base

◆ epsilon

template<typename TDigitalSurfaceContainer>
bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::epsilon

◆ k

template<typename TDigitalSurfaceContainer>
Dimension DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::k

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