123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321 |
- import * as Commands from './commands/Commands.js';
- class History {
- constructor( editor ) {
- this.editor = editor;
- this.undos = [];
- this.redos = [];
- this.lastCmdTime = Date.now();
- this.idCounter = 0;
- this.historyDisabled = false;
- this.config = editor.config;
- // signals
- const scope = this;
- this.editor.signals.startPlayer.add( function () {
- scope.historyDisabled = true;
- } );
- this.editor.signals.stopPlayer.add( function () {
- scope.historyDisabled = false;
- } );
- }
- execute( cmd, optionalName ) {
- const lastCmd = this.undos[ this.undos.length - 1 ];
- const timeDifference = Date.now() - this.lastCmdTime;
- const isUpdatableCmd = lastCmd &&
- lastCmd.updatable &&
- cmd.updatable &&
- lastCmd.object === cmd.object &&
- lastCmd.type === cmd.type &&
- lastCmd.script === cmd.script &&
- lastCmd.attributeName === cmd.attributeName;
- if ( isUpdatableCmd && cmd.type === 'SetScriptValueCommand' ) {
- // When the cmd.type is "SetScriptValueCommand" the timeDifference is ignored
- lastCmd.update( cmd );
- cmd = lastCmd;
- } else if ( isUpdatableCmd && timeDifference < 500 ) {
- lastCmd.update( cmd );
- cmd = lastCmd;
- } else {
- // the command is not updatable and is added as a new part of the history
- this.undos.push( cmd );
- cmd.id = ++ this.idCounter;
- }
- cmd.name = ( optionalName !== undefined ) ? optionalName : cmd.name;
- cmd.execute();
- cmd.inMemory = true;
- if ( this.config.getKey( 'settings/history' ) ) {
- cmd.json = cmd.toJSON(); // serialize the cmd immediately after execution and append the json to the cmd
- }
- this.lastCmdTime = Date.now();
- // clearing all the redo-commands
- this.redos = [];
- this.editor.signals.historyChanged.dispatch( cmd );
- }
- undo() {
- if ( this.historyDisabled ) {
- alert( this.editor.strings.getKey( 'prompt/history/forbid' ) );
- return;
- }
- let cmd = undefined;
- if ( this.undos.length > 0 ) {
- cmd = this.undos.pop();
- if ( cmd.inMemory === false ) {
- cmd.fromJSON( cmd.json );
- }
- }
- if ( cmd !== undefined ) {
- cmd.undo();
- this.redos.push( cmd );
- this.editor.signals.historyChanged.dispatch( cmd );
- }
- return cmd;
- }
- redo() {
- if ( this.historyDisabled ) {
- alert( this.editor.strings.getKey( 'prompt/history/forbid' ) );
- return;
- }
- let cmd = undefined;
- if ( this.redos.length > 0 ) {
- cmd = this.redos.pop();
- if ( cmd.inMemory === false ) {
- cmd.fromJSON( cmd.json );
- }
- }
- if ( cmd !== undefined ) {
- cmd.execute();
- this.undos.push( cmd );
- this.editor.signals.historyChanged.dispatch( cmd );
- }
- return cmd;
- }
- toJSON() {
- const history = {};
- history.undos = [];
- history.redos = [];
- if ( ! this.config.getKey( 'settings/history' ) ) {
- return history;
- }
- // Append Undos to History
- for ( let i = 0; i < this.undos.length; i ++ ) {
- if ( this.undos[ i ].hasOwnProperty( 'json' ) ) {
- history.undos.push( this.undos[ i ].json );
- }
- }
- // Append Redos to History
- for ( let i = 0; i < this.redos.length; i ++ ) {
- if ( this.redos[ i ].hasOwnProperty( 'json' ) ) {
- history.redos.push( this.redos[ i ].json );
- }
- }
- return history;
- }
- fromJSON( json ) {
- if ( json === undefined ) return;
- for ( let i = 0; i < json.undos.length; i ++ ) {
- const cmdJSON = json.undos[ i ];
- const cmd = new Commands[ cmdJSON.type ]( this.editor ); // creates a new object of type "json.type"
- cmd.json = cmdJSON;
- cmd.id = cmdJSON.id;
- cmd.name = cmdJSON.name;
- this.undos.push( cmd );
- this.idCounter = ( cmdJSON.id > this.idCounter ) ? cmdJSON.id : this.idCounter; // set last used idCounter
- }
- for ( let i = 0; i < json.redos.length; i ++ ) {
- const cmdJSON = json.redos[ i ];
- const cmd = new Commands[ cmdJSON.type ]( this.editor ); // creates a new object of type "json.type"
- cmd.json = cmdJSON;
- cmd.id = cmdJSON.id;
- cmd.name = cmdJSON.name;
- this.redos.push( cmd );
- this.idCounter = ( cmdJSON.id > this.idCounter ) ? cmdJSON.id : this.idCounter; // set last used idCounter
- }
- // Select the last executed undo-command
- this.editor.signals.historyChanged.dispatch( this.undos[ this.undos.length - 1 ] );
- }
- clear() {
- this.undos = [];
- this.redos = [];
- this.idCounter = 0;
- this.editor.signals.historyChanged.dispatch();
- }
- goToState( id ) {
- if ( this.historyDisabled ) {
- alert( this.editor.strings.getKey( 'prompt/history/forbid' ) );
- return;
- }
- this.editor.signals.sceneGraphChanged.active = false;
- this.editor.signals.historyChanged.active = false;
- let cmd = this.undos.length > 0 ? this.undos[ this.undos.length - 1 ] : undefined; // next cmd to pop
- if ( cmd === undefined || id > cmd.id ) {
- cmd = this.redo();
- while ( cmd !== undefined && id > cmd.id ) {
- cmd = this.redo();
- }
- } else {
- while ( true ) {
- cmd = this.undos[ this.undos.length - 1 ]; // next cmd to pop
- if ( cmd === undefined || id === cmd.id ) break;
- this.undo();
- }
- }
- this.editor.signals.sceneGraphChanged.active = true;
- this.editor.signals.historyChanged.active = true;
- this.editor.signals.sceneGraphChanged.dispatch();
- this.editor.signals.historyChanged.dispatch( cmd );
- }
- enableSerialization( id ) {
- /**
- * because there might be commands in this.undos and this.redos
- * which have not been serialized with .toJSON() we go back
- * to the oldest command and redo one command after the other
- * while also calling .toJSON() on them.
- */
- this.goToState( - 1 );
- this.editor.signals.sceneGraphChanged.active = false;
- this.editor.signals.historyChanged.active = false;
- let cmd = this.redo();
- while ( cmd !== undefined ) {
- if ( ! cmd.hasOwnProperty( 'json' ) ) {
- cmd.json = cmd.toJSON();
- }
- cmd = this.redo();
- }
- this.editor.signals.sceneGraphChanged.active = true;
- this.editor.signals.historyChanged.active = true;
- this.goToState( id );
- }
- }
- export { History };
|