TickedColorMap.h

#pragma once

#if defined(TickedColorMap_RECURSES)
#error Recursive header files inclusion detected in TickedColorMap.h
#else // defined(TickedColorMap_RECURSES)

#define TickedColorMap_RECURSES

#if !defined TickedColorMap_h

#define TickedColorMap_h

// Inclusions
#include <iostream>
#include <vector>
#include <utility>
#include <algorithm>
#include "DGtal/base/Common.h"
#include "DGtal/io/Color.h"
#include "DGtal/io/colormaps/CColorMap.h"

namespace DGtal
{
  
  // template class TickedColorMap
  template <typename TValue, typename TColorMap>
  class TickedColorMap
  {
    
  public:
    
    typedef TValue Value;
    
    typedef TColorMap ColorMap;
    
    BOOST_CONCEPT_ASSERT(( concepts::CColorMap<ColorMap> )) ;
    BOOST_STATIC_ASSERT(( concepts::ConceptUtils::SameType<Value, typename ColorMap::Value>::value));
    
    // ----------------------- Standard services ------------------------------
  public:
    
    TickedColorMap(const Value & aMin,
                   const Value & aMax,
                   const Color &color = Color::White);
    
    Color operator()( const Value & value ) const;
    
    ~TickedColorMap();
    
    TickedColorMap ( const TickedColorMap & other );
    
    TickedColorMap & operator= ( const TickedColorMap & other );
    
    // ----------------------- Interface --------------------------------------
  public:
    
    void addTick(const Value position,
                 const Value thickness);
    
    void addRegularTicks(const unsigned int nbTicks,
                         const Value thickness);
    
    void finalize();
    
    ColorMap * colormap() const
    {
      return myColorMap;
    }
    
    void selfDisplay ( std::ostream & out ) const;
    
    bool isValid() const;
    
    const Value & min() const;
    
    const Value & max() const;
    
    
    // ------------------------- Hidden services ------------------------------
  protected:
    
    Value myMin;    
    Value myMax;           
    ColorMap *myColorMap;  
    Color myTickColor; 
    std::vector< std::pair<Value,Value> > myTicks;
    
    TickedColorMap();
    
  }; // end of class TickedColorMap2d
  
  
  template <typename TValue, typename CMAP >
  std::ostream&
  operator<< ( std::ostream & out, const TickedColorMap<TValue,CMAP> & object );
  
} // namespace DGtal


// Includes inline functions.
#include "DGtal/io/colormaps/TickedColorMap.ih"

//                                                                           //

#endif // !defined TickedColorMap_h

#undef TickedColorMap_RECURSES
#endif // else defined(TickedColorMap_RECURSES)