display parameter help messages in gui

geoflow3d · May 25, 2020 · 86c0ed0 · 86c0ed0
1 parent 03cbac6
commit 86c0ed0
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/src/geoflow/gui/parameter_widgets.cpp b/src/geoflow/gui/parameter_widgets.cpp
@@ -18,6 +18,18 @@ namespace geoflow {
         ImGui::Checkbox(valptr->get_label().c_str(), &valptr->get());
     }
   };
+  static void HelpMarker(const char* desc)
+  {
+    ImGui::TextDisabled("(?)");
+    if (ImGui::IsItemHovered())
+    {
+        ImGui::BeginTooltip();
+        ImGui::PushTextWrapPos(ImGui::GetFontSize() * 35.0f);
+        ImGui::TextUnformatted(desc);
+        ImGui::PopTextWrapPos();
+        ImGui::EndTooltip();
+    }
+  }
 
   bool draw_parameter(Parameter* param) {
     bool changed=false;
@@ -95,6 +107,8 @@ namespace geoflow {
     } else {
       ImGui::Text("%s", param->get_label().c_str());
     }
+    ImGui::SameLine();
+    HelpMarker(param->get_help().c_str());
     return changed;
   };
 

diff --git a/src/geoflow/parameters.cpp b/src/geoflow/parameters.cpp
@@ -29,6 +29,9 @@ namespace geoflow {
   std::string Parameter::get_label() {
     return label_;
   }
+  const std::string& Parameter::get_help() const {
+    return help_;
+  }
   bool Parameter::is_type(std::type_index type) {
     return type_ == type;
   }

diff --git a/src/geoflow/parameters.hpp b/src/geoflow/parameters.hpp
@@ -48,6 +48,7 @@ namespace geoflow {
     public:
     Parameter(std::string label, std::string help, std::type_index ttype=typeid(void));
     std::string get_label();
+    const std::string& get_help() const;
     virtual json as_json() const = 0;
     virtual void from_json(const json& json_object) = 0;
     // virtual void to_string(std::string& str) const = 0;