Class TemplateUtility

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

Hierarchy (view full)

rsx.TemplateUtility
- TemplateUtility

Constructors

`Protected`constructor

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

Methods

`Static`applySceneObjectToTemplate

applySceneObjectToTemplate(sceneObject, template, autoApply?): 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, objectTemplate): 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): 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, templateRoot, templateResource): 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): 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, sceneObjects, fnOnSuccess?, fnOnError?): 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.
  - - (): void
    - Returns void
- OptionalfnOnError: ((errorMessage: string) => void)
  An optional callback that is invoked on error.
  - - (errorMessage): void
    - Parameters
      errorMessage: string
      Returns void
Returns void

`Static`createTemplate

createTemplate(sceneObject, virtualPath): 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.
- virtualPath: FilePath
  Virtual 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, virtualFilePath, fnOnSuccess?, fnOnError?): 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.
- virtualFilePath: LibraryIdentifierPath
  Path at which to store the template.
- OptionalfnOnSuccess: ((result: TemplateOperationResult) => void)
  - - (result): void
    - Parameters
      result: TemplateOperationResult
      Returns void
- OptionalfnOnError: ((errorMessage: string) => void)
  - - (errorMessage): void
    - Parameters
      errorMessage: string
      Returns void
Returns void

`Static`createTemplateFromObjects

createTemplateFromObjects(undoRedo, sceneObjects, destinationLibraryPath, libraryPathContainsName?, fnOnSuccess?, fnOnError?): 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: LibraryIdentifierPath
  The directory in the library where to save the template.
- OptionallibraryPathContainsName: boolean
- OptionalfnOnSuccess: ((result: TemplateOperationResult, templateLibraryPath: LibraryIdentifierPath, templateRoot: SceneObject) => void)
  - - (result, templateLibraryPath, templateRoot): void
    - Parameters
      result: TemplateOperationResult
      templateLibraryPath: LibraryIdentifierPath
      templateRoot: SceneObject
      Returns void
- OptionalfnOnError: ((errorMessage: string) => void)
  - - (errorMessage): void
    - Parameters
      errorMessage: string
      Returns void
Returns boolean
True if the template creation operation was started.

`Static`gatherAffectedHandlesByTemplateSave

gatherAffectedHandlesByTemplateSave(root): 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): string
Gets a string that represents a template delta. This is only a debug representation and should not be used to parse or extract more informatio about the template.
Parameters
- object: SceneObject
Returns string
Inherited from TemplateUtility.getTemplateDeltaDebug

`Static`getTemplateInstanceRoot

getTemplateInstanceRoot(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): 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): 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`recordDeltasForAllActiveScenes

recordDeltasForAllActiveScenes(): void
Performs delta record for all template instances in all currently loaded scenes.

Returns void
Inherited from TemplateUtility.recordDeltasForAllActiveScenes

`Static`recordTemplateDelta

recordTemplateDelta(sceneObject, isRecursive?): void
Updates the internal template delta data by recording the difference between the current values in provided template instance.
Parameters
- sceneObject: SceneObject
  Scene object that is part of the template instance for which to record the deltas for.
- OptionalisRecursive: boolean
  If true, will recursively record deltas for all children templates, alongside a delta the scene object.
Returns void
Inherited from TemplateUtility.recordTemplateDelta

`Static`recordTemplateDeltaForChildInstances

recordTemplateDeltaForChildInstances(sceneObject): void
Updates the internal template delta data by recording the difference between the current values in template instances that are children of the provided object hierarchy.
Parameters
- sceneObject: SceneObject
  Scene object at the root of the hierarchy to record template deltas for. Deltas will not be recorded for the root itself, in case it is also a template instance.
Returns void
Note
If the provided object contains any child template instances, this will be done recursively for them as well.

Inherited from TemplateUtility.recordTemplateDeltaForChildInstances

`Static`resaveDependantTemplates

resaveDependantTemplates(templateResource): void
Resaves all template resources that have the given templateResource as a nested template.
Parameters
- templateResource: Template | ResourceHandle<Template>
Returns void
Inherited from TemplateUtility.resaveDependantTemplates

`Static`revertToTemplate

revertToTemplate(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`updateAllInstancesOfTemplate

updateAllInstancesOfTemplate(templateResource, isUpdatingNonInstantiatedOnly?): void
Updates all template instances of the given template in currently loaded scenes.
Parameters
- templateResource: Template | ResourceHandle<Template>
  The template resource to update the instances for. Null if all instances should be updated.
- OptionalisUpdatingNonInstantiatedOnly: boolean
  If true, only template instances that have not been instantiated properly yet are updated.
Returns void
Inherited from TemplateUtility.updateAllInstancesOfTemplate

`Static`updateInstanceFromTemplate

updateInstanceFromTemplate(sceneObject, flags?): 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, number>
Returns void
Inherited from TemplateUtility.updateInstanceFromTemplate

`Static`updateInstancesFromTemplate

updateInstancesFromTemplate(instances, flags?): 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, number>
  Flags that determine the update behavior.
Returns void
Inherited from TemplateUtility.updateInstancesFromTemplate

`Static`updateSceneFromTemplate

updateSceneFromTemplate(scene, templateResource, isUpdatingNonInstantiatedOnly?): void
Updates all template instances in the scene to their most recent version, as stored in the Template resource. Any instance specific changes are preserved.
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.
- OptionalisUpdatingNonInstantiatedOnly: boolean
  If true, only template instances that have not been instantiated properly yet are updated.
Returns void
Inherited from TemplateUtility.updateSceneFromTemplate

`Static`updateTemplateFromNestedTemplate

updateTemplateFromNestedTemplate(templateResource, nestedTemplate): void
Updates all instances of the nestedTemplate in the templateResource.
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.updateTemplateFromNestedTemplate

Events

`Static` `Readonly`onRevertedToTemplate

onRevertedToTemplate: Event<[p0: SceneObject], void>

Invoked when a scene object was reverted to the template.

`Static` `Readonly`onTemplateSaved

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

Invoked when a template resource is saved.

Class TemplateUtility

Hierarchy (view full)

Index

Constructors

Properties

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

Parameters

Returns void

Returns void

StaticcreateTemplate

Parameters

Returns UncertainAsyncOp<TemplateOperationResult, string>

StaticcreateTemplateChecked

Parameters

Parameters

Returns void

Parameters

Returns void

Returns void

StaticcreateTemplateFromObjects

Parameters

Parameters

Returns void

Parameters

Returns void

Returns boolean

StaticgatherAffectedHandlesByTemplateSave

Parameters

Returns SceneNode[]

StaticgetTemplateDeltaDebug

Parameters

Returns string

StaticgetTemplateInstanceRoot

Parameters

Returns SceneObject

StaticgetTemplateLinkUUID

Parameters

Returns UUID

StaticisTemplateInstance

Parameters

Returns boolean

StaticrecordDeltasForAllActiveScenes

Returns void

StaticrecordTemplateDelta

Parameters

Returns void

StaticrecordTemplateDeltaForChildInstances

Parameters

Returns void

Note

StaticresaveDependantTemplates

Parameters

Returns void

StaticrevertToTemplate

Parameters

Returns void

`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`recordDeltasForAllActiveScenes

`Static`recordTemplateDelta

`Static`recordTemplateDeltaForChildInstances

`Static`resaveDependantTemplates

`Static`revertToTemplate

`Static`updateAllInstancesOfTemplate

`Static`updateInstanceFromTemplate

`Static`updateInstancesFromTemplate

`Static`updateSceneFromTemplate

`Static`updateTemplateFromNestedTemplate

`Static` `Readonly`onRevertedToTemplate

`Static` `Readonly`onTemplateSaved