gradient.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2011 by the OpenStructure authors
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 3.0 of the License, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
#ifndef OST_GFX_GRADIENT_HH
#define OST_GFX_GRADIENT_HH

/*
  Authors: Marco Biasini, Ansgar Philippsen
*/

#include <vector>

#include "color.hh"

#include <ost/info/info.hh>
#include <ost/info/info_fw.hh>

namespace ost { namespace gfx {

class DLLEXPORT_OST_GFX Gradient {
public:
  struct Stop {
    Stop(): t(0.0) {}
    
    Stop(float tt, const Color& c): t(tt), color(c) {}
    float t;
    Color color;
    
    Color GetColor() const {
      return color;
    }
    
    float GetRel() const {
      return t;
    }

    bool operator==(const Stop& ref) const
    {
      return t==ref.t && color==ref.color;
    }
    
  };
  
  typedef std::vector<Stop> StopList;
  
public:
  Gradient();

  Gradient(const String& name);

  Color GetColorAt(float t) const;
  void SetColorAt(float t, const Color& color);  
  
  // TODO: rename to ToInfo
  // TODO:: add stand-alone function named GradientToInfo(Gradient, InfoGroup)
  void GradientToInfo(info::InfoGroup& group) const;

  StopList GetStops() const;
  
  // TODO: move outside
  // TODO: add FromInfo member function that overwrites this
  static gfx::Gradient GradientFromInfo(const info::InfoGroup& group);

  void SetHSVMode(bool m) {hsv_mode_=m;}
  bool GetHSVMode() const {return hsv_mode_;}
    
private:
  std::vector<Stop>  stops_;
  bool hsv_mode_;
};


}}

#endif