RhinoCommon API documentation - wishes / critique

For 'getselectedobjects, I can find the one on the ObjectTable in the old doc search link you just posted, 8 links and it’s number 7.

It also fails to list the result for ‘selected’ and notes a lot of omitted results.

That’s the class I’m actually getting with RhinoDoc.ActiveDoc.Objects, so it’s the correct thing to find. (in my use case, for me step two would be 'so where can I get the ObjectTable from… oh, the doc has one, and I want the activedoc).


I added a show more button to load more search results

1 Like

Looks great, thank you!

I’m currently developing on Rhino 7 and stumbled upon methods only available in Rhino 8 (e.g. FileAi class (rhino3d.com))

Is there any way to filter the docs for a Rhino version? Am I missing something?

I mean there is the what’s new section, but I don’t want to check for everything there. Would be great to see in which version something was added or filter based on Rhino version.

4 Likes

some but not all entries in the documation have section

Available since:
   8.0

see at the bottom of FileAi.Read for example:
https://developer.rhino3d.com/api/rhinocommon/rhino.fileio.fileai/read

also see
https://developer.rhino3d.com/api/rhinocommon/whatsnew/8.0

but I agree - it would be great to filter the documentation for 7.0 and below or similar…

2 Likes

I think it’s been suggested before. I logged it here: https://mcneel.myjetbrains.com/youtrack/issue/WWW-2123/Add-version-filter-for-Rhino-Common-docs

For now @Tom_P 's suggestion is the only way to figure it out, but I’ll add that filter when I get a chance

4 Likes

I added a dropdown to set a version filter.

5 Likes

great. thanks.

EDIT
@mkarimi
oh - just checked - would be nice if using the drop down menu, the page should not reload.

meaning / example
I check a function with 8 and older…
https://developer.rhino3d.com/api/rhinocommon/rhino.geometry.mesh/pullcurve
(available 7.0)
now i use the dropdown to 7 and older
the function should stay in the page
(currently it reloads)

if i choose 6 and older - not sure what feels best for the user
(function not available) -
maybe a info ? - but keep showing the function ?
maybe just a background color ? a background image ?
some warning ? a pop up. ( I hate pop up s)
an overlay (better)
“current member / function / Property not available in Version 6”
maybe @Bernd_Möller has an idea ?

i like overlay best.
switching the version should filter the page / navigation-tree /… but if a current item is shown - it would be nice to stay on the page, but with an overlay … not available in Version …
???

This is great! Thanks for the quick change.

Small note, it works for methods, but looks like constructors don’t have any version attached to them. That still shows them for older version even though they are not available, here is an example:
image

Hi @mkarimi, not a wish or critique, but a massive praise: The new search functionality is wildly better than the old one. Thanks so much :raised_hands:

4 Likes

I noticed this too, this is something that’s not documented in the source code. @stevebaer do you what’s the reason <since> tag doesn’t exist on FileAi class and many other classes?
https://github.com/mcneel/rhino/blame/45c10627233997db1afebd2528e9c543e4592e5d/src4/DotNetSDK/rhinocommon/dotnet/FileIO/FileAi.cs#L8

It’s because I’m lazy. I run a process once in a while to fill in the tags for functions in RhinoCommon. Things like FileAi are new and I haven’t run the process on this yet.

3 Likes

Try now.

4 Likes

much butter - it s really great that you react that fast.

Another small wish: Dark mode has to be toggled on everytime a new tab with rhinocommon is opened. Can we make it
a) Remember the dark/light mode setting
b) Retreive the system mode and apple the same

Thanks a lot and best wished from Vienna,
Rudi

1 Like

Nitpick: Spelling of ‘inheritance’
Wish: You show the upwards inheritance path. It would be nice to see the subclasses.

Example of both:
GeometryBase class (rhino3d.com)

2 Likes

In dark view, deprecated methods get an odd highlight, not educed visibility as is the case with bright view. It took me a minute to figure out why it was showing that way.

You have several little icons you use to provide information about line items anyway (such as ‘protected’). I would prefer that to the low-contrast hard-to-read approach in any case.

Example: method section of RhinoObject
RhinoObject class (rhino3d.com)

This is a good suggestion. Logged it here:
https://mcneel.myjetbrains.com/youtrack/issue/WWW-2133/Persistent-dark-mode-settings

I agree that looks odd. Will fix it when I get a chance.
https://mcneel.myjetbrains.com/youtrack/issue/WWW-2134/Improve-dark-mode-styling

This is now fixed
https://developer.rhino3d.com/api/rhinocommon/rhino.geometry.collections.brepfacelist/item

1 Like