API

Class SerializationHelper

Class used to help serialization objects

Index
AllowLoadingUniqueId: boolean = false

Gets or sets a boolean to indicate if the UniqueId property should be serialized

  • Clones an object

    Type Parameters

    • T

    Parameters

    • creationFunction: () => T

      defines the function used to instanciate the new object

    • source: T

      defines the source object

    • options: ICopySourceOptions = {}

      defines the options to use

    Returns T

    the cloned object

  • Instanciates a new object based on a source one (some data will be shared between both object)

    Type Parameters

    • T

    Parameters

    • creationFunction: () => T

      defines the function used to instanciate the new object

    • source: T

      defines the source object

    Returns T

    the new object

  • Creates a new entity from a serialization data object

    Type Parameters

    • T

    Parameters

    • creationFunction: () => T

      defines a function used to instanciated the new entity

    • source: any

      defines the source serialization data

    • scene: Nullable<Scene>

      defines the hosting scene

    • rootUrl: Nullable<string> = null

      defines the root url for resources

    Returns T

    a new entity

  • Given a source json and a destination object in a scene, this function will parse the source and will try to apply its content to the destination object

    Parameters

    • source: any

      the source json data

    • destination: any

      the destination object

    • scene: Nullable<Scene>

      the scene where the object is

    • rootUrl: Nullable<string>

      root url to use to load assets

    Returns void

  • Static function used to serialized a specific entity

    Type Parameters

    • T

    Parameters

    • entity: T

      defines the entity to serialize

    • OptionalserializationObject: any

      defines the optional target object where serialization data will be stored

    Returns any

    a JSON compatible object representing the serialization of the entity