include/basegfx/color/bcolor.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_BASEGFX_COLOR_BCOLOR_HXX
  21 #define INCLUDED_BASEGFX_COLOR_BCOLOR_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <ostream>
  26
  27 #include <basegfx/tuple/b3dtuple.hxx>
  28 #include <vector>
  29 #include <basegfx/basegfxdllapi.h>
  30
  31 namespace com { namespace sun { namespace star { namespace rendering {
  32     class XGraphicDevice;
  33 }}}}
  34
  35 namespace basegfx
  36 {
  37     /** Base Color class with three double values
  38
  39         This class derives all operators and common handling for
  40         a 3D data class from B3DTuple. All necessary extensions
  41         which are special for colors will be added here.
  42
  43         @see B3DTuple
  44     */
  45     class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC BColor : public B3DTuple
  46     {
  47     public:
  48         /** Create a Color with red, green and blue components from [0.0 to 1.0]
  49
  50             The color is initialized to (0.0, 0.0, 0.0)
  51         */
  52         BColor()
  53         :   B3DTuple()
  54         {}
  55
  56         /** Create a 3D Color
  57
  58             @param fRed
  59             @param fGreen
  60             @param fBlue
  61             These parameters are used to initialize the red, green and blue intensities of the color
  62         */
  63         BColor(double fRed, double fGreen, double fBlue)
  64         :   B3DTuple(fRed, fGreen, fBlue)
  65         {}
  66
  67         /** Create a 3D Color
  68
  69             @param fLuminosity
  70             The parameter is used to initialize the red, green and blue intensities of the color
  71         */
  72         explicit BColor(double fLuminosity)
  73         :   B3DTuple(fLuminosity, fLuminosity, fLuminosity)
  74         {}
  75
  76         /** constructor with tuple to allow copy-constructing
  77             from B3DTuple-based classes
  78         */
  79         BColor(const ::basegfx::B3DTuple& rTuple)
  80         :   B3DTuple(rTuple)
  81         {}
  82
  83         // data access read
  84         double getRed() const { return mfX; }
  85         double getGreen() const { return mfY; }
  86         double getBlue() const { return mfZ; }
  87
  88         // data access write
  89         void setRed(double fNew) { mfX = fNew; }
  90         void setGreen(double fNew) { mfY = fNew; }
  91         void setBlue(double fNew) { mfZ = fNew; }
  92
  93         /** *=operator to allow usage from BColor, too
  94         */
  95         BColor& operator*=( const BColor& rPnt )
  96         {
  97             mfX *= rPnt.mfX;
  98             mfY *= rPnt.mfY;
  99             mfZ *= rPnt.mfZ;
 100             return *this;
 101         }
 102
 103         /** *=operator to allow usage from BColor, too
 104         */
 105         BColor& operator*=(double t)
 106         {
 107             mfX *= t;
 108             mfY *= t;
 109             mfZ *= t;
 110             return *this;
 111         }
 112
 113         /** assignment operator to allow assigning the results
 114             of B3DTuple calculations
 115         */
 116         BColor& operator=( const ::basegfx::B3DTuple& rVec )
 117         {
 118             mfX = rVec.getX();
 119             mfY = rVec.getY();
 120             mfZ = rVec.getZ();
 121             return *this;
 122         }
 123
 124         // luminance
 125         double luminance() const
 126         {
 127             const double fRedWeight(77.0 / 256.0);      // 0.30
 128             const double fGreenWeight(151.0 / 256.0);   // 0.59
 129             const double fBlueWeight(28.0 / 256.0);     // 0.11
 130
 131             return (mfX * fRedWeight + mfY * fGreenWeight + mfZ * fBlueWeight);
 132         }
 133
 134         // distances in color space
 135         double getDistanceRed(const BColor& rColor) const { return (getRed() > rColor.getRed() ? getRed() - rColor.getRed() : rColor.getRed() - getRed()); }
 136         double getDistanceGreen(const BColor& rColor) const { return (getGreen() > rColor.getGreen() ? getGreen() - rColor.getGreen() : rColor.getGreen() - getGreen()); }
 137         double getDistanceBlue(const BColor& rColor) const { return (getBlue() > rColor.getBlue() ? getBlue() - rColor.getBlue() : rColor.getBlue() - getBlue()); }
 138
 139         double getDistance(const BColor& rColor) const
 140         {
 141             const double fDistR(getDistanceRed(rColor));
 142             const double fDistG(getDistanceGreen(rColor));
 143             const double fDistB(getDistanceBlue(rColor));
 144
 145             return sqrt(fDistR * fDistR + fDistG * fDistG + fDistB * fDistB);
 146         }
 147
 148         double getMaximumDistance(const BColor& rColor) const
 149         {
 150             const double fDistR(getDistanceRed(rColor));
 151             const double fDistG(getDistanceGreen(rColor));
 152             const double fDistB(getDistanceBlue(rColor));
 153
 154             double fRetval(fDistR > fDistG ? fDistR : fDistG);
 155             return (fRetval > fDistB ? fRetval : fDistB);
 156         }
 157
 158         // clamp color to [0.0..1.0] values in all three intensity components
 159         BColor& clamp()
 160         {
 161             mfX = basegfx::clamp(mfX, 0.0, 1.0);
 162             mfY = basegfx::clamp(mfY, 0.0, 1.0);
 163             mfZ = basegfx::clamp(mfZ, 0.0, 1.0);
 164             return *this;
 165         }
 166
 167         void invert()
 168         {
 169             mfX = 1.0 - mfX;
 170             mfY = 1.0 - mfY;
 171             mfZ = 1.0 - mfZ;
 172         }
 173
 174         static const BColor& getEmptyBColor()
 175         {
 176             return static_cast<const BColor&>( ::basegfx::B3DTuple::getEmptyTuple() );
 177         }
 178
 179     };
 180
 181     template<typename charT, typename traits>
 182     std::basic_ostream<charT, traits> & operator <<(
 183         std::basic_ostream<charT, traits> & stream, BColor const & color)
 184     {
 185         return stream
 186             << '[' << color.getRed() << ", " << color.getGreen() << ", "
 187             << color.getBlue() << ']';
 188     }
 189 } // end of namespace basegfx
 190
 191 #endif // INCLUDED_BASEGFX_COLOR_BCOLOR_HXX
 192
 193 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */