dedicated object to setup actions

kleber-swf · Dec 15, 2021 · 3962fac · 3962fac
1 parent ab47838
commit 3962fac
Show file tree

Hide file tree

Showing 9 changed files with 135 additions and 99 deletions.
diff --git a/example/game.js b/example/game.js
@@ -34,6 +34,7 @@ function preload() {
 
 function create() {
 	const plugin = game.plugins.add(new Phaser.Plugin.RuntimeEditor(game, {
+		saveLockedObjectsPath: true,
 		referenceImageUrl(width, height, _responsive) {
 			return width > height
 				? './refs/ref_landscape.jpg'

diff --git a/src/core/actions-setup.ts b/src/core/actions-setup.ts
@@ -0,0 +1,121 @@
+import { DataOrigin, EditorData } from 'data/editor-data';
+import { Size } from 'plugin.model';
+import { ActionHandler } from './action-handler';
+import { Actions } from './actions';
+import { History } from './history';
+import { Preferences } from './preferences/preferences';
+
+export class ActionsSetup {
+	public setup(actions: ActionHandler, data: EditorData, history: History, prefs: Preferences) {
+		this.setupDataActions(data, actions, prefs);
+		this.setuphistoryActions(history, actions);
+		this.setupPreferencesActions(prefs, actions);
+	}
+
+	public setuphistoryActions(history: History, actions: ActionHandler) {
+		actions.setActionCommand(Actions.UNDO, history.undo.bind(history));
+	}
+
+	private setupPreferencesActions(prefs: Preferences, actions: ActionHandler) {
+		actions.setActionCommand(
+			Actions.TOGGLE_SNAP,
+			() => prefs.toggle('snap'),
+			() => prefs.get('snap') as boolean
+		);
+
+		actions.setActionCommand(
+			Actions.TOGGLE_GIZMOS,
+			() => prefs.toggle('gizmos'),
+			() => prefs.get('gizmos') as boolean
+		);
+
+		actions.setActionCommand(
+			Actions.TOGGLE_GUIDES,
+			() => prefs.toggle('guides'),
+			() => prefs.get('guides') as boolean
+		);
+
+		actions.setActionCommand(
+			Actions.TOGGLE_HIT_AREA,
+			() => prefs.toggle('hitArea'),
+			() => prefs.get('hitArea') as boolean
+		);
+
+		actions.setActionCommand(
+			Actions.TOGGLE_RESPONSIVE,
+			() => prefs.toggle('responsive'),
+			() => prefs.get('responsive') as boolean
+		);
+
+		actions.setActionCommand(Actions.TOGGLE_ORIENTATION, () => {
+			const size = prefs.get('responsiveSize') as Size;
+			prefs.set('responsiveSize', { width: size.height, height: size.width });
+		});
+
+		actions.setActionCommand(
+			Actions.TOGGLE_HIT_AREAS_SNAPSHOT,
+			() => prefs.toggle('hitAreasSnapshot'),
+			() => prefs.get('hitAreasSnapshot') as boolean
+		);
+
+		actions.setActionCommand(
+			Actions.TOGGLE_REF_IMAGE,
+			() => prefs.toggle('referenceImageVisible'),
+			() => prefs.get('referenceImageVisible') as boolean
+		);
+
+		actions.setActionCommand(
+			Actions.TOGGLE_LEFT_PANEL,
+			() => prefs.toggle('leftPanelVisible'),
+			() => prefs.get('leftPanelVisible') as boolean
+		);
+
+		actions.setActionCommand(
+			Actions.TOGGLE_RIGHT_PANEL,
+			() => prefs.toggle('rightPanelVisible'),
+			() => prefs.get('rightPanelVisible') as boolean
+		);
+	}
+
+	public setupDataActions(data: EditorData, actions: ActionHandler, prefs: Preferences) {
+		actions.setActionCommand(Actions.CLEAR_SELECTION, () => data.selectObject(null, DataOrigin.ACTION));
+		actions.setActionCommand(Actions.PRINT_OBJECT, () => {
+			if (data.selectedObject) console.info(data.selectedObject);
+		});
+
+		actions.setActionCommand(Actions.SELECT_PARENT, () => {
+			if (data.selectedObject) data.selectObject(data.selectedObject.parent, DataOrigin.ACTION);
+		});
+
+		actions.setActionCommand(
+			Actions.LOCK_SELECTION,
+			() => this.toggleLockSelection(data, prefs),
+			() => data.selectedObject?.__locked
+		);
+	}
+
+	private toggleLockSelection(data: EditorData, prefs: Preferences) {
+		if (!data.selectedObject) return;
+		const obj = data.selectedObject;
+		obj.__locked = !obj.__locked;
+
+		const path: number[] = [];
+		let o = obj;
+		while (o.parent) {
+			path.unshift(o.parent.getChildIndex(o));
+			o = o.parent;
+		}
+
+		const pathId = path.join(',');
+		const locked = prefs.get('lockedObjects') as string[];
+		const i = locked.indexOf(pathId);
+
+		if (obj.__locked) {
+			if (i < 0) locked.push(pathId);
+		} else if (i >= 0) locked.splice(i, 1);
+
+		prefs.set('lockedObjects', locked);
+
+		data.onObjectLocked.dispatch(obj);
+	}
+}
diff --git a/src/core/editor.ts b/src/core/editor.ts
@@ -2,9 +2,10 @@ import { Actions } from 'core/actions';
 import { DataOrigin, EditorData } from 'data/editor-data';
 import { InspectorData } from 'data/inspector-data';
 import { PhaserMeta } from 'data/phaser-meta';
-import { PluginConfig, Size } from 'plugin.model';
+import { PluginConfig } from 'plugin.model';
 import { PropertyElementTag } from 'property-element-tag';
 import { ActionHandler } from './action-handler';
+import { ActionsSetup } from './actions-setup';
 import { History } from './history';
 import { Preferences } from './preferences/preferences';
 import { ReferenceImageController } from './reference-image.controller';
@@ -380,74 +381,8 @@ class EditorClass {
 		return actions;
 	}
 
-	private setupPreferencesActions(actions: ActionHandler) {
-		const prefs = this.prefs;
-
-		actions.setActionCommand(
-			Actions.TOGGLE_SNAP,
-			() => prefs.toggle('snap'),
-			() => prefs.get('snap') as boolean
-		);
-
-		actions.setActionCommand(
-			Actions.TOGGLE_GIZMOS,
-			() => prefs.toggle('gizmos'),
-			() => prefs.get('gizmos') as boolean
-		);
-
-		actions.setActionCommand(
-			Actions.TOGGLE_GUIDES,
-			() => prefs.toggle('guides'),
-			() => prefs.get('guides') as boolean
-		);
-
-		actions.setActionCommand(
-			Actions.TOGGLE_HIT_AREA,
-			() => prefs.toggle('hitArea'),
-			() => prefs.get('hitArea') as boolean
-		);
-
-		actions.setActionCommand(
-			Actions.TOGGLE_RESPONSIVE,
-			() => prefs.toggle('responsive'),
-			() => prefs.get('responsive') as boolean
-		);
-
-		actions.setActionCommand(Actions.TOGGLE_ORIENTATION, () => {
-			const size = prefs.get('responsiveSize') as Size;
-			prefs.set('responsiveSize', { width: size.height, height: size.width });
-		});
-
-		actions.setActionCommand(
-			Actions.TOGGLE_HIT_AREAS_SNAPSHOT,
-			() => prefs.toggle('hitAreasSnapshot'),
-			() => prefs.get('hitAreasSnapshot') as boolean
-		);
-
-		actions.setActionCommand(
-			Actions.TOGGLE_REF_IMAGE,
-			() => prefs.toggle('referenceImageVisible'),
-			() => prefs.get('referenceImageVisible') as boolean
-		);
-
-		actions.setActionCommand(
-			Actions.TOGGLE_LEFT_PANEL,
-			() => prefs.toggle('leftPanelVisible'),
-			() => prefs.get('leftPanelVisible') as boolean
-		);
-
-		actions.setActionCommand(
-			Actions.TOGGLE_RIGHT_PANEL,
-			() => prefs.toggle('rightPanelVisible'),
-			() => prefs.get('rightPanelVisible') as boolean
-		);
-	}
-
 	public setupInitialActions() {
-		const actions = this.actions;
-		this.setupPreferencesActions(actions);
-		this.history.setupActions(actions);
-		this.data.setupActions(actions);
+		new ActionsSetup().setup(this.actions, this.data, this.history, this.prefs);
 	}
 
 	public enable(config: PluginConfig) {

diff --git a/src/core/history.ts b/src/core/history.ts
@@ -1,6 +1,4 @@
 import { DataOrigin, EditorData } from '../data/editor-data';
-import { ActionHandler } from './action-handler';
-import { Actions } from './actions';
 
 export interface HistoryEntry {
 	obj: PIXI.DisplayObject;
@@ -18,10 +16,6 @@ export class History {
 
 	constructor(private readonly data: EditorData) { }
 
-	public setupActions(actions: ActionHandler) {
-		actions.setActionCommand(Actions.UNDO, this.undo.bind(this));
-	}
-
 	public prepare(obj: PIXI.DisplayObject, properties: { [id: string]: any }) {
 		const entry = this.holdingEntry = { obj, properties };
 		Object.keys(entry.properties)

diff --git a/src/core/preferences/preferences.model.ts b/src/core/preferences/preferences.model.ts
@@ -6,6 +6,7 @@ export interface PersistentData {
 	gizmos: boolean;
 	guides: boolean;
 	hitArea: boolean;
+	lockedObjects: string[]
 
 	leftPanelVisible: boolean;
 	leftPanelSize: string;

diff --git a/src/core/preferences/preferences.ts b/src/core/preferences/preferences.ts
@@ -11,6 +11,8 @@ export class Preferences {
 		gizmos: true,
 		guides: false,
 		hitArea: false,
+		lockedObjects: [],
+
 		responsive: false,
 		responsiveSize: Preferences.DefaultResponsiveSize,
 		responsiveTemplateIndex: 0,

diff --git a/src/data/editor-data.ts b/src/data/editor-data.ts
@@ -1,6 +1,3 @@
-import { ActionHandler } from 'core/action-handler';
-import { Actions } from 'core/actions';
-
 export enum DataOrigin {
 	ACTION = 0,
 	SCENE = 1,
@@ -53,22 +50,4 @@ export class EditorData {
 			this.onPropertyChanged.dispatch(e.from, k, e.value, this._selectedObject);
 		});
 	}
-
-	public setupActions(actions: ActionHandler) {
-		actions.setActionCommand(Actions.CLEAR_SELECTION, () => this.selectObject(null, DataOrigin.ACTION));
-		actions.setActionCommand(Actions.PRINT_OBJECT, () => {
-			if (this._selectedObject) console.info(this._selectedObject);
-		});
-
-		actions.setActionCommand(Actions.SELECT_PARENT, () => {
-			if (this._selectedObject) this.selectObject(this._selectedObject.parent, DataOrigin.ACTION);
-		});
-
-		actions.setActionCommand(Actions.LOCK_SELECTION, () => {
-			if (this._selectedObject) {
-				this._selectedObject.__locked = !this._selectedObject.__locked;
-				this.onObjectLocked.dispatch(this._selectedObject);
-			}
-		}, () => this._selectedObject?.__locked);
-	}
 }
diff --git a/src/editor.state-handler.ts b/src/editor.state-handler.ts
@@ -70,6 +70,7 @@ export class EditorStateHandler {
 		return {
 			clearPreferences: builder.clearPreferences,
 			pauseGame: builder.pauseGame,
+			saveLockedObjectsPath: builder.saveLockedObjectsPath ?? false,
 			referenceImageUrl: builder.referenceImageUrl,
 			root: builder.root(),
 		};

diff --git a/src/plugin.model.ts b/src/plugin.model.ts
@@ -1,17 +1,19 @@
 export interface PluginConfigBuilder {
-	root?: () => Container;
-	referenceImageUrl?: (width: number, height: number, responsive: boolean) => string;
 	pauseGame?: boolean;
 	clearPreferences?: boolean;
+	saveLockedObjectsPath?: boolean;
+	root?: () => Container;
+	referenceImageUrl?: (width: number, height: number, responsive: boolean) => string;
 	onShow?: () => void;
 	onHide?: () => void;
 }
 
 export interface PluginConfig {
-	root: Container;
-	referenceImageUrl: (width: number, height: number, responsive: boolean) => string;
 	pauseGame: boolean;
 	clearPreferences: boolean;
+	saveLockedObjectsPath: boolean;
+	root: Container;
+	referenceImageUrl: (width: number, height: number, responsive: boolean) => string;
 }
 
 export interface Point {