API reference

SerializationHelpers Class

This contains helpers to serialize/deserialze Scene data to/from JSON.

Static Fields

UnrealWorldToMeters : const float
Signature
const float UnrealWorldToMeters

Static Methods

Deserialize ( json )
Deserializes a JSON string into a list of MRUKRoom objects.
Signature
static Data.SceneData Deserialize(string json)
Parameters
json: string  The JSON string representing the serialized scene data.
Returns
Data.SceneData  A list of MRUKRoom objects representing the deserialized scene data.
Serialize ( coordinateSystem , includeGlobalMesh , rooms )
Serializes the scene data into a JSON string.
The scene data includes rooms, anchors, and their associated properties. The method allows for the specification of the coordinate system (Unity or Unreal) and whether to include the global mesh data.
Signature
static string Serialize(CoordinateSystem coordinateSystem=CoordinateSystem.Unity, bool includeGlobalMesh=true, List< MRUKRoom > rooms=null)
Parameters
coordinateSystem: CoordinateSystem  The coordinate system to use for the serialization (Unity or Unreal).
includeGlobalMesh: bool  A boolean indicating whether to include the global mesh data in the serialization. Default is true.
rooms: List< MRUKRoom >  A list of rooms to serialize, if this is null then all rooms will be serialized.
Returns
string  A JSON string representing the serialized scene data.

Inner Enum

CoordinateSystem Enum

Defines the coordinate systems that can be used for serialization.

Enumeration Constants

Member
Unity
Unreal