@babylonjs/inspector 8.34.1-preview → 8.35.0-preview

package/lib/index.d.ts

@@ -661,11 +661,33 @@ type WeaklyTypedServiceDefinition = Omit<ServiceDefinition<IService<symbol>[] |
     factory: (...args: any) => ReturnType<ServiceDefinition<IService<symbol>[] | [], IService<symbol>[] | []>["factory"]>;
 };
 
+type PersonMetadata = {
+    /**
+     * The name of the person.
+     */
+    readonly name: string;
+    /**
+     * The email address of the person.
+     */
+    readonly email?: string;
+    /**
+     * The URL to the person's website.
+     */
+    readonly url?: string;
+    /**
+     * The Babylon forum username of the person.
+     */
+    readonly forumUserName?: string;
+};
 type ExtensionMetadata = {
     /**
      * The name of the extension.
      */
     readonly name: string;
+    /**
+     * The version of the extension (as valid semver).
+     */
+    readonly version?: string;
     /**
      * The description of the extension.
      */
@@ -673,7 +695,31 @@ type ExtensionMetadata = {
     /**
      * The keywords of the extension.
      */
-    readonly keywords: readonly string[];
+    readonly keywords?: readonly string[];
+    /**
+     * The URL to the extension homepage.
+     */
+    readonly homepage?: string;
+    /**
+     * Specify the place where your code lives. This is helpful for people who want to contribute.
+     */
+    readonly repository?: string;
+    /**
+     * The URL to your extension's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your extension.
+     */
+    readonly bugs?: string;
+    /**
+     * A license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it.
+     */
+    readonly license?: string;
+    /**
+     * The primary author of the extension.
+     */
+    readonly author?: string | PersonMetadata;
+    /**
+     * The contributors to the extension.
+     */
+    readonly contributors?: readonly (string | PersonMetadata)[];
 };
 type ExtensionModule = {
     /**
@@ -1214,11 +1260,16 @@ interface IVector3Like extends IVector2Like {
 /**
  * @internal
  */
-interface IVector3LikeInternal {
+interface IDirtyFlagLike {
+    _isDirty?: boolean;
+}
+/**
+ * @internal
+ */
+interface IVector3LikeInternal extends IDirtyFlagLike {
     _x: number;
     _y: number;
     _z: number;
-    _isDirty?: boolean;
 }
 /**
  * @internal
@@ -20649,10 +20700,6 @@ declare class NodeParticleBuildState {
      * @returns the value associated with the source
      */
     getContextualValue(source: NodeParticleContextualSources): number | Color4 | Nullable<Vector3> | Vector2;
-    /**
-     * Gets a boolean indicating if the emitter is a transform node (or a simple vector3)
-     */
-    get isEmitterTransformNode(): boolean;
     /**
      * Gets the emitter world matrix
      */
@@ -20664,13 +20711,13 @@ declare class NodeParticleBuildState {
     /**
      * Gets the emitter position
      */
-    get emitterPosition(): Vector3 | null;
+    get emitterPosition(): Nullable<Vector3>;
     /**
      * Gets the value associated with a system source
      * @param source Source of the system value
      * @returns the value associated with the source
      */
-    getSystemValue(source: NodeParticleSystemSources): number | Nullable<Vector3 | AbstractMesh>;
+    getSystemValue(source: NodeParticleSystemSources): number | Nullable<Vector3>;
 }
 
 /**
@@ -21025,6 +21072,10 @@ declare class SystemBlock extends NodeParticleBlock {
      * Gets or sets the emit rate
      */
     emitRate: number;
+    /**
+     * Gets or sets the manual emit count
+     */
+    manualEmitCount: number;
     /**
      * Gets or sets the target stop duration for the particle system
      */
@@ -21037,6 +21088,26 @@ declare class SystemBlock extends NodeParticleBlock {
      * Gets or sets the target stop duration for the particle system
      */
     updateSpeed: number;
+    /**
+     * Gets or sets the number of pre-warm cycles before rendering the particle system
+     */
+    preWarmCycles: number;
+    /**
+     * Gets or sets the time step multiplier used for pre-warm
+     */
+    preWarmStepOffset: number;
+    /**
+     * Gets or sets a boolean indicating if the system is billboard based
+     */
+    isBillboardBased: boolean;
+    /**
+     * Gets or sets a boolean indicating if the system coordinate space is local or global
+     */
+    isLocal: boolean;
+    /**
+     * Gets or sets a boolean indicating if the system should be disposed when stopped
+     */
+    disposeOnStop: boolean;
     /**
      * Gets or sets a boolean indicating if the system should not start automatically
      */
@@ -21069,6 +21140,14 @@ declare class SystemBlock extends NodeParticleBlock {
      * Gets the onEnd input component
      */
     get onEnd(): NodeParticleConnectionPoint;
+    /**
+     * Gets the translationPivot input component
+     */
+    get translationPivot(): NodeParticleConnectionPoint;
+    /**
+     * Gets the gravity input component
+     */
+    get gravity(): NodeParticleConnectionPoint;
     /**
      * Gets the system output component
      */
@@ -33459,6 +33538,8 @@ interface IRaycastQuery {
     collideWith?: number;
     /** Should trigger collisions be considered in the query? */
     shouldHitTriggers?: boolean;
+    /** Ignores the body passed if it is in the query */
+    ignoreBody?: PhysicsBody;
 }
 /**
  * Holds the data for the raycast result
@@ -39454,41 +39535,44 @@ declare module "../scene" {
         /**
          * The main sound track played by the scene.
          * It contains your primary collection of sounds.
+         * @deprecated please use AudioEngineV2 instead
          */
         mainSoundTrack: SoundTrack;
         /**
          * The list of sound tracks added to the scene
-         * @see https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic
+         * @deprecated please use AudioEngineV2 instead
          */
         soundTracks: Nullable<Array<SoundTrack>>;
         /**
          * Gets a sound using a given name
          * @param name defines the name to search for
          * @returns the found sound or null if not found at all.
+         * @deprecated please use AudioEngineV2 instead
          */
         getSoundByName(name: string): Nullable<Sound>;
         /**
          * Gets or sets if audio support is enabled
-         * @see https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic
+         * @deprecated please use AudioEngineV2 instead
          */
         audioEnabled: boolean;
         /**
          * Gets or sets if audio will be output to headphones
-         * @see https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic
+         * @deprecated please use AudioEngineV2 instead
          */
         headphone: boolean;
         /**
          * Gets or sets custom audio listener position provider
-         * @see https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic
+         * @deprecated please use AudioEngineV2 instead
          */
         audioListenerPositionProvider: Nullable<() => Vector3>;
         /**
          * Gets or sets custom audio listener rotation provider
-         * @see https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic
+         * @deprecated please use AudioEngineV2 instead
          */
         audioListenerRotationProvider: Nullable<() => Vector3>;
         /**
          * Gets or sets a refresh rate when using 3D audio positioning
+         * @deprecated please use AudioEngineV2 instead
          */
         audioPositioningRefreshRate: number;
     }
@@ -48689,8 +48773,9 @@ declare abstract class FrameGraphTask {
     dependencies?: Set<FrameGraphTextureHandle>;
     /**
      * Records the task in the frame graph. Use this function to add content (render passes, ...) to the task.
+     * @param skipCreationOfDisabledPasses If true, the disabled passe(s) won't be created.
      */
-    abstract record(): void;
+    abstract record(skipCreationOfDisabledPasses?: boolean): void;
     /**
      * An observable that is triggered after the textures have been allocated.
      */
@@ -48717,7 +48802,7 @@ declare abstract class FrameGraphTask {
     /** @internal */
     _checkTask(): void;
     /** @internal */
-    _getPasses(): IFrameGraphPass[];
+    _execute(): void;
     private _checkSameRenderTarget;
 }
 
@@ -48761,17 +48846,27 @@ declare class NodeRenderGraphOutputBlock extends NodeRenderGraphBlock {
 }
 
 /**
- * @internal
+ * Base class for a frame graph pass.
  */
 declare class FrameGraphPass<T extends FrameGraphContext> implements IFrameGraphPass {
     name: string;
     protected readonly _parentTask: FrameGraphTask;
     protected readonly _context: T;
     private _executeFunc;
+    /**
+     * Whether the pass is disabled. Disabled passes will be skipped during execution.
+     */
     disabled: boolean;
+    /** @internal */
     constructor(name: string, _parentTask: FrameGraphTask, _context: T);
+    /**
+     * Executes the pass.
+     * @param func The function to execute for the pass.
+     */
     setExecuteFunc(func: (context: T) => void): void;
+    /** @internal */
     _execute(): void;
+    /** @internal */
     _isValid(): Nullable<string>;
 }
 
@@ -49289,7 +49384,7 @@ declare class FrameGraph implements IDisposable {
      * Returns a promise that resolves when the frame graph is ready to be executed
      * This method must be called after the graph has been built (FrameGraph.build called)!
      * @param timeStep Time step in ms between retries (default is 16)
-     * @param maxTimeout Maximum time in ms to wait for the graph to be ready (default is 30000)
+     * @param maxTimeout Maximum time in ms to wait for the graph to be ready (default is 5000)
      * @returns The promise that resolves when the graph is ready
      */
     whenReadyAsync(timeStep?: number, maxTimeout?: number): Promise<void>;
@@ -49516,7 +49611,7 @@ declare class NodeRenderGraph {
      * Returns a promise that resolves when the node render graph is ready to be executed
      * This method must be called after the graph has been built (NodeRenderGraph.build called)!
      * @param timeStep Time step in ms between retries (default is 16)
-     * @param maxTimeout Maximum time in ms to wait for the graph to be ready (default is 30000)
+     * @param maxTimeout Maximum time in ms to wait for the graph to be ready (default is 5000)
      * @returns The promise that resolves when the graph is ready
      */
     whenReadyAsync(timeStep?: number, maxTimeout?: number): Promise<void>;
@@ -61047,6 +61142,10 @@ declare class Camera extends Node {
      * Defines if stereoscopic rendering is done side by side or over under.
      */
     isStereoscopicSideBySide: boolean;
+    /**
+     * Ignores camera maxZ when computing the projection matrix (ie. use 0 instead of maxZ), meaning objects won't be culled by the far plane
+     */
+    ignoreCameraMaxZ: boolean;
     /**
      * Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene
      * This is pretty helpful if you wish to make a camera render to a texture you could reuse somewhere
@@ -66955,6 +67054,7 @@ declare class Scene implements IAnimatable, IClipPlanesHolder, IAssetContainer {
      */
     autoClearDepthAndStencil: boolean;
     private _clearColor;
+    private _tempVect3;
     private _tempVect4;
     /**
      * Observable triggered when the performance priority is changed
@@ -67167,6 +67267,7 @@ declare class Scene implements IAnimatable, IClipPlanesHolder, IAssetContainer {
     effectLayers: Array<EffectLayer>;
     /**
      * The list of sounds used in the scene.
+     * @deprecated please use AudioEngineV2 instead
      */
     sounds: Nullable<Array<Sound>>;
     /**
@@ -67609,6 +67710,10 @@ declare class Scene implements IAnimatable, IClipPlanesHolder, IAssetContainer {
     /** If you need to check double click without raising a single click at first click, enable this flag */
     static get ExclusiveDoubleClickMode(): boolean;
     static set ExclusiveDoubleClickMode(value: boolean);
+    /**
+     * Gets the current eye position, in order of forcedViewPosition, mirroredCameraPosition, activeCamera world position, ZeroReadonlyVector3
+     */
+    private get _eyePosition();
     /**
      * Bind the current view position to an effect.
      * @param effect The effect to be bound
@@ -68388,10 +68493,9 @@ declare class Scene implements IAnimatable, IClipPlanesHolder, IAssetContainer {
      * This mode avoids floating point imprecision in huge coordinate system by offsetting uniform values before passing to shader, centering camera at origin and displacing rest of scene by camera position
      */
     get floatingOriginMode(): boolean;
-    private _floatingOriginOffsetDefault;
     /**
      * @experimental
-     * When floatingOriginMode is enabled, offset is equal to the active camera position in world space. If no active camera or floatingOriginMode is disabled, offset is 0.
+     * When floatingOriginMode is enabled, offset is equal to the eye position. Default to ZeroReadonly when mode is disabled.
      */
     get floatingOriginOffset(): Vector3;
     /**
@@ -71793,4 +71897,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, Link, 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, useCompactMode, useEventfulState, useInterceptObservable, useObservableCollection, useObservableState, useOrderedObservableCollection, usePollingObservable, useProperty, useQuaternionProperty, useResource, useSidePaneDockOverrides, useVector3Property };
-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, LinkProps, ListItem, NumberInputPropertyLineProps, PaneProps, PrimitiveProps, PropertyHooks, PropertyLineProps, SceneExplorerCommand, SceneExplorerCommandProvider, SceneExplorerSection, ServiceDefinition, ServiceFactory, SidePaneDefinition, SpinButtonProps, SwitchProps, SyncedSliderProps, TensorPropertyLineProps, TextInputProps, TextareaProps, ToolbarItemDefinition };
+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, LinkProps, ListItem, NumberInputPropertyLineProps, PaneProps, PersonMetadata, PrimitiveProps, PropertyHooks, PropertyLineProps, SceneExplorerCommand, SceneExplorerCommandProvider, SceneExplorerSection, ServiceDefinition, ServiceFactory, SidePaneDefinition, SpinButtonProps, SwitchProps, SyncedSliderProps, TensorPropertyLineProps, TextInputProps, TextareaProps, ToolbarItemDefinition };