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

Merged, abandoned or rejected pull requests are moved here to clear the main Pull Requests forum.
User avatar
Kunda1
Posts: 7319
Joined: Thu Jan 05, 2017 9:03 pm

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

Post by Kunda1 » Thu Oct 03, 2019 8:53 pm

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.
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
vocx
Posts: 3956
Joined: Thu Oct 18, 2018 9:18 pm

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by vocx » Thu Oct 03, 2019 9:30 pm

Kunda1 wrote:
Thu Oct 03, 2019 8:53 pm
...
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?
Always add the important information to your posts if you need help.
To support the documentation effort, and code development, your donation is appreciated: paypal.
User avatar
Kunda1
Posts: 7319
Joined: Thu Jan 05, 2017 9:03 pm

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by Kunda1 » Thu Oct 03, 2019 9:57 pm

vocx wrote:
Thu Oct 03, 2019 9:30 pm
git grep -i 'Render cache'
super helpful, thanks @vocx 8-)

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 ?
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
vocx
Posts: 3956
Joined: Thu Oct 18, 2018 9:18 pm

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by vocx » Thu Oct 03, 2019 10:13 pm

Kunda1 wrote:
Thu Oct 03, 2019 9:57 pm
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.
Always add the important information to your posts if you need help.
To support the documentation effort, and code development, your donation is appreciated: paypal.
User avatar
Kunda1
Posts: 7319
Joined: Thu Jan 05, 2017 9:03 pm

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by Kunda1 » Thu Oct 03, 2019 10:39 pm

vocx wrote:
Thu Oct 03, 2019 10:13 pm
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)
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
realthunder
Posts: 1536
Joined: Tue Jan 03, 2017 10:55 am

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by realthunder » Thu Oct 03, 2019 11:00 pm

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.
Try Assembly3 (latest version 0.11) along with my custom build of FreeCAD at here.
And if you'd like to show your support, you can donate through patreon, liberapay, or paypal
User avatar
Kunda1
Posts: 7319
Joined: Thu Jan 05, 2017 9:03 pm

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by Kunda1 » Fri Oct 04, 2019 12:38 am

realthunder wrote:
Thu Oct 03, 2019 11:00 pm
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
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
realthunder
Posts: 1536
Joined: Tue Jan 03, 2017 10:55 am

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by realthunder » Fri Oct 04, 2019 1:01 am

Kunda1 wrote:
Fri Oct 04, 2019 12:38 am
realthunder wrote:
Thu Oct 03, 2019 11:00 pm
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. 
Try Assembly3 (latest version 0.11) along with my custom build of FreeCAD at here.
And if you'd like to show your support, you can donate through patreon, liberapay, or paypal
User avatar
Kunda1
Posts: 7319
Joined: Thu Jan 05, 2017 9:03 pm

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by Kunda1 » Fri Oct 04, 2019 1:12 am

realthunder wrote:
Fri Oct 04, 2019 1:01 am
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
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
adrianinsaval
Posts: 317
Joined: Thu Apr 05, 2018 5:15 pm

Re: PR #2577: Docs: Update Prefs > Display > '3D View' tooltips

Post by adrianinsaval » Fri Oct 04, 2019 7:31 pm

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

Who is online

Users browsing this forum: No registered users and 1 guest