[Merged] PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

[Kunda1]

https://github.com/FreeCAD/FreeCAD/pull/2577

I added a longer explanation about VBO and spruced up some other tooltips.
Please advise what the tooltips for 'Render Cache' and 'Rotate at cursor' should be.

[vocx]

...
Please advise what the tooltips for 'Render Cache' and 'Rotate at cursor' should be.

Do this

Code: Select all

git grep -i 'Render cache'

This will tell you where the line is in the source. It seems it's in /src/Gui/DlgSettings3DView.ui.

So, by checking this file in GitHub, https://github.com/FreeCAD/FreeCAD/comm ... s3DView.ui

we see the person who added that option was realthunder in git commit c744157, with the LinkMerge. So, you may ask him directly.

Similarly for the other string, it seems it was added in git commit a2fa902, by donovaly. I think that's uwestoer in the forum?

[Kunda1]

git grep -i 'Render cache'

super helpful, thanks @vocx

So...looks like @realthunder documented this feature in https://github.com/realthunder/FreeCAD_ ... er-caching
Trying to understand that page is overwhelming. Can tooltips have active URLs in them ?

[vocx]

So...looks like @realthunder documented this feature in https://github.com/realthunder/FreeCAD_ ... er-caching
Trying to understand that page is overwhelming. Can tooltips have active URLs in them ?

It seems to be an expert option, so I guess there is not much point in giving a full explanation in the tooltip. Better to try to document it in Preferences Editor page.

It seems that "Rotate at cursor" is the same as the previously named "Drag at cursor", which already was described by uwe in the wiki.

[Kunda1]

It seems to be an expert option, so I guess there is not much point in giving a full explanation in the tooltip. Better to try to document it in Preferences Editor page.

I guess we can ask @realthunder to summarize it in to a paragraph or so ? (giving 1 line explanation summary for every option)

[realthunder]

Yes, it is documented here.

You can use the following description as the tooltip I guess.

Auto (default), let Coin3D decide where to cache.

Distributed, manually turn on cache for all view provider root node.

Centralized, manually turn off cache in all nodes of all view provider, and only cache at the scene graph root node. This offers the fastest rendering speed, but slower response to any scene changes.

[Kunda1]

You can use the following description as the tooltip I guess.

Thanks! I've added the tooltip. Do you mind reviewing it ?
https://github.com/FreeCAD/FreeCAD/pull/2577/files

Edit: I've also updated the wiki page https://www.freecadweb.org/wiki/Prefere ... or#3D_View

[realthunder]

You can use the following description as the tooltip I guess.

Thanks! I've added the tooltip. Do you mind reviewing it ?
https://github.com/FreeCAD/FreeCAD/pull/2577/files

Edit: I've also updated the wiki page https://www.freecadweb.org/wiki/Prefere ... or#3D_View

Looks fine for the 'Render Caching' document. But for the VBO part, maybe it is better to change 'video device' to 'graphics card'? Something like

Code: Select all

A VBO is an OpenGL feature that provides methods for uploading
vertex data (position, normal vector, color, etc.) to the graphics card.
VBOs offer substantial performance gains because the data resides
in the graphics memory rather than the system memory and so it
can be rendered directly by GPU. 

[Kunda1]

Looks fine for the 'Render Caching' document. But for the VBO part, maybe it is better to change 'video device' to 'graphics card'? Something like

Thanks for reviewing. I will make the revision.

Edit: PR updated

[adrianinsaval]

Speaking of tooltips and documentation, can you guys explain what this option does?