DGtal  0.9.4beta
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
 
Dimension k
 
bool epsilon
 

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 219 of file DigitalSurface.h.

Constructor & Destructor Documentation

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

Default constructor. The arc is invalid.

Definition at line 226 of file DigitalSurface.h.

227  : base(), k( 0 ), epsilon( false ) {}
Vertex base
base surfel
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel
template<typename TDigitalSurfaceContainer>
DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::Arc ( const Vertex theTail,
Dimension  aK,
bool  aEpsilon 
)
inline

Definition at line 228 of file DigitalSurface.h.

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

Member Function Documentation

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

Definition at line 243 of file DigitalSurface.h.

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

244  {
245  return ( base != other.base )
246  || ( k != other.k ) || ( epsilon != other.epsilon );
247  }
Vertex base
base surfel
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel
template<typename TDigitalSurfaceContainer>
bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::operator< ( const Arc other) const
inline

Definition at line 235 of file DigitalSurface.h.

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

236  {
237  return ( base < other.base )
238  || ( ( base == other.base )
239  && ( ( k < other.k )
240  || ( ( k == other.k )
241  && ( epsilon < other.epsilon ) ) ) );
242  }
Vertex base
base surfel
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel
template<typename TDigitalSurfaceContainer>
bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::operator== ( const Arc other) const
inline

Definition at line 230 of file DigitalSurface.h.

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

231  {
232  return ( base == other.base )
233  && ( k == other.k ) && ( epsilon == other.epsilon );
234  }
Vertex base
base surfel
Dimension k
direction toward the head surfel
bool epsilon
orientation toward the head surfel

Field Documentation

template<typename TDigitalSurfaceContainer>
Vertex DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::base
template<typename TDigitalSurfaceContainer>
bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::epsilon
template<typename TDigitalSurfaceContainer>
Dimension DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::k

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