Fixing SurfaceMagnetism quaternion math #10074
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.
Overview
Currently, SurfaceMagnetism uses
Vector3.up
as the up vector for all surface normalQuaternion.LookRotation
calculations. This causes gimbal-lock-like behavior when the surface that is being magnetized to is mostly looking upwards. This manifests in ugly temporal instability when a hologram is magnetized to the floor of the scene reconstruction mesh.The quaternion math in
SurfaceMagnetism
has been fixed to now use the "best guess" up vector, derived from the current working rotation's up vector. This ensures temporal stability in all cases. Compatibility has been ensured with both modes ofKeepOrientationVertical
, as well asOrientationMode.TrackedTarget
.A unit test has been added that verifies the absence of any gimbal locking behavior when a floor-like surface is tilted/updated.
Changes
SurfaceMagnetism
to properly calculate a temporally stable look rotation.Verification
The test should cover #10064's reported incident. @holomatt feel free to clone this PR and verify that your issue is fixed.