simulation_map_parameter.h

[詳解]

 
 
// Copyright(c) 2023-2025 Design Engineering Laboratory, Saitama University
// Released under the MIT license
// https://opensource.org/licenses/mit-license.php
 
#ifndef DESIGNLAB_SIMULATION_MAP_PARAMETER_H_
#define DESIGNLAB_SIMULATION_MAP_PARAMETER_H_
 
#include <vector>
 
#include "cassert_define.h"
#include "string_util.h"
#include "toml_serialize_macro.h"
 
 
namespace designlab::enums
{
 
enum class SimulationMapMode : int
{
    kFlat = 0,  
    kVerticalStripe,  
    kHorizontalStripe,  
    kDiagonalStripe,  
    kMesh,  
    kLatticePoint,  
    kCircle,  
    kDonut,  
};
 
enum class SimulationMapOption : unsigned int
{
    // 1 <<  x は 2^x を表す．
 
    kNone = 0,              
    kPerforated = 1 << 0,   
    kStep = 1 << 1,         
    kSlope = 1 << 2,        
    kTilt = 1 << 3,         
    kRough = 1 << 4,        
    kRadiation = 1 << 5,    
};
 
}  // namespace designlab::enums
 
 
namespace designlab
{
 
struct SimulationMapParameter final
{
public:
    constexpr SimulationMapParameter() :
        mode(enums::SimulationMapMode::kFlat),
        option(static_cast<unsigned int>(enums::SimulationMapOption::kNone))
    {
    }
 
    constexpr void SetMode(const enums::SimulationMapMode create_mode)
    {
        mode = create_mode;
    }
 
    void SetOption(const std::vector<enums::SimulationMapOption> create_options)
    {
        assert(!create_options.empty());
 
        for (const auto& i : create_options)
        {
            option |= static_cast<unsigned int>(i);
        }
    }
 
    constexpr void SetMapSize(const float max_x, const float min_x, const float max_y,
                  const float min_y, const float start_rough_x, const float map_base_z)
    {
        assert(min_x < max_x);
        assert(min_y < max_y);
        assert(min_x < start_rough_x);
        assert(start_rough_x < max_x);
 
        map_max_x = max_x;
        map_min_x = min_x;
        map_max_y = max_y;
        map_min_y = min_y;
        map_start_rough_x = start_rough_x;
        base_z = map_base_z;
    }
 
    constexpr void SetStripeInterval(const int interval)
    {
        assert(0 < interval);
 
        stripe_interval = interval;
    }
 
    constexpr void SetHoleRate(const int rate)
    {
        assert(0 <= rate);
        assert(rate <= 100);
 
        hole_rate = rate;
    }
 
    constexpr void SetStepValue(const float height, const float length)
    {
        assert(0 < length);
 
        step_height = height;
        step_length = length;
    }
 
    constexpr void SetTiltAngle(const float angle)
    {
        tilt_angle = angle;
    }
 
    constexpr void SetSlopeAngle(const float angle)
    {
        slope_angle = angle;
    }
 
    constexpr void SetRouthHeight(const float height_min, const float height_max)
    {
        assert(height_min < height_max);
 
        rough_min_height = height_min;
        rough_max_height = height_max;
    }
 
    enums::SimulationMapMode mode{ enums::SimulationMapMode::kFlat };
    unsigned int option{ 0 };  
 
    float base_z{ 0.0f };               
    float map_max_x{ 2600.f };          
    float map_min_x{ -400.f };          
    float map_max_y{ 2000.f };          
    float map_min_y{ -2000.f };         
    float map_start_rough_x{ 400.f };   
 
    int stripe_interval{ 5 };
 
    int hole_rate{ 20 };                
    float step_height{ 100.f };         
    float step_length{ 600.f };         
    float slope_angle{ 10.f };          
    float tilt_angle{ 5.f };            
    float rough_max_height{ 30.f };     
    float rough_min_height{ -30.f };    
 
    Vector3 circle_center{ 0.f, 0.f, 0.f };  
    float circle_radius{ 1000.f };           
    float donut_radius{ 200.f };             
 
    Vector2 radial_center{ 0.f, 0.f };  
    int radial_division{ 10 };  
    int radial_hole_rate{ 100 };  
    float radial_angle_offset{ 0.0 };  
};
 
 
DESIGNLAB_TOML11_DESCRIPTION_CLASS(SimulationMapParameter)
{
    DESIGNLAB_TOML11_FILE_NO_DESCRIPTION();
 
    DESIGNLAB_TOML11_TABLE_NO_DESCRIPTION();
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(mode,
        DESIGNLAB_TOML11_NO_TABLE,
        "生成するマップの種類．(\"" +
        string_util::EnumValuesToString<enums::SimulationMapMode>("\" / \"") +
        "\")");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(option,
        DESIGNLAB_TOML11_NO_TABLE,
        "マップ生成のオプション．複数指定したいならば足し合わせて指定すること．( " +
        string_util::EnumEntriesToString<enums::SimulationMapOption>(" / ") +
        " )");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(base_z, "Basic", "マップの基準となるZ座標．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(map_max_x, "Basic", "マップのX座標の最大値．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(map_min_x, "Basic", "マップのX座標の最小値．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(map_max_y, "Basic", "マップのY座標の最大値．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(map_min_y, "Basic", "マップのY座標の最小値．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(map_start_rough_x, "Basic", "不整地が始まるX座標．");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(stripe_interval, "Stripe",
        "各種模様や穴を作成する際，これで指定したマス分(1マス20[mm])の1辺を持つ"
        "正方形状にあなをあける．0より大きくすること．");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(hole_rate, "Perforated", "不整地上の足場を除外する割合．ホール率[%]．0～100の間にすること．");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(step_height, "Step", "段差高さ[mm]．負の値にすると下りの階段になる．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(step_length, "Step", "階段の奥行[mm]．正の値にすること．");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(slope_angle, "Slope", "斜面の傾斜角[deg]．");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(tilt_angle, "Tilt", "地形を傾ける角度[deg]．");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(rough_max_height, "Rough", "デコボコな地形の最大高さ[mm]．最小値より大きい値にすること．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(rough_min_height, "Rough", "デコボコな地形の最小高さ[mm]");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(circle_center, "Circle", "円 / ドーナツの中心座標．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(circle_radius, "Circle", "円 / ドーナツの半径．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(donut_radius, "Circle", "ドーナツの内側の半径．");
 
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(radial_center, "Radial", "放射状の地形の中心座標．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(radial_division, "Radial", "放射状の地形の分割数．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(radial_hole_rate, "Radial", "放射状の地形のホール率[%]．");
    DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(radial_angle_offset, "Radial", "放射状の地形の角度オフセット[deg]．");
};
 
}  // namespace designlab
 
 
DESIGNLAB_TOML11_SERIALIZE(
    designlab::SimulationMapParameter,
    mode, option,
    base_z, map_max_x, map_min_x, map_max_y, map_min_y, map_start_rough_x,
    stripe_interval,
    hole_rate, step_height, step_length, slope_angle, tilt_angle, rough_max_height, rough_min_height,
    circle_center, circle_radius, donut_radius,
    radial_center, radial_division, radial_hole_rate, radial_angle_offset);
 
 
#endif  // DESIGNLAB_SIMULATION_MAP_PARAMETER_H_