Skip to content

Commit 6408c04

Browse files
PitouGamesPitouGames
committed
feat: Add built-in serialization for UnityEngine.Pose (#2675)
1 parent b5b8eda commit 6408c04

21 files changed

+396
-24
lines changed

‎com.unity.netcode.gameobjects/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Additional documentation and release notes are available at [Multiplayer Documen
99
## [Unreleased]
1010
### Added
1111

12+
- Added serializer for `Pose` (#2675)
13+
1214
### Fixed
1315

1416
- Fixed issue where `NetworkAnimator` was not internally tracking changes to layer weights which prevented proper layer weight synchronization back to the original layer weight value. (#2674)

‎com.unity.netcode.gameobjects/Editor/CodeGen/CodeGenHelpers.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ internal static class CodeGenHelpers
4141
public static readonly string UnityVector3_FullName = typeof(Vector3).FullName;
4242
public static readonly string UnityVector4_FullName = typeof(Vector4).FullName;
4343
public static readonly string UnityQuaternion_FullName = typeof(Quaternion).FullName;
44+
public static readonly string UnityPose_FullName = typeof(Pose).FullName;
4445
public static readonly string UnityRay_FullName = typeof(Ray).FullName;
4546
public static readonly string UnityRay2D_FullName = typeof(Ray2D).FullName;
4647

@@ -305,6 +306,11 @@ public static bool IsSerializable(this TypeReference typeReference)
305306
return true;
306307
}
307308

309+
if (typeReference.FullName == UnityPose_FullName)
310+
{
311+
return true;
312+
}
313+
308314
if (typeReference.FullName == UnityRay_FullName)
309315
{
310316
return true;

‎com.unity.netcode.gameobjects/Editor/CodeGen/NetworkBehaviourILPP.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,7 @@ private void CreateNetworkVariableTypeInitializers(AssemblyDefinition assembly)
434434
typeof(Vector3Int),
435435
typeof(Vector4),
436436
typeof(Quaternion),
437+
typeof(Pose),
437438
typeof(Color),
438439
typeof(Color32),
439440
typeof(Ray),

‎com.unity.netcode.gameobjects/Runtime/Serialization/BufferSerializer.cs

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,18 @@ public FastBufferWriter GetFastBufferWriter()
231231
/// <param name="value">The values to read/write</param>
232232
public void SerializeValue(ref Quaternion[] value) => m_Implementation.SerializeValue(ref value);
233233

234+
/// <summary>
235+
/// Read or write a Pose value
236+
/// </summary>
237+
/// <param name="value">The value to read/write</param>
238+
public void SerializeValue(ref Pose value) => m_Implementation.SerializeValue(ref value);
239+
240+
/// <summary>
241+
/// Read or write an array of Pose values
242+
/// </summary>
243+
/// <param name="value">The values to read/write</param>
244+
public void SerializeValue(ref Pose[] value) => m_Implementation.SerializeValue(ref value);
245+
234246
/// <summary>
235247
/// Read or write a Color value
236248
/// </summary>
@@ -555,6 +567,24 @@ public bool PreCheck(int amount)
555567
/// <param name="value">The value to read/write</param>
556568
public void SerializeValuePreChecked(ref Quaternion[] value) => m_Implementation.SerializeValuePreChecked(ref value);
557569

570+
/// <summary>
571+
/// Serialize a Pose, "pre-checked", which skips buffer checks.
572+
/// In debug and editor builds, a check is made to ensure you've called "PreCheck" before
573+
/// calling this. In release builds, calling this without calling "PreCheck" may read or write
574+
/// past the end of the buffer, which will cause memory corruption and undefined behavior.
575+
/// </summary>
576+
/// <param name="value">The value to read/write</param>
577+
public void SerializeValuePreChecked(ref Pose value) => m_Implementation.SerializeValuePreChecked(ref value);
578+
579+
/// <summary>
580+
/// Serialize a Pose array, "pre-checked", which skips buffer checks.
581+
/// In debug and editor builds, a check is made to ensure you've called "PreCheck" before
582+
/// calling this. In release builds, calling this without calling "PreCheck" may read or write
583+
/// past the end of the buffer, which will cause memory corruption and undefined behavior.
584+
/// </summary>
585+
/// <param name="value">The value to read/write</param>
586+
public void SerializeValuePreChecked(ref Pose[] value) => m_Implementation.SerializeValuePreChecked(ref value);
587+
558588
/// <summary>
559589
/// Serialize a Color, "pre-checked", which skips buffer checks.
560590
/// In debug and editor builds, a check is made to ensure you've called "PreCheck" before

‎com.unity.netcode.gameobjects/Runtime/Serialization/BufferSerializerReader.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ public void SerializeValue<T>(ref T value, FastBufferWriter.ForFixedStrings unus
7171
public void SerializeValue(ref Quaternion value) => m_Reader.ReadValueSafe(out value);
7272
public void SerializeValue(ref Quaternion[] value) => m_Reader.ReadValueSafe(out value);
7373

74+
public void SerializeValue(ref Pose value) => m_Reader.ReadValueSafe(out value);
75+
public void SerializeValue(ref Pose[] value) => m_Reader.ReadValueSafe(out value);
76+
7477
public void SerializeValue(ref Color value) => m_Reader.ReadValueSafe(out value);
7578
public void SerializeValue(ref Color[] value) => m_Reader.ReadValueSafe(out value);
7679

@@ -127,6 +130,9 @@ public void SerializeValuePreChecked<T>(ref T value, FastBufferWriter.ForFixedSt
127130
public void SerializeValuePreChecked(ref Quaternion value) => m_Reader.ReadValue(out value);
128131
public void SerializeValuePreChecked(ref Quaternion[] value) => m_Reader.ReadValue(out value);
129132

133+
public void SerializeValuePreChecked(ref Pose value) => m_Reader.ReadValue(out value);
134+
public void SerializeValuePreChecked(ref Pose[] value) => m_Reader.ReadValue(out value);
135+
130136
public void SerializeValuePreChecked(ref Color value) => m_Reader.ReadValue(out value);
131137
public void SerializeValuePreChecked(ref Color[] value) => m_Reader.ReadValue(out value);
132138

‎com.unity.netcode.gameobjects/Runtime/Serialization/BufferSerializerWriter.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,9 @@ public void SerializeValue<T>(ref T value, FastBufferWriter.ForFixedStrings unus
7070
public void SerializeValue(ref Quaternion value) => m_Writer.WriteValueSafe(value);
7171
public void SerializeValue(ref Quaternion[] value) => m_Writer.WriteValueSafe(value);
7272

73+
public void SerializeValue(ref Pose value) => m_Writer.WriteValueSafe(value);
74+
public void SerializeValue(ref Pose[] value) => m_Writer.WriteValueSafe(value);
75+
7376
public void SerializeValue(ref Color value) => m_Writer.WriteValueSafe(value);
7477
public void SerializeValue(ref Color[] value) => m_Writer.WriteValueSafe(value);
7578

@@ -128,6 +131,9 @@ public void SerializeValuePreChecked<T>(ref T value, FastBufferWriter.ForFixedSt
128131
public void SerializeValuePreChecked(ref Quaternion value) => m_Writer.WriteValue(value);
129132
public void SerializeValuePreChecked(ref Quaternion[] value) => m_Writer.WriteValue(value);
130133

134+
public void SerializeValuePreChecked(ref Pose value) => m_Writer.WriteValue(value);
135+
public void SerializeValuePreChecked(ref Pose[] value) => m_Writer.WriteValue(value);
136+
131137
public void SerializeValuePreChecked(ref Color value) => m_Writer.WriteValue(value);
132138
public void SerializeValuePreChecked(ref Color[] value) => m_Writer.WriteValue(value);
133139

‎com.unity.netcode.gameobjects/Runtime/Serialization/BytePacker.cs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,23 @@ public static void WriteValuePacked(FastBufferWriter writer, Quaternion rotation
259259
WriteValuePacked(writer, rotation.w);
260260
}
261261

262+
/// <summary>
263+
/// Writes the pose to the buffer.
264+
/// </summary>
265+
/// <param name="writer">The writer to write to</param>
266+
/// <param name="pose">Pose to write</param>
267+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
268+
public static void WriteValuePacked(FastBufferWriter writer, Pose pose)
269+
{
270+
WriteValuePacked(writer, pose.position.x);
271+
WriteValuePacked(writer, pose.position.y);
272+
WriteValuePacked(writer, pose.position.z);
273+
WriteValuePacked(writer, pose.rotation.x);
274+
WriteValuePacked(writer, pose.rotation.y);
275+
WriteValuePacked(writer, pose.rotation.z);
276+
WriteValuePacked(writer, pose.rotation.w);
277+
}
278+
262279
/// <summary>
263280
/// Writes a string in a packed format
264281
/// </summary>

‎com.unity.netcode.gameobjects/Runtime/Serialization/ByteUnpacker.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,24 @@ public static void ReadValuePacked(FastBufferReader reader, out Quaternion rotat
278278
ReadValuePacked(reader, out rotation.w);
279279
}
280280

281+
/// <summary>
282+
/// Reads the pose from the stream.
283+
/// </summary>
284+
/// <param name="reader">The reader to read from</param>
285+
/// <param name="pose">Pose to read</param>
286+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
287+
public static void ReadValuePacked(FastBufferReader reader, out Pose pose)
288+
{
289+
pose = new Pose();
290+
ReadValuePacked(reader, out pose.position.x);
291+
ReadValuePacked(reader, out pose.position.y);
292+
ReadValuePacked(reader, out pose.position.z);
293+
ReadValuePacked(reader, out pose.rotation.x);
294+
ReadValuePacked(reader, out pose.rotation.y);
295+
ReadValuePacked(reader, out pose.rotation.z);
296+
ReadValuePacked(reader, out pose.rotation.w);
297+
}
298+
281299
/// <summary>
282300
/// Reads a string in a packed format
283301
/// </summary>

‎com.unity.netcode.gameobjects/Runtime/Serialization/FastBufferReader.cs

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1249,6 +1249,20 @@ public void ReadValueSafeInPlace<T>(ref NativeList<T> value, FastBufferWriter.Fo
12491249
[MethodImpl(MethodImplOptions.AggressiveInlining)]
12501250
public void ReadValue(out Quaternion[] value) => ReadUnmanaged(out value);
12511251

1252+
/// <summary>
1253+
/// Read a Pose
1254+
/// </summary>
1255+
/// <param name="value">the value to read</param>
1256+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
1257+
public void ReadValue(out Pose value) => ReadUnmanaged(out value);
1258+
1259+
/// <summary>
1260+
/// Read a Pose array
1261+
/// </summary>
1262+
/// <param name="value">the values to read</param>
1263+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
1264+
public void ReadValue(out Pose[] value) => ReadUnmanaged(out value);
1265+
12521266
/// <summary>
12531267
/// Read a Color
12541268
/// </summary>
@@ -1426,6 +1440,26 @@ public void ReadValueSafeInPlace<T>(ref NativeList<T> value, FastBufferWriter.Fo
14261440
[MethodImpl(MethodImplOptions.AggressiveInlining)]
14271441
public void ReadValueSafe(out Quaternion[] value) => ReadUnmanagedSafe(out value);
14281442

1443+
/// <summary>
1444+
/// Read a Pose
1445+
///
1446+
/// "Safe" version - automatically performs bounds checking. Less efficient than bounds checking
1447+
/// for multiple reads at once by calling TryBeginRead.
1448+
/// </summary>
1449+
/// <param name="value">the value to read</param>
1450+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
1451+
public void ReadValueSafe(out Pose value) => ReadUnmanagedSafe(out value);
1452+
1453+
/// <summary>
1454+
/// Read a Pose array
1455+
///
1456+
/// "Safe" version - automatically performs bounds checking. Less efficient than bounds checking
1457+
/// for multiple reads at once by calling TryBeginRead.
1458+
/// </summary>
1459+
/// <param name="value">the values to read</param>
1460+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
1461+
public void ReadValueSafe(out Pose[] value) => ReadUnmanagedSafe(out value);
1462+
14291463
/// <summary>
14301464
/// Read a Color
14311465
///

‎com.unity.netcode.gameobjects/Runtime/Serialization/FastBufferWriter.cs

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1441,6 +1441,20 @@ public void WriteValueSafe<T>(NativeList<T> value, ForGeneric unused = default)
14411441
[MethodImpl(MethodImplOptions.AggressiveInlining)]
14421442
public void WriteValue(Quaternion[] value) => WriteUnmanaged(value);
14431443

1444+
/// <summary>
1445+
/// Write a Pose
1446+
/// </summary>
1447+
/// <param name="value">the value to write</param>
1448+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
1449+
public void WriteValue(in Pose value) => WriteUnmanaged(value);
1450+
1451+
/// <summary>
1452+
/// Write a Pose array
1453+
/// </summary>
1454+
/// <param name="value">the values to write</param>
1455+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
1456+
public void WriteValue(Pose[] value) => WriteUnmanaged(value);
1457+
14441458
/// <summary>
14451459
/// Write a Color
14461460
/// </summary>
@@ -1617,6 +1631,26 @@ public void WriteValueSafe<T>(NativeList<T> value, ForGeneric unused = default)
16171631
[MethodImpl(MethodImplOptions.AggressiveInlining)]
16181632
public void WriteValueSafe(Quaternion[] value) => WriteUnmanagedSafe(value);
16191633

1634+
/// <summary>
1635+
/// Write a Pose
1636+
///
1637+
/// "Safe" version - automatically performs bounds checking. Less efficient than bounds checking
1638+
/// for multiple writes at once by calling TryBeginWrite.
1639+
/// </summary>
1640+
/// <param name="value">the value to write</param>
1641+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
1642+
public void WriteValueSafe(in Pose value) => WriteUnmanagedSafe(value);
1643+
1644+
/// <summary>
1645+
/// Write a Pose array
1646+
///
1647+
/// "Safe" version - automatically performs bounds checking. Less efficient than bounds checking
1648+
/// for multiple writes at once by calling TryBeginWrite.
1649+
/// </summary>
1650+
/// <param name="value">the values to write</param>
1651+
[MethodImpl(MethodImplOptions.AggressiveInlining)]
1652+
public void WriteValueSafe(Pose[] value) => WriteUnmanagedSafe(value);
1653+
16201654
/// <summary>
16211655
/// Write a Color
16221656
///

‎com.unity.netcode.gameobjects/Runtime/Serialization/IReaderWriter.cs

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,18 @@ void SerializeValue<T>(ref NativeList<T> value)
233233
/// <param name="value">The values to read/write</param>
234234
void SerializeValue(ref Quaternion[] value);
235235

236+
/// <summary>
237+
/// Read or write a Pose value
238+
/// </summary>
239+
/// <param name="value">The value to read/write</param>
240+
void SerializeValue(ref Pose value);
241+
242+
/// <summary>
243+
/// Read or write an array of Pose values
244+
/// </summary>
245+
/// <param name="value">The values to read/write</param>
246+
void SerializeValue(ref Pose[] value);
247+
236248
/// <summary>
237249
/// Read or write a Color value
238250
/// </summary>
@@ -529,6 +541,24 @@ void SerializeValuePreChecked<T>(ref T value, FastBufferWriter.ForFixedStrings u
529541
/// <param name="value">The value to read/write</param>
530542
void SerializeValuePreChecked(ref Quaternion[] value);
531543

544+
/// <summary>
545+
/// Serialize a Pose, "pre-checked", which skips buffer checks.
546+
/// In debug and editor builds, a check is made to ensure you've called "PreCheck" before
547+
/// calling this. In release builds, calling this without calling "PreCheck" may read or write
548+
/// past the end of the buffer, which will cause memory corruption and undefined behavior.
549+
/// </summary>
550+
/// <param name="value">The value to read/write</param>
551+
void SerializeValuePreChecked(ref Pose value);
552+
553+
/// <summary>
554+
/// Serialize a Pose array, "pre-checked", which skips buffer checks.
555+
/// In debug and editor builds, a check is made to ensure you've called "PreCheck" before
556+
/// calling this. In release builds, calling this without calling "PreCheck" may read or write
557+
/// past the end of the buffer, which will cause memory corruption and undefined behavior.
558+
/// </summary>
559+
/// <param name="value">The value to read/write</param>
560+
void SerializeValuePreChecked(ref Pose[] value);
561+
532562
/// <summary>
533563
/// Serialize a Color, "pre-checked", which skips buffer checks.
534564
/// In debug and editor builds, a check is made to ensure you've called "PreCheck" before

0 commit comments

Comments
 (0)