C# - Custom Data Output - Input: Where to start?

Grasshopper Developer
1

OK, I give up on DataOutput/Datainput.

I’ve had a look at splitting my huge GH definitions using DataOutput and DataInput and yes, they would have done the job, but only if :

  1. I could define the File name via an input (I need to concatenate file names), and
  2. Save and Read back data from (default) the same directory as the Rhino model (or the GH def), or from an optional (input) Path

I need to have full control of my “data flow” (which can vary, and can be complex) so I will have to write my own Data Output/Input components for my needs.

Q: But how do I save individual GH objects (do I have to bake them first?) to file (fast & compact format?) in the most straight forward way? Are there any code examples/links? Prefered File format? Etc. A simple (C#) example would get me started.

// Rolf

2

Yep, not only that performance is bad. Better try sticky

3

What is “sticky”?

4

Python stuff

5

it is a dictionary shared between Rhino and Grasshopper that allows you to store data in the memory and transfer it

6

Here use this:

You can attach a timer to them (to the one without number input, the one with the input will update every time you make a change) to update or make them self update with some tweaking.

GH.Sticky-DataInputOutput.gh (7.9 KB)

By the way, using sticky will update the data at a speed defined by the timer (or the self-update function) while DataInput-Output are set to update at 1s delay. This slows down everything.

7

I believe @RIL is developing in C#, so probably needs a C# solution.

8

That gives me the impression that he looks for a substitute. If there’s nothing like sticky in csharp this will do.

9

I need to write objects to disk from separate GH definitions, with a naming convention based on (Rhino || GH) source file as well as “processing step”.

Such an approach makes it possible to:

  1. Distribute Processing.
  2. Delay Distribution & Processing.
  3. Restart a failing Process from the Porcessing Step where it went wrong.
  4. Separate different concurrent jobs (naming conflicts)

Sticky or any form of internal variables (Plugin or Document scope) thus is not an option.

// Rolf

10

Sticky is not internal, it is shared between Rhino and GH and other GH definitions that are open at the same time.

but yes maybe not useful if you want a file on the disk

11

I’ve been increasingly serialising large chunks of RhinoCommon and custom objects to/from files as part of my modelling pipelines (especially for analysis stuff, but also when exploring design spaces and generating phenomes). This is using Python pickling, but .NET will surely have some namespaces for this as well. @dave_stasiuk added some components for writing/reading data to file in his TreeSloth plugin, this might work for you OOTB, or serve as a starting point for developing your own custom workflow perhaps.

1 Like
12

I tried peeking into the Data Output components via NodeInCode, hoping to find the filename properties being public, but… :frowning:

var cfi = Rhino.NodeInCode.Components.FindComponent("Data Output");

That way it would have been easy to implement a custom component supporting all the criterias I listed.

// Rolf

13

You might want to use GH_IO.Serialization. But the serialized data will stay associated with the particular GH file that contains the component instance (right, @DavidRutten?) , so it’s probably not what you want.

14

Looks like there are many tutorials on .NET serialistion, that’d probably be the place to start:

https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/serialization/

I’m sure David can share which assemblies/namespaces he’s implemented in the DataOutput/DataInput components.

1 Like
15

Here’s how the Data Output component creates a file which contains multiple datatrees:

GH_LooseChunk archive = new GH_LooseChunk("Grasshopper Data");
archive.SetGuid("OriginId", InstanceGuid);
archive.SetInt32("Count", Params.Input.Count);

for (int i = 0; i < Params.Input.Count; i++)
{
  IGH_Param param = Params.Input[i];
  IGH_Structure structure = param.VolatileData;

  if (string.IsNullOrEmpty(param.NickName))
  {
    AddRuntimeMessage(GH_RuntimeMessageLevel.Warning, "Parameters without a name will not be included.");
    continue;
  }

  GH_IWriter chunk = archive.CreateChunk("Block", i);
  chunk.SetString("Name", param.NickName);
  chunk.SetBoolean("Empty", structure.IsEmpty);

  if (!structure.IsEmpty)
  {
    GH_Structure<IGH_Goo> tree;
    access.GetDataTree(i, out tree);
    if (!tree.Write(chunk.CreateChunk("Data")))
      AddRuntimeMessage(GH_RuntimeMessageLevel.Error, string.Format("There was a problem writing the {0} data.", param.NickName));
  }
}

byte[] data = archive.Serialize_Binary();
try
{
  File.WriteAllBytes(Destination, data);
}
catch (Exception e)
{
  AddRuntimeMessage(GH_RuntimeMessageLevel.Error, e.Message);
}

Looking at it now, it’s not the most efficient way, there’s no need to both access the VolatileData and call access.GetDataTree(). Those amount to the same thing.

4 Likes
16

Thank you all for your hints. I’ve tried the serialization as David describes it and it gets written to disk exactly as I wish.

When I have tested it I’ll share the custom data components.

// Rolf

2 Likes
17

One problem I found is that, when I want to save a capsule menu option, the component’s Writer runs before the Menu_NameClicked event, which means that I always have the wrong (bool toggled) state stored in the file. For example the below event is stored as false, although the actual state is true:

bild

storing the properties:

        public override bool Write(GH_IO.Serialization.GH_IWriter writer)
        {
            writer.SetBoolean("UseRhinoPath", UseRhinoPath);
            writer.SetBoolean("UseGhPath", UseGhPath);
            return base.Write(writer);
        }

Is there any trick I can use to capture the state & event in the correct order?

// Rolf

18

If you consistently have the wrong state stored, can you use the inverse of the state

19

Since there is no code which handles clicks on custom menu items, it’s very strange that anything at all happens when you click on it.

What does the handler for that menu click event look like?

20

Hi Rolf!

This is exactly what I am looking for.
Have you found a working solution? Are you willing to share it?

Many thanks!
Mathias