colorRGBA.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: colorRGBA.h,v 1.21.16.1 2007/03/25 21:25:40 oliver Exp $
//

#ifndef BALL_VIEW_DATATYPE_COLORRGBA_H
#define BALL_VIEW_DATATYPE_COLORRGBA_H

#ifndef BALL_VIEW_DATATYPE_COLORUNIT_H
# include <BALL/VIEW/DATATYPE/colorUnit.h>
#endif

#ifndef BALL_CONCEPT_TIMESTAMP_H
 #include <BALL/CONCEPT/timeStamp.h>
#endif

class QColor;
namespace BALL 
{
  namespace VIEW 
  {
    // forward declarations 
    class ColorHSV;

    class BALL_VIEW_EXPORT ColorRGBA
    {
      friend class ColorHSV;

      public:

//      BALL_CREATE(ColorRGBA)


      ColorRGBA();

      ColorRGBA(const ColorRGBA& color);

      ColorRGBA(const ColorHSV& color);

      ColorRGBA(const char* value)
        throw(Exception::InvalidRange, ColorUnit::NotInHexFormat);

      ColorRGBA(const String& value)
        throw(Exception::InvalidRange, ColorUnit::NotInHexFormat);

      ColorRGBA
        (const ColorUnit& red_value, const ColorUnit& green_value,
         const ColorUnit& blue_value, const ColorUnit& alpha_value = (float)1);

      ColorRGBA(const QColor& color, const ColorUnit& alpha = (float)1);



      ~ColorRGBA();

      void clear();



      operator String() const;



      void set(const ColorRGBA& color);

      const ColorRGBA& operator = (const ColorRGBA& color);

      void set(const ColorHSV& color);

      const ColorRGBA& operator = (const ColorHSV& color);

      void get(ColorHSV& color) const;

      void set(const char* value)
        throw(Exception::InvalidRange, ColorUnit::NotInHexFormat);

      const ColorRGBA& operator = (const char* value)
        throw(Exception::InvalidRange, ColorUnit::NotInHexFormat);

      void get(char* value) const;

      void set(const String& value)
        throw(Exception::InvalidRange, ColorUnit::NotInHexFormat);

      const ColorRGBA& operator = (const String& value)
        throw(Exception::InvalidRange, ColorUnit::NotInHexFormat);

      void get(String& value) const;

      void get(QColor& color) const;

      bool set(const QColor& color);

      QColor getQColor() const;

      void swap(ColorRGBA& color);



      void setRed(const ColorUnit& red_value);

      ColorUnit& getRed();

      const ColorUnit& getRed() const;

      void setGreen(const ColorUnit& green_value);

      ColorUnit& getGreen();

      const ColorUnit& getGreen() const;

      void setBlue(const ColorUnit& blue_value);

      ColorUnit& getBlue();

      const ColorUnit& getBlue() const;

      void setAlpha(const ColorUnit& alpha_value);

      ColorUnit& getAlpha();

      const ColorUnit& getAlpha() const;

      void set
        (const ColorUnit& red_value, const ColorUnit& green_value,
         const ColorUnit& blue_value, const ColorUnit& alpha_value = (float)1);

      void get(ColorUnit& red_value, ColorUnit& green_value,
               ColorUnit& blue_value, ColorUnit& alpha_value) const;

      void get(ColorUnit& red_value,
               ColorUnit& green_value,
               ColorUnit& blue_value) const;

      ColorRGBA getInverseColor() const;
       


      bool operator == (const ColorRGBA& color) const;

      bool operator !=  (const ColorRGBA& color) const;

      bool operator < (const ColorRGBA& color) const;

      bool operator <= (const ColorRGBA& color) const;

      bool operator > (const ColorRGBA& color) const;

      bool operator >= (const ColorRGBA& color) const;
      


      void dump(std::ostream& s = std::cout, Size depth = 0) const;
      


      friend std::istream& operator >> (std::istream& s, ColorRGBA& color);

      friend std::ostream& operator << (std::ostream& s, const ColorRGBA& color);


      private:

      ColorUnit red_;
      ColorUnit green_;
      ColorUnit blue_;
      ColorUnit alpha_;

      void stringToRGBA_(const String& s)
        throw(Exception::InvalidRange, ColorUnit::NotInHexFormat);
    };

    extern ColorRGBA        BALL_SELECTED_COLOR;
    extern PreciseTime      BALL_SELECTED_COLOR_CHANGE_TIME;

#ifdef BALL_COMPILER_MSVC
#include <vector>
template class BALL_VIEW_EXPORT std::vector<ColorRGBA>;
#endif

#   ifndef BALL_NO_INLINE_FUNCTIONS
#     include <BALL/VIEW/DATATYPE/colorRGBA.iC>
#   endif
      
  } // namespace VIEW
} // namespace BALL

#endif // <BALL/VIEW_DATATYPE_COLORRGBA_H