/*
 * (C) Copyright 1996-2016 ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation nor
 * does it submit to any jurisdiction.
 */

/*! \file IsoShading.h
    \brief Definition of the Template class IsoShading.

    Magics Team - ECMWF 2004

    Started: Tue 9-Mar-2004

    Changes:
*/

#ifndef IsoShading_H
#define IsoShading_H

#include "Factory.h"
#include "MagTranslator.h"
#include "magics.h"

#include "Colour.h"
#include "IsoShadingAttributes.h"
#include "LegendVisitor.h"
#include "LevelSelection.h"
#include "MatrixHandler.h"
#include "Polyline.h"

namespace magics {

class ContourMethod;
class IsoPlot;
class NoIsoShading {
public:
    NoIsoShading() {}
    virtual ~NoIsoShading() {}
    virtual void set(const map<string, string>&) {}
    virtual void set(const XmlNode&) {}
    virtual void toxml(ostream&, int = 0) const {}
    virtual bool accept(const string&) { return true; }

    virtual void operator()(IsoPlot*, MatrixHandler&,
                            BasicGraphicsObjectContainer&) {  // Should return
                                                              // CellArray* array = technique_->array(matrix, range,
                                                              // transformation, width, height, resolution, technique);

        // return array;
    }
    virtual void operator()(Data&, BasicGraphicsObjectContainer&) {}


    virtual NoIsoShading* clone() {
        NoIsoShading* object = new NoIsoShading();
        return object;
    }
    virtual CellArray* array(MatrixHandler& matrix, IntervalMap<int>& range, const Transformation& transformation,
                             int width, int height, float resolution, const string& technique);
    void close(const MatrixHandler&) const {}
    virtual bool shadingMode() { return false; }
    virtual bool hasLegend() { return false; }
    virtual int shadingIndex(double) { return -1; }
    virtual int leftIndex(double) { return -1; }
    virtual int rightIndex(double) { return -1; }
    virtual double leftRange(double) { return 0; }
    virtual double rightRange(double) { return 0; }
    virtual bool operator()(LevelSelection&) { return false; }
    virtual void visit(LegendVisitor&) {}
    virtual void operator()(Polyline*) const {}
    virtual void colour(double, Colour&){};
    virtual bool needClipping() { return false; }
    virtual bool method(ContourMethod*) { return false; }
    virtual void reset() {}

protected:
    //! Method to print string about this class on to a stream of type ostream (virtual).
    virtual void print(ostream& out) const { out << "No Shading"; }

private:
    //! Copy constructor - No copy allowed
    NoIsoShading(const NoIsoShading&);
    //! Overloaded << operator to copy - No copy allowed
    NoIsoShading& operator=(const NoIsoShading&);
    // -- Friends
    //! Overloaded << operator to call print().
    friend ostream& operator<<(ostream& s, const NoIsoShading& p) {
        p.print(s);
        return s;
    }
};


class IsoShading : public NoIsoShading, public IsoShadingAttributes {
public:
    IsoShading();
    ~IsoShading();
    void set(const map<string, string>& map) { IsoShadingAttributes::set(map); }
    void set(const XmlNode& node) { IsoShadingAttributes::set(node); }
    virtual void operator()(Polyline*) const;

    virtual bool accept(const string&) { return true; }
    virtual NoIsoShading* clone() const {
        IsoShading* object = new IsoShading();
        object->copy(*this);
        return object;
    }

    CellArray* array(MatrixHandler& matrix, IntervalMap<int>& range, const Transformation& transformation, int width,
                     int height, float resolution, const string& technique) {
        CellArray* array = technique_->array(matrix, range, transformation, width, height, resolution, technique);

        return array;
    }
    virtual void operator()(IsoPlot* iso, MatrixHandler& data, BasicGraphicsObjectContainer& parent) {
        (*this->technique_)(iso, data, parent);
    }
    virtual void operator()(Data& data, BasicGraphicsObjectContainer& parent) { (*this->technique_)(data, parent); }
    virtual int shadingIndex(double);
    virtual int leftIndex(double);
    virtual int rightIndex(double);
    void reset() { technique_->reset(); }

    virtual bool needClipping() { return (*this->technique_).needClipping(); }
    virtual bool operator()(LevelSelection& list) {
        LevelSelection filter;
        for (LevelSelection::const_iterator level = list.begin(); level != list.end(); ++level)
            if (this->min_ <= *level && *level <= this->max_)
                filter.push_back(*level);


        (*this->colourMethod_).prepare(list, filter);


        if (!filter.empty() && (filter.back() == filter.front()))
            filter.push_back(filter.front());


        return (*this->technique_).prepare(filter, *this->colourMethod_);
    }
    // returns true, if the contouring lines have to be created... False, is the shading is finished...
    virtual void visit(LegendVisitor& legend) {
        legend.newLegend();
        (*this->technique_).visit(legend, *this->colourMethod_);
    }
    virtual bool shadingMode() { return (*this->technique_).shadingMode(); }
    virtual bool hasLegend() { return (*this->technique_).hasLegend(); }
    virtual void colour(double val, Colour& colour) {
        ColourTechnique::iterator icolour = colourMethod_->find(val);
        if (icolour != colourMethod_->end())
            colour = icolour->second.right_;
    }
    virtual bool method(ContourMethod* method) { return (*this->technique_).method(method); }

protected:
    //! Method to print string about this class on to a stream of type ostream (virtual).
    virtual void print(ostream&) const;
    vector<Colour> colours_;
    vector<Colour>::iterator colour_;


private:
    //! Copy constructor - No copy allowed
    IsoShading(const IsoShading&);
    //! Overloaded << operator to copy - No copy allowed
    IsoShading& operator=(const IsoShading&);
};

template <>
class MagTranslator<string, NoIsoShading> {
public:
    NoIsoShading* operator()(const string& val) { return SimpleObjectMaker<NoIsoShading>::create(val); }
    NoIsoShading* magics(const string& param) {
        NoIsoShading* object = 0;
        ParameterManager::update(param, object);
        return object;
    }
};
}  // namespace magics


#endif
