RandomColorGenerator.h

Go to the documentation of this file.

#pragma once
#include <NDEVR/RGBColor.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/Bounds.h>
#include <NDEVR/Dictionary.h>
#include <cmath>
namespace NDEVR 
{
    /**----------------------------------------------------------------------------
    \brief Used with RandomColorGenerator to generate random colors 
    Options allow for custom hues and brightness.
    ----------------------------------------------------------------------------*/
    struct NDEVR_BASE_API RandomColorOptions 
    {
        enum LuminosityStyle 
        {
            e_random,
            e_bright,
            e_light,
            e_dark
        };
        enum HueStyle 
        {
            e_unset,
            e_monochrome,
            e_red,
            e_orange,
            e_yellow,
            e_green,
            e_blue,
            e_purple,
            e_pink
        };
        RandomColorOptions();
        int        hue;
        HueStyle   hue_name;
        size_t     seed;
        LuminosityStyle luminosity;
    };
    /**----------------------------------------------------------------------------
    \brief Generates random colors based off of some specified settings
    Useful for generating unique colors for lists of objects.
    ----------------------------------------------------------------------------*/
    class NDEVR_BASE_API RandomColorGenerator 
    {
    private:
        enum ColorRangeType
        {
            e_hue_range,
            e_low_bounds,
            e_saturation_range,
            e_brightness_range
        };
        using ColorMap = Dictionary<RandomColorOptions::HueStyle, Dictionary<ColorRangeType, Buffer<Bounds<1, sint04>>>>;
    public:
        
        
        static ColorMap LoadColorBounds();
        //--------------------------------------------------------------------------
        RandomColorGenerator() 
            : options() 
        {}
        RandomColorGenerator(const RandomColorOptions& opt)
            : options(opt)
        {}
        Buffer<RGBColor> randomColors(uint04 count) const;
        RGBColor randomColorRGB() const;
 
    private:
        
        mutable RandomColorOptions options;
        static ColorMap s_color_dictionary;
        //--------------------------------------------------------------------------
    private:
        //--------------------------------------------------------------------------
        Bounds<1, sint04> getSaturationRange(const Angle<sint02>& hue) const {
            return getColorInfo(hue.toTypeAngle<sint04>())[ColorRangeType::e_saturation_range][0];
        }
        //--------------------------------------------------------------------------
        static Bounds<1, sint04> getHueRange(int colorInput);
        //--------------------------------------------------------------------------
        static Bounds<1, sint04> getHueRange_s(RandomColorOptions::HueStyle colorInput);
        //--------------------------------------------------------------------------
        sint04 randomWithin(const Bounds<1, sint04>& range) const;
        //--------------------------------------------------------------------------
        Angle<sint02> pickHue() const;
        //--------------------------------------------------------------------------
        Dictionary<ColorRangeType, Buffer<Bounds<1, sint04>>> getColorInfo(Angle<sint04> hue) const;
        //--------------------------------------------------------------------------
        uint01 pickSaturation(const Angle<sint02>& hue) const;
        //--------------------------------------------------------------------------
        uint01 getMinimumBrightness(const Angle<sint02>& H, uint01 S) const;
        //--------------------------------------------------------------------------
        uint01 pickBrightness(const Angle<sint02>& H, uint01 S) const;
 
    };
};