@babylonjs/inspector 8.31.1-preview → 8.31.2-preview

package/lib/index.d.ts

@@ -1,13 +1,13 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { ComponentType, ComponentProps, FunctionComponent, PropsWithChildren, HTMLProps, ElementRef, ReactNode, ReactElement } from 'react';
-import { IDisposable as IDisposable$1, Nullable as Nullable$1, IReadonlyObservable as IReadonlyObservable$1, Scene as Scene$1 } from '@babylonjs/core/index.js';
+import { IDisposable as IDisposable$1, Nullable as Nullable$1, IReadonlyObservable as IReadonlyObservable$2, Scene as Scene$1 } from '@babylonjs/core/index.js';
+import { IReadonlyObservable as IReadonlyObservable$1 } from '@babylonjs/core/Misc/observable.js';
 import { Nullable as Nullable$2 } from '@babylonjs/core/types.js';
 import { PositioningImperativeRef, OnOpenChangeData, SpinnerProps } from '@fluentui/react-components';
 export { Link } from '@fluentui/react-components';
 import { Color3 as Color3$1, Color4 as Color4$1 } from '@babylonjs/core/Maths/math.color.js';
 import { Vector3 as Vector3$1, Quaternion as Quaternion$1 } from '@babylonjs/core/Maths/math.vector.js';
-import { IReadonlyObservable as IReadonlyObservable$2 } from '@babylonjs/core/Misc/observable.js';
 import { IDisposable as IDisposable$2, Scene as Scene$2 } from '@babylonjs/core/scene.js';
 import { IInspectorOptions as IInspectorOptions$1 } from '@babylonjs/core/Debug/debugLayer.js';
 import { TernaryDarkMode } from 'usehooks-ts';
@@ -222,6 +222,197 @@ type ServiceDefinition<Produces extends IService<symbol>[] = [], Consumes extend
     consumes: ExtractContractIdentities<Consumes>;
 });
 
+declare const SettingsContextIdentity: unique symbol;
+/**
+ * SettingsContext provides a set of settings used across the inspector.
+ */
+interface ISettingsContext extends IService<typeof SettingsContextIdentity> {
+    /**
+     * Use degrees instead of radians for angles.
+     */
+    useDegrees: boolean;
+    /**
+     * Ignore backfaces when picking.
+     */
+    ignoreBackfacesForPicking: boolean;
+    /**
+     * Shows the Properties pane when an entity is selected.
+     */
+    showPropertiesOnEntitySelection: boolean;
+    /**
+     * Observable that fires whenever a setting changes.
+     */
+    readonly settingsChangedObservable: IReadonlyObservable$1<ISettingsContext>;
+}
+
+/**
+ * Describes an item that can be added to one of the shell's toolbars.
+ */
+type ToolbarItemDefinition = Readonly<{
+    /**
+     * A unique key for the toolbar item.
+     */
+    key: string;
+    /**
+     * The component to render for the toolbar item.
+     */
+    component: ComponentType;
+    /**
+     * An optional order for the toolbar item, relative to other items.
+     * Defaults to 0.
+     */
+    order?: number;
+    /**
+     * The horizontal location of the toolbar item.
+     * Can be either "left" or "right".
+     * In "compact" toolbar mode, "left" and "right" mean the "compact" toolbars at the top/bottom of the left/right side panes.
+     * In "full" toolbar mode, "left" and "right" mean the left side and right side of the full width toolbars above/below the side panes.
+     */
+    horizontalLocation: "left" | "right";
+    /**
+     * The vertical location of the toolbar item.
+     * Can be either "top" or "bottom".
+     */
+    verticalLocation: "top" | "bottom";
+    /**
+     * An optional display name for the toolbar item, used for teaching moments, tooltips, etc.
+     */
+    displayName?: string;
+    /**
+     * An optional flag to suppress the teaching moment for this toolbar item.
+     * Defaults to false.
+     * Teaching moments are more helpful for dynamically added items, possibly from extensions.
+     */
+    suppressTeachingMoment?: boolean;
+}>;
+/**
+ * Describes a side pane that can be added to the shell's left or right side.
+ */
+type SidePaneDefinition = Readonly<{
+    /**
+     * A unique key for the side pane.
+     */
+    key: string;
+    /**
+     * An icon component to render for the pane tab.
+     */
+    icon: ComponentType;
+    /**
+     * The component to render for the side pane's content.
+     */
+    content: ComponentType;
+    /**
+     * An optional order for the side pane, relative to other panes.
+     * Defaults to 0.
+     */
+    order?: number;
+    /**
+     * The horizontal location of the side pane.
+     * Can be either "left" or "right".
+     */
+    horizontalLocation: "left" | "right";
+    /**
+     * The vertical location of the side pane.
+     * Can be either "top" or "bottom".
+     */
+    verticalLocation: "top" | "bottom";
+    /**
+     * An optional title for the side pane, displayed as a standardized header at the top of the pane.
+     */
+    title?: string;
+    /**
+     * An optional flag to suppress the teaching moment for this side pane.
+     * Defaults to false.
+     * Teaching moments are more helpful for dynamically added panes, possibly from extensions.
+     */
+    suppressTeachingMoment?: boolean;
+}>;
+type RegisteredSidePane = {
+    key: string;
+    select(): void;
+};
+/**
+ * Describes content that can be added to the shell's central area (between the side panes and toolbars - e.g. the main content).
+ */
+type CentralContentDefinition = Readonly<{
+    /**
+     * A unique key for the central content.
+     */
+    key: string;
+    /**
+     * The component to render for the central content.
+     */
+    component: ComponentType;
+    /**
+     * An optional order for content, relative to other central content.
+     * Defaults to 0.
+     */
+    order?: number;
+}>;
+declare const ShellServiceIdentity: unique symbol;
+/**
+ * Provides a shell for the application, including toolbars, side panes, and central content.
+ * This service allows adding toolbar items, side panes, and central content dynamically.
+ */
+interface IShellService extends IService<typeof ShellServiceIdentity> {
+    /**
+     * Adds a new item to one of the shell's toolbars.
+     * @param item Defines the item to add.
+     */
+    addToolbarItem(item: ToolbarItemDefinition): IDisposable$1;
+    /**
+     * Adds a new side pane to the shell.
+     * @param pane Defines the side pane to add.
+     */
+    addSidePane(pane: SidePaneDefinition): IDisposable$1;
+    /**
+     * Adds new central content to the shell.
+     * @param content Defines the content area to add.
+     */
+    addCentralContent(content: CentralContentDefinition): IDisposable$1;
+    /**
+     * The side panes currently present in the shell.
+     */
+    readonly sidePanes: readonly RegisteredSidePane[];
+}
+type ToolbarMode = "full" | "compact";
+type SidePaneMode = "both" | "right";
+/**
+ * Options for configuring the shell service.
+ */
+type ShellServiceOptions = {
+    /**
+     * The default width of the left side pane.
+     */
+    leftPaneDefaultWidth?: number;
+    /**
+     * The minimum width of the left side pane.
+     */
+    leftPaneMinWidth?: number;
+    /**
+     * The default width of the right side pane.
+     */
+    rightPaneDefaultWidth?: number;
+    /**
+     * The minimum width of the right side pane.
+     */
+    rightPaneMinWidth?: number;
+    /**
+     * The mode of the toolbars.
+     * Can be either "full" (default) or "compact".
+     * In "full" mode, toolbars are displayed above and below the side panes.
+     * In "compact" mode, toolbars are displayed at the top and bottom of the left and right side panes.
+     */
+    toolbarMode?: ToolbarMode;
+    /**
+     * The mode of the side panes.
+     * Can be either "both" (default) or "right".
+     * In "both" mode, side panes can be added to both the left and right sides.
+     * In "right" mode, all left panes are moved to the upper right, and all right panes are moved to the lower right.
+     */
+    sidePaneMode?: SidePaneMode;
+};
+
 declare const SelectionServiceIdentity: unique symbol;
 /**
  * Tracks the currently selected entity.
@@ -234,9 +425,9 @@ interface ISelectionService extends IService<typeof SelectionServiceIdentity> {
     /**
      * An observable that notifies when the selected entity changes.
      */
-    readonly onSelectedEntityChanged: IReadonlyObservable$1<void>;
+    readonly onSelectedEntityChanged: IReadonlyObservable$2<void>;
 }
-declare const SelectionServiceDefinition: ServiceDefinition<[ISelectionService], []>;
+declare const SelectionServiceDefinition: ServiceDefinition<[ISelectionService], [IShellService, ISettingsContext]>;
 
 type LinkToEntityProps = {
     entity: Nullable$2<{
@@ -264,7 +455,7 @@ type EntityDisplayInfo = Partial<IDisposable$1> & Readonly<{
     /**
      * An observable that notifies when the display info (such as the name) changes.
      */
-    onChange?: IReadonlyObservable$1<void>;
+    onChange?: IReadonlyObservable$2<void>;
 }>;
 type SceneExplorerSection<T extends EntityBase> = Readonly<{
     /**
@@ -299,15 +490,15 @@ type SceneExplorerSection<T extends EntityBase> = Readonly<{
     /**
      * A function that returns an array of observables for when entities are added to the scene.
      */
-    getEntityAddedObservables: () => readonly IReadonlyObservable$1<T>[];
+    getEntityAddedObservables: () => readonly IReadonlyObservable$2<T>[];
     /**
      * A function that returns an array of observables for when entities are removed from the scene.
      */
-    getEntityRemovedObservables: () => readonly IReadonlyObservable$1<T>[];
+    getEntityRemovedObservables: () => readonly IReadonlyObservable$2<T>[];
     /**
      * A function that returns an array of observables for when entities are moved (e.g. re-parented) within the scene.
      */
-    getEntityMovedObservables?: () => readonly IReadonlyObservable$1<T>[];
+    getEntityMovedObservables?: () => readonly IReadonlyObservable$2<T>[];
 }>;
 type Command = Partial<IDisposable$1> & Readonly<{
     /**
@@ -321,7 +512,7 @@ type Command = Partial<IDisposable$1> & Readonly<{
     /**
      * An observable that notifies when the command state changes.
      */
-    onChange?: IReadonlyObservable$1<unknown>;
+    onChange?: IReadonlyObservable$2<unknown>;
 }>;
 type SceneExplorerCommand = ActionCommand | ToggleCommand;
 type SceneExplorerCommandProvider<T extends EntityBase> = Readonly<{
@@ -573,7 +764,7 @@ declare function MakePropertyHook(value: unknown): typeof useVector3Property;
  * @param propertyKey The key of the function/property to intercept.
  * @returns An observable that fires when the function/property is called/set.
  */
-declare function useInterceptObservable<T extends object>(type: "function" | "property", target: T | null | undefined, propertyKey: keyof T): IReadonlyObservable$1<void>;
+declare function useInterceptObservable<T extends object>(type: "function" | "property", target: T | null | undefined, propertyKey: keyof T): IReadonlyObservable$2<void>;
 
 /**
  * A collection of items that can be observed for changes.
@@ -585,7 +776,7 @@ declare class ObservableCollection<T> {
     /**
      * An observable that notifies observers when the collection changes.
      */
-    get observable(): IReadonlyObservable$1<void>;
+    get observable(): IReadonlyObservable$2<void>;
     /**
      * The items in the collection.
      */
@@ -616,7 +807,7 @@ declare function useEventfulState<T>(accessor: () => T, element: HTMLElement | n
  * @remarks If the accessor function is not idempotent (e.g. it returns a different array or object instance each time it is called),
  * then there is a good chance it should be wrapped in a `useCallback` to prevent unnecessary re-renders or re-render infinite loops.
  */
-declare function useObservableState<T>(accessor: () => T, ...observables: Array<IReadonlyObservable$1 | null | undefined>): T;
+declare function useObservableState<T>(accessor: () => T, ...observables: Array<IReadonlyObservable$2 | null | undefined>): T;
 /**
  * Returns a copy of the items in the collection and updates it when the collection changes.
  * @param collection The collection to observe.
@@ -637,7 +828,7 @@ declare function useOrderedObservableCollection<T extends Readonly<{
  * @param delay The polling interval in milliseconds.
  * @returns A readonly observable that can be used to subscribe to polling notifications.
  */
-declare function usePollingObservable(delay: number): IReadonlyObservable$1<void>;
+declare function usePollingObservable(delay: number): IReadonlyObservable$2<void>;
 
 /**
  * Custom hook to manage a resource with automatic disposal. The resource is created once initially, and recreated
@@ -656,25 +847,6 @@ declare function useResource<T extends IDisposable$1>(factory: () => T): T;
  */
 declare function useAsyncResource<T extends IDisposable$1>(factory: (abortSignal: AbortSignal) => Promise<T>): T | undefined;
 
-declare const SettingsContextIdentity: unique symbol;
-/**
- * SettingsContext provides a set of settings used across the inspector.
- */
-interface ISettingsContext extends IService<typeof SettingsContextIdentity> {
-    /**
-     * Use dregrees instead of radians for angles.
-     */
-    useDegrees: boolean;
-    /**
-     * Ignore backfaces when picking
-     */
-    ignoreBackfacesForPicking: boolean;
-    /**
-     * Observable that fires whenever a setting changes.
-     */
-    readonly settingsChangedObservable: IReadonlyObservable$2<ISettingsContext>;
-}
-
 /**
  * Gets functions used to convert to/from display values for angles based on the current settings.
  * @param settings The settings context to use for determining if angles should be displayed in degrees or radians.
@@ -725,154 +897,6 @@ type PropertyHooks = {
  */
 declare function InterceptProperty<T extends object>(target: T, propertyKey: keyof T, hooks: PropertyHooks): IDisposable$1;
 
-/**
- * Describes an item that can be added to one of the shell's toolbars.
- */
-type ToolbarItem = Readonly<{
-    /**
-     * A unique key for the toolbar item.
-     */
-    key: string;
-    /**
-     * The component to render for the toolbar item.
-     */
-    component: ComponentType;
-    /**
-     * An optional order for the toolbar item, relative to other items.
-     * Defaults to 0.
-     */
-    order?: number;
-    /**
-     * The horizontal location of the toolbar item.
-     * Can be either "left" or "right".
-     * In "compact" toolbar mode, "left" and "right" mean the "compact" toolbars at the top/bottom of the left/right side panes.
-     * In "full" toolbar mode, "left" and "right" mean the left side and right side of the full width toolbars above/below the side panes.
-     */
-    horizontalLocation: "left" | "right";
-    /**
-     * The vertical location of the toolbar item.
-     * Can be either "top" or "bottom".
-     */
-    verticalLocation: "top" | "bottom";
-    /**
-     * An optional display name for the toolbar item, used for teaching moments, tooltips, etc.
-     */
-    displayName?: string;
-    /**
-     * An optional flag to suppress the teaching moment for this toolbar item.
-     * Defaults to false.
-     * Teaching moments are more helpful for dynamically added items, possibly from extensions.
-     */
-    suppressTeachingMoment?: boolean;
-}>;
-/**
- * Describes a side pane that can be added to the shell's left or right side.
- */
-type SidePane = Readonly<{
-    /**
-     * A unique key for the side pane.
-     */
-    key: string;
-    /**
-     * An icon component to render for the pane tab.
-     */
-    icon: ComponentType;
-    /**
-     * The component to render for the side pane's content.
-     */
-    content: ComponentType;
-    /**
-     * An optional order for the side pane, relative to other panes.
-     * Defaults to 0.
-     */
-    order?: number;
-    /**
-     * The horizontal location of the side pane.
-     * Can be either "left" or "right".
-     */
-    horizontalLocation: "left" | "right";
-    /**
-     * The vertical location of the side pane.
-     * Can be either "top" or "bottom".
-     */
-    verticalLocation: "top" | "bottom";
-    /**
-     * An optional title for the side pane, displayed as a standardized header at the top of the pane.
-     */
-    title?: string;
-    /**
-     * An optional flag to suppress the teaching moment for this side pane.
-     * Defaults to false.
-     * Teaching moments are more helpful for dynamically added panes, possibly from extensions.
-     */
-    suppressTeachingMoment?: boolean;
-}>;
-/**
- * Describes content that can be added to the shell's central area (between the side panes and toolbars - e.g. the main content).
- */
-type CentralContent = Readonly<{
-    /**
-     * A unique key for the central content.
-     */
-    key: string;
-    /**
-     * The component to render for the central content.
-     */
-    component: ComponentType;
-    /**
-     * An optional order for content, relative to other central content.
-     * Defaults to 0.
-     */
-    order?: number;
-}>;
-declare const ShellServiceIdentity: unique symbol;
-/**
- * Provides a shell for the application, including toolbars, side panes, and central content.
- * This service allows adding toolbar items, side panes, and central content dynamically.
- */
-interface IShellService extends IService<typeof ShellServiceIdentity> {
-    addToolbarItem(item: ToolbarItem): IDisposable$1;
-    addSidePane(pane: SidePane): IDisposable$1;
-    addCentralContent(content: CentralContent): IDisposable$1;
-}
-type ToolbarMode = "full" | "compact";
-type SidePaneMode = "both" | "right";
-/**
- * Options for configuring the shell service.
- */
-type ShellServiceOptions = {
-    /**
-     * The default width of the left side pane.
-     */
-    leftPaneDefaultWidth?: number;
-    /**
-     * The minimum width of the left side pane.
-     */
-    leftPaneMinWidth?: number;
-    /**
-     * The default width of the right side pane.
-     */
-    rightPaneDefaultWidth?: number;
-    /**
-     * The minimum width of the right side pane.
-     */
-    rightPaneMinWidth?: number;
-    /**
-     * The mode of the toolbars.
-     * Can be either "full" (default) or "compact".
-     * In "full" mode, toolbars are displayed above and below the side panes.
-     * In "compact" mode, toolbars are displayed at the top and bottom of the left and right side panes.
-     */
-    toolbarMode?: ToolbarMode;
-    /**
-     * The mode of the side panes.
-     * Can be either "both" (default) or "right".
-     * In "both" mode, side panes can be added to both the left and right sides.
-     * In "right" mode, all left panes are moved to the upper right, and all right panes are moved to the lower right.
-     */
-    sidePaneMode?: SidePaneMode;
-};
-
 declare const PropertiesServiceIdentity: unique symbol;
 type PropertiesSectionContent<EntityT> = {
     /**
@@ -914,7 +938,7 @@ interface ISceneContext extends IService<typeof SceneContextIdentity> {
     /**
      * Observable that fires whenever the current scene changes.
      */
-    readonly currentSceneObservable: IReadonlyObservable$1<Nullable$1<Scene$1>>;
+    readonly currentSceneObservable: IReadonlyObservable$2<Nullable$1<Scene$1>>;
 }
 
 declare const SceneExplorerServiceIdentity: unique symbol;
@@ -71645,4 +71669,4 @@ declare const Vector3PropertyLine: FunctionComponent<TensorPropertyLineProps<Vec
 declare const Vector4PropertyLine: FunctionComponent<TensorPropertyLineProps<Vector4>>;
 
 export { Accordion, AccordionSection, BooleanBadgePropertyLine, BoundProperty, BuiltInsExtensionFeed, Button, ButtonLine, Checkbox, CheckboxPropertyLine, Collapse, Color3GradientComponent, Color3GradientList, Color3PropertyLine, Color4GradientComponent, Color4GradientList, Color4PropertyLine, ColorPickerPopup, ColorStepGradientComponent, ComboBox, ConstructorFactory, DebugServiceIdentity, DraggableLine, Dropdown, ExtensibleAccordion, FactorGradientComponent, FactorGradientList, FileUploadLine, GetPropertyDescriptor, HexPropertyLine, HideInspector, InfoLabel, InputHexField, InputHsvField, Inspector, InterceptFunction, InterceptProperty, IsInspectorVisible, IsPropertyReadonly, LineContainer, LinkPropertyLine, LinkToEntityPropertyLine, List, MakeDialogTeachingMoment, MakeLazyComponent, MakePopoverTeachingMoment, MakePropertyHook, MakeTeachingMoment, MessageBar, NumberDropdown, NumberDropdownPropertyLine, NumberInputPropertyLine, ObservableCollection, Pane, PlaceholderPropertyLine, PositionedPopover, PropertiesServiceIdentity, PropertyLine, QuaternionPropertyLine, RotationVectorPropertyLine, SceneContextIdentity, SceneExplorerServiceIdentity, SearchBar, SearchBox, SelectionServiceDefinition, SelectionServiceIdentity, SettingsContextIdentity, SettingsServiceIdentity, ShellServiceIdentity, ShowInspector, SidePaneContainer, SpinButton, SpinButtonPropertyLine, StatsServiceIdentity, StringDropdown, StringDropdownPropertyLine, StringifiedPropertyLine, Switch, SwitchPropertyLine, SyncedSliderInput, SyncedSliderPropertyLine, TeachingMoment, TextAreaPropertyLine, TextInput, TextInputPropertyLine, TextPropertyLine, Textarea, ToggleButton, ToolsServiceIdentity, Vector2PropertyLine, Vector3PropertyLine, Vector4PropertyLine, useAngleConverters, useAsyncResource, useColor3Property, useColor4Property, useEventfulState, useInterceptObservable, useObservableCollection, useObservableState, useOrderedObservableCollection, usePollingObservable, useProperty, useQuaternionProperty, useResource, useVector3Property };
-export type { AcceptedDropdownValue, AccordionSectionProps, BasePrimitiveProps, BoundPropertyProps, BuiltInExtension, ButtonProps, CentralContent, ColorPickerProps, ColorPropertyLineProps, ComboBoxProps, DraggableLineProps, DropdownOption, DropdownProps, DynamicAccordionSection, DynamicAccordionSectionContent, EntityBase, EntityDisplayInfo, ExtensionMetadata, ExtensionModule, FunctionHooks, IDebugService, IExtensionFeed, IExtensionMetadataQuery, IPropertiesService, ISceneContext, ISceneExplorerService, ISelectionService, IService, ISettingsContext, ISettingsService, IShellService, IStatsService, IToolsService, ImmutablePrimitiveProps, InfoLabelParentProps, InfoLabelProps, InputHexProps, ListItem, NumberInputPropertyLineProps, PaneProps, PrimitiveProps, PropertyHooks, PropertyLineProps, SceneExplorerCommand, SceneExplorerCommandProvider, SceneExplorerSection, ServiceDefinition, ServiceFactory, SidePane, SpinButtonProps, SwitchProps, SyncedSliderProps, TensorPropertyLineProps, TextInputProps, TextareaProps, ToolbarItem };
+export type { AcceptedDropdownValue, AccordionSectionProps, BasePrimitiveProps, BoundPropertyProps, BuiltInExtension, ButtonProps, CentralContentDefinition, ColorPickerProps, ColorPropertyLineProps, ComboBoxProps, DraggableLineProps, DropdownOption, DropdownProps, DynamicAccordionSection, DynamicAccordionSectionContent, EntityBase, EntityDisplayInfo, ExtensionMetadata, ExtensionModule, FunctionHooks, IDebugService, IExtensionFeed, IExtensionMetadataQuery, IPropertiesService, ISceneContext, ISceneExplorerService, ISelectionService, IService, ISettingsContext, ISettingsService, IShellService, IStatsService, IToolsService, ImmutablePrimitiveProps, InfoLabelParentProps, InfoLabelProps, InputHexProps, ListItem, NumberInputPropertyLineProps, PaneProps, PrimitiveProps, PropertyHooks, PropertyLineProps, SceneExplorerCommand, SceneExplorerCommandProvider, SceneExplorerSection, ServiceDefinition, ServiceFactory, SidePaneDefinition, SpinButtonProps, SwitchProps, SyncedSliderProps, TensorPropertyLineProps, TextInputProps, TextareaProps, ToolbarItemDefinition };