Class TemplateUtility

The TemplateUtility class provides various template specific utilities and helpers to interact with Template and SceneObject instances.

Hierarchy (View Summary)

rsx.TemplateUtility
- TemplateUtility

Constructors

`Protected`constructor

new TemplateUtility(isInternalConstructor?: boolean): rsx.Editor.TemplateUtility
Parameters
- OptionalisInternalConstructor: boolean
Returns rsx.Editor.TemplateUtility

Inherited from TemplateUtility.constructor

Methods

`Static`applySceneObjectToTemplate

applySceneObjectToTemplate(
    sceneObject: SceneObject,
    template: Template,
    autoApply?: boolean,
): void
Updates the contents of the template with the contents of a provided scene object.
Parameters
- sceneObject: SceneObject
  SceneObject to save as a template
- template: Template
  The template resource to save to.
- OptionalautoApply: boolean
Returns void

`Static`applyTemplate

applyTemplate(
sceneObject: SceneObject,
objectTemplate: Template,
): UncertainAsyncOp<TemplateOperationResult, string>
Updates the contents of the template with the contents of the provided template instance. If the provided object is not a template instance nothing happens. All template instances in all open scenes will have their diffs recorded, and will be updated after the apply operation is done.
Parameters
- sceneObject: SceneObject
  Template instance whose template to update.
- objectTemplate: Template
  The template to apply.
Returns UncertainAsyncOp<TemplateOperationResult, string>
Object signaling status and return value of the operation.

Inherited from TemplateUtility.applyTemplate

`Static`applyTemplateInstanceToTemplate

applyTemplateInstanceToTemplate(sceneObject: SceneObject): void
Updates the contents of the template with the contents of the provided sceneObject. The sceneObject must be a template instance. If it is not a template instance, an error is logged to the console.
Parameters
- sceneObject: SceneObject
  SceneObject that is part of a template instance to apply to the template resource.
Returns void

`Static`assignTemplateInstanceUUIDs

assignTemplateInstanceUUIDs(
    instanceRoot: SceneObject,
    templateRoot: SceneObject,
    templateResource: Template | ResourceHandle<Template>,
): void
Populates Template UUIDs of the provided scene object. The template UUIDs are taken from the provided template object UUIDs. Both of the hierarchies must match identically. Also ensures all objects in the instance hierarchy have the provided template resource UUID link, essentially breaking any nested template links.
Parameters
- instanceRoot: SceneObject
- templateRoot: SceneObject
- templateResource: Template | ResourceHandle<Template>
Returns void

Inherited from TemplateUtility.assignTemplateInstanceUUIDs

`Static`breakTemplate

breakTemplate(sceneObject: SceneObject): void
Breaks the link between a template instance and its template. Object will retain all current values but will no longer be influenced by modifications to its parent template.
Parameters
- sceneObject: SceneObject
  Template instance whose link to break.
Returns void

Inherited from TemplateUtility.breakTemplate

`Static`breakTemplateLinkForSceneObjects

breakTemplateLinkForSceneObjects(
    undoRedo: UndoRedo,
    sceneObjects: SceneObject[],
    fnOnSuccess?: () => void,
    fnOnError?: (errorMessage: string) => void,
): void
Breaks the template link for the provided scene objects.
Parameters
- undoRedo: UndoRedo
  The undo/redo information structure.
- sceneObjects: SceneObject[]
  The scene objects to break the template link for.
- OptionalfnOnSuccess: () => void
  An optional callback that is invoked on success.
- OptionalfnOnError: (errorMessage: string) => void
  An optional callback that is invoked on error.
Returns void

`Static`createTemplate

createTemplate(
sceneObject: SceneObject,
libraryPath: LibraryPath,
): UncertainAsyncOp<TemplateOperationResult, string>
Creates a new template from the provided scene object hierarchy, and makes the scene object an instance of the template if succesful.
Parameters
- sceneObject: SceneObject
  Scene object hierarchy from which to create the template.
- libraryPath: LibraryPath
  Virtual library path at which to store the template in.
Returns UncertainAsyncOp<TemplateOperationResult, string>
Object signaling status and return value of the operation.

Inherited from TemplateUtility.createTemplate

`Static`createTemplateChecked

createTemplateChecked(
    sceneObject: SceneObject,
    libraryPath: LibraryPath,
    fnOnSuccess?: (result: TemplateOperationResult) => void,
    fnOnError?: (errorMessage: string) => void,
): void
Creates a new template from the provided scene object and stores it in the library.
Parameters
- sceneObject: SceneObject
  Objects to create the template from. Once template save is completed the object will be converted to the instance of the template.
- libraryPath: LibraryPath
  Virtual library path at which to store the template.
- OptionalfnOnSuccess: (result: TemplateOperationResult) => void
- OptionalfnOnError: (errorMessage: string) => void
Returns void

`Static`createTemplateFromObjects

createTemplateFromObjects(
    undoRedo: UndoRedo,
    sceneObjects: SceneObject[],
    destinationLibraryPath: LibraryPath,
    libraryPathContainsName?: boolean,
    fnOnSuccess?: (
        result: TemplateOperationResult,
        templateLibraryPath: LibraryPath,
        templateRoot: SceneObject,
    ) => void,
    fnOnError?: (errorMessage: string) => void,
): boolean
Creates a template from the selected scene objects, the object will be grouped in a new parent if needed, can be undone.
Parameters
- undoRedo: UndoRedo
  The undo/redo information structure.
- sceneObjects: SceneObject[]
  The scene objects to create a template from.
- destinationLibraryPath: LibraryPath
  The directory in the library where to save the template.
- OptionallibraryPathContainsName: boolean
- OptionalfnOnSuccess: (
      result: TemplateOperationResult,
      templateLibraryPath: LibraryPath,
      templateRoot: SceneObject,
  ) => void
- OptionalfnOnError: (errorMessage: string) => void
Returns boolean
True if the template creation operation was started.

`Static`gatherAffectedHandlesByTemplateSave

gatherAffectedHandlesByTemplateSave(root: SceneObject): SceneNode[]
Gathers all affectted SceneNodes by a template save operation.
Parameters
- root: SceneObject
  The root to start gathering new objects fron.
Returns SceneNode[]
A vector of all new scene nodes on the template instance.

Inherited from TemplateUtility.gatherAffectedHandlesByTemplateSave

`Static`getTemplateDeltaDebug

getTemplateDeltaDebug(object: SceneObject): string
Computes and returns a debug string representation of the template delta for the provided scene object. The delta is computed on the fly against the template version the instance was last synced to.
Parameters
- object: SceneObject
  Scene object to compute the template delta debug string for.
Returns string
Debug string of the template delta, or empty string if the object is not a template instance.

Inherited from TemplateUtility.getTemplateDeltaDebug

`Static`getTemplateInstanceRoot

getTemplateInstanceRoot(sceneObject: SceneObject): SceneObject
Returns the root object of the template instance that this object belongs to, if any.
Parameters
- sceneObject: SceneObject
  Scene object to retrieve the template parent for.
Returns SceneObject
Template parent of the provided object, or null if the object is not part of a template instance.

Inherited from TemplateUtility.getTemplateInstanceRoot

`Static`getTemplateLinkUUID

getTemplateLinkUUID(sceneObject: SceneObject): UUID
Returns the UUID of the template attached to the provided scene object.
Parameters
- sceneObject: SceneObject
  Scene object to retrieve the template UUID for.
Returns UUID
Template UUID if the object is part of a template, empty uuid otherwise.

Inherited from TemplateUtility.getTemplateLinkUUID

`Static`isTemplateInstance

isTemplateInstance(sceneObject: SceneObject): boolean
Checks if a scene object has a template link. Scene objects with a template link will be automatically updated when their template changes in order to reflect its changes.
Parameters
- sceneObject: SceneObject
  Scene object to check if it has a template link.
Returns boolean
True if the object is a template instance (has a template link), false otherwise.

Inherited from TemplateUtility.isTemplateInstance

`Static`isTemplateInstanceOutOfDate

isTemplateInstanceOutOfDate(sceneObject: SceneObject): boolean
Checks if a template instance root is out of date relative to its template resource.
Parameters
- sceneObject: SceneObject
Returns boolean

`Static`revertToTemplate

revertToTemplate(sceneObject: SceneObject): void
Remove any instance specific changes to the object or its hierarchy from the provided template instance and restore it to the exact copy of the linked template.
Parameters
- sceneObject: SceneObject
  Object to revert.
Returns void

Inherited from TemplateUtility.revertToTemplate

`Static`updateAllUnversionedInstancesOfTemplate

updateAllUnversionedInstancesOfTemplate(
templateResource: Template | ResourceHandle<Template>,
): void
Updates unversioned instances of the given template across all currently loaded scenes. Instances that have a pinned template version are skipped; use UpdateInstanceFromTemplate for those.
Parameters
- templateResource: Template | ResourceHandle<Template>
  The template resource to update the instances for.
Returns void

Inherited from TemplateUtility.updateAllUnversionedInstancesOfTemplate

`Static`updateInstanceFromTemplate

updateInstanceFromTemplate(
sceneObject: SceneObject,
flags?: EnumValue<TemplateInstanceUpdateFlag>,
): void
Updates a template instance to the most recent version of the object from the template resource.
Parameters
- sceneObject: SceneObject
  Object to update.
- Optionalflags: EnumValue<TemplateInstanceUpdateFlag>
  Flags that determine the update behavior.
Returns void

Inherited from TemplateUtility.updateInstanceFromTemplate

`Static`updateInstancesFromTemplate

updateInstancesFromTemplate(
instances: SceneObject[],
flags?: EnumValue<TemplateInstanceUpdateFlag>,
): void
Updates multiple template instances to the most recent version of the object from the template resources. Use this over updateInstanceFromTemplate if it is possible that one object has moved from one template instance to another. Calling this method with both instances instead of separate calls to updateInstanceFromTemplate ensures that UUIDs are resolved properly.
Parameters
- instances: SceneObject[]
  The template instances to update.
- Optionalflags: EnumValue<TemplateInstanceUpdateFlag>
  Flags that determine the update behavior.
Returns void

Inherited from TemplateUtility.updateInstancesFromTemplate

`Static`updateInternalInstanceFromTemplate

updateInternalInstanceFromTemplate(
    instance: SceneObject,
    templateResource: Template | ResourceHandle<Template>,
    flags?: EnumValue<TemplateInstanceUpdateFlag>,
): void
Updates an internal template instance (keepTemplateInternals) to the most recent version from the provided template resource. Unlike UpdateInstanceFromTemplate, this does not require template link data (OriginObjectID, templateResource) on the instance.
Parameters
- instance: SceneObject
  The internal template instance root to update.
- templateResource: Template | ResourceHandle<Template>
  The template resource to update from.
- Optionalflags: EnumValue<TemplateInstanceUpdateFlag>
  Flags that determine the update behavior.
Returns void

Inherited from TemplateUtility.updateInternalInstanceFromTemplate

`Static`updateUnversionedInstancesFromNestedTemplate

updateUnversionedInstancesFromNestedTemplate(
templateResource: Template | ResourceHandle<Template>,
nestedTemplate: Template | ResourceHandle<Template>,
): void
Updates unversioned instances of nestedTemplate within templateResource. Instances that have a pinned template version are skipped.
Parameters
- templateResource: Template | ResourceHandle<Template>
  The template resource to update.
- nestedTemplate: Template | ResourceHandle<Template>
  The template resource of the instances to update.
Returns void

Inherited from TemplateUtility.updateUnversionedInstancesFromNestedTemplate

`Static`updateUnversionedInstancesInScene

updateUnversionedInstancesInScene(
scene: SceneInstance,
templateResource: Template | ResourceHandle<Template>,
): void
Updates unversioned template instances in the scene to their most recent version. Instances that have a pinned template version are skipped; use UpdateInstanceFromTemplate for those.
Parameters
- scene: SceneInstance
  Scene instance to update.
- templateResource: Template | ResourceHandle<Template>
  The template resource to update the instances for. Null if all instances should be updated.
Returns void

Inherited from TemplateUtility.updateUnversionedInstancesInScene

Events

`Static` `Readonly`onRevertedToTemplate

onRevertedToTemplate: Event<[sceneObject: SceneObject]>

Invoked when a scene object was reverted to the template.

`Static` `Readonly`onTemplateSaved

onTemplateSaved: Event<[p0: ResourceHandle<Template>]>

Invoked when a template resource is saved.

Class TemplateUtility

Hierarchy (View Summary)

Index

Constructors

Methods

Events

Constructors

Protectedconstructor

Parameters

Returns rsx.Editor.TemplateUtility

Methods

StaticapplySceneObjectToTemplate

Parameters

Returns void

StaticapplyTemplate

Parameters

Returns UncertainAsyncOp<TemplateOperationResult, string>

StaticapplyTemplateInstanceToTemplate

Parameters

Returns void

StaticassignTemplateInstanceUUIDs

Parameters

Returns void

StaticbreakTemplate

Parameters

Returns void

StaticbreakTemplateLinkForSceneObjects

Parameters

Returns void

StaticcreateTemplate

Parameters

Returns UncertainAsyncOp<TemplateOperationResult, string>

StaticcreateTemplateChecked

Parameters

Returns void

StaticcreateTemplateFromObjects

Parameters

Returns boolean

StaticgatherAffectedHandlesByTemplateSave

Parameters

Returns SceneNode[]

StaticgetTemplateDeltaDebug

Parameters

Returns string

StaticgetTemplateInstanceRoot

Parameters

Returns SceneObject

StaticgetTemplateLinkUUID

Parameters

Returns UUID

StaticisTemplateInstance

Parameters

Returns boolean

StaticisTemplateInstanceOutOfDate

Parameters

Returns boolean

StaticrevertToTemplate

Parameters

Returns void

StaticupdateAllUnversionedInstancesOfTemplate

Parameters

Returns void

StaticupdateInstanceFromTemplate

Parameters

Returns void

StaticupdateInstancesFromTemplate

Parameters

Returns void

StaticupdateInternalInstanceFromTemplate

Parameters

Returns void

StaticupdateUnversionedInstancesFromNestedTemplate

Parameters

Returns void

StaticupdateUnversionedInstancesInScene

Parameters

Returns void

Events

Static ReadonlyonRevertedToTemplate

Static ReadonlyonTemplateSaved

`Protected`constructor

`Static`applySceneObjectToTemplate

`Static`applyTemplate

`Static`applyTemplateInstanceToTemplate

`Static`assignTemplateInstanceUUIDs

`Static`breakTemplate

`Static`breakTemplateLinkForSceneObjects

`Static`createTemplate

`Static`createTemplateChecked

`Static`createTemplateFromObjects

`Static`gatherAffectedHandlesByTemplateSave

`Static`getTemplateDeltaDebug

`Static`getTemplateInstanceRoot

`Static`getTemplateLinkUUID

`Static`isTemplateInstance

`Static`isTemplateInstanceOutOfDate

`Static`revertToTemplate

`Static`updateAllUnversionedInstancesOfTemplate

`Static`updateInstanceFromTemplate

`Static`updateInstancesFromTemplate

`Static`updateInternalInstanceFromTemplate

`Static`updateUnversionedInstancesFromNestedTemplate

`Static`updateUnversionedInstancesInScene

`Static` `Readonly`onRevertedToTemplate

`Static` `Readonly`onTemplateSaved