DGtal  0.9.4beta
Public Types | Public Member Functions | Protected Attributes
DGtal::detail::DSSDecorator< TDSS > Class Template Referenceabstract

#include <DGtal/geometry/curves/FP.h>

Inheritance diagram for DGtal::detail::DSSDecorator< TDSS >:
[legend]

Public Types

typedef TDSS DSS
 

Public Member Functions

bool isExtendableFront () const
 
bool extendFront ()
 
bool retractBack ()
 
DSS::ConstIterator end ()
 
virtual ~DSSDecorator ()
 
virtual TDSS::Point firstLeaningPoint () const =0
 
virtual TDSS::Point lastLeaningPoint () const =0
 
virtual bool isInConvexPart () const =0
 

Protected Attributes

TDSS * myDSS
 

Detailed Description

template<typename TDSS>
class DGtal::detail::DSSDecorator< TDSS >

Aim: Abstract DSSDecorator for ArithmeticalDSSComputer. Has 2 virtual methods returning the first and last leaning point:

See also
DSSDecorator4ConvexPart DSSDecorator4ConcavePart
Template Parameters
TDSStype devoted to DSS recognition Must have a nested type 'Point' and four accessors: Uf(), Ul(), Lf(), Ll()

Definition at line 74 of file FP.h.

Member Typedef Documentation

template<typename TDSS >
typedef TDSS DGtal::detail::DSSDecorator< TDSS >::DSS

Type of the underlying DSS

Definition at line 80 of file FP.h.

Constructor & Destructor Documentation

template<typename TDSS >
virtual DGtal::detail::DSSDecorator< TDSS >::~DSSDecorator ( )
inlinevirtual

Destructor ( virtual to disable warnings [-Wdelete-non-virtual-dtor] )

Definition at line 126 of file FP.h.

126 {}

Member Function Documentation

template<typename TDSS >
DSS::ConstIterator DGtal::detail::DSSDecorator< TDSS >::end ( )
inline

End of the underlying segment

Returns
end iterator of the underlying segment

Definition at line 117 of file FP.h.

118  {
119  return myDSS->end();
120  }
template<typename TDSS >
bool DGtal::detail::DSSDecorator< TDSS >::extendFront ( )
inline

Extends the underlying segment (if possible)

Returns
'true' if the segment has been extended, 'false' otherwise

Definition at line 100 of file FP.h.

101  {
102  return myDSS->extendFront();
103  }
template<typename TDSS >
virtual TDSS::Point DGtal::detail::DSSDecorator< TDSS >::firstLeaningPoint ( ) const
pure virtual

First leaning point accessor

Returns
the first upper or lower leaning point

Implemented in DGtal::detail::DSSDecorator4ConcavePart< TDSS >, and DGtal::detail::DSSDecorator4ConvexPart< TDSS >.

template<typename TDSS >
bool DGtal::detail::DSSDecorator< TDSS >::isExtendableFront ( ) const
inline

Tells whether the underlying segment can be extended or not

Returns
'true' if extendable, 'false' otherwise

Definition at line 91 of file FP.h.

92  {
93  return myDSS->isExtendableFront();
94  }
template<typename TDSS >
virtual bool DGtal::detail::DSSDecorator< TDSS >::isInConvexPart ( ) const
pure virtual

Tells whether it adapts a DSS computer for convex parts or not

Returns
'true' for convex parts, 'false' for concave parts

Implemented in DGtal::detail::DSSDecorator4ConcavePart< TDSS >, and DGtal::detail::DSSDecorator4ConvexPart< TDSS >.

template<typename TDSS >
virtual TDSS::Point DGtal::detail::DSSDecorator< TDSS >::lastLeaningPoint ( ) const
pure virtual

Last leaning point accessor

Returns
the last upper or lower leaning point

Implemented in DGtal::detail::DSSDecorator4ConcavePart< TDSS >, and DGtal::detail::DSSDecorator4ConvexPart< TDSS >.

template<typename TDSS >
bool DGtal::detail::DSSDecorator< TDSS >::retractBack ( )
inline

Retracts the underlying segment (if possible)

Returns
'true' if the segment has been retracted, 'false' otherwise

Definition at line 109 of file FP.h.

110  {
111  return myDSS->retractBack();
112  }

Field Documentation

template<typename TDSS >
TDSS* DGtal::detail::DSSDecorator< TDSS >::myDSS
protected

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