feat: NetworkTransform with blittable states and handled in jobs #4123
+6,665
−648
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| using Unity.Burst; | ||
| using Unity.Collections; | ||
| using UnityEngine.Jobs; | ||
| using static Unity.Netcode.Components.NetworkTransform; | ||
|
|
||
| namespace Unity.Netcode.Components | ||
| { | ||
| /// <summary> | ||
| /// Motion Authority Only: | ||
| /// Detects <see cref="NetworkTransform"/> state changes for every registered instance in a parallel job. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// <see cref="CheckForStateChange(ref NetworkTransformState, ref NetworkDeltaPosition, ref TransformDeltaConfig, in TransformSample, bool, bool, bool)"/> | ||
| /// is the common method used for both per instance, runs on the main thread, and batched modes. This assures both paths detect changes in state identically. | ||
| /// </remarks> | ||
| [BurstCompile] | ||
| internal struct DetectTransformDeltaJob : IJobParallelForTransform | ||
| { | ||
| /// <summary> | ||
| /// The per instance input and output, parallel to the job's scheduled transforms. | ||
| /// </summary> | ||
| public NativeArray<TransformDeltaEntry> Entries; | ||
|
|
||
| /// <summary> | ||
| /// This job's primary entry point. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// TODO: Investigate ways to work around the fact that a Rigidbody's position and rotation cannot | ||
| /// be sampled from a job. As such, any NetworkTransform that is using Rigidbody for motion will | ||
| /// use the <see cref="UnityEngine.GameObject.transform"/> to detect changes in position and rotation | ||
| /// states on the authority side. | ||
| /// </remarks> | ||
| /// <param name="index">Index for the transform in question.</param> | ||
| /// <param name="transform">The job safe <see cref="TransformAccess"/></param> | ||
| public void Execute(int index, TransformAccess transform) | ||
| { | ||
| if (!transform.isValid) | ||
| { | ||
| return; | ||
|
Check warning on line 39 in com.unity.netcode.gameobjects/Runtime/Components/DetectTransformDeltaJob.cs
|
||
| } | ||
|
|
||
| var entry = Entries[index]; | ||
| var flagStates = entry.State.FlagStates; | ||
| // Only ResolveTransformSpace can raise this on the batched path. The one caller that forces a full | ||
| // state update does so from CommitDetectedState on the main thread, after this job has run. | ||
| var forceState = false; | ||
|
|
||
| // Resolve the transform space before sampling, otherwise the wrong set of values gets compared. | ||
| var transformSpaceChanged = ResolveTransformSpace(ref entry.Config, ref flagStates, entry.TransformHasParent, false, ref forceState); | ||
| entry.State.FlagStates = flagStates; | ||
|
|
||
| var rotation = entry.Config.InLocalSpace ? transform.localRotation : transform.rotation; | ||
| entry.Sample.Position = entry.Config.InLocalSpace ? transform.localPosition : transform.position; | ||
| entry.Sample.Rotation = rotation; | ||
| entry.Sample.RotAngles = NetworkTransformMath.EulerAngles(rotation); | ||
| entry.Sample.Scale = transform.localScale; | ||
|
|
||
| entry.IsDirty = CheckForStateChange(ref entry.State, ref entry.HalfPositionState, ref entry.Config, | ||
| entry.Sample, false, forceState, transformSpaceChanged); | ||
|
|
||
| Entries[index] = entry; | ||
| } | ||
| } | ||
| } | ||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| using Unity.Burst; | ||
| using Unity.Collections; | ||
| using Unity.Jobs; | ||
| using Unity.Mathematics; | ||
|
|
||
| namespace Unity.Netcode.Components | ||
| { | ||
| /// <summary> | ||
| /// The NGO non-authority instance's transform state used by <see cref="InterpolateTransformJob"/>. | ||
| /// See also: | ||
| /// - <see cref="NativeInterpolator"/> | ||
| /// - <see cref="NativeInterpolatorState"/> | ||
| /// </summary> | ||
| internal struct InterpolationEntry | ||
| { | ||
| internal NativeInterpolatorState Position; | ||
| internal NativeInterpolatorState Rotation; | ||
| internal NativeInterpolatorState Scale; | ||
|
|
||
| /// <summary> | ||
| /// The delta frame time whether fixed or standard delta. | ||
| /// </summary> | ||
| internal float DeltaTime; | ||
|
|
||
| /// <summary> | ||
| /// The "ticks ago" time used to decide which buffered measurements are ready to consume. | ||
| /// </summary> | ||
| internal double TickLatencyAsTime; | ||
|
|
||
| /// <summary> | ||
| /// The render time used by <see cref="NetworkTransform.InterpolationTypes.LegacyLerp"/> only. | ||
| /// </summary> | ||
| internal double LegacyRenderTime; | ||
|
|
||
| internal double CurrentTime; | ||
| internal double MinDeltaTime; | ||
| internal double MaxDeltaTime; | ||
|
|
||
| internal NetworkTransform.InterpolationTypes PositionInterpolationType; | ||
| internal NetworkTransform.InterpolationTypes RotationInterpolationType; | ||
| internal NetworkTransform.InterpolationTypes ScaleInterpolationType; | ||
|
|
||
| internal bool SynchronizePosition; | ||
| internal bool SynchronizeRotation; | ||
| internal bool SynchronizeScale; | ||
|
|
||
| // Results, read back on the main thread and applied to the transform there. | ||
| internal float4 InterpolatedPosition; | ||
| internal float4 InterpolatedRotation; | ||
| internal float4 InterpolatedScale; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Non-Authority Only: | ||
| /// Handles interpolation for every registered non-authority <see cref="NetworkTransform"/> in | ||
| /// a parallel job. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// This performs the buffer consumption and interpolation between two state updates only.<br /> | ||
| /// Applying the results to the transforms stays on the main thread, which keeps this job free | ||
| /// of hierarchy write ordering.<br /> | ||
| /// Each entry owns its own slice of <see cref="BufferedItems"/>, so no two indices address the same items.<br /> | ||
| /// The whole array can be written without aliasing (access is to a distinct, independent memory region). | ||
| /// </remarks> | ||
| [BurstCompile] | ||
| internal struct InterpolateTransformJob : IJobParallelFor | ||
| { | ||
| public NativeArray<InterpolationEntry> Entries; | ||
|
|
||
| /// <summary> | ||
| /// The shared state measurement storage. Disabling the safety restriction is what allows each index to write | ||
| /// into its own slice of one array; <see cref="NativeInterpolatorState.BufferOffset"/> keeps those | ||
| /// slices disjoint. | ||
| /// </summary> | ||
| [NativeDisableParallelForRestriction] | ||
| public NativeArray<BufferedItemNative> BufferedItems; | ||
|
|
||
| public void Execute(int index) | ||
| { | ||
| var entry = Entries[index]; | ||
|
|
||
| if (entry.SynchronizePosition) | ||
| { | ||
| entry.InterpolatedPosition = Advance(ref entry.Position, ref entry, entry.PositionInterpolationType); | ||
| } | ||
|
|
||
| if (entry.SynchronizeRotation) | ||
| { | ||
| entry.InterpolatedRotation = Advance(ref entry.Rotation, ref entry, entry.RotationInterpolationType); | ||
| } | ||
|
|
||
| if (entry.SynchronizeScale) | ||
| { | ||
| entry.InterpolatedScale = Advance(ref entry.Scale, ref entry, entry.ScaleInterpolationType); | ||
| } | ||
|
|
||
| Entries[index] = entry; | ||
| } | ||
|
|
||
| private float4 Advance(ref NativeInterpolatorState state, ref InterpolationEntry entry, NetworkTransform.InterpolationTypes interpolationType) | ||
| { | ||
| if (interpolationType == NetworkTransform.InterpolationTypes.LegacyLerp) | ||
| { | ||
| return NativeInterpolator.UpdateLegacy(ref state, ref BufferedItems, entry.DeltaTime, entry.LegacyRenderTime, entry.CurrentTime); | ||
| } | ||
|
|
||
| return NativeInterpolator.Update(ref state, ref BufferedItems, entry.DeltaTime, entry.TickLatencyAsTime, | ||
|
Check warning on line 107 in com.unity.netcode.gameobjects/Runtime/Components/Interpolator/InterpolateTransformJob.cs
|
||
| entry.MinDeltaTime, entry.MaxDeltaTime, interpolationType == NetworkTransform.InterpolationTypes.Lerp); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we deprecate UseUnreliableDeltas, then we can remove this, but if we do not then we have to make sure users know this (even though I doubt there are many users actually using that feature).