slideshow/source/inc/rgbcolor.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_SLIDESHOW_SOURCE_INC_RGBCOLOR_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_INC_RGBCOLOR_HXX
  22
  23 #include <cppcanvas/color.hxx>
  24
  25
  26 /* Definition of RGBColor class */
  27
  28 namespace slideshow
  29 {
  30     namespace internal
  31     {
  32         class HSLColor;
  33
  34         /** RGB color space class.
  35          */
  36         class RGBColor
  37         {
  38         public:
  39             RGBColor();
  40             explicit RGBColor( ::cppcanvas::IntSRGBA nRGBColor );
  41             RGBColor( double nRed, double nGreen, double nBlue );
  42             explicit RGBColor( const HSLColor& rColor );
  43
  44             /** Get the RGB red value.
  45              */
  46             double getRed() const {  return maRGBTriple.mnRed; }
  47
  48             /** Get the RGB green value.
  49              */
  50             double getGreen() const {  return maRGBTriple.mnGreen; }
  51
  52             /** Get the RGB blue value.
  53              */
  54             double getBlue() const {  return maRGBTriple.mnBlue; }
  55
  56             /** Create an integer sRGBA color.
  57              */
  58             ::cppcanvas::IntSRGBA getIntegerColor() const;
  59
  60             struct RGBTriple
  61             {
  62                 RGBTriple();
  63                 RGBTriple( double nRed, double nGreen, double nBlue );
  64
  65                 double mnRed;
  66                 double mnGreen;
  67                 double mnBlue;
  68             };
  69
  70         private:
  71             // default copy/assignment are okay
  72             // RGBColor(const RGBColor&);
  73             // RGBColor& operator=( const RGBColor& );
  74
  75             RGBTriple   maRGBTriple;
  76         };
  77
  78         bool operator==( const RGBColor& rLHS, const RGBColor& rRHS );
  79         bool operator!=( const RGBColor& rLHS, const RGBColor& rRHS );
  80         RGBColor operator+( const RGBColor& rLHS, const RGBColor& rRHS );
  81         RGBColor operator*( const RGBColor& rLHS, const RGBColor& rRHS );
  82         RGBColor operator*( double nFactor, const RGBColor& rRHS );
  83
  84
  85         /** RGB color linear interpolator.
  86
  87             @param t
  88             As usual, t must be in the [0,1] range
  89         */
  90         RGBColor interpolate( const RGBColor& rFrom, const RGBColor& rTo, double t );
  91     }
  92 }
  93
  94 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_RGBCOLOR_HXX
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */