color.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2000-2022 Inria
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *  * Neither the name of the ALICE Project-Team nor the names of its
 *  contributors may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 *  Contact: Bruno Levy
 *
 *     https://www.inria.fr/fr/bruno-levy
 *
 *     Inria,
 *     Domaine de Voluceau,
 *     78150 Le Chesnay - Rocquencourt
 *     FRANCE
 *
 */
 
 
#ifndef H_OGF_IMAGE_TYPES_COLOR_H
#define H_OGF_IMAGE_TYPES_COLOR_H
 
#include <geogram/basic/common.h>
#include <geogram/basic/geometry.h>
 
namespace GEO {
 
    template <class T> class GenColor : public vecng<4,T> {
    public:
        typedef vecng<4,T> superclass;
 
        inline GenColor(const superclass& rhs) : superclass(rhs) {
        }
 
        inline GenColor(const T* rhs) : superclass(rhs) {
        }
 
        inline GenColor(
            T r=0, T g=0, T b=0, T a=1
        ):superclass(r,g,b,a) {
        }
 
        inline GenColor& operator=(const superclass& rhs) {
            superclass::operator=(rhs);
            return *this;
        }
 
        T r() const {
            return superclass::x;
        }
 
        T g() const {
            return superclass::y;
        }
 
        T b() const {
            return superclass::z;
        }
 
        T a() const {
            return superclass::w;
        }
 
        void set_r(T r) {
            superclass::x = r;
        }
 
        void set_g(T g) {
            superclass::y = g;
        }
 
        void set_b(T b) {
            superclass::z = b;
        }
 
        void set_a(T a) {
            superclass::w = a;
        }
 
    };
 
    typedef GenColor<Numeric::float64> Color;
 
    Color GEOGRAM_API make_color_from_hsl(double h, double s, double l);
 
    Color GEOGRAM_API make_random_color(
        double min_h=0.0,   double max_h=1.0,
        double min_s=0.165, double max_s=0.4,
        double min_l=0.4,   double max_l=0.8
    );
}
 
#endif