color.h

Go to the documentation of this file.

//
// Copyright 2024 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_GF_COLOR_H
#define PXR_BASE_GF_COLOR_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/gf/colorSpace.h"
#include "pxr/base/gf/vec2f.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix3f.h"
#include "pxr/base/gf/api.h"
 
#include <iosfwd>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class GfColor {
public:
    GF_API GfColor();
 
    GF_API
    explicit GfColor(const GfColorSpace& colorSpace);
 
    GF_API
    GfColor(const GfVec3f &rgb, const GfColorSpace& colorSpace);
 
    GF_API
    GfColor(const GfColor &color, const GfColorSpace& colorSpace);
 
    GF_API
    void SetFromPlanckianLocus(float kelvin, float luminance);
 
    GfVec3f GetRGB() const { return _rgb; }
 
    GfColorSpace GetColorSpace() const { return _colorSpace; }
 
    bool operator ==(const GfColor &rh) const {
        return _rgb == rh._rgb && _colorSpace == rh._colorSpace;
    }
 
    bool operator !=(const GfColor &rh) const { return !(*this == rh); }
 
protected:
    GfColorSpace _colorSpace; 
    GfVec3f      _rgb;        
 
    // Get the CIEXY coordinate of the color in the chromaticity chart,
    // For use in testing.
    GF_API
    GfVec2f _GetChromaticity() const;
 
    // Set the color from a CIEXY coordinate in the chromaticity chart.
    // For use in testing.
    GF_API
    void _SetFromChromaticity(const GfVec2f& xy);
};
 
 
inline bool
GfIsClose(GfColor const &c1, GfColor const &c2, double tolerance)
{
    return GfIsClose(c1.GetRGB(), c2.GetRGB(), tolerance);
}
 
std::ostream& operator<<(std::ostream &, GfColor const &);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_COLOR_H