vpRGBf.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * 32-bit floating point RGB pixel.
 */

 
#ifndef VP_RGBF_H
#define VP_RGBF_H
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpColVector.h>
 
#ifdef VISP_HAVE_NLOHMANN_JSON
#include VISP_NLOHMANN_JSON(json.hpp)
#endif
 
#if ((__cplusplus >= 201703L) || (defined(_MSVC_LANG) && (_MSVC_LANG >= 201703L)))
#include <type_traits>
#endif
 
BEGIN_VISP_NAMESPACE

class VISP_EXPORT vpRGBf
{
public:
  inline vpRGBf() : R(0), G(0), B(0) { }

  inline vpRGBf(float r, float g, float b)
    : R(r), G(g), B(b)
  { }

  VP_EXPLICIT inline vpRGBf(float v) : R(v), G(v), B(v) { }

  VP_EXPLICIT inline vpRGBf(int v)
  {
    *this = v;
  }

#if ((__cplusplus >= 201103L) || (defined(_MSVC_LANG) && (_MSVC_LANG >= 201103L))) // Check if cxx11 or higher
  inline vpRGBf(const vpRGBf &v) = default;
#else
  inline vpRGBf(const vpRGBf &v) : R(v.R), G(v.G), B(v.B) { }
#endif
  VP_EXPLICIT inline vpRGBf(const vpColVector &v) : R(0), G(0), B(0) { *this = v; }
 
  vpRGBf &operator=(float v);
  vpRGBf &operator=(int v);
#if ((__cplusplus >= 201103L) || (defined(_MSVC_LANG) && (_MSVC_LANG >= 201103L))) // Check if cxx11 or higher
  vpRGBf &operator=(const vpRGBf &v) = default;
  vpRGBf &operator=(vpRGBf &&v) = default;
#else
  vpRGBf &operator=(const vpRGBf &v)
  {
    this->R = v.R;
    this->G = v.G;
    this->B = v.B;
    return *this;
  }
#endif
  vpRGBf &operator=(const vpColVector &v);
  bool operator==(const vpRGBf &v) const;
  bool operator!=(const vpRGBf &v) const;
 
  vpColVector operator-(const vpRGBf &v) const;
  vpRGBf operator+(const vpRGBf &v) const;
  vpColVector operator-(const vpColVector &v) const;
  vpColVector operator+(const vpColVector &v) const;
  vpColVector operator*(float v) const;
  vpColVector operator*(double v) const;
 
  bool operator<(const vpRGBf &v) const;
  bool operator>(const vpRGBf &v) const;
 
  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpRGBf &rgb);
 
public:
  float R; 
  float G; 
  float B; 
 
  friend VISP_EXPORT vpRGBf operator*(double x, const vpRGBf &rgb);
  friend VISP_EXPORT vpRGBf operator*(float x, const vpRGBf &rgb);
};
 
#if ((__cplusplus >= 201703L) || (defined(_MSVC_LANG) && (_MSVC_LANG >= 201703L)))
static_assert(std::is_trivially_assignable_v<vpRGBf, vpRGBf>);
static_assert(std::is_trivially_copyable_v<vpRGBf>);
#endif
 
#ifdef VISP_HAVE_NLOHMANN_JSON
 
inline void from_json(const nlohmann::json &j, vpRGBf &c)
{
  c.R = j.at(0);
  c.G = j.at(1);
  c.B = j.at(2);
 
}
 
inline void to_json(nlohmann::json &j, const vpRGBf &c)
{
  j = { c.R, c.G, c.B };
}
#endif
 
END_VISP_NAMESPACE
 
#endif