babylonjs-editor 5.5.0 → 5.5.1-alpha.0

package/declaration/src/editor/layout/inspector/light/components/volumetric.d.ts

@@ -0,0 +1,11 @@
+import { Light } from "babylonjs";
+import { Editor } from "../../../../main";
+export interface IEditorLightVolumetricInspectorProps {
+    light: Light;
+    editor: Editor;
+}
+/**
+ * Draws the "Volumetric Lighting" section of the inspector of a light. Each light of the scene, including
+ * the ones that live inside a clustered light container, is configured individually here.
+ */
+export declare function EditorLightVolumetricInspector(props: IEditorLightVolumetricInspectorProps): import("react/jsx-runtime").JSX.Element | null;

package/declaration/src/editor/layout/inspector/scene/scene.d.ts

@@ -18,11 +18,14 @@ export declare class EditorSceneInspector extends Component<IEditorInspectorImpl
     get scene(): Scene;
     get isPlaying(): boolean;
     private _getPhysicsComponent;
+    private _getVolumetricLightingComponent;
     private _getDefaultRenderingPipelineComponent;
     private _getTAARenderingPipelineComponent;
     private _getSSAO2RenderingPipelineComponent;
     private _getMotionBlurPostProcessComponent;
     private _getSSRPipelineComponent;
+    private _volumetricAmbientColor;
+    private _getVolumetricAmbientColorObject;
     private _getVLSComponent;
     private _handleDragOverVlsMesh;
     private _handleDropVlsMesh;

package/declaration/src/editor/rendering/volumetric-lighting.d.ts

@@ -0,0 +1,22 @@
+import { Camera } from "babylonjs";
+import { Editor } from "../main";
+import { VolumetricLightingRenderingPipeline } from "babylonjs-editor-tools";
+/**
+ * Defines the configuration of the volumetric lighting rendering pipeline per camera.
+ */
+export declare const volumetricLightingRenderingPipelineCameraConfigurations: Map<Camera, any>;
+export declare function getVolumetricLightingRenderingPipeline(): VolumetricLightingRenderingPipeline | null;
+/**
+ * Returns wether or not the volumetric lighting rendering pipeline is supported by the engine used by the editor.
+ * @param editor defines the reference to the editor.
+ */
+export declare function isVolumetricLightingSupported(editor: Editor): boolean;
+export declare function disposeVolumetricLightingRenderingPipeline(): void;
+export declare function createVolumetricLightingRenderingPipeline(editor: Editor): VolumetricLightingRenderingPipeline;
+export declare function serializeVolumetricLightingRenderingPipeline(): any;
+export declare function parseVolumetricLightingRenderingPipeline(editor: Editor, data: any): VolumetricLightingRenderingPipeline;
+/**
+ * Marks the list of lights contributing to the volumetric lighting as dirty. Called when the volumetric
+ * configuration of a light is edited so the effect updates without waiting for the next selection pass.
+ */
+export declare function markVolumetricLightsDirty(): void;

package/declaration/src/export.d.ts

@@ -50,6 +50,7 @@ export * from "./editor/rendering/vls";
 export * from "./editor/rendering/ssao";
 export * from "./editor/rendering/motion-blur";
 export * from "./editor/rendering/default-pipeline";
+export * from "./editor/rendering/volumetric-lighting";
 export * from "./ui/spinner";
 export * from "./ui/color-picker";
 export * from "./ui/dialog";

package/declaration/src/tools/light/volumetric.d.ts

@@ -0,0 +1,47 @@
+import { Color3, Light } from "babylonjs";
+import { IVolumetricLightConfiguration } from "babylonjs-editor-tools";
+import { Editor } from "../../editor/main";
+/**
+ * Returns wether or not the given light can take part in the volumetric lighting.
+ * @param light defines the reference to the light to check.
+ */
+export declare function isVolumetricLightingAvailable(light: Light): boolean;
+export declare function getVolumetricLightConfigurationProxy(light: Light): IVolumetricLightConfiguration;
+/**
+ * Creates a Color3 whose three channels are accessors over the given array instead of plain values.
+ *
+ * The color field of the inspector mutates a Color3 in place, and its per-channel number fields register
+ * their own undo/redo that writes straight into that Color3, bypassing every callback. Binding the channels
+ * to the array makes all of those paths, including undo and redo, update the configuration itself.
+ * @param read defines the function returning the array backing the color.
+ * @param write defines the function storing the new array.
+ */
+export declare function createArrayBoundColor3(read: () => number[], write: (value: number[]) => void): Color3;
+/**
+ * Returns a stable object holding the custom volumetric color of the given light as a Color3 bound to the
+ * array stored in its configuration, so the inspector can edit it like any other color.
+ * @param light defines the reference to the light to get its custom volumetric color.
+ */
+export declare function getVolumetricLightColorObject(light: Light): {
+    color: Color3;
+};
+/**
+ * Returns how the light shafts of the given light are occluded by the geometry of the scene, and explains it.
+ *
+ * A light that renders a shadow map is occluded by it, which is exact. Any other light, including every light
+ * of a clustered light container, falls back on the depth buffer of the scene, which is an approximation but
+ * is what stops its shafts from showing through the walls that stand between it and the camera.
+ * @param light defines the reference to the light to check.
+ * @param editor defines the reference to the editor.
+ */
+export declare function getVolumetricLightOcclusionMode(light: Light, editor: Editor): {
+    usesShadowMap: boolean;
+    reason: string;
+};
+/**
+ * Returns a human readable description of what the given light currently does in the volumetric lighting
+ * rendering pipeline, drawn under the fields of the inspector.
+ * @param light defines the reference to the light to describe.
+ * @param editor defines the reference to the editor.
+ */
+export declare function getVolumetricLightStatusLabel(light: Light, editor: Editor): string;

package/declaration/src/tools/node/metadata.d.ts

@@ -1,4 +1,5 @@
 import { Node } from "babylonjs";
+import { IVolumetricLightConfiguration } from "babylonjs-editor-tools";
 export interface INodeMetadata {
     /**
      * Defines wether or not the object is locked.
@@ -12,6 +13,10 @@ export interface INodeMetadata {
      * Defines wether or not the object is visible in the graph panel in the editor.
      */
     notVisibleInGraph?: boolean;
+    /**
+     * Defines the configuration of the volumetric lighting for the light. @see IVolumetricLightConfiguration
+     */
+    volumetricLighting?: IVolumetricLightConfiguration;
 }
 /**
  * Ensures that metadata exists for the given node.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "babylonjs-editor",
-	"version": "5.5.0",
+	"version": "5.5.1-alpha.0",
 	"description": "Babylon.js Editor is a Web Application helping artists to work with Babylon.js",
 	"productName": "Babylon.js Editor",
 	"main": "build/src/index.js",