DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face Struct Reference

#include <DigitalSurface.h>

Public Member Functions
	Face (const UmbrellaState &aState, unsigned int nb, bool aIsClosed)
bool	isClosed () const
bool	operator== (const Face &other) const
bool	operator< (const Face &other) const

Data Fields
UmbrellaState	state
unsigned int	nbVertices
bool	closed

---

Detailed Description

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

Defines a face on the digital surface, i.e. an umbrella (open or closed) around a pivot cell (n-3-cell). To be able to compare faces, the face is characterized by one of its possible states. If the face is closed, the representative state is the smallest one. If the face is open, the representative state is the first (applying previous() does not move).

Definition at line 222 of file DigitalSurface.h.

---

Constructor & Destructor Documentation

template<typename TDigitalSurfaceContainer>

DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::Face ( const UmbrellaState &  aState, unsigned int  nb, bool  aIsClosed  )

inline

Definition at line 227 of file DigitalSurface.h.

        : state( aState ), nbVertices( nb ), closed( aIsClosed )
      {}

---

Member Function Documentation

template<typename TDigitalSurfaceContainer>

bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::isClosed ( ) const

inline

Definition at line 231 of file DigitalSurface.h.

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::closed.

      { return closed; }

template<typename TDigitalSurfaceContainer>

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

inline

Definition at line 237 of file DigitalSurface.h.

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::state.

      {
        return state < other.state;
      }

template<typename TDigitalSurfaceContainer>

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

inline

Definition at line 233 of file DigitalSurface.h.

References DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::state.

      {
        return state == other.state;
      }

---

Field Documentation

template<typename TDigitalSurfaceContainer>

bool DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::closed

tells if the face is closed or open.

Definition at line 226 of file DigitalSurface.h.

Referenced by DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::isClosed().

template<typename TDigitalSurfaceContainer>

unsigned int DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::nbVertices

number of vertices incident to face.

Definition at line 225 of file DigitalSurface.h.

Referenced by DGtal::DigitalSurface< TDigitalSurfaceContainer >::verticesAroundFace().

template<typename TDigitalSurfaceContainer>

UmbrellaState DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::state

stores a state from which the whole umbrella can be recomputed.

Definition at line 223 of file DigitalSurface.h.

Referenced by DGtal::DigitalSurface< TDigitalSurfaceContainer >::computeFace(), DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::operator<(), DGtal::DigitalSurface< TDigitalSurfaceContainer >::Face::operator==(), DGtal::DigitalSurface< TDigitalSurfaceContainer >::pivot(), and DGtal::DigitalSurface< TDigitalSurfaceContainer >::verticesAroundFace().

---

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

• DigitalSurface.h