@inweb/client 25.2.2 → 25.2.8

package/lib/Viewer/Options.d.ts

@@ -1,228 +1,239 @@
-import { EventEmitter2 } from "./EventEmitter2";
-export interface RGB {
-    red: number;
-    green: number;
-    blue: number;
-}
-/**
- * `VisualizeJS` parameters.
- */
-export interface OptionsData {
-    /**
-     * Show WCS
-     *
-     * @defaultValue true
-     */
-    showWCS?: boolean;
-    /**
-     * Enable camera animation
-     *
-     * @defaultValue true
-     */
-    cameraAnimation?: boolean;
-    /**
-     * Enable antialiasing use FXAA
-     *
-     * @defaultValue true
-     */
-    antialiasing?: boolean;
-    /**
-     * Enable ground shadows
-     *
-     * @defaultValue false
-     */
-    groundShadow?: boolean;
-    /**
-     * Enable shadows
-     *
-     * @defaultValue false
-     */
-    shadows?: boolean;
-    /**
-     * Camera speed on X axis
-     *
-     * @defaultValue 4
-     */
-    cameraAxisXSpeed?: number;
-    /**
-     * Camera speed on Y axis
-     *
-     * @defaultValue 1
-     */
-    cameraAxisYSpeed?: number;
-    /**
-     * Ambient occlusion
-     *
-     * @defaultValue false
-     */
-    ambientOcclusion?: boolean;
-    /**
-     * Enable partial load mode to be able open large drawing If enablePartialMode enabled, then
-     * sceneGraph will be switched off
-     *
-     * @defaultValue false
-     */
-    enablePartialMode?: boolean;
-    /**
-     * The size of the memory buffer that the Viewer can use for graphics data
-     *
-     * @defaultValue 3294967296
-     */
-    memoryLimit?: number;
-    /**
-     * Cutting plane fill color
-     *
-     * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
-     */
-    cuttingPlaneFillColor?: RGB;
-    /**
-     * Outline edges color in RGB format.
-     */
-    edgesColor?: {
-        r: number;
-        g: number;
-        b: number;
-    };
-    /**
-     * Faces color in the RGB format.
-     */
-    facesColor?: {
-        r: number;
-        g: number;
-        b: number;
-    };
-    /**
-     * Show or hide edges.
-     */
-    edgesVisibility?: boolean;
-    /**
-     * Show edges over drawing.
-     */
-    edgesOverlap?: boolean;
-    /**
-     * Show faces over drawing.
-     */
-    facesOverlap?: boolean;
-    /**
-     * Faces transparency value from 0 to 255.
-     */
-    facesTransparancy?: number;
-    /**
-     * Enable custom highlight settings.
-     */
-    enableCustomHighlight?: boolean;
-    /**
-     * Enable or disable scene graph, it increases perfomance improvement, but consumes memory
-     * Large drawings can take up a lot of memory. If sceneGraph enabled, then enablePartialMode
-     * will be switched off
-     */
-    sceneGraph: boolean;
-    /**
-     * Edge display models. No edges is usefull for less memory consumption: `false` - no edges
-     * are displayed, `true` - display isolines.
-     */
-    edgeModel: boolean;
-    /**
-     * Reverse the mouse wheel direction for zooming: false - moving the wheel up zooms in,
-     * moving down zooms out, `true` - moving the wheel up zooms out, moving down zooms in.
-     */
-    reverseZoomWheel: boolean;
-    /**
-     * Enable mouse wheel zooming.
-     */
-    enableZoomWheel: boolean;
-    /**
-     * Enable touch gestures. This option will be ignored when enableZoomWheel is disabled, since
-     * gestures contains touch zoom.
-     */
-    enableGestures: boolean;
-    /**
-     * Default file geometry data type. Can be one of:
-     *
-     * - `vsfx` - `VSFX` (default), for opening a file in `VisualizeJS` viewer.
-     * - `gltf` - `glTF`, for opening a file in `Three.js` viewer.
-     */
-    geometryType?: string;
-}
-export declare class Options {
-    protected _emitter?: EventEmitter2;
-    protected _data: OptionsData;
-    constructor(emitter?: EventEmitter2);
-    static defaults(): OptionsData;
-    notifierChangeEvent(): void;
-    saveToStorage(): void;
-    loadFromStorage(): void;
-    /**
-     * Reset options to default
-     *
-     * @param fields - Name of fields to be reset
-     */
-    resetToDefaults(fields?: string[]): void;
-    get data(): OptionsData;
-    set data(value: OptionsData);
-    get showWCS(): boolean;
-    set showWCS(value: boolean);
-    get cameraAnimation(): boolean;
-    set cameraAnimation(value: boolean);
-    get antialiasing(): boolean;
-    set antialiasing(value: boolean);
-    get groundShadow(): boolean;
-    set groundShadow(value: boolean);
-    get shadows(): boolean;
-    set shadows(value: boolean);
-    get cameraAxisXSpeed(): number;
-    set cameraAxisXSpeed(value: number);
-    get cameraAxisYSpeed(): number;
-    set cameraAxisYSpeed(value: number);
-    get ambientOcclusion(): boolean;
-    set ambientOcclusion(value: boolean);
-    get enablePartialMode(): boolean;
-    set enablePartialMode(value: boolean);
-    get memoryLimit(): number;
-    set memoryLimit(value: number);
-    get cuttingPlaneFillColor(): RGB;
-    set cuttingPlaneFillColor(value: RGB);
-    get edgesColor(): {
-        r: number;
-        g: number;
-        b: number;
-    };
-    set edgesColor(value: {
-        r: number;
-        g: number;
-        b: number;
-    });
-    get facesColor(): {
-        r: number;
-        g: number;
-        b: number;
-    };
-    set facesColor(value: {
-        r: number;
-        g: number;
-        b: number;
-    });
-    get edgesVisibility(): boolean;
-    set edgesVisibility(value: boolean);
-    get edgesOverlap(): boolean;
-    set edgesOverlap(value: boolean);
-    get facesOverlap(): boolean;
-    set facesOverlap(value: boolean);
-    get facesTransparancy(): number;
-    set facesTransparancy(value: number);
-    get enableCustomHighlight(): boolean;
-    set enableCustomHighlight(value: boolean);
-    get sceneGraph(): boolean;
-    set sceneGraph(value: boolean);
-    get edgeModel(): boolean;
-    set edgeModel(value: boolean);
-    get reverseZoomWheel(): boolean;
-    set reverseZoomWheel(value: boolean);
-    get enableZoomWheel(): boolean;
-    set enableZoomWheel(value: boolean);
-    get enableGestures(): boolean;
-    set enableGestures(value: boolean);
-    get geometryType(): string;
-    set geometryType(value: string);
-}
+import { EventEmitter2 } from "./EventEmitter2";
+export interface RGB {
+    red: number;
+    green: number;
+    blue: number;
+}
+/**
+ * `VisualizeJS` parameters.
+ */
+export interface OptionsData {
+    /**
+     * Show WCS
+     *
+     * @defaultValue true
+     */
+    showWCS?: boolean;
+    /**
+     * Enable camera animation
+     *
+     * @defaultValue true
+     */
+    cameraAnimation?: boolean;
+    /**
+     * Enable antialiasing use FXAA
+     *
+     * @defaultValue true
+     */
+    antialiasing?: boolean;
+    /**
+     * Enable ground shadows
+     *
+     * @defaultValue false
+     */
+    groundShadow?: boolean;
+    /**
+     * Enable shadows
+     *
+     * @defaultValue false
+     */
+    shadows?: boolean;
+    /**
+     * Camera speed on X axis
+     *
+     * @defaultValue 4
+     */
+    cameraAxisXSpeed?: number;
+    /**
+     * Camera speed on Y axis
+     *
+     * @defaultValue 1
+     */
+    cameraAxisYSpeed?: number;
+    /**
+     * Ambient occlusion
+     *
+     * @defaultValue false
+     */
+    ambientOcclusion?: boolean;
+    /**
+     * Enable streaming mode
+     *
+     * If enableStreamingMode is true then enablePartialMode will be used, otherwise -
+     * enablePartialMode will be ignored and file / assembly will be loaded in one go
+     *
+     * @defaultValue true
+     */
+    enableStreamingMode?: boolean;
+    /**
+     * Enable partial load mode to be able open large drawing If enablePartialMode enabled, then
+     * sceneGraph will be switched off
+     *
+     * @defaultValue false
+     */
+    enablePartialMode?: boolean;
+    /**
+     * The size of the memory buffer that the Viewer can use for graphics data
+     *
+     * @defaultValue 3294967296
+     */
+    memoryLimit?: number;
+    /**
+     * Cutting plane fill color
+     *
+     * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
+     */
+    cuttingPlaneFillColor?: RGB;
+    /**
+     * Outline edges color in RGB format.
+     */
+    edgesColor?: {
+        r: number;
+        g: number;
+        b: number;
+    };
+    /**
+     * Faces color in the RGB format.
+     */
+    facesColor?: {
+        r: number;
+        g: number;
+        b: number;
+    };
+    /**
+     * Show or hide edges.
+     */
+    edgesVisibility?: boolean;
+    /**
+     * Show edges over drawing.
+     */
+    edgesOverlap?: boolean;
+    /**
+     * Show faces over drawing.
+     */
+    facesOverlap?: boolean;
+    /**
+     * Faces transparency value from 0 to 255.
+     */
+    facesTransparancy?: number;
+    /**
+     * Enable custom highlight settings.
+     */
+    enableCustomHighlight?: boolean;
+    /**
+     * Enable or disable scene graph, it increases perfomance improvement, but consumes memory
+     * Large drawings can take up a lot of memory. If sceneGraph enabled, then enablePartialMode
+     * will be switched off
+     */
+    sceneGraph: boolean;
+    /**
+     * Edge display models. No edges is usefull for less memory consumption: `false` - no edges
+     * are displayed, `true` - display isolines.
+     */
+    edgeModel: boolean;
+    /**
+     * Reverse the mouse wheel direction for zooming: false - moving the wheel up zooms in,
+     * moving down zooms out, `true` - moving the wheel up zooms out, moving down zooms in.
+     */
+    reverseZoomWheel: boolean;
+    /**
+     * Enable mouse wheel zooming.
+     */
+    enableZoomWheel: boolean;
+    /**
+     * Enable touch gestures. This option will be ignored when enableZoomWheel is disabled, since
+     * gestures contains touch zoom.
+     */
+    enableGestures: boolean;
+    /**
+     * Default file geometry data type. Can be one of:
+     *
+     * - `vsfx` - `VSFX` (default), for opening a file in `VisualizeJS` viewer.
+     * - `gltf` - `glTF`, for opening a file in `Three.js` viewer.
+     */
+    geometryType?: string;
+}
+export declare class Options {
+    protected _emitter?: EventEmitter2;
+    protected _data: OptionsData;
+    constructor(emitter?: EventEmitter2);
+    static defaults(): OptionsData;
+    notifierChangeEvent(): void;
+    saveToStorage(): void;
+    loadFromStorage(): void;
+    /**
+     * Reset options to default
+     *
+     * @param fields - Name of fields to be reset
+     */
+    resetToDefaults(fields?: string[]): void;
+    get data(): OptionsData;
+    set data(value: OptionsData);
+    get showWCS(): boolean;
+    set showWCS(value: boolean);
+    get cameraAnimation(): boolean;
+    set cameraAnimation(value: boolean);
+    get antialiasing(): boolean;
+    set antialiasing(value: boolean);
+    get groundShadow(): boolean;
+    set groundShadow(value: boolean);
+    get shadows(): boolean;
+    set shadows(value: boolean);
+    get cameraAxisXSpeed(): number;
+    set cameraAxisXSpeed(value: number);
+    get cameraAxisYSpeed(): number;
+    set cameraAxisYSpeed(value: number);
+    get ambientOcclusion(): boolean;
+    set ambientOcclusion(value: boolean);
+    get enableStreamingMode(): boolean;
+    set enableStreamingMode(value: boolean);
+    get enablePartialMode(): boolean;
+    set enablePartialMode(value: boolean);
+    get memoryLimit(): number;
+    set memoryLimit(value: number);
+    get cuttingPlaneFillColor(): RGB;
+    set cuttingPlaneFillColor(value: RGB);
+    get edgesColor(): {
+        r: number;
+        g: number;
+        b: number;
+    };
+    set edgesColor(value: {
+        r: number;
+        g: number;
+        b: number;
+    });
+    get facesColor(): {
+        r: number;
+        g: number;
+        b: number;
+    };
+    set facesColor(value: {
+        r: number;
+        g: number;
+        b: number;
+    });
+    get edgesVisibility(): boolean;
+    set edgesVisibility(value: boolean);
+    get edgesOverlap(): boolean;
+    set edgesOverlap(value: boolean);
+    get facesOverlap(): boolean;
+    set facesOverlap(value: boolean);
+    get facesTransparancy(): number;
+    set facesTransparancy(value: number);
+    get enableCustomHighlight(): boolean;
+    set enableCustomHighlight(value: boolean);
+    get sceneGraph(): boolean;
+    set sceneGraph(value: boolean);
+    get edgeModel(): boolean;
+    set edgeModel(value: boolean);
+    get reverseZoomWheel(): boolean;
+    set reverseZoomWheel(value: boolean);
+    get enableZoomWheel(): boolean;
+    set enableZoomWheel(value: boolean);
+    get enableGestures(): boolean;
+    set enableGestures(value: boolean);
+    get geometryType(): string;
+    set geometryType(value: string);
+}
 //# sourceMappingURL=Options.d.ts.map

package/lib/Viewer/OptionsEvents.d.ts

@@ -1,26 +1,26 @@
-import { Options } from "./Options";
-/**
- * An event that fires when options has been changed.
- *
- * @event
- */
-export interface OptionsChangeEvent {
-    /**
-     * Event type.
-     */
-    type: "optionschange";
-    /**
-     * New parameters.
-     */
-    data: Options;
-}
-/**
- * Options events.
- */
-export interface OptionsEventMap {
-    /**
-     * An event that fires when options has been changed.
-     */
-    optionschange: OptionsChangeEvent;
-}
+import { Options } from "./Options";
+/**
+ * An event that fires when options has been changed.
+ *
+ * @event
+ */
+export interface OptionsChangeEvent {
+    /**
+     * Event type.
+     */
+    type: "optionschange";
+    /**
+     * New parameters.
+     */
+    data: Options;
+}
+/**
+ * Options events.
+ */
+export interface OptionsEventMap {
+    /**
+     * An event that fires when options has been changed.
+     */
+    optionschange: OptionsChangeEvent;
+}
 //# sourceMappingURL=OptionsEvents.d.ts.map