BorderSpecs.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
 
// C++ includes
#include <bitset>
#include <sciplot/Default.hpp>
#include <sciplot/specs/DepthSpecsOf.hpp>
#include <sciplot/specs/LineSpecsOf.hpp>
#include <sciplot/Utils.hpp>
 
// sciplot includes
 
namespace sciplot {
 
class BorderSpecs : public LineSpecsOf<BorderSpecs>, public DepthSpecsOf<BorderSpecs>
{
  public:
    BorderSpecs();
 
    auto clear() -> BorderSpecs&;
 
    auto none() -> BorderSpecs&;
 
    auto bottom() -> BorderSpecs&;
 
    auto left() -> BorderSpecs&;
 
    auto top() -> BorderSpecs&;
 
    auto right() -> BorderSpecs&;
 
    auto bottomLeftFront() -> BorderSpecs&;
 
    auto bottomLeftBack() -> BorderSpecs&;
 
    auto bottomRightFront() -> BorderSpecs&;
 
    auto bottomRightBack() -> BorderSpecs&;
 
    auto leftVertical() -> BorderSpecs&;
 
    auto backVertical() -> BorderSpecs&;
 
    auto rightVertical() -> BorderSpecs&;
 
    auto frontVertical() -> BorderSpecs&;
 
    auto topLeftBack() -> BorderSpecs&;
 
    auto topRightBack() -> BorderSpecs&;
 
    auto topLeftFront() -> BorderSpecs&;
 
    auto topRightFront() -> BorderSpecs&;
 
    auto polar() -> BorderSpecs&;
 
    auto repr() const -> std::string;
 
  private:
    std::bitset<13> m_encoding;
 
    std::string m_depth;
};
 
inline BorderSpecs::BorderSpecs()
{
    left();
    bottom();
    lineType(internal::DEFAULT_BORDER_LINETYPE);
    lineWidth(internal::DEFAULT_BORDER_LINEWIDTH);
    lineColor(internal::DEFAULT_BORDER_LINECOLOR);
    front();
}
 
inline auto BorderSpecs::clear() -> BorderSpecs&
{
    m_encoding.reset();
    return *this;
}
 
inline auto BorderSpecs::none() -> BorderSpecs&
{
    return clear();
}
 
inline auto BorderSpecs::bottom() -> BorderSpecs&
{
    m_encoding.set(0);
    return *this;
}
 
inline auto BorderSpecs::left() -> BorderSpecs&
{
    m_encoding.set(1);
    return *this;
}
 
inline auto BorderSpecs::top() -> BorderSpecs&
{
    m_encoding.set(2);
    return *this;
}
 
inline auto BorderSpecs::right() -> BorderSpecs&
{
    m_encoding.set(3);
    return *this;
}
 
inline auto BorderSpecs::bottomLeftFront() -> BorderSpecs&
{
    m_encoding.set(0);
    return *this;
}
 
inline auto BorderSpecs::bottomLeftBack() -> BorderSpecs&
{
    m_encoding.set(1);
    return *this;
}
 
inline auto BorderSpecs::bottomRightFront() -> BorderSpecs&
{
    m_encoding.set(2);
    return *this;
}
 
inline auto BorderSpecs::bottomRightBack() -> BorderSpecs&
{
    m_encoding.set(3);
    return *this;
}
 
inline auto BorderSpecs::leftVertical() -> BorderSpecs&
{
    m_encoding.set(4);
    return *this;
}
 
inline auto BorderSpecs::backVertical() -> BorderSpecs&
{
    m_encoding.set(5);
    return *this;
}
 
inline auto BorderSpecs::rightVertical() -> BorderSpecs&
{
    m_encoding.set(6);
    return *this;
}
 
inline auto BorderSpecs::frontVertical() -> BorderSpecs&
{
    m_encoding.set(7);
    return *this;
}
 
inline auto BorderSpecs::topLeftBack() -> BorderSpecs&
{
    m_encoding.set(8);
    return *this;
}
 
inline auto BorderSpecs::topRightBack() -> BorderSpecs&
{
    m_encoding.set(9);
    return *this;
}
 
inline auto BorderSpecs::topLeftFront() -> BorderSpecs&
{
    m_encoding.set(10);
    return *this;
}
 
inline auto BorderSpecs::topRightFront() -> BorderSpecs&
{
    m_encoding.set(11);
    return *this;
}
 
inline auto BorderSpecs::polar() -> BorderSpecs&
{
    m_encoding.set(2);
    return *this;
}
 
inline auto BorderSpecs::repr() const -> std::string
{
    std::stringstream ss;
    ss << "set border " << m_encoding.to_ulong() << " ";
    ss << DepthSpecsOf<BorderSpecs>::repr() << " ";
    ss << LineSpecsOf<BorderSpecs>::repr();
    return internal::removeExtraWhitespaces(ss.str());
}
 
} // namespace sciplot