Merge pull request #979 from mcneel/1.16

'Allows Parameters' should not be Primary.
mcneel · Jul 31, 2023 · 6ffad1e · 6ffad1e
2 parents 4b2d59e + a08070a
commit 6ffad1e
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 8 deletions.
diff --git a/src/RhinoInside.Revit.GH/Components/ObjectStyles/CategoryIdentity.cs b/src/RhinoInside.Revit.GH/Components/ObjectStyles/CategoryIdentity.cs
@@ -31,12 +31,12 @@ public CategoryIdentity() : base
       ParamDefinition.Create<Parameters.Param_Enum<Types.CategoryType>>("Type", "T", "Category type", relevance: ParamRelevance.Primary),
       ParamDefinition.Create<Parameters.Category>("Parent", "P", "Parent category", relevance: ParamRelevance.Occasional),
       ParamDefinition.Create<Param_String>("Name", "N", "Category name"),
-      ParamDefinition.Create<Param_Boolean>("Is Visible UI", "VUI", "Category is exposed in UI", relevance: ParamRelevance.Secondary),
+      ParamDefinition.Create<Param_Boolean>("Is Visible UI", "VUI", "Category is exposed in UI", relevance: ParamRelevance.Primary),
       ParamDefinition.Create<Param_Boolean>("Is Subcategory", "ISC", "Is subcategory"),
-      ParamDefinition.Create<Param_Boolean>("Allows Subcategories", "ASC", "Category allows subcategories to be added", relevance: ParamRelevance.Secondary),
-      ParamDefinition.Create<Param_Boolean>("Allows Parameters", "AP", "Category allows bound parameters", relevance: ParamRelevance.Primary),
+      ParamDefinition.Create<Param_Boolean>("Allows Subcategories", "ASC", "Category allows subcategories to be added", relevance: ParamRelevance.Tertiary),
+      ParamDefinition.Create<Param_Boolean>("Allows Parameters", "AP", "Category allows bound parameters", relevance: ParamRelevance.Secondary),
       ParamDefinition.Create<Param_Boolean>("Has Material Quantities", "HMQ", "Category has material quantities", relevance: ParamRelevance.Secondary),
-      ParamDefinition.Create<Param_Boolean>("Cuttable", "C", "Category is cuttable", relevance: ParamRelevance.Secondary),
+      ParamDefinition.Create<Param_Boolean>("Cuttable", "C", "Category is cuttable", relevance: ParamRelevance.Tertiary),
     };
 
     protected override void TrySolveInstance(IGH_DataAccess DA)

diff --git a/src/RhinoInside.Revit.GH/Components/ObjectStyles/QueryCategories.cs b/src/RhinoInside.Revit.GH/Components/ObjectStyles/QueryCategories.cs
@@ -58,12 +58,12 @@ public QueryCategories() : base
       ParamDefinition.Create<Parameters.Param_Enum<Types.CategoryType>>("Type", "T", "Category type", ARDB.CategoryType.Model, optional: true, relevance: ParamRelevance.Primary),
       ParamDefinition.Create<Parameters.Category>("Parent", "P", "Parent category", optional: true, relevance: ParamRelevance.Occasional),
       ParamDefinition.Create<Param_String>("Name", "N", "Category name", optional: true),
-      ParamDefinition.Create<Param_Boolean>("Is Visible UI", "VUI", "Category is exposed in UI", defaultValue: true, optional: true, relevance: ParamRelevance.Secondary),
+      ParamDefinition.Create<Param_Boolean>("Is Visible UI", "VUI", "Category is exposed in UI", defaultValue: true, optional: true, relevance: ParamRelevance.Primary),
       ParamDefinition.Create<Param_Boolean>("Is Subcategory", "ISC", "Is subcategory", defaultValue: false, optional: true),
-      ParamDefinition.Create<Param_Boolean>("Allows Subcategories", "ASC", "Category allows subcategories to be added", optional: true, relevance: ParamRelevance.Secondary),
-      ParamDefinition.Create<Param_Boolean>("Allows Parameters", "AP", "Category allows bound parameters", defaultValue: true, optional: true, relevance: ParamRelevance.Primary),
+      ParamDefinition.Create<Param_Boolean>("Allows Subcategories", "ASC", "Category allows subcategories to be added", optional: true, relevance: ParamRelevance.Tertiary),
+      ParamDefinition.Create<Param_Boolean>("Allows Parameters", "AP", "Category allows bound parameters", defaultValue: true, optional: true, relevance: ParamRelevance.Secondary),
       ParamDefinition.Create<Param_Boolean>("Has Material Quantities", "HMQ", "Category has material quantities", defaultValue: true, optional: true, relevance: ParamRelevance.Secondary),
-      ParamDefinition.Create<Param_Boolean>("Cuttable", "C", "Category is cuttable", defaultValue: true, optional: true, relevance: ParamRelevance.Secondary),
+      ParamDefinition.Create<Param_Boolean>("Cuttable", "C", "Category is cuttable", defaultValue: true, optional: true, relevance: ParamRelevance.Tertiary),
     };
 
     protected override ParamDefinition[] Outputs => outputs;

diff --git a/src/RhinoInside.Revit.GH/Components/ZuiComponent.cs b/src/RhinoInside.Revit.GH/Components/ZuiComponent.cs
@@ -7,6 +7,7 @@
 using Grasshopper;
 using Grasshopper.GUI;
 using Grasshopper.GUI.Canvas;
+using Grasshopper.GUI.HTML;
 using Grasshopper.Kernel;
 using Grasshopper.Kernel.Attributes;
 using Grasshopper.Kernel.Parameters;
@@ -642,6 +643,46 @@ void Menu_HideUnconnectedParameters(object sender, EventArgs e)
     }
     #endregion
 
+    #region Help
+    protected override string HtmlHelp_Source()
+    {
+      string text = HelpDescription + "<BR><BR><HR>" + Environment.NewLine;
+      text += GenerateParameterHelp();
+
+      var formatter = new GH_HtmlFormatter(this, Name, text);
+      formatter.AddRemark($"This component is a ZUI component. Zoom in on it to enable the parameters managment UI visible.");
+
+      return formatter.HtmlFormat();
+    }
+
+    protected new string GenerateParameterHelp()
+    {
+      string text = string.Empty;
+      if (Inputs.Length > 0)
+      {
+        text += $"Input parameters: <BR>{Environment.NewLine}<dl>{Environment.NewLine}";
+        foreach (var item in Inputs) text += GenerateParameterHelp(item.Param);
+        text += $"</dl> <BR>{Environment.NewLine}";
+      }
+
+      if (Outputs.Length > 0)
+      {
+        text += $"Output parameters: <BR>{Environment.NewLine}<dl>{Environment.NewLine}";
+        foreach (var item in Outputs) text += GenerateParameterHelp(item.Param);
+        text += $"</dl> <BR>{Environment.NewLine}";
+      }
+
+      return text;
+    }
+
+    private new string GenerateParameterHelp(IGH_Param param)
+    {
+      var description = $"<dt><b> {param.Name} </b><i> ({param.TypeName})</i></dt>{Environment.NewLine}";
+      description += $"<dd> {param.Description} </dd>{Environment.NewLine}";
+      return description;
+    }
+    #endregion
+
     #region IO
     protected static ParamDefinition FindDefinition(ParamDefinition[] list, string name)
     {