utils/color/functions.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_COLOR_FUNCTIONS_H_
#define GENESIS_UTILS_COLOR_FUNCTIONS_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2023 Lucas Czech
 
    This program 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 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include <iosfwd>
#include <map>
#include <string>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
class Color;
 
// =================================================================================================
//     Color Conversion
// =================================================================================================
 
Color color_from_bytes( unsigned char r, unsigned char g, unsigned char b, unsigned char a = 255 );
 
Color color_from_hex( std::string const& hex_color, std::string const& prefix = "#" );
 
std::string color_to_hex(
    Color const& c,
    std::string const& prefix = "#",
    bool uppercase = false,
    bool with_alpha = false
);
 
// =================================================================================================
//     Color Operators
// =================================================================================================
 
std::ostream& operator<< ( std::ostream& os, Color const& h );
 
Color resolve_color_string( std::string const& color_str );
 
// =================================================================================================
//     Color Gradients
// =================================================================================================
 
Color interpolate (Color const& color1, Color const& color2, double fraction);
 
Color gradient ( std::map<double, Color> const& ranges, double value );
 
Color heat_gradient (double percentage);
 
} // namespace utils
} // namespace genesis
 
#endif // include guard