ParamSchema.h

浏览该文件的文档.

#pragma once
 
#include "procgen/Params.h"
 
#include <string>
#include <vector>
 
namespace eve::procgen {
 
enum class ParamKind { Integer, Float, Boolean, String, Choice };
 
struct EVENGINE_API_DOMAINS ParamDescriptor {
    std::string              key;
    std::string              displayName;
    std::string              description;
    std::string              category = "General";
    ParamKind                kind     = ParamKind::String;
    std::string              defaultValue;
    bool                     hasMinimum = false;
    bool                     hasMaximum = false;
    double                   minimum    = 0.0;
    double                   maximum    = 0.0;
    double                   step       = 0.0;
    std::vector<std::string> choices;
    bool                     advanced = false;
 
    static ParamDescriptor integer(std::string key, std::string label, int defaultValue, int minimum, int maximum,
                                   int step = 1);
    static ParamDescriptor floating(std::string key, std::string label, float defaultValue, float minimum,
                                    float maximum, float step);
    static ParamDescriptor boolean(std::string key, std::string label, bool defaultValue);
    static ParamDescriptor text(std::string key, std::string label, std::string defaultValue);
    static ParamDescriptor choice(std::string key, std::string label, std::string defaultValue,
                                  std::vector<std::string> choices);
};
 
struct EVENGINE_API_DOMAINS RecipeDescriptor {
    std::string                  id;
    std::string                  displayName;
    std::string                  category;
    std::vector<ParamDescriptor> params;
 
    static RecipeDescriptor grid(std::string id, std::string displayName, std::string category, int minimumWidth,
                                 int minimumHeight, int maximumWidth = 4096, int maximumHeight = 4096);
    const ParamDescriptor* find(const std::string& key) const;
    void applyDefaults(Params& params) const;
 
    int getParamCount() const { return int(params.size()); }
    std::string getId() const { return id; }
    std::string getDisplayName() const { return displayName; }
    std::string getCategory() const { return category; }
    std::string getParamKey(int index) const;
    std::string getParamLabel(int index) const;
    std::string getParamDescription(int index) const;
    std::string getParamCategory(int index) const;
    std::string getParamKind(int index) const;
    std::string getParamDefault(int index) const;
    bool paramHasMinimum(int index) const;
    bool paramHasMaximum(int index) const;
    float getParamMinimum(int index) const;
    float getParamMaximum(int index) const;
    float getParamStep(int index) const;
    bool isParamAdvanced(int index) const;
    int getParamChoiceCount(int index) const;
    std::string getParamChoice(int paramIndex, int choiceIndex) const;
 
private:
    const ParamDescriptor* at(int index) const;
};
 
}  // namespace eve::procgen