Template.h

#pragma once
#include "Engine/Core/Types.h"
#include "Engine/Parameter/Default.h"
#include "Engine/Parameter/PrmName.h"
#include "Engine/Parameter/Range.h"
#include <any>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <utility>
#include <vector>
 
namespace enzo::prm {
 
class Template
{
  public:
    Template(enzo::prm::Type type, prm::Name name);
    Template(enzo::prm::Type type, prm::Name name, unsigned int vectorSize);
    Template(
        enzo::prm::Type type,
        prm::Name name,
        std::vector<prm::Default> defaults,
        unsigned int vectorSize = 1,
        std::vector<prm::Range> ranges = std::vector<prm::Range>()
    );
    Template(
        enzo::prm::Type type,
        prm::Name name,
        prm::Default theDefault,
        unsigned int vectorSize = 1,
        Range range = Range()
    );
    // get name and get token are identical
    enzo::String getName() const;
    enzo::String getToken() const;
    enzo::String getLabel() const;
    const prm::Default getDefault(unsigned int index = 0) const;
    const prm::Range& getRange(unsigned int index = 0) const;
    const std::vector<prm::Name>& getOptions() const;
    bool hasOptions() const;
 
    intT getNumOptions() const;
 
    const prm::Type getType() const;
    const unsigned int getSize() const;
    const unsigned int getNumDefaults() const;
 
    Direction getDirection() const;
    const std::vector<Template>& getChildren() const;
 
    const Template& getChild(const enzo::String& token) const;
 
    const bool isContainer() const;
    bool isMultiParm() const;
 
    enzo::String getTooltip() const;
    enzo::String getDocumentation() const;
    enzo::String getDisableCondition() const;
    enzo::String getHideCondition() const;
    bool isLabelHidden() const;
    bool isBackgroundEnabled() const;
 
    // Chainable setters. Mutate in place and return *this so a Template can
    // be configured inline at construction.
    Template& setTooltip(String tooltip);
    Template& setDocumentation(String documentation);
    Template& setDisableCondition(String condition);
    Template& setHideCondition(String condition);
    Template& setDirection(Direction direction);
    Template& setOptions(std::vector<prm::Name> options);
    Template& addParm(Template child);
    // Supplies the per instance default for a multiparm field, one Default per
    // instance. Entries past the live count are ignored, missing ones fall back
    // to the field's own default.
    Template& setInstanceDefault(std::string fieldToken, std::vector<Default> defaults);
    std::optional<Default>
    getInstanceDefault(const std::string& fieldToken, unsigned int instanceIndex) const;
    Template& setLabelHidden(bool hidden);
    Template& setBackgroundEnabled(bool enabled);
 
    // Style structs may hold parameters with change signals, which cannot
    // be copied. Wrapping in a shared pointer lets the style live inside
    // the std::any without ever being copied.
    template <typename T> Template& setStyle(T style)
    {
        style_ = std::make_shared<T>(std::move(style));
        return *this;
    }
 
    const std::any& getStyle() const;
 
  private:
    enzo::prm::Type type_;
    std::vector<prm::Default> defaults_;
    std::vector<prm::Range> ranges_;
    std::vector<prm::Name> options_;
    prm::Name name_;
    unsigned int vectorSize_;
 
    String tooltip_;
    String documentation_;
    String disableCondition_;
    String hideCondition_;
 
    bool labelHidden_ = false;
    bool backgroundEnabled_ = true;
 
    Direction direction_ = Direction::HORIZONTAL;
    std::vector<Template> children_;
    std::unordered_map<std::string, std::vector<Default>> instanceDefaults_;
    std::any style_;
    inline const static std::unordered_set<prm::Type> containerTypes_ = {prm::Type::GROUP};
    // Types whose children are the per instance template duplicated by the
    // parameter count.
    inline const static std::unordered_set<prm::Type> multiParmTypes_ = {prm::Type::RAMP};
    inline const static std::unordered_set<prm::Type> backgroundDisabledByDefault_ =
        {prm::Type::GROUP, prm::Type::XYZ, prm::Type::SPACER};
    // Types that render without a label, such as blank spacers.
    inline const static std::unordered_set<prm::Type> labelHiddenByDefault_ = {prm::Type::SPACER};
};
 
} // namespace enzo::prm