StarShaped3D.h

 
#pragma once
 
#if defined(StarShaped3D_RECURSES)
#error Recursive header files inclusion detected in StarShaped3D.h
#else // defined(StarShaped3D_RECURSES)
#define StarShaped3D_RECURSES
 
#if !defined StarShaped3D_h
#define StarShaped3D_h
 
// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/NumberTraits.h"
 
namespace DGtal
{
 
  // template class StarShaped3D
  template <typename TSpace>
  class StarShaped3D
  {
 
  public:
    typedef TSpace Space;
    typedef typename Space::RealPoint RealPoint;
    typedef std::pair<double,double> AngularCoordinates;
 
    StarShaped3D() = default;
 
    StarShaped3D & operator= ( const StarShaped3D & other ) = delete;
 
    virtual ~StarShaped3D() = default;
 
  // ------------------------- Implemented services -------------------------
  public:
    virtual RealPoint interiorPoint() const
    {
      return center();
    }
 
  // ------------------------- Abstract services ----------------------------
  public:
 
    virtual RealPoint getLowerBound() const = 0;
 
    virtual RealPoint getUpperBound() const = 0;
 
    virtual RealPoint center() const = 0;
 
    virtual void moveTo( const RealPoint& newCenter ) = 0;
 
    virtual AngularCoordinates parameter( const RealPoint& p ) const = 0;
 
    virtual RealPoint x( const AngularCoordinates& t ) const = 0;
 
    virtual RealPoint gradient( const AngularCoordinates& t ) const = 0;
 
    virtual RealPoint rt( const AngularCoordinates& t ) const = 0;
 
    virtual RealPoint rp( const AngularCoordinates& t ) const = 0;
 
    virtual RealPoint rtt( const AngularCoordinates& t ) const = 0;
 
    virtual RealPoint rpp( const AngularCoordinates& t ) const = 0;
 
    virtual RealPoint rtp( const AngularCoordinates& t ) const = 0;
 
  // ------------------------- star-shaped services -------------------------
  public:
 
    virtual Orientation orientation( const RealPoint& p ) const;
 
    /*
     * @param t is a couple of Teta && Phi wich are 2 angles
     respectivly between [0,2PI] and [0,Pi].
     *
     * @return the vector (x'(t),y'(t),z'(t)) made unitary which is
     * the unit tangent to the shape boundary.
     */
    /*
      virtual RealPoint tangent( AngularCoordinates t ) const;
    */
 
    virtual RealPoint normal( const AngularCoordinates& t ) const;
 
    virtual double gaussianCurvature( const AngularCoordinates& t ) const;
 
 
    virtual double meanCurvature( const AngularCoordinates& t ) const;
 
 
    virtual double arclength( const AngularCoordinates& t1,
                              AngularCoordinates t2,
                              unsigned int nb ) const;
 
 
    virtual double surfacelength( const AngularCoordinates& t1,
                                  AngularCoordinates t2,
                                  unsigned int nb ) const;
 
 
 
  // ----------------------- Interface --------------------------------------
  public:
 
    void selfDisplay( std::ostream & out ) const;
 
    bool isValid() const;
 
  // ------------------------- Hidden services ------------------------------
  private:
 
    template <typename T>
    inline
    bool isAlmostEqual( T x, T y ) const
    {
      return std::abs(x - y) <= std::numeric_limits<T>::epsilon();
    }
 
  }; // end of class StarShaped3D
 
 
  template <typename T>
  std::ostream&
  operator<< ( std::ostream & out, const StarShaped3D<T> & object );
 
} // namespace DGtal
 
 
// Includes inline functions.
#include "StarShaped3D.ih"
 
// //
 
#endif // !defined StarShaped3D_h
 
#undef StarShaped3D_RECURSES
#endif // else defined(StarShaped3D_RECURSES)