Class SceneObjectDelta

A delta object that contains the differences between two scenes.

Hierarchy

FrameworkObject
- SceneObjectDelta

Index

Constructors

Methods

apply toDebugString

Constructors

constructor

new SceneObjectDelta(base, head, isInternalConstructor?): SceneObjectDelta
Creates a new scene object delta that computes the changes from head has in relation to base scene.
Parameters
- base: SceneInstance
  The base scene to base the diff on.
- head: SceneInstance
  The head scene that contains changes from base.
- OptionalisInternalConstructor: boolean
Returns SceneObjectDelta
A shared pointer to the generated scene object delta.

Overrides FrameworkObject.constructor

Methods

apply

apply(root, flags?): void
Applies the changes stored on the SceneDelta to the given root scene object.
Parameters
- root: SceneObject
  The root scene object to apply the changes to.
- Optionalflags: EnumValue<SceneDeltaFlag, number>
  The flags that describe the scene delta applying behavior.
Returns void

toDebugString

toDebugString(): string
Creates a string that contains a dump of all serialized data on the scene delta. Useful for debugging the contents of a delta.

Returns string