@shapediver/viewer.viewport 3.0.0

package/dist/interfaces/IPostProcessingApi.d.ts

@@ -0,0 +1,229 @@
+import { ANTI_ALIASING_TECHNIQUE, Effect, EffectComposer, IBloomEffectDefinition, IChromaticAberrationEffectDefinition, IDepthOfFieldEffectDefinition, IDotScreenEffectDefinition, IGodRaysEffectDefinition, IGridEffectDefinition, IHBAOEffectDefinition, IHueSaturationEffectDefinition, INoiseEffectDefinition, IOutlineEffectDefinition, IPixelationEffectDefinition, IPostProcessingEffectDefinition, IPostProcessingEffectsArray, IScanlineEffectDefinition, ISelectiveBloomEffectDefinition, ISepiaEffectDefinition, ISSAOEffectDefinition, ITiltShiftEffectDefinition, IVignetteEffectDefinition, POST_PROCESSING_EFFECT_TYPE } from '@shapediver/viewer.rendering-engine.rendering-engine-threejs';
+import { ITreeNode } from '@shapediver/viewer.shared.node-tree';
+export interface IPostProcessingApi {
+    /**
+     * The effect composer that is used internally for the rendering of the postprocessing effects.
+     * In combination with {@link manualPostProcessing} you can adjust the effects and passes yourself.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     */
+    readonly effectComposer: EffectComposer | undefined;
+    /**
+     * Defines the anti-aliasing technique that is used when the post-processing is active. (default: ANTI_ALIASING_TECHNIQUE.SSAA)
+     *
+     * The various anti-aliasing technique have an impact on the performance and the rendering quality.
+     * The order is as follows: NONE -> FXAA -> SMAA -> SSAA
+     * (lowest to highest quality, fastest to slowest performance)
+     *
+     * For the SSAA approach please see {@link ssaaSampleLevel}.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     */
+    antiAliasingTechnique: ANTI_ALIASING_TECHNIQUE;
+    /**
+     * Defines the anti-aliasing technique that is used when the post-processing is active on mobile. (default: ANTI_ALIASING_TECHNIQUE.FXAA)
+     *
+     * The various anti-aliasing technique have an impact on the performance and the rendering quality.
+     * The order is as follows: NONE -> FXAA -> SMAA -> SSAA
+     * (lowest to highest quality, fastest to slowest performance)
+     *
+     * For the SSAA approach please see {@link ssaaSampleLevel}.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     */
+    antiAliasingTechniqueMobile: ANTI_ALIASING_TECHNIQUE;
+    /**
+     * If the post-processing effects should be enabled on mobile. (default: true)
+     *
+     * As some post-processing effects greatly effect the rendering performance it might make sense to not use post-processing on mobile device.
+     * This will ensure that the rendering on mobile devices is still fluid, while providing the best results on desktop.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     */
+    enablePostProcessingOnMobile: boolean;
+    /**
+     * Access to all currently added god ray effects via token.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @see addEffect
+     * @see updateEffect
+     * @see removeEffect
+     */
+    godRaysEffects: {
+        [key: string]: {
+            /**
+             * Set the light source for the god ray effect.
+             * This light source is the geometry on which the god ray effect is applied.
+             *
+             * @param node
+             */
+            setLightSource(node: ITreeNode): void;
+            /**
+             * Remove the currently set light source.
+             */
+            removeLightSource(): void;
+        };
+    };
+    /**
+     * By setting this option to `true` you can manually work on the postprocessing pipeline.
+     * All current effects and passes are removed from the EffectComposer and you can start from scratch.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @see effectComposer
+     */
+    manualPostProcessing: boolean;
+    /**
+     * Access to all currently added outline effects via token.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @see addEffect
+     * @see updateEffect
+     * @see removeEffect
+     */
+    outlineEffects: {
+        [key: string]: {
+            /**
+             * Add a node to the selection for the outline effect.
+             *
+             * @param node
+             */
+            addSelection(node: ITreeNode): void;
+            /**
+             * Remove a node from the selection for the outline effect.
+             *
+             * @param node
+             */
+            removeSelection(node: ITreeNode): boolean;
+            /**
+             * Clear all currently selected nodes.
+             */
+            clearSelection(): void;
+        };
+    };
+    /**
+     * Access to all currently added selective bloom effects via token.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @see addEffect
+     * @see updateEffect
+     * @see removeEffect
+     */
+    selectiveBloomEffects: {
+        [key: string]: {
+            /**
+             * Add a node to the selection for the selective bloom effect.
+             *
+             * @param node
+             */
+            addSelection(node: ITreeNode): void;
+            /**
+             * Remove a node from the selection for the selective bloom effect.
+             *
+             * @param node
+             */
+            removeSelection(node: ITreeNode): boolean;
+            /**
+             * Clear all currently selected nodes.
+             */
+            clearSelection(): void;
+        };
+    };
+    /**
+     * The number of samples that are taken in the Supersample Anti-Aliasing Render Pass.
+     * Specified as n, where the number of samples is 2^n, so sampleLevel = 4, is 2^4 samples, 16. (default: 4)
+     *
+     * Only works with {@link ANTI_ALIASING_TECHNIQUE.SSAA}.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     */
+    ssaaSampleLevel: number;
+    addEffect(definition: IBloomEffectDefinition): string;
+    addEffect(definition: IChromaticAberrationEffectDefinition): string;
+    addEffect(definition: IDepthOfFieldEffectDefinition): string;
+    addEffect(definition: IDotScreenEffectDefinition): string;
+    addEffect(definition: IGodRaysEffectDefinition): string;
+    addEffect(definition: IGridEffectDefinition): string;
+    addEffect(definition: IHBAOEffectDefinition): string;
+    addEffect(definition: IHueSaturationEffectDefinition): string;
+    addEffect(definition: INoiseEffectDefinition): string;
+    addEffect(definition: IOutlineEffectDefinition): string;
+    addEffect(definition: IPixelationEffectDefinition): string;
+    addEffect(definition: ISSAOEffectDefinition): string;
+    addEffect(definition: IScanlineEffectDefinition): string;
+    addEffect(definition: ISelectiveBloomEffectDefinition): string;
+    addEffect(definition: ISepiaEffectDefinition): string;
+    addEffect(definition: ITiltShiftEffectDefinition): string;
+    addEffect(definition: IVignetteEffectDefinition): string;
+    /**
+     * Add an effect to the postprocessing pipeline.
+     * A token is return which identifies this effect when using other API functions.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @param definition
+     *
+     * @see updateEffect
+     * @see removeEffect
+     */
+    addEffect(definition: IPostProcessingEffectDefinition): string;
+    /**
+     * Get the default settings of an effect by their type.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @param type
+     */
+    getDefaultEffectProperties(type: POST_PROCESSING_EFFECT_TYPE): unknown;
+    /**
+     * Get the effect that was created with the specified token.
+     * This functions returns the Effect-Classes as used by the postprocessing package.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @param token
+     */
+    getEffect(token: string): Effect;
+    /**
+     * Get all currently specified effects in a dictionary with the token as a key and
+     * the type as a value.
+     */
+    getEffectTokens(): {
+        [key: string]: POST_PROCESSING_EFFECT_TYPE;
+    };
+    /**
+     * Get a description of the post-processing effects that are current applied.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     */
+    getPostProcessingEffectsArray(): IPostProcessingEffectsArray;
+    /**
+     * Remove an effect of the postprocessing pipeline.
+     * Use the token that was generated by the {@link addEffect}-function.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @param token
+     *
+     * @see addEffect
+     * @see updateEffect
+     */
+    removeEffect(token: string): boolean;
+    /**
+     * Update an effect of the postprocessing pipeline with the specified token and definition.
+     * Use the token that was generated by the {@link addEffect}-function.
+     *
+     * Note: The post-processing API is still WIP. Breaking changes are to be expected.
+     *
+     * @param token
+     * @param definition
+     *
+     * @see addEffect
+     * @see removeEffect
+     */
+    updateEffect(token: string, definition: IPostProcessingEffectDefinition): void;
+}
+//# sourceMappingURL=IPostProcessingApi.d.ts.map

package/dist/interfaces/IPostProcessingApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPostProcessingApi.d.ts","sourceRoot":"","sources":["../../src/interfaces/IPostProcessingApi.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,uBAAuB,EACvB,MAAM,EACN,cAAc,EACd,sBAAsB,EACtB,oCAAoC,EACpC,6BAA6B,EAC7B,0BAA0B,EAC1B,wBAAwB,EACxB,qBAAqB,EACrB,qBAAqB,EACrB,8BAA8B,EAC9B,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,+BAA+B,EAC/B,2BAA2B,EAC3B,yBAAyB,EACzB,+BAA+B,EAC/B,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,EAC1B,yBAAyB,EACzB,2BAA2B,EAC9B,MAAM,8DAA8D,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAEhE,MAAM,WAAW,kBAAkB;IAG/B;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,CAAC;IAEpD;;;;;;;;;;OAUG;IACH,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C;;;;;;;;;;OAUG;IACH,2BAA2B,EAAE,uBAAuB,CAAC;IACrD;;;;;;;OAOG;IACH,4BAA4B,EAAE,OAAO,CAAC;IACtC;;;;;;;;OAQG;IACH,cAAc,EAAE;QACZ,CAAC,GAAG,EAAE,MAAM,GAAG;YACX;;;;;eAKG;YACH,cAAc,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;YAEtC;;eAEG;YACH,iBAAiB,IAAI,IAAI,CAAC;SAC7B,CAAA;KACJ,CAAA;IAED;;;;;;;OAOG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;;;;;;;OAQG;IACH,cAAc,EAAE;QACZ,CAAC,GAAG,EAAE,MAAM,GAAG;YACX;;;;eAIG;YACH,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;YAEpC;;;;eAIG;YACH,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;YAE1C;;eAEG;YACH,cAAc,IAAI,IAAI,CAAC;SAC1B,CAAA;KACJ,CAAA;IAED;;;;;;;;OAQG;IACH,qBAAqB,EAAE;QACnB,CAAC,GAAG,EAAE,MAAM,GAAG;YACX;;;;eAIG;YACH,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;YAEpC;;;;eAIG;YACH,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;YAE1C;;eAEG;YACH,cAAc,IAAI,IAAI,CAAC;SAC1B,CAAA;KACJ,CAAA;IAED;;;;;;;OAOG;IACH,eAAe,EAAE,MAAM,CAAC;IAMxB,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,MAAM,CAAC;IACtD,SAAS,CAAC,UAAU,EAAE,oCAAoC,GAAG,MAAM,CAAC;IACpE,SAAS,CAAC,UAAU,EAAE,6BAA6B,GAAG,MAAM,CAAC;IAC7D,SAAS,CAAC,UAAU,EAAE,0BAA0B,GAAG,MAAM,CAAC;IAC1D,SAAS,CAAC,UAAU,EAAE,wBAAwB,GAAG,MAAM,CAAC;IACxD,SAAS,CAAC,UAAU,EAAE,qBAAqB,GAAG,MAAM,CAAC;IACrD,SAAS,CAAC,UAAU,EAAE,qBAAqB,GAAG,MAAM,CAAC;IACrD,SAAS,CAAC,UAAU,EAAE,8BAA8B,GAAG,MAAM,CAAC;IAC9D,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,MAAM,CAAC;IACtD,SAAS,CAAC,UAAU,EAAE,wBAAwB,GAAG,MAAM,CAAC;IACxD,SAAS,CAAC,UAAU,EAAE,2BAA2B,GAAG,MAAM,CAAC;IAC3D,SAAS,CAAC,UAAU,EAAE,qBAAqB,GAAG,MAAM,CAAC;IACrD,SAAS,CAAC,UAAU,EAAE,yBAAyB,GAAG,MAAM,CAAC;IACzD,SAAS,CAAC,UAAU,EAAE,+BAA+B,GAAG,MAAM,CAAC;IAC/D,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,MAAM,CAAC;IACtD,SAAS,CAAC,UAAU,EAAE,0BAA0B,GAAG,MAAM,CAAC;IAC1D,SAAS,CAAC,UAAU,EAAE,yBAAyB,GAAG,MAAM,CAAC;IACzD;;;;;;;;;;OAUG;IACH,SAAS,CAAC,UAAU,EAAE,+BAA+B,GAAG,MAAM,CAAC;IAC/D;;;;;;OAMG;IACH,0BAA0B,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC;IACvE;;;;;;;OAOG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC;;;OAGG;IACH,eAAe,IAAI;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,2BAA2B,CAAA;KAAE,CAAC;IAClE;;;;OAIG;IACH,6BAA6B,IAAI,2BAA2B,CAAA;IAC5D;;;;;;;;;;OAUG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACrC;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,+BAA+B,GAAG,IAAI,CAAC;CAGlF"}

package/dist/interfaces/IPostProcessingApi.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IPostProcessingApi.js.map

package/dist/interfaces/IPostProcessingApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPostProcessingApi.js","sourceRoot":"","sources":["../../src/interfaces/IPostProcessingApi.ts"],"names":[],"mappings":""}