ProtectedconstructorOptionalisInternalConstructor: booleanRecords the current state of the provided SceneObject headers.
A diff is automatically generated after the callback has been invoked.
If a change is detected an UndoableCommand will be created.
The undo/redo information structure.
The name of the undo command.
The callback that performs the change.
OptionalisGroupable: boolean
Determines if the command should be grouped with similar commands.
The SceneObjectHeader only contains primary properties such as name, transform, active and
similar basal properties. All components of the sceneObject as well as child objects are ignored.
To track changes to Component or children use createUndoForSceneObject instead.
Use this API for performance critical situations.
Records the complete state of the provided SceneObject including changes to Component objects assigned to the scene object. Optionally, all child objects can be recorded. A diff is generated with a call to commitActiveOperations. If a change is detected an UndoableCommand will be created.
The undo/redo information structure.
Scene object to record.
Determines if the child objects will be recorded as well, otherwise just the provided object.
Optional description specifying the type of changes about to be made.
OptionalisGroupable: boolean
Determines if the command should be grouped with similar commands.
If you only modify basic SceneObject properties such as name or the transform values,
it's better to use the more lightweight recordSceneObjectHeader API instead.
StaticbreakBreak the template link for some scene objects.
The scene objects to break the template link.
The description of the command to show in the command history.
StaticcloneClone a scene object.
The scene object to clone.
The description of the command to show in the command history.
The cloned scene object.
StaticcloneClone scene objects.
The scene objects to clone.
The transforms to apply to the cloned objects.
The description of the command to show in the command history.
The cloned scene objects.
StaticcreateCreate a new scene object.
The name of the new object.
The description of the command to show in the command history.
The new scene object.
Create a new scene object with a fat component.
The fat component.
The name of the new object.
The description of the command to show in the command history.
The new scene object.
StaticcreateRecords the complete state of the provided SceneObject including changes to Component objects
assigned to the scene object. Optionally, all child objects can be recorded.
A diff is automatically generated after the callback has been invoked.
If a change is detected an UndoableCommand will be created.
The undo/redo information structure.
Scene object.
The name of the undo command.
The callback that performs the change.
OptionalisRecursive: boolean
Set to true to include changes to children of the sceneObject
OptionalisGroupable: boolean
Determines if the command should be grouped with similar commands.
True when an undo operation was committed and retained.
If you only modify basic SceneObject properties such as name or the transform values,
it's better to use the more lightweight createUndoForSceneObjectHeaders API instead.
StaticdeleteDelete a scene object.
The scene object to delete.
The description of the command to show in the command history.
StaticdeleteDelete scene objects.
The scene objects to delete.
The description of the command to show in the command history.
StaticgroupGroup scene objects under a common parent.
The scene objects to group.
The description of the command to show in the command history.
The new parent of the group.
StaticinstantiateInstantiate a new scene object from a template
The template.
The description of the command to show in the command history.
The instantiated scene object.
StaticinvertInverts the lock state of a list of scene objects and puts an undo command to revert the operation on the undo stack.
StaticinvertInverts the visibility of a list of scene objects and puts an undo command to revert the operation on the undo stack.
StaticpasteCreate a new component instance based on data in the clipboard.
The object under which the component will be pasted.
The description of the command to show in the command history.
true if the component could be created and added to the object
StaticpasteCreate new scene object instances based on any SceneObject data in the clipboard.
The parent under which the scene objects will be pasted.
The description of the command to show in the command history.
true if any objects were created.
StaticrecordCreates a brand new scene object and begins a recordSceneObject operation on the newly created scene object. Both the creation and the initially recorded set of data will be recorded as a single undo/redo command. Generally you want to call this when creating a new scene object and immediately make some initial changes to it (such as adding component or modifying their properties).
The undo/redo information structure.
Newly created scene object on which to initiate the record operation on.
OptionalisGroupable: boolean
Determines if the command should be grouped with similar commands.
StaticrecordRecords the current state of the provided SceneObject header, and generates a diff with a call to commitActiveOperations. If a change is detected an UndoableCommand will be created.
The undo/redo information structure.
Scene object to record the state of.
Name to the field which should be focused when performing the undo/redo operation.
Optionaldescription: string
Description of the undo command.
OptionalisGroupable: boolean
Determines if the command should be grouped with similar commands.
The SceneObjectHeader only contains primary properties such as name, transform, active and
similar basal properties. All components of the sceneObject as well as child objects are ignored.
To track changes to Component or children use recordSceneObject instead.
StaticrecordRecords the current state of the provided SceneObject headers, and generates a diff with a call to commitActiveOperations. If a change is detected an UndoableCommand will be created.
The undo/redo information structure.
Scene objects to record the state of.
Description of the undo command.
OptionalisGroupable: boolean
Determines if the command should be grouped with similar commands.
The SceneObjectHeader only contains primary properties such as name, transform, active and
similar basal properties. All components of the sceneObject as well as child objects are ignored.
To track changes to Component or children use recordSceneObject instead.
Use this API for performance critical situations.
StaticremoveStaticreparentPlace a scene object under a new parent.
The scene object to reparent.
The new parent to place the object under.
The description of the command to show in the command history.
StaticreparentPlace scene objects under a new parent.
The scene objects to reparent.
The new parent to place the objects under.
The description of the command to show in the command history.
StaticreparentReparents sceneObjects to newParent, handling template-linked objects by prompting the user to duplicate, unlink and move them.
The undo/redo information structure.
Scene objects to reparent.
The new parent scene object.
StatictoggleToggles the visibility of a list of scene objects and puts an undo command to revert the operation on the undo stack.
The SceneObjectUndoRedo class provides undo helpers for scene objects that can be undone through the editor's undo-redo system.