How to Deserialize JSON in Rhino3dm

Rhino Developer rhino3dm
, , , ,
1

I would like to take a json representation of a GeometryBase that has been ToJson’d using RhinoCommon.CommonObject.ToJson(...) and deserialize it in Rhino3dm (I am using 8.4.0).

I’m a bit confused, the docs do show a GeometryBase and CommonObject type. And I even see a DracoCompression type. But their decode methods seem to only run on a static object and do not take or return any values.

CommonObject

https://mcneel.github.io/rhino3dm/javascript/api/CommonObject.html#decode

DracoCompression

https://mcneel.github.io/rhino3dm/javascript/api/DracoCompression.html#.decompressBase64String

My assumption is that I don’t understand something about typescript or javascript, and the reason I assume that, is two-fold;

  1. I am new
  2. this snippet here:

In this sample we see createFromThreejsJSON() called with some args, yet in the docs, and when I try to use it I cannot pass these args. The docs state Mesh.createFromThreejsJSON is similar to the above two methods in that it is static, and does not take any args or return anything.
https://mcneel.github.io/rhino3dm/javascript/api/Mesh.html#.createFromThreejsJSON

– cs

2

Hey @fraguada, @mkarimi told me it’d be worth poking you to see if we can get the docs updated and the mysteries unveiled.

– cs

3

@csykes The docs for js and py rhino3dm are in need of an overhaul as the way they are generated is based on the dotnet SDK, and there isn’t always parity between what is offered in each language. One bit that I have done some work on are the typescript definitions, but again, this includes some manual work and is a pain to maintain. Looking at them now, it seems the specific threejs calls are missing their arguments, which I definitely have filled in before. In short, we need to put in some time to get accurate, maintainable documentation across rhino3dm languages.

A few things I can suggest in the meantime:

  1. You can get acquainted with the binding code. For example, CommonObject.decode() calls BND_CommonObject::Decode(BND_DICT jsonObject). I know this suggestion isn’t ideal, but you eventually get used to what’s what.
  2. The js compute samples use rhino3dm.js to decode the response from Rhino.Compute servers. For example: rhino-developer-samples/compute/js/SampleGHClash/script.js at 8 · mcneel/rhino-developer-samples · GitHub
1 Like
4

That’s smashing thank you! I’ve got some other issues at the moment which are issues seemingly with webpack, When I get those solved I’ll have another crack at it referencing the links you sent :slight_smile:

5

I just pushed this sample that shows how one can decode all of the things that have such a function: rhino-developer-samples/rhino3dm/js/node/SampleDecodeObjects/index.js at 8 · mcneel/rhino-developer-samples · GitHub