ScalePal.hpp

#ifndef OPALS_SCALE_PAL_HPP_INCLUDED
#define OPALS_SCALE_PAL_HPP_INCLUDED

#pragma once

#include "opals/config.hpp"
#include "opals/Vector.hpp"

namespace opals {

  /// Class describing different scaling methods for palette entries
  class OPALS_API ScalePal
  {
  public:
    ScalePal();
    virtual ~ScalePal();

    /// scaling of palette nodes
    struct TypeScalePal {
      enum Type {
        autoScale = 0,           ///< automatic scaling of palette nodes
        scaleByFactor,           ///< single scaling factor
        scaleByRange,            ///< scaling range 
        scaleByRelRange,         ///< scaling relative range 
        scaleByRangeClip,        ///< scaling range with clipping
        scaleByRelRangeClip,     ///< scaling relative range with clipping
      };
    };

    bool isAutoScale() const     { return type == TypeScalePal::autoScale; };
    bool isScaleByFactor() const { return type == TypeScalePal::scaleByFactor; };
    bool isScaleByRange() const  { return type >= TypeScalePal::scaleByRange && type <= TypeScalePal::scaleByRelRangeClip; };

    bool isRelativeRange() const  { return type == TypeScalePal::scaleByRelRange  || type == TypeScalePal::scaleByRelRangeClip; };
    bool withClipping() const     { return type == TypeScalePal::scaleByRangeClip || type == TypeScalePal::scaleByRelRangeClip; };

    TypeScalePal::Type getType() const { return type; }

    void setAutoScale();
    void setScaleFactor( const double& scalefac );
    void setScaleRange( const double& rangemin, const double& rangemax, bool relativeValues, bool withClipping );
    void setScaleRange( const opals::Vector<double>& values, bool relativeValues, bool withClipping  );

    double getScaleFactor() const { return isScaleByFactor() ? scale[0] : 0.; };
    double getScaleMin() const    { return *scale.begin(); };
    double getScaleMax() const    { return *scale.rbegin(); };
    const opals::Vector<double>& getScaleValues() const  { return scale; };

    private: 
      TypeScalePal::Type type;
      opals::Vector<double> scale;
  };
}

#endif //OPALS_SCALE_PAL_HPP_INCLUDED