From 925a3424d172e8cc10a0158c8f07cb108f37b18c Mon Sep 17 00:00:00 2001 From: Thomas Oberbichler Date: Thu, 1 Apr 2021 09:45:44 +0200 Subject: [PATCH] Add missing tooltips --- .../ConstructCurvatureFieldComponent.cs | 14 +++++++------- .../ConstructCurveOnSurfaceComponent.cs | 10 +++++----- .../CurvatureComponent.cs | 12 ++++++------ .../DeconstructCurveOnSurfaceComponent.cs | 10 +++++----- .../EvaluateComponent.cs | 14 +++++++------- .../CurveOnSurfaceComponents/ExtrudeComponent.cs | 10 +++++----- .../GeodesicCurvatureComponent.cs | 10 +++++----- .../GeodesicTorsionComponent.cs | 10 +++++----- .../IntegrateComponent.cs | 16 ++++++++-------- .../NormalCurvatureComponent.cs | 10 +++++----- .../ConstructGeodesicTorsionPath.cs | 10 +++++----- .../ConstructNormalCurvaturePath.cs | 10 +++++----- .../PathfinderComponents/ConstructPathfinder.cs | 16 ++++++++-------- 13 files changed, 76 insertions(+), 76 deletions(-) diff --git a/Bowerbird/Components/CurvatureComponents/ConstructCurvatureFieldComponent.cs b/Bowerbird/Components/CurvatureComponents/ConstructCurvatureFieldComponent.cs index fe7cc1d..a256d1a 100644 --- a/Bowerbird/Components/CurvatureComponents/ConstructCurvatureFieldComponent.cs +++ b/Bowerbird/Components/CurvatureComponents/ConstructCurvatureFieldComponent.cs @@ -13,23 +13,23 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class ConstructCurvatureFieldComponent : GH_Component { - public ConstructCurvatureFieldComponent() : base("BB Curvature Field", "Field", "Beta! Interface might change!", "Bowerbird", "Paths") + public ConstructCurvatureFieldComponent() : base("BB Curvature Field", "Field", "Show the direction field to a given path type. The field can be displayed in the geometry or parameter space (see context menu).", "Bowerbird", "Paths") { UpdateMessage(); } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new PathParameter(), "Path Type", "T", "", GH_ParamAccess.item); - pManager.AddBrepParameter("Surface", "S", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Distance", "D", "", GH_ParamAccess.item, 0.5); - pManager.AddNumberParameter("Scale", "s", "", GH_ParamAccess.item, 0.1); + pManager.AddParameter(new PathParameter(), "Path Type", "T", "Path type to be displayed as a vector field.", GH_ParamAccess.item); + pManager.AddBrepParameter("Surface", "S", "Surface or Brep for which the field is to be displayed.", GH_ParamAccess.item); + pManager.AddNumberParameter("Distance", "D", "Approximate distance between the evaluation points.", GH_ParamAccess.item, 0.5); + pManager.AddNumberParameter("Scale", "s", "Size of the cross axes.", GH_ParamAccess.item, 0.1); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddLineParameter("A", "A", "", GH_ParamAccess.list); - pManager.AddLineParameter("B", "B", "", GH_ParamAccess.list); + pManager.AddLineParameter("First Directions", "A", "List of the first directions.", GH_ParamAccess.list); + pManager.AddLineParameter("Second Directions", "B", "List of the second directions.", GH_ParamAccess.list); } public enum SpaceTypes diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/ConstructCurveOnSurfaceComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/ConstructCurveOnSurfaceComponent.cs index 81b4c75..e7770c0 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/ConstructCurveOnSurfaceComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/ConstructCurveOnSurfaceComponent.cs @@ -11,21 +11,21 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class ConstructCurveOnSurfaceComponent : GH_Component { - public ConstructCurveOnSurfaceComponent() : base("BB Construct CurveOnSurface", "BBCrvOnSrf", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public ConstructCurveOnSurfaceComponent() : base("BB Construct CurveOnSurface", "CrvOnSrf", "Embed a curve on a surface.", "Bowerbird", "Curve on Surface") { UpdateMessage(); } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddSurfaceParameter("Surface", "S", "", GH_ParamAccess.item); - pManager.AddCurveParameter("Curve", "C", "", GH_ParamAccess.item); + pManager.AddSurfaceParameter("Surface", "S", "Surface on which the curve is to be embedded", GH_ParamAccess.item); + pManager.AddCurveParameter("Curve", "C", "Curve which is to be embedded. The curve can be defined in geometry or parameter space (see context menu).", GH_ParamAccess.item); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); - pManager.AddCurveParameter("Approximation", "A", "", GH_ParamAccess.item); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "Embedded curve", GH_ParamAccess.item); + pManager.AddCurveParameter("Approximation", "A", "Approximation of the embedded curve as ordinary Rhino curve", GH_ParamAccess.item); } protected override void SolveInstance(IGH_DataAccess DA) diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/CurvatureComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/CurvatureComponent.cs index 51ae6cf..1f6b790 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/CurvatureComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/CurvatureComponent.cs @@ -9,21 +9,21 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class CurvatureComponent : GH_Component { - public CurvatureComponent() : base("BB Curvature CurveOnSurface", "κ", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public CurvatureComponent() : base("BB Curvature CurveOnSurface", "κ", "Evaluate the curvature of an embedded curve at a specified parameter.", "Bowerbird", "Curve on Surface") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Parameter", "t", "", GH_ParamAccess.item); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "Embedded curve to evaluate", GH_ParamAccess.item); + pManager.AddNumberParameter("Parameter", "t", "Parameter on curve domain to evaluate", GH_ParamAccess.item); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddPointParameter("Point", "P", "", GH_ParamAccess.item); - pManager.AddVectorParameter("Curvature", "K", "", GH_ParamAccess.item); - pManager.AddCircleParameter("Osculating Circle", "C", "", GH_ParamAccess.item); + pManager.AddPointParameter("Point", "P", "Point on curve at {t}", GH_ParamAccess.item); + pManager.AddVectorParameter("Curvature", "K", "Curvature vector at {t}", GH_ParamAccess.item); + pManager.AddCircleParameter("Osculating Circle", "C", "Curvature circle at {t}", GH_ParamAccess.item); } protected override void SolveInstance(IGH_DataAccess DA) diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/DeconstructCurveOnSurfaceComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/DeconstructCurveOnSurfaceComponent.cs index 6d1299c..75a4bec 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/DeconstructCurveOnSurfaceComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/DeconstructCurveOnSurfaceComponent.cs @@ -8,20 +8,20 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class DeconstructCurveOnSurfaceComponent : GH_Component { - public DeconstructCurveOnSurfaceComponent() : base("BB Deconstruct CurveOnSurface", "Deconstruct", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public DeconstructCurveOnSurfaceComponent() : base("BB Deconstruct CurveOnSurface", "Deconstruct", "Deconstruct an embedded curve into its components.", "Bowerbird", "Curve on Surface") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "Embeded curve to deconstruct", GH_ParamAccess.item); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddSurfaceParameter("Surface", "S", "", GH_ParamAccess.item); - pManager.AddCurveParameter("Curve", "C", "", GH_ParamAccess.item); - pManager.AddCurveParameter("Approximation", "A", "", GH_ParamAccess.item); + pManager.AddSurfaceParameter("Surface", "S", "Surface on which the curve is embedded", GH_ParamAccess.item); + pManager.AddCurveParameter("Curve", "C", "Parameter curve", GH_ParamAccess.item); + pManager.AddCurveParameter("Approximation", "A", "Approximation of the embedded curve as ordinary Rhino curve", GH_ParamAccess.item); } protected override void SolveInstance(IGH_DataAccess DA) diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/EvaluateComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/EvaluateComponent.cs index 84fb6b1..824f6a1 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/EvaluateComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/EvaluateComponent.cs @@ -8,22 +8,22 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class EvaluateComponent : GH_Component { - public EvaluateComponent() : base("BB Evaluate CurveOnSurface", "BBEval", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public EvaluateComponent() : base("BB Evaluate CurveOnSurface", "BBEval", "Evaluate an embedded curve at a specified parameter.", "Bowerbird", "Curve on Surface") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Parameter", "t", "", GH_ParamAccess.item); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "Embedded curve to evaluate", GH_ParamAccess.item); + pManager.AddNumberParameter("Parameter", "t", "Parameter on curve domain to evaluate", GH_ParamAccess.item); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddPointParameter("Point", "P", "", GH_ParamAccess.item); - pManager.AddVectorParameter("Tangent", "T", "", GH_ParamAccess.item); - pManager.AddVectorParameter("Binormal", "B", "", GH_ParamAccess.item); - pManager.AddVectorParameter("Normal", "N", "", GH_ParamAccess.item); + pManager.AddPointParameter("Point", "P", "Point on curve at {t}", GH_ParamAccess.item); + pManager.AddVectorParameter("Tangent", "T", "Tangent vector of curve at {t}", GH_ParamAccess.item); + pManager.AddVectorParameter("Binormal", "B", "Binormal vector of curve at {t}", GH_ParamAccess.item); + pManager.AddVectorParameter("Normal", "N", "Normal vector of curve at {t}", GH_ParamAccess.item); } protected override void SolveInstance(IGH_DataAccess DA) diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/ExtrudeComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/ExtrudeComponent.cs index 9469065..2fa99c4 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/ExtrudeComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/ExtrudeComponent.cs @@ -12,20 +12,20 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class ExtrudeComponent : GH_Component { - public ExtrudeComponent() : base("BB Extrude CurveOnSurface", "Extrude", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public ExtrudeComponent() : base("BB Extrude CurveOnSurface", "Extrude", "Extrude an embedded curve in direction of its normal vector.", "Bowerbird", "Curve on Surface") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Thickness", "t", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Offset", "o", "", GH_ParamAccess.item, 0.0); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "Embeded curve to extrude", GH_ParamAccess.item); + pManager.AddNumberParameter("Thickness", "t", "Thickness of the extrusion (t/2 in both directions)", GH_ParamAccess.item); + pManager.AddNumberParameter("Offset", "o", "Offset of the center line in direction of the normal vector", GH_ParamAccess.item, 0.0); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddMeshParameter("Mesh", "M", "", GH_ParamAccess.item); + pManager.AddMeshParameter("Mesh", "M", "Extrusion result", GH_ParamAccess.item); } protected override void SolveInstance(IGH_DataAccess DA) diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/GeodesicCurvatureComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/GeodesicCurvatureComponent.cs index 2d4fff6..f525d23 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/GeodesicCurvatureComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/GeodesicCurvatureComponent.cs @@ -9,21 +9,21 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class GeodesicCurvatureComponent : GH_Component { - public GeodesicCurvatureComponent() : base("BB Geodesic Curvature CurveOnSurface", "κg", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public GeodesicCurvatureComponent() : base("BB Geodesic Curvature CurveOnSurface", "κg", "Evaluate the geodesic curvature of an embedded curve at a specified parameter.", "Bowerbird", "Curve on Surface") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Parameter", "t", "", GH_ParamAccess.item); + pManager.AddNumberParameter("Parameter", "t", "Parameter on curve domain to evaluate", GH_ParamAccess.item); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddPointParameter("Point", "P", "", GH_ParamAccess.item); - pManager.AddVectorParameter("Curvature", "K", "", GH_ParamAccess.item); - pManager.AddCircleParameter("Osculating Circle", "C", "", GH_ParamAccess.item); + pManager.AddPointParameter("Point", "P", "Point on curve at {t}", GH_ParamAccess.item); + pManager.AddVectorParameter("Curvature", "K", "Curvature vector at {t}", GH_ParamAccess.item); + pManager.AddCircleParameter("Osculating Circle", "C", "Curvature circle at {t}", GH_ParamAccess.item); } protected override void SolveInstance(IGH_DataAccess DA) diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/GeodesicTorsionComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/GeodesicTorsionComponent.cs index 7152114..b7aa774 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/GeodesicTorsionComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/GeodesicTorsionComponent.cs @@ -8,20 +8,20 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class GeodesicTorsionComponent : GH_Component { - public GeodesicTorsionComponent() : base("BB Geodesic Torsion CurveOnSurface", "τg", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public GeodesicTorsionComponent() : base("BB Geodesic Torsion CurveOnSurface", "τg", "Evaluate the geodesic torsion of an embedded curve at a specified parameter.", "Bowerbird", "Curve on Surface") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Parameter", "t", "", GH_ParamAccess.item); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "Embedded curve to evaluate", GH_ParamAccess.item); + pManager.AddNumberParameter("Parameter", "t", "Parameter on curve domain to evaluate", GH_ParamAccess.item); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddPointParameter("Point", "P", "", GH_ParamAccess.item); - pManager.AddVectorParameter("Torsion", "T", "", GH_ParamAccess.item); + pManager.AddPointParameter("Point", "P", "Point on curve at {t}", GH_ParamAccess.item); + pManager.AddVectorParameter("Torsion", "T", "Torsion vector at {t}", GH_ParamAccess.item); } protected override void SolveInstance(IGH_DataAccess DA) diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/IntegrateComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/IntegrateComponent.cs index 5114b29..d32593f 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/IntegrateComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/IntegrateComponent.cs @@ -10,18 +10,18 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class IntegrateComponent : GH_Component { - public IntegrateComponent() : base("BB Integrate CurveOnSurface", "BBIntegrate", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public IntegrateComponent() : base("BB Integrate CurveOnSurface", "BBIntegrate", "Integrate the curvature of an embedded curve over a specified domain.", "Bowerbird", "Curve on Surface") { ValueType = ValueTypes.NormalCurvature; } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Start Parameter", "A", "", GH_ParamAccess.item); - pManager.AddNumberParameter("End Parameter", "B", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Tolerance", "T", "", GH_ParamAccess.item, 1e-6); - pManager.AddIntegerParameter("Maximum Iterations", "N", "", GH_ParamAccess.item, 1000); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "Embeded curve to evaluate", GH_ParamAccess.item); + pManager.AddNumberParameter("Start Parameter", "A", "Start of the integration domain (default: start of the curve domain)", GH_ParamAccess.item); + pManager.AddNumberParameter("End Parameter", "B", "End of the integration domain (default: end of the curve domain)", GH_ParamAccess.item); + pManager.AddNumberParameter("Tolerance", "T", "Tolerance for the adaptive numerical integration", GH_ParamAccess.item, 1e-6); + pManager.AddIntegerParameter("Maximum Iterations", "N", "Iteration limit for the numerical integration", GH_ParamAccess.item, 1000); pManager[1].Optional = true; pManager[2].Optional = true; @@ -29,8 +29,8 @@ protected override void RegisterInputParams(GH_InputParamManager pManager) protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddNumberParameter("Integral", "V", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Integral of squared", "V2", "", GH_ParamAccess.item); + pManager.AddNumberParameter("Integral", "V", "Integral of the value selected in the context menu", GH_ParamAccess.item); + pManager.AddNumberParameter("Integral of squared", "V2", "Integral of the squared value selected in the context menu", GH_ParamAccess.item); } Func Evaluate(IOrientableCurve curve, bool squared) diff --git a/Bowerbird/Components/CurveOnSurfaceComponents/NormalCurvatureComponent.cs b/Bowerbird/Components/CurveOnSurfaceComponents/NormalCurvatureComponent.cs index 38b2844..c3db177 100644 --- a/Bowerbird/Components/CurveOnSurfaceComponents/NormalCurvatureComponent.cs +++ b/Bowerbird/Components/CurveOnSurfaceComponents/NormalCurvatureComponent.cs @@ -9,21 +9,21 @@ namespace Bowerbird.Components.CurveOnSurfaceComponents { public class NormalCurvatureComponent : GH_Component { - public NormalCurvatureComponent() : base("BB Normal Curvature CurveOnSurface", "κn", "Beta! Interface might change!", "Bowerbird", "Curve on Surface") + public NormalCurvatureComponent() : base("BB Normal Curvature CurveOnSurface", "κn", "Evaluate the normal curvature of an embedded curve at a specified parameter.", "Bowerbird", "Curve on Surface") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "", GH_ParamAccess.item); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Curve on Surface", "C", "Embeded curve to evaluate", GH_ParamAccess.item); pManager.AddNumberParameter("Parameter", "t", "", GH_ParamAccess.item); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddPointParameter("Point", "P", "", GH_ParamAccess.item); - pManager.AddVectorParameter("Curvature", "K", "", GH_ParamAccess.item); - pManager.AddCircleParameter("Osculating Circle", "C", "", GH_ParamAccess.item); + pManager.AddPointParameter("Point", "P", "Point on curve at {t}", GH_ParamAccess.item); + pManager.AddVectorParameter("Curvature", "K", "Curvature vector at {t}", GH_ParamAccess.item); + pManager.AddCircleParameter("Osculating Circle", "C", "Curvature circle at {t}", GH_ParamAccess.item); } protected override void SolveInstance(IGH_DataAccess DA) diff --git a/Bowerbird/Components/PathfinderComponents/ConstructGeodesicTorsionPath.cs b/Bowerbird/Components/PathfinderComponents/ConstructGeodesicTorsionPath.cs index 45254ab..d538bdd 100644 --- a/Bowerbird/Components/PathfinderComponents/ConstructGeodesicTorsionPath.cs +++ b/Bowerbird/Components/PathfinderComponents/ConstructGeodesicTorsionPath.cs @@ -8,21 +8,21 @@ namespace Bowerbird.Components.PathfinderComponents { public class ConstructGeodesicTorsionPath : GH_Component { - public ConstructGeodesicTorsionPath() : base("BB Geodesic Torsion Path", "BBτg", "Beta! Interface might change!", "Bowerbird", "Paths") + public ConstructGeodesicTorsionPath() : base("BB Geodesic Torsion Path", "BBτg", "Follow the surface along a specified geodesic torsion. Connect this component to a Pathfinder.", "Bowerbird", "Paths") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddNumberParameter("Value", "V", "", GH_ParamAccess.item, 0.0); - pManager.AddNumberParameter("Angle", "A", "", GH_ParamAccess.item, 0.0); - pManager.AddIntegerParameter("Direction", "D", "", GH_ParamAccess.item, 3); + pManager.AddNumberParameter("Value", "V", "Desired geodesic torsion. Choosing value=0 returns principal curvature paths.", GH_ParamAccess.item, 0.0); + pManager.AddNumberParameter("Angle", "A", "Optional angle to rotate the search direction", GH_ParamAccess.item, 0.0); + pManager.AddIntegerParameter("Direction", "D", "Paths to evaluated (1=first, 2=second, 3=both, or use the context menu of the input parameter)", GH_ParamAccess.item, 3); Utility.AddNamedValues(Params.Input[2]); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddParameter(new PathParameter(), "Path Type", "T", "", GH_ParamAccess.item); + pManager.AddParameter(new PathParameter(), "Path Type", "T", "Path type for the Pathfinder component", GH_ParamAccess.item); } protected override void BeforeSolveInstance() diff --git a/Bowerbird/Components/PathfinderComponents/ConstructNormalCurvaturePath.cs b/Bowerbird/Components/PathfinderComponents/ConstructNormalCurvaturePath.cs index 66ff41b..f6f51bd 100644 --- a/Bowerbird/Components/PathfinderComponents/ConstructNormalCurvaturePath.cs +++ b/Bowerbird/Components/PathfinderComponents/ConstructNormalCurvaturePath.cs @@ -8,21 +8,21 @@ namespace Bowerbird.Components.PathfinderComponents { public class ConstructNormalCurvaturePath : GH_Component { - public ConstructNormalCurvaturePath() : base("BB Normal Curvature Path", "BBκn", "Beta! Interface might change!", "Bowerbird", "Paths") + public ConstructNormalCurvaturePath() : base("BB Normal Curvature Path", "BBκn", "Follow the surface along a specified normal curvature. Connect this component to a Pathfinder.", "Bowerbird", "Paths") { } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddNumberParameter("Value", "V", "", GH_ParamAccess.item, 0.0); - pManager.AddNumberParameter("Angle", "A", "", GH_ParamAccess.item, 0.0); - pManager.AddIntegerParameter("Direction", "D", "", GH_ParamAccess.item, 3); + pManager.AddNumberParameter("Value", "V", "Desired normal curvature. Choosing value=0 returns asympotic curves.", GH_ParamAccess.item, 0.0); + pManager.AddNumberParameter("Angle", "A", "Optional angle to rotate the search direction", GH_ParamAccess.item, 0.0); + pManager.AddIntegerParameter("Direction", "D", "Paths to evaluated (1=first, 2=second, 3=both, or use the context menu of the input parameter)", GH_ParamAccess.item, 3); Utility.AddNamedValues(Params.Input[2]); } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddParameter(new PathParameter(), "Path Type", "T", "", GH_ParamAccess.item); + pManager.AddParameter(new PathParameter(), "Path Type", "T", "Path type for the Pathfinder component", GH_ParamAccess.item); } protected override void BeforeSolveInstance() diff --git a/Bowerbird/Components/PathfinderComponents/ConstructPathfinder.cs b/Bowerbird/Components/PathfinderComponents/ConstructPathfinder.cs index 5c09ad9..4e95832 100644 --- a/Bowerbird/Components/PathfinderComponents/ConstructPathfinder.cs +++ b/Bowerbird/Components/PathfinderComponents/ConstructPathfinder.cs @@ -12,26 +12,26 @@ namespace Bowerbird.Components.PathfinderComponents { public class ConstructPathfinder : GH_Component { - public ConstructPathfinder() : base("BB Pathfinder", "BBPathfinder", "Beta! Interface might change!", "Bowerbird", "Paths") + public ConstructPathfinder() : base("BB Pathfinder", "BBPathfinder", "Find a specified path type on a surface or Brep.", "Bowerbird", "Paths") { UpdateMessage(); } protected override void RegisterInputParams(GH_InputParamManager pManager) { - pManager.AddParameter(new PathParameter(), "Path Type", "T", "", GH_ParamAccess.item); - pManager.AddBrepParameter("Surface", "S", "", GH_ParamAccess.item); - pManager.AddVectorParameter("Point", "P", "", GH_ParamAccess.item); - pManager.AddNumberParameter("Step Size", "H", "", GH_ParamAccess.item, 0.1); - pManager.AddIntegerParameter("Maximum number of Points", "N", "", GH_ParamAccess.item, 10000); - pManager.AddNumberParameter("Loop Tolerance", "t", "", GH_ParamAccess.item); + pManager.AddParameter(new PathParameter(), "Path Type", "T", "Path type to search", GH_ParamAccess.item); + pManager.AddBrepParameter("Surface", "S", "Surface or Brep to evaluate", GH_ParamAccess.item); + pManager.AddVectorParameter("Start Point", "P", "Start point for the search. Can be specified in geometry or parameter space (see context menu of the component).", GH_ParamAccess.item); + pManager.AddNumberParameter("Step Size", "H", "Step size for the search (too high: large error, too low: no progress and therefore no result)", GH_ParamAccess.item, 0.1); + pManager.AddIntegerParameter("Maximum number of Points", "N", "Limit of points for the search (break criterion)", GH_ParamAccess.item, 10000); + pManager.AddNumberParameter("Loop Tolerance", "t", "Tolerance for detecting closed loops (break criterion)", GH_ParamAccess.item); pManager[5].Optional = true; } protected override void RegisterOutputParams(GH_OutputParamManager pManager) { - pManager.AddParameter(new CurveOnSurfaceParameter(), "Paths", "P", "", GH_ParamAccess.list); + pManager.AddParameter(new CurveOnSurfaceParameter(), "Paths", "P", "Results as embedded curves (CurveOnSurface)", GH_ParamAccess.list); } protected override void SolveInstance(IGH_DataAccess DA)