Rhino 6 documentation bugs

(Kelvin Cheng) #92

They are either a panel group or panel tabs. Panel group tabs sounds like a tab contains a group. I changed it to Panel tabs.

I changed it to Property page icons because “tabs” will cause confusion with the tabs above.
The Properties panel shared by object and viewport properties. They can’t be called Object property page icons.

OK, changed it.




RefreshShade documentation is here:

It says: This mode is turned off in all viewports…

Which mode?

(John Brock) #94

Normally, if an object is modified in a shaded style display mode, the render mesh is updated for that object.
You can use the RefreshShade command to recalculate the render mesh without modifying the object.
Running ClearAllMeshes, deletes the render mesh from the file AND turns off automatic refreshing so the model stays in a Wireframe display.


What is automatic refreshing?

(Kelvin Cheng) #96

In Rhino 4 and the early version of Rhino 5, editing surface control points does not update the render meshes. RefreshShade can be used to force updating the render meshes. I updated the topic, thanks.


(John Brock) #97

My first sentence describes that.

Draw a box in a shaded display mode. You are looking at the render mesh. Change the box with MoveFace or anything that changes it’s shape. The render mesh is refreshed and you see the modified shape. If the mesh was not modified you would see the old box and changed edges that didn’t fit


Two pictures of Mask property should be swapped in the Leader page: https://docs.mcneel.com/rhino/6/help/en-us/commands/leader.htm

Background: https://docs.mcneel.com/rhino/6/help/en-us/image/topic_illustrations/dimensionmask-001.png

and Color: https://docs.mcneel.com/rhino/6/help/en-us/image/topic_illustrations/dimensionmask-002.png

The same mistake is on the Text page:

(Kelvin Cheng) #99

I’m updating the the related topics. A lot of issues to fix.


I agree. For several years I was talking about it on Rhino forums. Here is quotation from my old post:

Nobody cares about documentation. Rhino 5 help file has dozens or errors and hundreds of omissions. Bongo help file is worse. Flamingo does not have a help file. All its documentation is on a website, so it is difficult to find anything.

A Rhino user claims that Gumball axis plane indicator is called paddle (2:36): https://www.youtube.com/watch?v=tr8Tw71jRFU
He actually invented this paddle name because he hates long names. Most people prefer short names.

(Kelvin Cheng) #101

I’m sorry you had the kind of feeling. Rhino help is a huge project. It’s not easy to maintain. We can only do our best.

I fixed the two pages and the problems I discovered on several topics.

I understand, but it’s been existing for years, I can’t just invent a new name and change it. It will cause inconsistencies across different documents. Thanks, anyway.


The Rhino window page: https://docs.mcneel.com/rhino/6/help/en-us/user_interface/rhino_window.htm
…mentions Autogumball mode, but it does not explains what the Autogumball mode is.


The GumballScaleMode is described here: https://docs.mcneel.com/rhino/6/help/en-us/commands/gumball.htm#GumballScaleMode

Its wording is confusing. It suggests that handle size is changing dynamically in the Relative mode, and is fixed in the Absolute mode. In reality, the handle size is fixed in the Relative mode, and it is changing dynamically in the Absolute mode.

It would be good idea to emphasize that GumballScaleMode does not change the size of Move arrows and Rotation arcs.

By the way, I believe that this command should be moved to Rhino options.

(Kelvin Cheng) #104

I’ll look into the issues. Thanks.

(Kelvin Cheng) #105

When Gumball was an experimental plug-in in Rhino 4, Gumball was turned on object by object manually.
The Gumball switch was added in Rhino 5. When it’s on, Gumball displays on the selected object automatically. “Autogumball” was used to describe the fact. I removed “Autogumball” from all topics.

“Relative” means relative to the gumball radius.
“Absolute” means using the absolute size of the object’s bounding box.
I improved the topic with new illustrations.


This is the background story.
Gumball scale handles are “Absolute” in Rhino 5. It was once changed to “Relative” in Rhino 6. The GumballScaleMode command was added for switching it back to “Absolute”. Several users complained about the change, so it was reverted to “Absolute” by default.

The developer’s comment in 2014:

I would revert back to scaling the old way if there’s no clear benefit from scaling the new way. I would not even expose the setting in the UI if there’s no massive popular demand for it.



Thanks. The new GumballScaleMode documentation looks perfect to me.


Documentation of Curvature, CurvatureAnalysis, and CurvatureGraph commands is here: https://docs.mcneel.com/rhino/6/help/en-us/commands/curvature.htm

This documentation is accurate and complete, but it is not organized well because there is no distinction between command options and notes. For example, the heading Curve Analysis options is followed by a note, rather than a list of command options. Another example: Curvature Graph heading is followed by a list of command options, but there is no “options” word in the heading.

There is clear distinction between document properties and Rhino options in the Options command. Most Rhino commands have command-line options. Some Rhino commands have other options. Examples:

  1. CurvatureAnalysis command has Style options and Curvature Range options.
  2. ShowDir command has Direction Analysis options.
  3. ShowEdges command has Zoom options.

For the sake of clarity it would be desirable to unify options naming. I would call all these options (command-line options + 1, 2, 3) command options.

(Kelvin Cheng) #108

I changed Curve Analysis options to Span continuity and updated the illustrations.

<p class=“Dialog_Box_Title”>Curvature Graph</p>
I think this was by design at some point in the past. No “options” in the dialog box title, so the heading doesn’t have it. There are many dialog box title headings in other topics do have “options”. I added it here anyway.

The “styles” are used across a lot of topics. It’s hard to maintain the consistency when the topics were added/updated again and again in the past 15+ years. I don’t know how many days will be needed if I’m going to “correct” all the dialog box title headings in all topics. If I really do it, 12 translators behind me will have to update the localization. I can’t be too picky about this.

When I added “options” to the dialog box title heading “Curvature”, I felt like “options” should be removed from the “Style options” and “Curvature Range options” because of too many “options”.

Obviously, you know what they are. It should not be a big problem. :slightly_smiling_face:

Thank you for spending time on these.


It would be good idea to mention link between ShowZBuffer command and Heightfield command. Brian James explained this link in the last 3 minutes of this video: https://vimeo.com/19501064

(Kelvin Cheng) #110

I’ll check, thanks.

(Kelvin Cheng) #111

I updated http://docs.mcneel.com/rhino/6/help/en-us/index.htm#commands/heightfield.htm
and http://docs.mcneel.com/rhino/6/help/en-us/index.htm#commands/showzbuffer.htm