color_writer_plugin.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_FORMATS_COLOR_WRITER_PLUGIN_H_
#define GENESIS_TREE_FORMATS_COLOR_WRITER_PLUGIN_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 "genesis/utils/color/color.hpp"
#include "genesis/utils/color/functions.hpp"
 
#include <vector>
 
namespace genesis {
namespace tree {
 
// =================================================================================================
//     Color Writer Plugin Base
// =================================================================================================
 
class ColorWriterPlugin
{
    // -------------------------------------------------------------------------
    //     Base Class
    // -------------------------------------------------------------------------
 
public:
 
    virtual ~ColorWriterPlugin() = default;
 
    // -------------------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------------------
 
public:
 
    void edge_colors( std::vector<utils::Color> const& color_vector )
    {
        edge_colors_ = color_vector;
    }
 
    std::vector<utils::Color> const& edge_colors() const
    {
        return edge_colors_;
    }
 
    void enable_color( bool value )
    {
        enable_color_ = value;
    }
 
    bool enable_color() const
    {
        return enable_color_;
    }
 
    void ignored_color( utils::Color value )
    {
        ignored_color_ = value;
        use_ignored_color_ = true;
    }
 
    utils::Color ignored_color() const
    {
        return ignored_color_;
    }
 
    void use_ignored_color( bool value )
    {
        use_ignored_color_ = value;
    }
 
    bool use_ignored_color() const
    {
        return use_ignored_color_;
    }
 
    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------
 
private:
 
    std::vector<utils::Color> edge_colors_;
    bool                      enable_color_  = true;
    utils::Color              ignored_color_ = utils::Color(0, 0, 0);
    bool                      use_ignored_color_ = false;
 
};
 
} // namespace tree
} // namespace genesis
 
#endif // include guard