GridSpecs.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/specs/GridSpecsBase.hpp>
#include <sciplot/Utils.hpp>
 
namespace sciplot {
 
class GridSpecs : public GridSpecsBase
{
  public:
    GridSpecs();
 
    auto xtics() -> GridSpecsBase& { return xticsMajorBottom(); }
 
    auto ytics() -> GridSpecsBase& { return yticsMajorLeft(); }
 
    auto ztics() -> GridSpecsBase& { return zticsMajor(); }
 
    auto rtics() -> GridSpecsBase& { return rticsMajor(); }
 
    auto xticsMajorBottom() -> GridSpecsBase& { return _gridmajor("xtics"); }
 
    auto xticsMajorTop() -> GridSpecsBase& { return _gridmajor("x2tics"); }
 
    auto xticsMinorBottom() -> GridSpecsBase& { return _gridminor("mxtics"); }
 
    auto xticsMinorTop() -> GridSpecsBase& { return _gridminor("mx2tics"); }
 
    auto yticsMajorLeft() -> GridSpecsBase& { return _gridmajor("ytics"); }
 
    auto yticsMajorRight() -> GridSpecsBase& { return _gridmajor("y2tics"); }
 
    auto yticsMinorLeft() -> GridSpecsBase& { return _gridminor("mytics"); }
 
    auto yticsMinorRight() -> GridSpecsBase& { return _gridminor("my2tics"); }
 
    auto zticsMajor() -> GridSpecsBase& { return _gridmajor("ztics"); }
 
    auto zticsMinor() -> GridSpecsBase& { return _gridminor("mztics"); }
 
    auto rticsMajor() -> GridSpecsBase& { return _gridmajor("rtics"); }
 
    auto rticsMinor() -> GridSpecsBase& { return _gridminor("mrtics"); }
 
    auto repr() const -> std::string;
 
  private:
    auto _gridmajor(std::string tics) -> GridSpecsBase&
    {
        m_gridticsspecs.emplace_back(tics, true);
        return m_gridticsspecs.back();
    }
 
    auto _gridminor(std::string tics) -> GridSpecsBase&
    {
        m_gridticsspecs.emplace_back(tics, false);
        return m_gridticsspecs.back();
    }
 
  private:
    std::vector<GridSpecsBase> m_gridticsspecs;
};
 
inline GridSpecs::GridSpecs()
: GridSpecsBase("", true)
{
    show(false);
    back();
}
 
inline auto GridSpecs::repr() const -> std::string
{
    std::stringstream ss;
    ss << GridSpecsBase::repr();
    for (auto specs : m_gridticsspecs)
        ss << '\n'
           << specs.repr();
    return ss.str();
}
 
} // namespace sciplot