Improve docs of addChild() and setParent() #16073
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I struggled a lot with using
addChild()
. It seemed to mess up the position of the child mesh. I had no idea why, because the documentation only said:It also wasn't clear to me what's the relationship between just assigning to
.parent
or callingsetParent()
.After struggling with these problems for many weeks, I finally read the source and figured out that
addChild()
simply callssetParent()
, the documentation of which does say what it does with child coordinates.I'd hope this little improvement to the docs will help others to better understand the relationship between these three ways of setting the parent.