plot_config.h

Go to the documentation of this file.

/*
 * Copyright 2026 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include <cstddef>
 
#include "func_sketch/plotter/rgb_color.h"
 
namespace func_sketch::plotter {
 
// TODO Tune these values

constexpr int default_left_margin = 60;

constexpr int default_right_margin = 60;

constexpr int default_top_margin = 50;

constexpr int default_bottom_margin = 50;

constexpr int default_tick_label_font_size = 11;

constexpr int default_axes_line_width = 1;

constexpr int default_grid_line_width = 1;

constexpr int default_zero_line_width = 2;

constexpr int default_curve_line_width = 1;

constexpr auto default_background_color =
    RGBColor{.r = 255, .g = 255, .b = 255};

constexpr auto default_axes_color = RGBColor{.r = 0x24, .g = 0x24, .b = 0x24};

constexpr auto default_grid_color = RGBColor{.r = 0xC8, .g = 0xC8, .b = 0xC8};

constexpr std::size_t default_initial_num_sample_points = 110;

constexpr std::size_t default_max_num_sample_points = 2000;

constexpr std::size_t max_max_num_sample_points = 10000;

constexpr double default_max_coordinate_change_rate = 0.01;

constexpr double default_slope_change_threshold = 0.1;

constexpr double default_min_param_change_rate = 0.001;

constexpr double min_min_param_change_rate = 1e-4;

constexpr std::size_t default_num_pixels_per_tick_in_x_axis = 120;

constexpr std::size_t default_num_pixels_per_tick_in_y_axis = 100;

class PlotConfig {
public:
    PlotConfig() = default;

    PlotConfig& left_margin(int value);

    PlotConfig& right_margin(int value);

    PlotConfig& top_margin(int value);

    PlotConfig& bottom_margin(int value);

    PlotConfig& tick_label_font_size(int value);

    PlotConfig& axes_line_width(int value);

    PlotConfig& grid_line_width(int value);

    PlotConfig& zero_line_width(int value);

    PlotConfig& curve_line_width(int value);

    PlotConfig& background_color(const RGBColor& value);

    PlotConfig& axes_color(const RGBColor& value);

    PlotConfig& grid_color(const RGBColor& value);

    PlotConfig& initial_num_sample_points(std::size_t value);

    PlotConfig& max_num_sample_points(std::size_t value);

    PlotConfig& max_coordinate_change_rate(double value);

    PlotConfig& slope_change_threshold(double value);

    PlotConfig& min_param_change_rate(double value);

    PlotConfig& num_pixels_per_tick_in_x_axis(std::size_t value);

    PlotConfig& num_pixels_per_tick_in_y_axis(std::size_t value);

    [[nodiscard]] int left_margin() const noexcept;

    [[nodiscard]] int right_margin() const noexcept;

    [[nodiscard]] int top_margin() const noexcept;

    [[nodiscard]] int bottom_margin() const noexcept;

    [[nodiscard]] int tick_label_font_size() const noexcept;

    [[nodiscard]] int axes_line_width() const noexcept;

    [[nodiscard]] int grid_line_width() const noexcept;

    [[nodiscard]] int zero_line_width() const noexcept;

    [[nodiscard]] int curve_line_width() const noexcept;

    [[nodiscard]] const RGBColor& background_color() const noexcept;

    [[nodiscard]] const RGBColor& axes_color() const noexcept;

    [[nodiscard]] const RGBColor& grid_color() const noexcept;

    [[nodiscard]] std::size_t initial_num_sample_points() const noexcept;

    [[nodiscard]] std::size_t max_num_sample_points() const noexcept;

    [[nodiscard]] double max_coordinate_change_rate() const noexcept;

    [[nodiscard]] double slope_change_threshold() const noexcept;

    [[nodiscard]] double min_param_change_rate() const noexcept;

    [[nodiscard]] std::size_t num_pixels_per_tick_in_x_axis() const noexcept;

    [[nodiscard]] std::size_t num_pixels_per_tick_in_y_axis() const noexcept;
 
private:
    int left_margin_{default_left_margin};

    int right_margin_{default_right_margin};

    int top_margin_{default_top_margin};

    int bottom_margin_{default_bottom_margin};

    int tick_label_font_size_{default_tick_label_font_size};

    int axes_line_width_{default_axes_line_width};

    int grid_line_width_{default_grid_line_width};

    int zero_line_width_{default_zero_line_width};

    int curve_line_width_{default_curve_line_width};

    RGBColor background_color_{default_background_color};

    RGBColor axes_color_{default_axes_color};

    RGBColor grid_color_{default_grid_color};

    std::size_t initial_num_sample_points_{default_initial_num_sample_points};

    std::size_t max_num_sample_points_{default_max_num_sample_points};

    double max_coordinate_change_rate_{default_max_coordinate_change_rate};

    double slope_change_threshold_{default_slope_change_threshold};

    double min_param_change_rate_{default_min_param_change_rate};

    std::size_t num_pixels_per_tick_in_x_axis_{
        default_num_pixels_per_tick_in_x_axis};

    std::size_t num_pixels_per_tick_in_y_axis_{
        default_num_pixels_per_tick_in_y_axis};
};
 
}  // namespace func_sketch::plotter