gradient.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_FORMATS_SVG_GRADIENT_H_
#define GENESIS_UTILS_FORMATS_SVG_GRADIENT_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/formats/svg/attributes.hpp"
#include "genesis/utils/formats/svg/helper.hpp"
#include "genesis/utils/color/color.hpp"
 
#include <cassert>
#include <iosfwd>
#include <map>
#include <stdexcept>
#include <string>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Svg Gradient Stop
// =================================================================================================
 
struct SvgGradientStop
{
public:
 
    // -------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------
 
    using self_type = SvgGradientStop;
 
    // -------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------
 
    SvgGradientStop(
        double       offset,
        Color const& stop_color = Color()
    )
        : offset( offset )
        , stop_color( stop_color )
    {
        validate();
    }
 
    ~SvgGradientStop() = default;
 
    SvgGradientStop( SvgGradientStop const& ) = default;
    SvgGradientStop( SvgGradientStop&& )      = default;
 
    SvgGradientStop& operator= ( SvgGradientStop const& ) = default;
    SvgGradientStop& operator= ( SvgGradientStop&& )      = default;
 
    // -------------------------------------------------------------
    //     Drawing Function
    // -------------------------------------------------------------
 
    bool operator< ( self_type const& rhs ) const;
 
    void validate() const;
    void write( std::ostream& out ) const;
 
    // -------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------
 
    double offset;
    Color  stop_color;
 
};
 
struct SvgGradientLinear
{
public:
 
    // -------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------
 
    using self_type = SvgGradientLinear;
 
    enum class SpreadMethod
    {
        kPad,
        kRepeat,
        kReflect
    };
 
    // -------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------
 
    SvgGradientLinear() = default;
 
    SvgGradientLinear(
        std::string const& id,
        SvgPoint point_1 = SvgPoint( 0.0, 0.0 ),
        SvgPoint point_2 = SvgPoint( 1.0, 0.0 )
    )
        : id( id )
        , point_1( point_1 )
        , point_2( point_2 )
    {}
 
    ~SvgGradientLinear() = default;
 
    SvgGradientLinear( SvgGradientLinear const& ) = default;
    SvgGradientLinear( SvgGradientLinear&& )      = default;
 
    SvgGradientLinear& operator= ( SvgGradientLinear const& ) = default;
    SvgGradientLinear& operator= ( SvgGradientLinear&& )      = default;
 
    // -------------------------------------------------------------
    //     Drawing Function
    // -------------------------------------------------------------
 
    void validate() const;
    void write( std::ostream& out, size_t indent = 0 ) const;
 
    SvgGradientLinear& set_stops( std::map<double, Color> const& ranges );
    SvgGradientLinear& add_stop( SvgGradientStop const& stop );
 
    bool empty() const;
 
    // -------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------
 
    std::string id;
 
    SvgPoint  point_1;
    SvgPoint  point_2;
 
    SpreadMethod spread_method = SpreadMethod::kPad;
 
    std::vector< SvgGradientStop > stops;
    SvgTransform                   transform;
 
};
 
} // namespace utils
} // namespace genesis
 
#endif // include guard