charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 11:00:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

breaking(NetworkTransform): Use Flags enum for Sync and Interpolation (#3751)

Browse Source 
* breaking(NetworkTransform): Use Flags enum for Sync and Interpolation
- retains public fields converted to readonly shortcuts to flag enum value
- breaking change because components would be reset to defaults.

This may not get merged to current NT, but could be applied to future versions.

* NetworkTransform2kTests: removed commented code

* Better Naming and Bandwidth Savings Flags

* Removed comment
This commit is contained in:
MrGadget 2024-04-15 11:06:48 -04:00
parent 461c111171
commit 3ad83d6911
2 changed files with 45 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
Assets/Mirror/Components/NetworkTransform/NetworkTransformBase.cs
View File

@ -24,6 +24,25 @@ namespace Mirror
{
public enum CoordinateSpace { Local, World }
[Flags]
public enum SyncInterpolateOptions
{
Nothing,
Position = 1 << 0,
Rotation = 1 << 1,
Scale = 1 << 2,
Default = Position | Rotation
}
[Flags]
public enum BandwidthSavingsOptions
{
Nothing,
OnlySyncOnChange = 1 << 0,
CompressRotation = 1 << 1,
Default = OnlySyncOnChange | CompressRotation
}
public abstract class NetworkTransformBase : NetworkBehaviour
{
// target transform to sync. can be on a child.
@ -41,29 +60,33 @@ public abstract class NetworkTransformBase : NetworkBehaviour
public readonly SortedList<double, TransformSnapshot> serverSnapshots = new SortedList<double, TransformSnapshot>(16);
// selective sync //////////////////////////////////////////////////////
[Header("Selective Sync\nDon't change these at Runtime")]
public bool syncPosition = true; // do not change at runtime!
public bool syncRotation = true; // do not change at runtime!
public bool syncScale = false; // do not change at runtime! rare. off by default.
[Header("Synchronization - Do Not Change At Runtime")]
[SerializeField, Tooltip("Selectively syncs position, rotation, and scale.\nDo Not Change At Runtime!")]
internal SyncInterpolateOptions synchronizationSelections = SyncInterpolateOptions.Default;
[Header("Bandwidth Savings")]
[Tooltip("When true, changes are not sent unless greater than sensitivity values below.")]
public bool onlySyncOnChange = true;
[Tooltip("Apply smallest-three quaternion compression. This is lossy, you can disable it if the small rotation inaccuracies are noticeable in your project.")]
public bool compressRotation = true;
public bool syncPosition => (synchronizationSelections & SyncInterpolateOptions.Position) == SyncInterpolateOptions.Position;
public bool syncRotation => (synchronizationSelections & SyncInterpolateOptions.Rotation) == SyncInterpolateOptions.Rotation;
public bool syncScale => (synchronizationSelections & SyncInterpolateOptions.Scale) == SyncInterpolateOptions.Scale;
// interpolation is on by default, but can be disabled to jump to
// the destination immediately. some projects need this.
[Header("Interpolation")]
[Tooltip("Set to false to have a snap-like effect on position movement.")]
public bool interpolatePosition = true;
[Tooltip("Set to false to have a snap-like effect on rotations.")]
public bool interpolateRotation = true;
[Tooltip("Set to false to remove scale smoothing. Example use-case: Instant flipping of sprites that use -X and +X for direction.")]
public bool interpolateScale = true;
[Header("Interpolation - Do Not Change At Runtime")]
[SerializeField, Tooltip("Interpolate smoothly between snapshots.\nDo Not Change At Runtime!")]
internal SyncInterpolateOptions interpolationOptions = SyncInterpolateOptions.Default;
public bool interpolatePosition => (interpolationOptions & SyncInterpolateOptions.Position) == SyncInterpolateOptions.Position;
public bool interpolateRotation => (interpolationOptions & SyncInterpolateOptions.Rotation) == SyncInterpolateOptions.Rotation;
public bool interpolateScale => (interpolationOptions & SyncInterpolateOptions.Scale) == SyncInterpolateOptions.Scale;
[Header("Bandwidth Savings - Do Not Change At Runtime")]
[SerializeField, Tooltip("Settings for reducing bandwidth usage.\nDo Not Change At Runtime!")]
internal BandwidthSavingsOptions bandwidthSavingsOptions = BandwidthSavingsOptions.Default;
public bool onlySyncOnChange => (bandwidthSavingsOptions & BandwidthSavingsOptions.OnlySyncOnChange) == BandwidthSavingsOptions.OnlySyncOnChange;
public bool compressRotation => (bandwidthSavingsOptions & BandwidthSavingsOptions.CompressRotation) == BandwidthSavingsOptions.CompressRotation;
// CoordinateSpace ///////////////////////////////////////////////////////////
[Header("Coordinate Space")]
[Header("Coordinate Space - Do Not Change At Runtime")]
[Tooltip("Local by default. World may be better when changing hierarchy, or non-NetworkTransforms root position/rotation/scale values.")]
public CoordinateSpace coordinateSpace = CoordinateSpace.Local;
@ -118,7 +141,7 @@ protected override void OnValidate()
// Unity doesn't support setting world scale.
// OnValidate force disables syncScale in world mode.
if (coordinateSpace == CoordinateSpace.World) syncScale = false;
if (coordinateSpace == CoordinateSpace.World) synchronizationSelections &= ~SyncInterpolateOptions.Scale;
}
// snapshot functions //////////////////////////////////////////////////

16
Assets/Mirror/Tests/Editor/NetworkTransform/NetworkTransform2kTests.cs
View File

@ -123,9 +123,7 @@ public void Apply()
Vector3 scale = new Vector3(4, 5, 6);
// apply snapshot with interpolation
component.syncPosition = true;
component.syncRotation = true;
component.syncScale = true;
component.synchronizationSelections = SyncInterpolateOptions.Position | SyncInterpolateOptions.Rotation | SyncInterpolateOptions.Scale;
component.Apply(new TransformSnapshot(0, 0, position, rotation, scale));
// was it applied?
@ -143,9 +141,7 @@ public void ApplySnapshot_DontSyncPosition()
Vector3 scale = new Vector3(4, 5, 6);
// apply snapshot without position sync should not apply position
component.syncPosition = false;
component.syncRotation = true;
component.syncScale = true;
component.synchronizationSelections = SyncInterpolateOptions.Rotation | SyncInterpolateOptions.Scale;
component.Apply(new TransformSnapshot(0, 0, position, rotation, scale));
// was it applied?
@ -163,9 +159,7 @@ public void ApplySnapshot_DontSyncRotation()
Vector3 scale = new Vector3(4, 5, 6);
// apply snapshot without position sync should not apply position
component.syncPosition = true;
component.syncRotation = false;
component.syncScale = true;
component.synchronizationSelections = SyncInterpolateOptions.Position | SyncInterpolateOptions.Scale;
component.Apply(new TransformSnapshot(0, 0, position, rotation, scale));
// was it applied?
@ -183,9 +177,7 @@ public void ApplySnapshot_DontSyncScale()
Vector3 scale = new Vector3(4, 5, 6);
// apply snapshot without position sync should not apply position
component.syncPosition = true;
component.syncRotation = true;
component.syncScale = false;
component.synchronizationSelections = SyncInterpolateOptions.Position | SyncInterpolateOptions.Rotation;
component.Apply(new TransformSnapshot(0, 0, position, rotation, scale));
// was it applied?