TicsSpecsBaseOf.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-2021 Allan Leal
//
// 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/Default.hpp>
#include <sciplot/Utils.hpp>
#include <sciplot/specs/OffsetSpecsOf.hpp>
#include <sciplot/specs/ShowSpecsOf.hpp>
#include <sciplot/specs/TextSpecsOf.hpp>
 
namespace sciplot
{
 
template <typename DerivedSpecs>
class TicsSpecsBaseOf : public TextSpecsOf<DerivedSpecs>, public OffsetSpecsOf<DerivedSpecs>, public ShowSpecsOf<DerivedSpecs>
{
  public:
    TicsSpecsBaseOf();
 
    auto alongAxis() -> DerivedSpecs&;
 
    auto alongBorder() -> DerivedSpecs&;
 
    auto mirror(bool value = true) -> DerivedSpecs&;
 
    auto insideGraph() -> DerivedSpecs&;
 
    auto outsideGraph() -> DerivedSpecs&;
 
    auto rotate(bool value = true) -> DerivedSpecs&;
 
    auto rotateBy(double degrees) -> DerivedSpecs&;
 
    auto scaleBy(double value) -> DerivedSpecs&;
 
    auto scaleMajorBy(double value) -> DerivedSpecs&;
 
    auto scaleMinorBy(double value) -> DerivedSpecs&;
 
    auto format(std::string fmt) -> DerivedSpecs&;
 
    auto logscale(int base = 10) -> DerivedSpecs&;
 
    auto repr() const -> std::string;
 
    auto repr(std::string axis) const -> std::string;
 
  private:
    std::string m_along;
 
    std::string m_mirror;
 
    std::string m_rotate;
 
    std::string m_inout;
 
    std::string m_format;
 
    double m_scalemajor = 1.0;
 
    double m_scaleminor = 1.0;
 
    std::string m_logscaleBase;
};
 
template <typename DerivedSpecs>
TicsSpecsBaseOf<DerivedSpecs>::TicsSpecsBaseOf()
{
    alongBorder();
    mirror(internal::DEFAULT_TICS_MIRROR);
    outsideGraph();
    rotate(internal::DEFAULT_TICS_ROTATE);
    scaleMajorBy(internal::DEFAULT_TICS_SCALE_MAJOR_BY);
    scaleMinorBy(internal::DEFAULT_TICS_SCALE_MINOR_BY);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::alongAxis() -> DerivedSpecs&
{
    m_along = "axis";
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::alongBorder() -> DerivedSpecs&
{
    m_along = "border";
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::mirror(bool value) -> DerivedSpecs&
{
    m_mirror = value ? "mirror" : "nomirror";
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::rotate(bool value) -> DerivedSpecs&
{
    m_rotate = value ? "rotate" : "norotate";
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::rotateBy(double degrees) -> DerivedSpecs&
{
    m_rotate = "rotate by " + internal::str(degrees);
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::insideGraph() -> DerivedSpecs&
{
    m_inout = "in";
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::outsideGraph() -> DerivedSpecs&
{
    m_inout = "out";
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::scaleBy(double value) -> DerivedSpecs&
{
    return scaleMajorBy(value);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::scaleMajorBy(double value) -> DerivedSpecs&
{
    m_scalemajor = value;
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::scaleMinorBy(double value) -> DerivedSpecs&
{
    m_scaleminor = value;
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::format(std::string fmt) -> DerivedSpecs&
{
    m_format = "'" + fmt + "'";
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::logscale(int base) -> DerivedSpecs&
{
    m_logscaleBase = std::to_string(base);
    return static_cast<DerivedSpecs&>(*this);
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::repr() const -> std::string
{
    return repr("");
}
 
template <typename DerivedSpecs>
auto TicsSpecsBaseOf<DerivedSpecs>::repr(std::string axis) const -> std::string
{
    const auto show = ShowSpecsOf<DerivedSpecs>::repr();
    if (show == "no")
        return "unset " + axis + "tics";
 
    std::stringstream ss;
    if (!m_logscaleBase.empty())
    {
        ss << "set logscale " + axis + " " + m_logscaleBase + "\n";
    }
    ss << "set " + axis + "tics"
       << " ";
    ss << m_along << " ";
    ss << m_mirror << " ";
    ss << m_inout << " ";
    ss << "scale " << m_scalemajor << "," << m_scaleminor << " ";
    ss << m_rotate << " ";
    ss << OffsetSpecsOf<DerivedSpecs>::repr() << " ";
    ss << TextSpecsOf<DerivedSpecs>::repr() << " ";
    ss << m_format;
    return internal::removeExtraWhitespaces(ss.str());
}
 
} // namespace sciplot