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
Dimension	k
	direction toward the head surfel
bool	epsilon
	orientation toward the head surfel

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.

        : base(), k( 0 ), epsilon( false ) {}

References base, epsilon, and k.

Referenced by operator!=(), operator<(), and operator==().

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.

        : base( theTail ), k( aK ), epsilon( aEpsilon ) {}

References base, epsilon, and k.

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.

      {
        return ( base != other.base ) 
          || ( k != other.k ) || ( epsilon != other.epsilon );
      }

References Arc(), base, epsilon, and k.

operator<()

template<typename TDigitalSurfaceContainer>

bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::operator< ( const Arc & other ) const

inline

Definition at line 254 of file DigitalSurface.h.

      {
        return ( base < other.base ) 
          || ( ( base == other.base ) 
               && ( ( k < other.k ) 
                    || ( ( k == other.k ) 
                         && ( epsilon < other.epsilon ) ) ) );
      }

References Arc(), base, epsilon, and k.

operator==()

template<typename TDigitalSurfaceContainer>

bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Arc::operator== ( const Arc & other ) const

inline

Definition at line 249 of file DigitalSurface.h.

      {
        return ( base == other.base ) 
          && ( k == other.k ) && ( epsilon == other.epsilon );
      }

References Arc(), base, epsilon, and k.

Field Documentation

base

template<typename TDigitalSurfaceContainer>

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

base surfel

Definition at line 239 of file DigitalSurface.h.

Referenced by Arc(), Arc(), operator!=(), operator<(), and operator==().

epsilon

template<typename TDigitalSurfaceContainer>

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

orientation toward the head surfel

Definition at line 241 of file DigitalSurface.h.

Referenced by Arc(), Arc(), operator!=(), operator<(), and operator==().

k

template<typename TDigitalSurfaceContainer>

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

direction toward the head surfel

Definition at line 240 of file DigitalSurface.h.

Referenced by Arc(), Arc(), operator!=(), operator<(), and operator==().

---

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

• DigitalSurface.h