Remove snap from global preferences

Author: Yuri Pourre

editor/src/editor/dialogs/edit-preferences/edit-preferences.tsx

@@ -12,9 +12,7 @@ import { trySetExperimentalFeaturesEnabledInLocalStorage } from "../../../tools/
 import {
 	gizmoSnapMinStep,
 	IGizmoSnapPreferences,
-	loadGizmoSnapPreferences,
 	roundGizmoSnapSteps,
-	saveGizmoSnapPreferences,
 } from "../../../tools/gizmo-snap-preferences";
 
 import { EditorInspectorKeyField } from "../../layout/inspector/fields/key";
@@ -44,13 +42,13 @@ export class EditorEditPreferencesComponent extends Component<IEditorEditPrefere
 
 		this.state = {
 			theme: document.body.classList.contains("dark") ? "dark" : "light",
-			gizmoSnap: loadGizmoSnapPreferences(),
+			gizmoSnap: this.props.editor.state.gizmoSnap,
 		};
 	}
 
 	public componentDidUpdate(prevProps: IEditorEditPreferencesComponentProps): void {
 		if (this.props.open && !prevProps.open) {
-			this.setState({ gizmoSnap: loadGizmoSnapPreferences() });
+			this.setState({ gizmoSnap: this.props.editor.state.gizmoSnap });
 		}
 	}
 
@@ -196,11 +194,10 @@ export class EditorEditPreferencesComponent extends Component<IEditorEditPrefere
 	private _commitGizmoSnapFromPreferences(next: IGizmoSnapPreferences): void {
 		const normalized = roundGizmoSnapSteps(next);
 		this.setState({ gizmoSnap: normalized });
+		this.props.editor.setState({ gizmoSnap: normalized });
 		const preview = this.props.editor.layout?.preview;
 		if (preview) {
 			preview.updateGizmoSnapPreferences(normalized);
-		} else {
-			saveGizmoSnapPreferences(normalized);
 		}
 	}
 
@@ -226,7 +223,7 @@ export class EditorEditPreferencesComponent extends Component<IEditorEditPrefere
 							inputClassName="h-9 w-28 rounded-md border border-input px-2 py-1 text-sm shadow-sm bg-background !w-28"
 							title="Translation snap step (scene units); drag horizontally to adjust (hold Shift for ×10)"
 							step={0.01}
-							decimals={2}
+
 							min={min}
 							onChange={(v) => this._commitGizmoSnapFromPreferences({ ...snap, translationStep: v })}
 						/>
@@ -244,7 +241,7 @@ export class EditorEditPreferencesComponent extends Component<IEditorEditPrefere
 							inputClassName="h-9 w-28 rounded-md border border-input px-2 py-1 text-sm shadow-sm bg-background !w-28"
 							title="Rotation snap step in degrees; drag horizontally to adjust (hold Shift for ×10)"
 							step={0.01}
-							decimals={2}
+
 							min={min}
 							onChange={(v) => this._commitGizmoSnapFromPreferences({ ...snap, rotationStepDegrees: v })}
 						/>
@@ -262,7 +259,7 @@ export class EditorEditPreferencesComponent extends Component<IEditorEditPrefere
 							inputClassName="h-9 w-28 rounded-md border border-input px-2 py-1 text-sm shadow-sm bg-background !w-28"
 							title="Scale snap step (additive); drag horizontally to adjust (hold Shift for ×10)"
 							step={0.01}
-							decimals={2}
+
 							min={min}
 							onChange={(v) => this._commitGizmoSnapFromPreferences({ ...snap, scaleStep: v })}
 						/>

editor/src/editor/layout/preview.tsx

@@ -61,9 +61,7 @@ import { createSceneLink, getRootSceneLink } from "../../tools/scene/scene-link"
 import {
 	gizmoSnapMinStep,
 	IGizmoSnapPreferences,
-	loadGizmoSnapPreferences,
 	roundGizmoSnapSteps,
-	saveGizmoSnapPreferences,
 } from "../../tools/gizmo-snap-preferences";
 import { UniqueNumber, waitNextAnimationFrame, waitUntil } from "../../tools/tools";
 import { isSprite, isSpriteManagerNode, isSpriteMapNode } from "../../tools/guards/sprites";
@@ -206,7 +204,7 @@ export class EditorPreview extends Component<IEditorPreviewProps, IEditorPreview
 			playEnabled: false,
 			playSceneLoadingProgress: 0,
 
-			gizmoSnap: loadGizmoSnapPreferences(),
+			gizmoSnap: this.props.editor.state.gizmoSnap,
 		};
 
 		ipcRenderer.on("gizmo:position", () => this.setActiveGizmo("position"));
@@ -892,8 +890,8 @@ export class EditorPreview extends Component<IEditorPreviewProps, IEditorPreview
 
 	private _commitGizmoSnap(next: IGizmoSnapPreferences): void {
 		const normalized = roundGizmoSnapSteps(next);
-		saveGizmoSnapPreferences(normalized);
 		this.setState({ gizmoSnap: normalized });
+		this.props.editor.setState({ gizmoSnap: normalized });
 		this.gizmo?.setSnapPreferences(normalized);
 	}
 
@@ -932,7 +930,7 @@ export class EditorPreview extends Component<IEditorPreviewProps, IEditorPreview
 						inputClassName="rounded-none border-0 border-l border-input h-9 w-12 px-1 py-0 text-xs bg-transparent shadow-none focus-visible:ring-0 focus-visible:ring-offset-0 !w-12"
 						title="Translation snap step (scene units); drag horizontally to adjust (hold Shift for ×10)"
 						step={0.01}
-						decimals={2}
+
 						min={min}
 						onChange={(v) => bumpTranslation(v)}
 					/>
@@ -959,7 +957,7 @@ export class EditorPreview extends Component<IEditorPreviewProps, IEditorPreview
 						inputClassName="rounded-none border-0 border-l border-input h-9 w-12 px-1 py-0 text-xs bg-transparent shadow-none focus-visible:ring-0 focus-visible:ring-offset-0 !w-12"
 						title="Rotation snap step (degrees); drag horizontally to adjust (hold Shift for ×10)"
 						step={0.01}
-						decimals={2}
+
 						min={min}
 						onChange={(v) => bumpRotation(v)}
 					/>
@@ -986,7 +984,7 @@ export class EditorPreview extends Component<IEditorPreviewProps, IEditorPreview
 						inputClassName="rounded-none border-0 border-l border-input h-9 w-12 px-1 py-0 text-xs bg-transparent shadow-none focus-visible:ring-0 focus-visible:ring-offset-0 !w-12"
 						title="Scale snap step (additive, incremental); drag horizontally to adjust (hold Shift for ×10)"
 						step={0.01}
-						decimals={2}
+
 						min={min}
 						onChange={(v) => bumpScale(v)}
 					/>

editor/src/editor/main.tsx

@@ -20,6 +20,7 @@ import { loadProject } from "../project/load/load";
 import { startProjectDevProcess } from "../project/run";
 import { exportProject } from "../project/export/export";
 import { EditorProjectPackageManager } from "../project/typings";
+import { defaultGizmoSnapPreferences, IGizmoSnapPreferences } from "../tools/gizmo-snap-preferences";
 
 import { disposeVLSPostProcess } from "./rendering/vls";
 import { disposeSSRRenderingPipeline } from "./rendering/ssr";
@@ -97,6 +98,11 @@ export interface IEditorState {
 	 */
 	compressedTexturesEnabledInPreview: boolean;
 
+	/**
+	 * Per-project gizmo snap preferences.
+	 */
+	gizmoSnap: IGizmoSnapPreferences;
+
 	/**
 	 * Defines wether or not experimental features are enabled.
 	 */
@@ -155,6 +161,7 @@ export class Editor extends Component<IEditorProps, IEditorState> {
 
 			compressedTexturesEnabled: false,
 			compressedTexturesEnabledInPreview: false,
+			gizmoSnap: { ...defaultGizmoSnapPreferences },
 			enableExperimentalFeatures: tryGetExperimentalFeaturesEnabledFromLocalStorage(),
 			openedTabs: [],
 

editor/src/project/load/load.tsx

@@ -11,6 +11,7 @@ import { requirePlugin } from "../../tools/plugins/require";
 
 import { EditorProjectPackageManager, IEditorProject } from "../typings";
 import { projectConfiguration } from "../configuration";
+import { defaultGizmoSnapPreferences, roundGizmoSnapSteps } from "../../tools/gizmo-snap-preferences";
 
 import { loadScene } from "./scene";
 import { LoadScenePrepareComponent } from "./prepare";
@@ -35,6 +36,7 @@ export async function loadProject(editor: Editor, path: string) {
 
 		compressedTexturesEnabled: project.compressedTexturesEnabled ?? false,
 		compressedTexturesEnabledInPreview: project.compressedTexturesEnabledInPreview ?? false,
+		gizmoSnap: roundGizmoSnapSteps(project.gizmoSnapPreferences ?? { ...defaultGizmoSnapPreferences }),
 	});
 
 	editor.layout.forceUpdate();

editor/src/project/save/save.tsx

@@ -52,6 +52,7 @@ export async function saveProjectConfiguration(editor: Editor) {
 
 		compressedTexturesEnabled: editor.state.compressedTexturesEnabled,
 		compressedTexturesEnabledInPreview: editor.state.compressedTexturesEnabledInPreview,
+		gizmoSnapPreferences: editor.state.gizmoSnap,
 	};
 
 	if (!editor.props.editedScenePath) {

editor/src/project/typings.ts

@@ -1,3 +1,5 @@
+import { IGizmoSnapPreferences } from "../tools/gizmo-snap-preferences";
+
 export interface IEditorProject {
 	/**
 	 * The version of the editor that saved this project.
@@ -26,6 +28,11 @@ export interface IEditorProject {
 	 * The package manager being used by the project.
 	 */
 	packageManager?: EditorProjectPackageManager;
+
+	/**
+	 * Per-project gizmo snap preferences (translate, rotate, scale steps and enabled flags).
+	 */
+	gizmoSnapPreferences?: IGizmoSnapPreferences;
 }
 
 export interface IEditorProjectPlugin {

editor/src/tools/gizmo-snap-preferences.ts

@@ -1,5 +1,3 @@
-export const editorGizmoSnapStorageKey = "editor-gizmo-snap";
-
 /** Minimum snap step (two-decimal increments cannot be smaller than 0.01). */
 export const gizmoSnapMinStep = 0.01;
 
@@ -40,43 +38,3 @@ export const defaultGizmoSnapPreferences: IGizmoSnapPreferences = {
 	scaleEnabled: false,
 	scaleStep: 0.25,
 };
-
-function clampPositive(value: number, fallback: number): number {
-	if (!Number.isFinite(value) || value <= 0) {
-		return fallback;
-	}
-	return value;
-}
-
-function asBoolean(value: unknown, fallback: boolean): boolean {
-	return typeof value === "boolean" ? value : fallback;
-}
-
-function asNumber(value: unknown, fallback: number): number {
-	return typeof value === "number" && Number.isFinite(value) ? value : fallback;
-}
-
-export function loadGizmoSnapPreferences(): IGizmoSnapPreferences {
-	try {
-		const raw = localStorage.getItem(editorGizmoSnapStorageKey);
-		if (!raw) {
-			return roundGizmoSnapSteps({ ...defaultGizmoSnapPreferences });
-		}
-		const parsed = JSON.parse(raw) as Partial<IGizmoSnapPreferences>;
-		const base = defaultGizmoSnapPreferences;
-		return roundGizmoSnapSteps({
-			translationEnabled: asBoolean(parsed.translationEnabled, base.translationEnabled),
-			translationStep: clampPositive(asNumber(parsed.translationStep, base.translationStep), base.translationStep),
-			rotationEnabled: asBoolean(parsed.rotationEnabled, base.rotationEnabled),
-			rotationStepDegrees: clampPositive(asNumber(parsed.rotationStepDegrees, base.rotationStepDegrees), base.rotationStepDegrees),
-			scaleEnabled: asBoolean(parsed.scaleEnabled, base.scaleEnabled),
-			scaleStep: clampPositive(asNumber(parsed.scaleStep, base.scaleStep), base.scaleStep),
-		});
-	} catch {
-		return roundGizmoSnapSteps({ ...defaultGizmoSnapPreferences });
-	}
-}
-
-export function saveGizmoSnapPreferences(prefs: IGizmoSnapPreferences): void {
-	localStorage.setItem(editorGizmoSnapStorageKey, JSON.stringify(roundGizmoSnapSteps(prefs)));
-}