Class SceneObjectDelta

A delta object that contains the differences between two scenes.

Hierarchy (view full)

SceneDelta
- SceneObjectDelta

Index

Constructors

Accessors

Methods

apply isAffectingObject toDebugJSON toDebugString

Constructors

constructor

new SceneObjectDelta(base, head, flags?, 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.
- Optionalflags: EnumValue<SceneDeltaFlag, number>
  A set of flags that customize the behavior of the delta generation.
- OptionalisInternalConstructor: boolean
Returns SceneObjectDelta
A shared pointer to the generated scene object delta.

Overrides SceneDelta.constructor

Accessors

isEmpty

get isEmpty(): boolean
Determines whether the delta is empty (i.e. will perform no change on the scene).

Returns boolean
Inherited from SceneDelta.isEmpty

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
Inherited from SceneDelta.apply

isAffectingObject

isAffectingObject(uuid): boolean
Checks whether the delta is affecting an object with the given UUID.
Parameters
- uuid: UUID
Returns boolean
Inherited from SceneDelta.isAffectingObject

toDebugJSON

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

Returns JsonObject

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