LayoutSpecs.hpp

// sciplot - a modern C++ scientific plotting library powered by gnuplot
// https://github.com/sciplot/sciplot
//
// Licensed under the MIT License <http://opensource.org/licenses/MIT>.
//
// Copyright (c) 2018-2022 Allan Leal, Bim Overbohm
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
// sciplot includes
#include <sciplot/specs/Specs.hpp>
 
namespace sciplot
{
 
template <typename DerivedSpecs>
class LayoutSpecsOf : virtual public Specs<DerivedSpecs>
{
  public:
    auto origin(double x, double y) -> DerivedSpecs&;
 
    auto size(double sx, double sy) -> DerivedSpecs&;
 
    auto marginsAbsolute(double left = -1, double right = -1, double top = -1, double bottom = -1) -> DerivedSpecs&;
 
    // auto marginsRelative(double left = -1, double right = -1, double top = -1, double bottom = -1) -> DerivedSpecs&;
 
    auto repr() const -> std::string;
 
  private:
    double m_originX = 0.0;
    double m_originY = 0.0;
    bool m_originSet = false;
 
    double m_sizeX = 0;
    double m_sizeY = 0;
    bool m_sizeSet = false;
 
    double m_marginsLeft = 0.0;
    double m_marginsRight = 0.0;
    double m_marginsTop = 0.0;
    double m_marginsBottom = 0.0;
    double m_marginsAbsolute = false;
    bool m_marginsSet = false;
};
 
class LayoutSpecs : public LayoutSpecsOf<LayoutSpecs>
{
};
 
template <typename DerivedSpecs>
auto LayoutSpecsOf<DerivedSpecs>::origin(double x, double y) -> DerivedSpecs&
{
    m_originX = x;
    m_originY = y;
    m_originSet = true;
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto LayoutSpecsOf<DerivedSpecs>::size(double sx, double sy) -> DerivedSpecs&
{
    m_sizeX = sx;
    m_sizeY = sy;
    m_sizeSet = true;
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto LayoutSpecsOf<DerivedSpecs>::marginsAbsolute(double left, double right, double top, double bottom) -> DerivedSpecs&
{
    m_marginsLeft = left;
    m_marginsRight = right;
    m_marginsTop = top;
    m_marginsBottom = bottom;
    m_marginsAbsolute = true;
    m_marginsSet = true;
    return static_cast<DerivedSpecs&>(*this);
}
 
/*
// This does not seem to work for me with gnuplot 5.4 patchlevel 2
template <typename DerivedSpecs>
auto LayoutSpecsOf<DerivedSpecs>::marginsRelative(double left, double right, double top, double bottom) -> DerivedSpecs&
{
    m_marginsLeft = left;
    m_marginsRight = right;
    m_marginsTop = top;
    m_marginsBottom = bottom;
    m_marginsAbsolute = false;
    m_marginsSet = true;
    return static_cast<DerivedSpecs&>(*this);
}*/
 
template <typename DerivedSpecs>
auto LayoutSpecsOf<DerivedSpecs>::repr() const -> std::string
{
    std::stringstream script;
    if (m_originSet)
    {
        script << "set origin " << m_originX << "," << m_originY << std::endl;
    }
    if (m_sizeSet)
    {
        script << "set size " << m_sizeX << "," << m_sizeY << std::endl;
    }
    if (m_marginsSet)
    {
        script << "set lmargin " << (m_marginsAbsolute ? "" : "at screen ") << m_marginsLeft << std::endl;
        script << "set rmargin " << (m_marginsAbsolute ? "" : "at screen ") << m_marginsRight << std::endl;
        script << "set tmargin " << (m_marginsAbsolute ? "" : "at screen ") << m_marginsTop << std::endl;
        script << "set bmargin " << (m_marginsAbsolute ? "" : "at screen ") << m_marginsBottom << std::endl;
    }
    return script.str();
}
 
} // namespace sciplot