Document how directional and spot lights are aimed - #9206
Merged
Conversation
Build size reportThis PR does not change the size of the minified bundles.
|
mvaligursky
added
docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
LightComponentdocumentation already states that directional and spot lights emit along the owner entity's negative y-axis, but nothing explains how to aim one.GraphNode#lookAtis the obvious tool to reach for and it orients an entity's negative z-axis, so it aims a camera and leaves a light pointing somewhere unrelated.Changes:
LightComponentclass documentation now covers aiming: lights are aimed with the owner entity's rotation, an unrotated light shines straight down, andlookAtneeds a followingrotateLocal(90, 0, 0)to bring the negative y-axis onto the target. A short snippet shows all three.typesetter, which already states the negative y-axis convention fordirectionalandspot, now cross-references the class documentation for the aiming details.Documentation only, no functional or API changes.