Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the CSG system's expected level of reliability #8767

Closed
31 opened this issue Jan 14, 2024 · 2 comments · Fixed by #9076
Closed

Document the CSG system's expected level of reliability #8767

31 opened this issue Jan 14, 2024 · 2 comments · Fixed by #9076
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation bug

Comments

@31
Copy link
Contributor

31 commented Jan 14, 2024

Your Godot version:
4.2.1

Issue description:
I think https://docs.godotengine.org/en/stable/tutorials/3d/csg_tools.html should mention that Godot's CSG can't reliably produce meshes without holes, and based on the conversation in this issue, my understanding is the Godot team thinks this isn't a totally fixable problem:

Accurate CSG algorithms (that handle coplanar faces correctly) are much slower, so I don't know if it's a viable tradeoff given many users are using those nodes at run-time.

I think the note at the top of the page is good ("mainly intended for prototyping"), but the second sentence seems to me to imply that the only reason that's the case is because of the missing features, not its reliability:

The CSG nodes in Godot are mainly intended for prototyping. There is no built-in support for UV mapping or editing 3D polygons (though extruded 2D polygons can be used with the CSGPolygon3D node).

I think reliability should be mentioned directly.

Having to keep an eye out for holes and jiggling the nodes around to get it to work might work for some situations, but not others, and I think it would be good for this doc to inform people about this so they can more carefully evaluate whether it fits their needs. Otherwise, they could depend on it without thinking they need to evaluate how reliable it is, and end up in trouble later in development.

I filed a issue with some other CSG meshing issues (before finding the older issue) that made me think about suggesting this doc change: godotengine/godot#86567

URL to the documentation page (if already existing):
https://docs.godotengine.org/en/stable/tutorials/3d/csg_tools.html

@31 31 added the enhancement label Jan 14, 2024
@31
Copy link
Contributor Author

31 commented Jan 14, 2024

@31 31 closed this as not planned Won't fix, can't repro, duplicate, stale Jan 14, 2024
@31
Copy link
Contributor Author

31 commented Jan 21, 2024

Moving back after godot-docs-user-notes rule change.

@31 31 reopened this Jan 21, 2024
@skyace65 skyace65 added bug area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jan 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants