vim-web 0.3.39-dev.5 → 0.3.39-dev.6

package/dist/types/core-viewers/webgl/viewer/rendering/renderingComposer.d.ts

@@ -7,40 +7,89 @@ import { RenderScene } from './renderScene';
 import { ViewerMaterials } from '../../loader/materials/viewerMaterials';
 import { Camera } from '../camera/camera';
 /**
- * Composer for AA and Outline effects.
+ * Composer for managing the rendering pipeline including anti-aliasing and outline effects.
+ * Handles the orchestration of multiple render passes including:
+ * - Main scene rendering
+ * - Selection outline rendering
+ * - FXAA anti-aliasing
+ * - Final composition and screen output
  */
 export declare class RenderingComposer {
     private _renderer;
     private _scene;
     private _materials;
     private _camera;
-    private _samples;
     private _size;
     private _composer;
     private _renderPass;
-    private _ssaaRenderPass;
     private _selectionRenderPass;
     private _transferPass;
+    private _outlineFxaaPass;
     private _outlines;
     private _clock;
-    private _nextAATime;
-    onDemand: boolean;
     private _outlinePass;
-    private _fxaaPass;
     private _mergePass;
     private _outlineTarget;
     private _sceneTarget;
+    /**
+     * Creates a new RenderingComposer instance
+     * @param renderer - The WebGL renderer instance
+     * @param scene - The scene to be rendered
+     * @param viewport - The viewport containing size information
+     * @param materials - Materials used for rendering including outline and mask materials
+     * @param camera - The camera used for rendering
+     */
     constructor(renderer: THREE.WebGLRenderer, scene: RenderScene, viewport: Viewport, materials: ViewerMaterials, camera: Camera);
-    private setup;
-    private setupRendering;
-    private setupOutline;
+    /**
+     * Initializes the main scene rendering pipeline
+     * Creates render targets and sets up the main render pass
+     * @private
+     */
+    private initSceneRenderingPipeline;
+    /**
+     * Initializes the outline rendering pipeline
+     * Sets up render targets and passes for selection, outline, FXAA, and final composition
+     * @private
+     */
+    private initOutlinePipeline;
+    /**
+     * @returns Whether outline rendering is enabled
+     */
     get outlines(): boolean;
+    /**
+     * Enables or disables outline rendering
+     */
     set outlines(value: boolean);
+    /**
+     * @returns The current camera
+     */
     get camera(): THREE.PerspectiveCamera | THREE.OrthographicCamera;
+    /**
+     * Updates the camera across all render passes
+     */
     set camera(value: THREE.PerspectiveCamera | THREE.OrthographicCamera);
+    /**
+     * Updates the size of all render targets and passes
+     * @param width - New width in pixels
+     * @param height - New height in pixels
+     */
     setSize(width: number, height: number): void;
+    /**
+     * @returns The current MSAA sample count
+     */
     get samples(): number;
+    /**
+     * Sets the MSAA sample count for the scene render target
+     */
     set samples(value: number);
-    render(updated: boolean, antialias: boolean): void;
+    /**
+     * Executes the complete rendering pipeline
+     * First renders the main scene, then processes outlines if enabled
+     */
+    render(): void;
+    /**
+     * Cleans up all resources used by the composer
+     * Should be called when the composer is no longer needed
+     */
     dispose(): void;
 }

package/dist/types/core-viewers/webgl/viewer/rendering/transferPass.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module viw-webgl-viewer/rendering
  */
-import THREE from 'three';
+import * as THREE from 'three';
 import { Pass } from 'three/examples/jsm/postprocessing/Pass';
 /**
  * Copies a source buffer to the current write buffer.
@@ -10,6 +10,8 @@ export declare class TransferPass extends Pass {
     private _fsQuad;
     private _uniforms;
     constructor(sceneTexture: THREE.Texture);
+    get source(): THREE.Texture;
+    set source(value: THREE.Texture);
     dispose(): void;
     render(renderer: THREE.WebGLRenderer, writeBuffer: THREE.WebGLRenderTarget, readBuffer: THREE.WebGLRenderTarget): void;
 }

package/dist/types/core-viewers/webgl/viewer/settings/viewerSettings.d.ts

@@ -264,6 +264,11 @@ export type ViewerSettings = {
         * Selection outline options
         */
         outline: {
+            /**
+            * Enable antialiasing for the outline.
+            * Default: false
+            */
+            antialias: boolean;
             /**
             * Selection outline intensity.
             * Default: 3

package/dist/types/react-viewers/errors/errors.d.ts

@@ -1,5 +1,6 @@
-export { fileOpeningError } from './fileOpeningError';
-export { fileDownloadingError as serverFileDownloadingError } from './fileDownloadingError';
-export { serverFileLoadingError } from './fileLoadingError';
-export { serverConnectionError } from './serverConnectionError';
-export { serverCompatibilityError } from './serverCompatibilityError';
+export { fileOpeningError } from '../ultra/errors/fileOpeningError';
+export { serverFileDownloadingError } from '../ultra/errors/serverFileDownloadingError';
+export { serverFileLoadingError } from '../ultra/errors/fileLoadingError';
+export { serverConnectionError } from '../ultra/errors/serverConnectionError';
+export { serverCompatibilityError } from '../ultra/errors/serverCompatibilityError';
+export { serverStreamError } from '../ultra/errors/serverStreamError';

package/dist/types/react-viewers/{errors → ultra/errors}/fileLoadingError.d.ts

@@ -1,2 +1,2 @@
-import { MessageBoxProps } from '../panels/messageBox';
+import { MessageBoxProps } from '../../panels/messageBox';
 export declare function serverFileLoadingError(url: string): MessageBoxProps;

package/dist/types/react-viewers/{errors → ultra/errors}/fileOpeningError.d.ts

@@ -1,2 +1,2 @@
-import { MessageBoxProps } from '../panels/messageBox';
+import { MessageBoxProps } from '../../panels/messageBox';
 export declare function fileOpeningError(url: string): MessageBoxProps;

package/dist/types/react-viewers/{errors → ultra/errors}/serverCompatibilityError.d.ts

@@ -1,2 +1,2 @@
-import { MessageBoxProps } from '../panels/messageBox';
+import { MessageBoxProps } from '../../panels/messageBox';
 export declare function serverCompatibilityError(url: string, localVersion: string, remoteVersion: string): MessageBoxProps;

package/dist/types/react-viewers/{errors → ultra/errors}/serverConnectionError.d.ts

@@ -1,2 +1,2 @@
-import { MessageBoxProps } from '../panels/messageBox';
+import { MessageBoxProps } from '../../panels/messageBox';
 export declare function serverConnectionError(url: string): MessageBoxProps;

package/dist/types/react-viewers/ultra/errors/serverFileDownloadingError.d.ts

@@ -0,0 +1,2 @@
+import { MessageBoxProps } from '../../panels/messageBox';
+export declare function serverFileDownloadingError(url: string, server?: string): MessageBoxProps;

package/dist/types/react-viewers/ultra/errors/serverStreamError.d.ts

@@ -0,0 +1,2 @@
+import { MessageBoxProps } from '../../panels/messageBox';
+export declare function serverStreamError(url: string): MessageBoxProps;

package/dist/types/react-viewers/ultra/errors/ultraErrors.d.ts

@@ -0,0 +1,3 @@
+import * as Ultra from '../../../core-viewers/ultra';
+export declare function getErrorMessage(state: Ultra.ClientState): import("../..").MessageBoxProps;
+export declare function getRequestErrorMessage(url: string, error: Ultra.VimRequestErrorType): import("../..").MessageBoxProps;