DigitalPlanePredicate.h

 
#pragma once

 
#if defined(DigitalPlanePredicate_RECURSES)
#error Recursive header files inclusion detected in DigitalPlanePredicate.h
#else // defined(DigitalPlanePredicate_RECURSES)
#define DigitalPlanePredicate_RECURSES
 
#if !defined DigitalPlanePredicate_h
#define DigitalPlanePredicate_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/CSpace.h"
 
namespace DGtal
{

  // template class DigitalPlanePredicate
  template <typename TSpace>
  class DigitalPlanePredicate
  {
    BOOST_CONCEPT_ASSERT((concepts::CSpace<TSpace>));
 
    // ----------------------- public types ------------------------------
  public:
    using Self    = DigitalPlanePredicate<TSpace>;
    using Space   = TSpace;
    using Integer = typename Space::Integer;
    using Point   = typename Space::Point;
    using Vector  = typename Space::Vector;
 
    // ----------------------- Standard services ------------------------------
  public:
    DigitalPlanePredicate() = default;

    DigitalPlanePredicate (Vector const& aN, Integer const& aMu, Integer const& aNu);

    ~DigitalPlanePredicate() = default;

    DigitalPlanePredicate ( const DigitalPlanePredicate & other );

    DigitalPlanePredicate ( DigitalPlanePredicate && other );

    DigitalPlanePredicate & operator= ( const DigitalPlanePredicate & other );

    DigitalPlanePredicate & operator= ( DigitalPlanePredicate && other );
 
    //-------------------- plane services -----------------------------
  public:
    Vector const& normal () const;

    Integer mu () const;

    Integer nu () const;
 
    //-------------------- model of concepts::CPointPredicate -----------------------------
  public:
    bool operator() (Point const& aPoint) const;
 
    // ----------------------- Interface --------------------------------------
  public:

    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;
 
    // ------------------------- Protected Data ------------------------------
  protected:
 
    // ------------------------- Private Data --------------------------------
  private:
    Vector myNormal; 
    Integer myMu; 
    Integer myNu; 
 
    // ------------------------- Hidden services ------------------------------
  protected:
 
    // ------------------------- Internals ------------------------------------
  private:
 
  }; // end of class DigitalPlanePredicate
 

  template <typename T>
  std::ostream&
  operator<< ( std::ostream & out, const DigitalPlanePredicate<T> & object );
 
} // namespace DGtal
 

// Includes inline functions.
#include "DGtal/geometry/surfaces/DigitalPlanePredicate.ih"
 
//                                                                           //
 
#endif // !defined DigitalPlanePredicate_h
 
#undef DigitalPlanePredicate_RECURSES
#endif // else defined(DigitalPlanePredicate_RECURSES)