Skip to content

Create abstraction layer over the inspector gizmo layer #17177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 22, 2025
Merged

Create abstraction layer over the inspector gizmo layer #17177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66c8ea2
Create abstraction layer over the inspector gizmo layer
kv-bh Sep 19, 2025
570b95f
Fix formatting
kv-bh Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions packages/dev/inspector/src/components/sceneExplorer/entities/cameraTreeItemComponent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { TreeItemLabelComponent } from "../treeItemLabelComponent";
import { ExtensionsComponent } from "../extensionsComponent";
import * as React from "react";
import type { GlobalState } from "../../globalState";
import { GetInspectorGizmoManager } from "../../../inspectorGizmoManager";

interface ICameraTreeItemComponentProps {
camera: Camera;
Expand Down Expand Up @@ -73,9 +74,7 @@ export class CameraTreeItemComponent extends React.Component<ICameraTreeItemComp
toggleGizmo(): void {
const camera = this.props.camera;
if (camera.reservedDataStore && camera.reservedDataStore.cameraGizmo) {
if (camera.getScene().reservedDataStore && camera.getScene().reservedDataStore.gizmoManager) {
camera.getScene().reservedDataStore.gizmoManager.attachToMesh(null);
}
GetInspectorGizmoManager(camera.getScene(), false)?.attachToMesh(null);
this.props.globalState.enableCameraGizmo(camera, false);
this.setState({ isGizmoEnabled: false });
} else {
Expand Down
5 changes: 2 additions & 3 deletions packages/dev/inspector/src/components/sceneExplorer/entities/lightTreeItemComponent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { TreeItemLabelComponent } from "../treeItemLabelComponent";
import { ExtensionsComponent } from "../extensionsComponent";
import * as React from "react";
import type { GlobalState } from "../../globalState";
import { GetInspectorGizmoManager } from "../../../inspectorGizmoManager";

interface ILightTreeItemComponentProps {
light: Light;
Expand Down Expand Up @@ -39,9 +40,7 @@ export class LightTreeItemComponent extends React.Component<ILightTreeItemCompon
toggleGizmo(): void {
const light = this.props.light;
if (light.reservedDataStore && light.reservedDataStore.lightGizmo) {
if (light.getScene().reservedDataStore && light.getScene().reservedDataStore.gizmoManager) {
light.getScene().reservedDataStore.gizmoManager.attachToMesh(null);
}
GetInspectorGizmoManager(light.getScene(), false)?.attachToMesh(null);
this.props.globalState.enableLightGizmo(light, false);
this.setState({ isGizmoEnabled: false });
} else {
Expand Down
41 changes: 14 additions & 27 deletions packages/dev/inspector/src/components/sceneExplorer/entities/sceneTreeItemComponent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import type { Observer, Observable } from "core/Misc/observable";
import type { PointerInfo } from "core/Events/pointerEvents";
import { PointerEventTypes } from "core/Events/pointerEvents";
import type { IExplorerExtensibilityGroup } from "core/Debug/debugLayer";
import { GizmoManager } from "core/Gizmos/gizmoManager";
import type { Scene } from "core/scene";

import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
Expand All @@ -22,8 +21,8 @@ import { GizmoCoordinatesMode } from "core/Gizmos/gizmo";
import type { Bone } from "core/Bones/bone";

import { setDebugNode } from "../treeNodeDebugger";
import { FrameGraphUtils } from "core/FrameGraph/frameGraphUtils";
import type { DragStartEndEvent } from "core/Behaviors/Meshes/pointerDragEvents";
import { DisposeInspectorGizmoManager, GetInspectorGizmoManager } from "../../../inspectorGizmoManager";

interface ISceneTreeItemComponentProps {
scene: Scene;
Expand Down Expand Up @@ -53,8 +52,8 @@ export class SceneTreeItemComponent extends React.Component<

const scene = this.props.scene;
let gizmoMode = 0;
if (scene.reservedDataStore && scene.reservedDataStore.gizmoManager) {
const manager: GizmoManager = scene.reservedDataStore.gizmoManager;
const manager = GetInspectorGizmoManager(scene, false);
if (manager) {
if (manager.positionGizmoEnabled) {
gizmoMode = 1;
} else if (manager.rotationGizmoEnabled) {
Expand Down Expand Up @@ -85,9 +84,8 @@ export class SceneTreeItemComponent extends React.Component<
}

updateGizmoAutoPicking(isInPickingMode: boolean) {
const scene = this.props.scene;
if (scene.reservedDataStore && scene.reservedDataStore.gizmoManager) {
const manager: GizmoManager = scene.reservedDataStore.gizmoManager;
const manager = GetInspectorGizmoManager(this.props.scene, false);
if (manager) {
manager.enableAutoPicking = isInPickingMode;
}
}
Expand All @@ -100,9 +98,8 @@ export class SceneTreeItemComponent extends React.Component<
const scene = this.props.scene;
this._onSelectionChangeObserver = this.props.onSelectionChangedObservable.add((entity) => {
this._selectedEntity = entity;
if (entity && scene.reservedDataStore && scene.reservedDataStore.gizmoManager) {
const manager: GizmoManager = scene.reservedDataStore.gizmoManager;

const manager = GetInspectorGizmoManager(scene, false);
if (entity && manager) {
const className = entity.getClassName();

if (className === "TransformNode" || className.indexOf("Mesh") !== -1) {
Expand Down Expand Up @@ -181,10 +178,11 @@ export class SceneTreeItemComponent extends React.Component<
}

onCoordinatesMode() {
const scene = this.props.scene;
const manager: GizmoManager = scene.reservedDataStore.gizmoManager;
const manager = GetInspectorGizmoManager(this.props.scene, false);
// flip coordinate system
manager.coordinatesMode = this.state.isInWorldCoodinatesMode ? GizmoCoordinatesMode.Local : GizmoCoordinatesMode.World;
if (manager) {
manager.coordinatesMode = this.state.isInWorldCoodinatesMode ? GizmoCoordinatesMode.Local : GizmoCoordinatesMode.World;
}
this.setState({ isInWorldCoodinatesMode: !this.state.isInWorldCoodinatesMode });
}
onPickingMode() {
Expand Down Expand Up @@ -266,27 +264,17 @@ export class SceneTreeItemComponent extends React.Component<
setGizmoMode(mode: number) {
const scene = this.props.scene;

if (!scene.reservedDataStore) {
scene.reservedDataStore = {};
}

if (this._gizmoLayerOnPointerObserver) {
scene.onPointerObservable.remove(this._gizmoLayerOnPointerObserver);
this._gizmoLayerOnPointerObserver = null;
}

if (!scene.reservedDataStore.gizmoManager) {
const layer1 = scene.frameGraph ? FrameGraphUtils.CreateUtilityLayerRenderer(scene.frameGraph) : new UtilityLayerRenderer(scene);
const layer2 = scene.frameGraph ? FrameGraphUtils.CreateUtilityLayerRenderer(scene.frameGraph) : new UtilityLayerRenderer(scene);

scene.reservedDataStore.gizmoManager = new GizmoManager(scene, undefined, layer1, layer2);
}
const manager = GetInspectorGizmoManager(scene, true);

if (this.props.gizmoCamera) {
scene.reservedDataStore.gizmoManager.utilityLayer.setRenderCamera(this.props.gizmoCamera);
manager.utilityLayer.setRenderCamera(this.props.gizmoCamera);
}

const manager: GizmoManager = scene.reservedDataStore.gizmoManager;
// Allow picking of light gizmo when a gizmo mode is selected
this._gizmoLayerOnPointerObserver = UtilityLayerRenderer.DefaultUtilityLayer.utilityLayerScene.onPointerObservable.add((pointerInfo) => {
if (pointerInfo.type == PointerEventTypes.POINTERDOWN) {
Expand All @@ -312,8 +300,7 @@ export class SceneTreeItemComponent extends React.Component<

if (this.state.gizmoMode === mode) {
mode = 0;
manager.dispose();
scene.reservedDataStore.gizmoManager = null;
DisposeInspectorGizmoManager(scene);
} else {
switch (mode) {
case 1:
Expand Down
6 changes: 2 additions & 4 deletions packages/dev/inspector/src/inspector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import type { IPopupComponentProps } from "./components/popupComponent";
import { PopupComponent } from "./components/popupComponent";
import { CopyStyles } from "shared-ui-components/styleHelper";
import { CreatePopup } from "shared-ui-components/popupHelper";
import { DisposeInspectorGizmoManager } from "./inspectorGizmoManager";

interface IInternalInspectorOptions extends IInspectorOptions {
popup: boolean;
Expand Down Expand Up @@ -538,10 +539,7 @@ export class Inspector {
this._GlobalState.enableCameraGizmo(g.camera, false);
}
}
if (this._Scene && this._Scene.reservedDataStore && this._Scene.reservedDataStore.gizmoManager) {
this._Scene.reservedDataStore.gizmoManager.dispose();
this._Scene.reservedDataStore.gizmoManager = null;
}
DisposeInspectorGizmoManager(this._Scene);

if (this._NewCanvasContainer) {
this._DestroyCanvasContainer();
Expand Down
36 changes: 36 additions & 0 deletions packages/dev/inspector/src/inspectorGizmoManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import type { Scene } from "core/scene";
import type { Nullable } from "core/types";
import { UtilityLayerRenderer } from "core/Rendering/utilityLayerRenderer";
import { GizmoManager } from "core/Gizmos/gizmoManager";
import { FrameGraphUtils } from "core/FrameGraph/frameGraphUtils";

function CreateInspectorGizmoManager(scene: Scene): GizmoManager {
const layer1 = scene.frameGraph ? FrameGraphUtils.CreateUtilityLayerRenderer(scene.frameGraph) : new UtilityLayerRenderer(scene);
const layer2 = scene.frameGraph ? FrameGraphUtils.CreateUtilityLayerRenderer(scene.frameGraph) : new UtilityLayerRenderer(scene);
const gizmoManager = new GizmoManager(scene, undefined, layer1, layer2);
scene.reservedDataStore ??= {};
scene.reservedDataStore.gizmoManager = gizmoManager;
return gizmoManager;
}

export function GetInspectorGizmoManager(scene: Nullable<Scene> | undefined, create: true): GizmoManager;
export function GetInspectorGizmoManager(scene: Nullable<Scene> | undefined, create: false): Nullable<GizmoManager>;
export function GetInspectorGizmoManager(scene: Nullable<Scene> | undefined, create: boolean): Nullable<GizmoManager> {
let gizmoManager = scene && scene.reservedDataStore && scene.reservedDataStore.gizmoManager ? (scene.reservedDataStore.gizmoManager as GizmoManager) : null;
if (!gizmoManager && create) {
if (!scene) {
throw new Error("Invalid scene provided to GetInspectorGizmoManager");
}
gizmoManager = CreateInspectorGizmoManager(scene);
}
return gizmoManager;
}

export function DisposeInspectorGizmoManager(scene: Nullable<Scene> | undefined): void {
const gizmoManager = GetInspectorGizmoManager(scene, false);
if (!gizmoManager) {
return;
}
gizmoManager.dispose();
scene!.reservedDataStore.gizmoManager = null;
}