Public API Reference

csgfx/gradient.h

Go to the documentation of this file.

/*
    Copyright (C) 2003 by Jorrit Tyberghein
              (C) 2003 by Frank Richter
              (C) 2006 by Christopher Nelson

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_CSGFX_GRADIENT_H__
#define __CS_CSGFX_GRADIENT_H__

#include "csextern.h"

#include "ivaria/gradient.h"

#include "csutil/array.h"
#include "csutil/cscolor.h"
#include "csutil/scf_implementation.h"
#include "csutil/scfarray.h"
#include "csgfx/rgbpixel.h"

class CS_CRYSTALSPACE_EXPORT csGradient :
  public scfImplementation1<csGradient, iGradient>
{
protected:
  csArray<csGradientShade> shades;
  struct scfGradientShadesArray : public scfArrayWrapConst<iGradientShades,
    csArray<csGradientShade> >
  {
    scfGradientShadesArray (csGradient* parent) : 
      scfArrayWrapConst<iGradientShades, csArray<csGradientShade> > (
        parent->shades, parent) {}
  };
public:
  csGradient ();
  csGradient (csColor4 first, csColor4 last);
  


  void AddShade (const csGradientShade& shade);
  void AddShade (const csColor4& color, float position);
  void AddShade (const csColor4& left, const csColor4& right, 
    float position);
  
  void Clear ();
  
  bool Render (csRGBcolor* pal, size_t count, float begin = 0.0f, 
    float end = 1.0f) const;
  
  bool Render (csRGBpixel* pal, size_t count, float begin = 0.0f, 
    float end = 1.0f) const;

  csPtr<iGradientShades> GetShades ();
};


#endif // __CS_CSGFX_GRADIENT_H__

---