ParallelStrip.h

 
#pragma once
 
#if defined(ParallelStrip_RECURSES)
#error Recursive header files inclusion detected in ParallelStrip.h
#else // defined(ParallelStrip_RECURSES)
#define ParallelStrip_RECURSES
 
#if !defined ParallelStrip_h
#define ParallelStrip_h
 
// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/CSpace.h"
 
namespace DGtal
{
 
  // template class ParallelStrip
  template <typename TSpace, bool muIncluded = true, bool muPlusNuIncluded = true>
  class ParallelStrip
  {
    BOOST_CONCEPT_ASSERT(( concepts::CSpace< TSpace > ));
 
    // ----------------------- public types ------------------------------
  public:
    typedef TSpace Space;
    typedef ParallelStrip<Space,muIncluded,muPlusNuIncluded> Self;
    typedef typename Space::Point Point;
    typedef typename Space::RealPoint RealPoint;
    typedef typename Space::Vector Vector;
    typedef typename Space::RealVector RealVector;
    typedef typename RealPoint::Coordinate Coordinate;
    typedef typename RealVector::Component Component;
    typedef Component Scalar;
 
    
    // ----------------------- Standard services ------------------------------
  public:
 
    ~ParallelStrip();
 
    ParallelStrip();
 
    ParallelStrip ( Scalar mu, const RealVector & N, Scalar nu );
 
    ParallelStrip ( const ParallelStrip & other );
 
    ParallelStrip & operator= ( const ParallelStrip & other );
 
    //-------------------- strip / plane services -----------------------------
  public:
 
    const RealVector & normal() const;
 
    Scalar mu() const;
 
    Scalar nu() const;
 
    Scalar width() const;
 
    Scalar axisWidth() const;
 
    Dimension mainAxis() const;
 
    Scalar diagonalWidth() const;
 
    Dimension mainDiagonal() const;
 
    void getBounds( Scalar & mu, Scalar & mu_plus_nu ) const;
 
    //-------------------- model of concepts::CPointPredicate -----------------------------
  public:
 
    bool operator()( const Point & p ) const;
 
    bool operator()( const RealPoint & p ) const;
 
    // ----------------------- Interface --------------------------------------
  public:
 
    void selfDisplay ( std::ostream & out ) const;
 
    bool isValid() const;
 
    // ------------------------- Protected Datas ------------------------------
  protected:
    Scalar myMu;
    RealVector myN;
    Scalar myNu;
 
    // ------------------------- Private Datas --------------------------------
  private:
 
    // ------------------------- Hidden services ------------------------------
  protected:
 
    // ------------------------- Internals ------------------------------------
  private:
 
  }; // end of class ParallelStrip
 
 
  template <typename TSpace, bool muIncluded, bool muPlusNuIncluded>
  std::ostream&
  operator<< ( std::ostream & out, 
               const ParallelStrip<TSpace,muIncluded,muPlusNuIncluded> & object );
 
} // namespace DGtal
 
 
// Includes inline functions.
#include "DGtal/geometry/surfaces/ParallelStrip.ih"
 
//                                                                           //
 
#endif // !defined ParallelStrip_h
 
#undef ParallelStrip_RECURSES
#endif // else defined(ParallelStrip_RECURSES)