SimpleGrasshopper 0.10.6

Simple Grasshopper

Hi, this is a repo to simplify your plugin development in Grasshopper.

With this repo, you don't need to understand what a GH_Component is and what a GH_Param is. All you need to do is add attributes!

NOTICE: For some reason, the SimpleGrasshopper.dll won't copy to the output directory automatically. If there is any way to make the nuget pacakge only copy this file, please tell me.

Quick Start

Add the package from nuget package.

  <ItemGroup>
    <PackageReference Include="SimpleGrasshopper" Version="0.9.1" />
  <ItemGroup>

Don't forget to copy this SimpleGrasshopper.dll file to your output folder!

How to use

Component

All the components are methods. to simplify creating these things, a method is a component! To let it know which method should be the component, please tag it with DocObjAttribute with the basic info about it called Name, NickName, and Description!

using SimpleGrasshopper.Attributes;

namespace SimpleGrasshopper.GHTests;

internal class SimpleSubcategory
{
    [DocObj("Addition", "Add", "The addition of the integers.")]
    private static void SimpleMethod(int a, int b, out int c)
    {
        c = a + b;
    }
}

Now, you'll see a component in GH!

The output is the parameters with the modifier out! And please don't use ref! It'll be regarded as input!

Component Infos

For some cases, you may want to add more information for this component, there are 3 attributes designed for this. They are SubCategoryAttribute, IconAttribute, and ExposureAttribute. You can also use the attribute ObsoleteAttribute.

using SimpleGrasshopper.Attributes;

namespace SimpleGrasshopper.GHTests;

[SubCategory("Just a test")]
internal class SimpleSubcategory
{
    [Icon("ConstructRenderItemComponent_24-24.png")] // The name of the png that is embedded in your dll.
    [Exposure(Grasshopper.Kernel.GH_Exposure.secondary)]
    [DocObj("Addition", "Add", "The addition of the integers.")]
    private static void SimpleMethod(int a, int b, out int c)
    {
        c = a + b;
    }
}

Parameters Info

If you want to change the description of the param, please use DocObjAttribute one more time to make it easier to read.

If you want to use some other Parameter with your parameter, please use ParamAttribute.

One more thing, for the angle parameter, is the AngleAttribute!

using SimpleGrasshopper.Attributes;
using SimpleGrasshopper.Data;

namespace SimpleGrasshopper.GHTests;

[SubCategory("Just a test")]
internal class SimpleSubcategory
{
    [DocObj("Special Param", "Spe", "Special Params")]
    private static void ParamTest(
        [DocObj("Name", "N", "The name of sth.")] string name, 
        [Param(ParamGuids.FilePath)]string path,
        [Angle]out double angle)
    {
        angle = Math.PI;
    }
}

Data Access

If you want your data access to be a list, please set the param type to List<T>.

If you want your data access to be a tree. That would be complex.

If it is a built-in type, please do it like GH_Structure<GH_XXXX>. If it is your type, please do it like GH_Structure<SimpleGoo<XXXXX>>.

Enum Type

For some cases, you may want to add some enum parameters to your project, so just do it!

You can also add a default value for making it optional.

using SimpleGrasshopper.Attributes;
using SimpleGrasshopper.Data;

namespace SimpleGrasshopper.GHTests;

[SubCategory("Just a test")]
internal class SimpleSubcategory
{
    [DocObj("Enum Param", "Enu", "Enum testing")]
    private static void EnumTypeTest(out EnumTest type, EnumTest input = EnumTest.First)
    {
        type = EnumTest.First;
    }
}

public enum EnumTest : byte
{
    First,
    Second,
}

Parameters

For parameters, they are just types! doing things like a type!

You can also add IconAttribute , ExposureAttribute, and ObsoleteAttribute.

using SimpleGrasshopper.Attributes;

namespace SimpleGrasshopper.GHTests;

[Icon("CurveRenderAttributeParameter_24-24.png")]
[DocObj("My type", "just a type", "Testing type.")]
public class TypeTest
{
}

And this parameter can also be used in the component!

using SimpleGrasshopper.Attributes;
using SimpleGrasshopper.Data;

namespace SimpleGrasshopper.GHTests;

[SubCategory("Just a test")]
internal class SimpleSubcategory
{
    [DocObj("Type Testing", "T", "Testing for my type")]
    private static void MyTypeTest(TypeTest type)
    {

    }
}

Settings

Well, for some lazy people like me, who doesn't like to use Instances.Setting.GetValue(XXX), etc. I just want to make it ez.

So, just tag a static field with the attribute SettingAttribute!

using SimpleGrasshopper.Attributes;
using System.Drawing;

namespace SimpleGrasshopper.GHTests;

internal static partial class SettingClass
{
    [Setting]
    private static readonly bool firstSetting = true;

    [Setting]
    private static readonly Color secondSetting = Color.AliceBlue;
}

internal readonly partial struct SettingStruct
{
    [Setting]
    private static readonly string anotherSetting = default!;
}

And you can use it like this.

var a = SettingClass.FirstSetting;
var b = SettingClass.SecondSetting;
var c = SettingStruct.AnotherSetting;

That makes it easier!

Advanced

So it is making it easier. But if you still want to modify the GH_Component or GH_PersistentParam. You can use the keyword partial to modify the class. For the components, the class is CLASSNAME_METHODNAME_Component. For the parameters, the class is CLASSNAME_Parameter.