fcs-core-viewer 0.2.2 → 0.3.0

package/fcs-core-viewer@types/CloudViewer/Index.d.ts

@@ -1 +1 @@
-export * from './FcsViewer';
+export * from './FcsViewer';

package/fcs-core-viewer@types/CloudViewer/Settings/CameraSettings.d.ts

@@ -1,44 +1,44 @@
-import { VectorGeometry } from "../../Foundations/VectorGeometry";
-export declare namespace CameraSettings {
-    /**
-     * Controls all camera related settings.
-     */
-    class Camera {
-        /**
-         * The direction of where the camera is looking.
-         * For a human, this would be the direction of where our eyes are looking.
-         */
-        readonly CameraViewDirection: VectorGeometry.Vector3D;
-        /**
-         * The 'up' direction in the plane defined by the `cameraViewDirection`.
-         * For a human, this would be the direction of where the head is pointing.
-         */
-        readonly CameraUpDirection: VectorGeometry.Vector3D;
-        /**
-         * A point around which the camera is rotating.
-         */
-        readonly OrbitPoint: VectorGeometry.Vector3D;
-        /**
-         * The 3D position of the camera. It is recommended to keep this null
-         * For a human, this would be the position where the person is standing.
-         */
-        readonly CameraPosition: VectorGeometry.Vector3D;
-        /**
-         * Adjusts zoom of the camera.
-         */
-        readonly ZoomFactor: number;
-        /**
-         * Constructor creates camera settings that clearly define
-         * @param {VectorGeometry.Vector3D} cameraViewDirection The direction of where the camera is looking.
-         * @param {VectorGeometry.Vector3D} cameraUpDirection The 'up' direction in the plane defined by the `camereViewDirection`.
-         * @param {VectorGeometry.Vector3D} cameraPosition Where is the camera?
-         */
-        constructor(cameraViewDirection: VectorGeometry.Vector3D, cameraUpDirection: VectorGeometry.Vector3D, orbitPoint: VectorGeometry.Vector3D, cameraPosition: VectorGeometry.Vector3D, zoomFactor: number);
-        /**
-         * Method to check equality of two Camera objects based on Vector3D properties
-         * @param otherCamera
-         * @returns True - if two cameras have the same exact setup.
-         */
-        isSame(otherCamera: Camera): boolean;
-    }
-}
+import { VectorGeometry } from "../../Foundations/VectorGeometry";
+export declare namespace CameraSettings {
+    /**
+     * Controls all camera related settings.
+     */
+    class Camera {
+        /**
+         * The direction of where the camera is looking.
+         * For a human, this would be the direction of where our eyes are looking.
+         */
+        readonly CameraViewDirection: VectorGeometry.Vector3D;
+        /**
+         * The 'up' direction in the plane defined by the `cameraViewDirection`.
+         * For a human, this would be the direction of where the head is pointing.
+         */
+        readonly CameraUpDirection: VectorGeometry.Vector3D;
+        /**
+         * A point around which the camera is rotating.
+         */
+        readonly OrbitPoint: VectorGeometry.Vector3D;
+        /**
+         * The 3D position of the camera. It is recommended to keep this null
+         * For a human, this would be the position where the person is standing.
+         */
+        readonly CameraPosition: VectorGeometry.Vector3D;
+        /**
+         * Adjusts zoom of the camera.
+         */
+        readonly ZoomFactor: number;
+        /**
+         * Constructor creates camera settings that clearly define
+         * @param {VectorGeometry.Vector3D} cameraViewDirection The direction of where the camera is looking.
+         * @param {VectorGeometry.Vector3D} cameraUpDirection The 'up' direction in the plane defined by the `camereViewDirection`.
+         * @param {VectorGeometry.Vector3D} cameraPosition Where is the camera?
+         */
+        constructor(cameraViewDirection: VectorGeometry.Vector3D, cameraUpDirection: VectorGeometry.Vector3D, orbitPoint: VectorGeometry.Vector3D, cameraPosition: VectorGeometry.Vector3D, zoomFactor: number);
+        /**
+         * Method to check equality of two Camera objects based on Vector3D properties
+         * @param otherCamera
+         * @returns True - if two cameras have the same exact setup.
+         */
+        isSame(otherCamera: Camera): boolean;
+    }
+}

package/fcs-core-viewer@types/CloudViewer/Settings/Index.d.ts

@@ -1,11 +1,11 @@
-import * as CameraSettings from './CameraSettings';
-import * as SelectionSettings from './SelectionSettings';
-import * as StyleSettings from './StyleSettings';
-import * as VisibilitySettings from './VisibilitySettings';
-declare const Settings: {
-    SelectionSettings: typeof SelectionSettings.SelectionSettings;
-    VisibilitySettings: typeof VisibilitySettings.VisibilitySettings;
-    CameraSettings: typeof CameraSettings.CameraSettings;
-    StyleSettings: typeof StyleSettings.StyleSettings;
-};
-export { Settings };
+import * as CameraSettings from './CameraSettings';
+import * as SelectionSettings from './SelectionSettings';
+import * as StyleSettings from './StyleSettings';
+import * as VisibilitySettings from './VisibilitySettings';
+declare const Settings: {
+    SelectionSettings: typeof SelectionSettings.SelectionSettings;
+    VisibilitySettings: typeof VisibilitySettings.VisibilitySettings;
+    CameraSettings: typeof CameraSettings.CameraSettings;
+    StyleSettings: typeof StyleSettings.StyleSettings;
+};
+export { Settings };

package/fcs-core-viewer@types/CloudViewer/Settings/SelectionSettings.d.ts

@@ -1,78 +1,78 @@
-export declare namespace SelectionSettings {
-    /**
-     * What do we allow to select
-     */
-    namespace SelectionControl {
-        /**
-         * Collection of those entities that are selectable.
-         */
-        enum AllowedEntities {
-            /**
-             * All entities (hierarchical, topological, discrete, abstract)
-             */
-            ANY_ENTITIES = 0,
-            /**
-             * Geometric vertices (topological)
-             */
-            VERTICES = 1,
-            /**
-             * Geometric edges (topological)
-             */
-            EDGES = 2,
-            /**
-             * Geometric face (topological)
-             */
-            FACES = 3,
-            /**
-             * Geometric solid (topological)
-             */
-            SOLIDS = 4,
-            /**
-             * Collection of combined geometric solids (topological)
-             */
-            COMPOUNDS = 5,
-            /**
-             * Text, dimensions, and
-             */
-            ANNOTATION = 6,
-            /**
-             * A vector with arrow-like representation (abstract)
-             */
-            VECTOR = 7,
-            /**
-             *
-             */
-            BOUNDARY_CONDITION = 8,
-            /**
-             * Multiple items in the object tree (hierarchical)
-             * ToDo: @Botond lehet csak erre van szükség?
-             */
-            ITEM = 9,
-            /**
-             * Only a single it the object tree (hierarchical)
-             * ToDo: @Botond
-             */
-            SINGLE_ITEM = 10
-        }
-        /**
-         * Contains selection area definitions that are produced
-         * on holding down the left mouse key.
-         */
-        enum AreaSelectionType {
-            /**
-             * The selection area is a rectangle. This is the default
-             * and most commonly used.
-             */
-            RECTANGLE = 0,
-            /**
-             * The selection area is a circle. The circle's radius is defined
-             * by the distance from the start and end locations of the cursor.
-             */
-            CIRCLE = 1,
-            /**
-             * The selection area is a square.
-             */
-            SQUARE = 2
-        }
-    }
-}
+export declare namespace SelectionSettings {
+    /**
+     * What do we allow to select
+     */
+    namespace SelectionControl {
+        /**
+         * Collection of those entities that are selectable.
+         */
+        enum AllowedEntities {
+            /**
+             * All entities (hierarchical, topological, discrete, abstract)
+             */
+            ANY_ENTITIES = 0,
+            /**
+             * Geometric vertices (topological)
+             */
+            VERTICES = 1,
+            /**
+             * Geometric edges (topological)
+             */
+            EDGES = 2,
+            /**
+             * Geometric face (topological)
+             */
+            FACES = 3,
+            /**
+             * Geometric solid (topological)
+             */
+            SOLIDS = 4,
+            /**
+             * Collection of combined geometric solids (topological)
+             */
+            COMPOUNDS = 5,
+            /**
+             * Text, dimensions, and
+             */
+            ANNOTATION = 6,
+            /**
+             * A vector with arrow-like representation (abstract)
+             */
+            VECTOR = 7,
+            /**
+             *
+             */
+            BOUNDARY_CONDITION = 8,
+            /**
+             * Multiple items in the object tree (hierarchical)
+             * ToDo: @Botond lehet csak erre van szükség?
+             */
+            ITEM = 9,
+            /**
+             * Only a single it the object tree (hierarchical)
+             * ToDo: @Botond
+             */
+            SINGLE_ITEM = 10
+        }
+        /**
+         * Contains selection area definitions that are produced
+         * on holding down the left mouse key.
+         */
+        enum AreaSelectionType {
+            /**
+             * The selection area is a rectangle. This is the default
+             * and most commonly used.
+             */
+            RECTANGLE = 0,
+            /**
+             * The selection area is a circle. The circle's radius is defined
+             * by the distance from the start and end locations of the cursor.
+             */
+            CIRCLE = 1,
+            /**
+             * The selection area is a square.
+             */
+            SQUARE = 2
+        }
+    }
+}

package/fcs-core-viewer@types/CloudViewer/Settings/StyleSettings.d.ts

@@ -1,71 +1,71 @@
-import { AbstractEntities } from "../../ViewerEntities/AbstractEntities";
-export declare namespace StyleSettings {
-    /**
-     * There are two existing preset styles for the viewer at time of writing
-     * this version:
-     *  0) Clean viewer
-     *  1) Simple Viewer
-     *  2) Cloud CAE
-     */
-    enum PresetStyles {
-        /**
-         * Clean viewer has only model and triade
-         */
-        CLEAN_VIEWER = 0,
-        /**
-         *  Minimal UI enabled, widgets for collaboration and model overview
-         */
-        SIMPLE_VIEWER = 1,
-        /**
-         *  All widgets to access operations enabled.
-         */
-        CLOUD_CAE = 2
-    }
-    /**
-     * Style settings customize the viewer so that it changes
-     * the visual appearance of the viewer but not how it functions.
-     */
-    class ViewerStyleSettings {
-        /**
-         * Constructor creates viewer style settings of default type.
-         */
-        constructor();
-        /**
-         * Selection color.
-         */
-        selectionColor: AbstractEntities.Color;
-        /**
-         * The color of the top half of the canvas.
-         */
-        private topColor;
-        /**
-         * The color of the bottom half of the canvas.
-         */
-        private bottomColor;
-        /**
-         * Widget control. ToDo: Separate into functional settings.
-         */
-        presetStyle: PresetStyles;
-        /**
-         * Sets the background top color of the canvas.
-         * @param {Femsolve.Color} backgroundTopColor - The color of the upper segment of the screen.
-         * */
-        setBackgroundTopColor(backgroundTopColor: AbstractEntities.Color): void;
-        /**
-         * Sets the highlighted entities default selection color
-         * ToDo?: Should be under selection settings.
-         * @param selectionColor
-         */
-        setSelectionColor(selectionColor: AbstractEntities.Color): void;
-        /**
-         * Set the background bottom color of the canvas.
-         * @param {Femsolve.Color} backgroundBottomColor - The color of the upper segment of the screen.
-         * */
-        setBackgroundBottomColor(backgroundBottomColor: AbstractEntities.Color): void;
-        /**
-         * Sets the required preset style from the available options.
-         * @param {PresetStyles} style Preset style for initialisation
-         */
-        setPresetStyle(style: PresetStyles): void;
-    }
-}
+import { AbstractEntities } from "../../ViewerEntities/AbstractEntities";
+export declare namespace StyleSettings {
+    /**
+     * There are two existing preset styles for the viewer at time of writing
+     * this version:
+     *  0) Clean viewer
+     *  1) Simple Viewer
+     *  2) Cloud CAE
+     */
+    enum PresetStyles {
+        /**
+         * Clean viewer has only model and triade
+         */
+        CLEAN_VIEWER = 0,
+        /**
+         *  Minimal UI enabled, widgets for collaboration and model overview
+         */
+        SIMPLE_VIEWER = 1,
+        /**
+         *  All widgets to access operations enabled.
+         */
+        CLOUD_CAE = 2
+    }
+    /**
+     * Style settings customize the viewer so that it changes
+     * the visual appearance of the viewer but not how it functions.
+     */
+    class ViewerStyleSettings {
+        /**
+         * Constructor creates viewer style settings of default type.
+         */
+        constructor();
+        /**
+         * Selection color.
+         */
+        selectionColor: AbstractEntities.Color;
+        /**
+         * The color of the top half of the canvas.
+         */
+        private topColor;
+        /**
+         * The color of the bottom half of the canvas.
+         */
+        private bottomColor;
+        /**
+         * Widget control. ToDo: Separate into functional settings.
+         */
+        presetStyle: PresetStyles;
+        /**
+         * Sets the background top color of the canvas.
+         * @param {Femsolve.Color} backgroundTopColor - The color of the upper segment of the screen.
+         * */
+        setBackgroundTopColor(backgroundTopColor: AbstractEntities.Color): void;
+        /**
+         * Sets the highlighted entities default selection color
+         * ToDo?: Should be under selection settings.
+         * @param selectionColor
+         */
+        setSelectionColor(selectionColor: AbstractEntities.Color): void;
+        /**
+         * Set the background bottom color of the canvas.
+         * @param {Femsolve.Color} backgroundBottomColor - The color of the upper segment of the screen.
+         * */
+        setBackgroundBottomColor(backgroundBottomColor: AbstractEntities.Color): void;
+        /**
+         * Sets the required preset style from the available options.
+         * @param {PresetStyles} style Preset style for initialisation
+         */
+        setPresetStyle(style: PresetStyles): void;
+    }
+}

package/fcs-core-viewer@types/CloudViewer/Settings/VisibilitySettings.d.ts

@@ -1,19 +1,19 @@
-export declare namespace VisibilitySettings {
-    /**
-     * Contains visibility toggles for topological entities
-     */
-    enum TopologyVisibility {
-        /**
-         * Visibility option for showing vertex entities.
-         */
-        VERTICES = 0,
-        /**
-         * Visibility option for showing edge entities.
-         */
-        EDGES = 1,
-        /**
-         * Visibility option for showing face entities.
-         */
-        FACES = 2
-    }
-}
+export declare namespace VisibilitySettings {
+    /**
+     * Contains visibility toggles for topological entities
+     */
+    enum TopologyVisibility {
+        /**
+         * Visibility option for showing vertex entities.
+         */
+        VERTICES = 0,
+        /**
+         * Visibility option for showing edge entities.
+         */
+        EDGES = 1,
+        /**
+         * Visibility option for showing face entities.
+         */
+        FACES = 2
+    }
+}

package/fcs-core-viewer@types/CloudViewer/TypesFcs.d.ts

@@ -1,12 +1,12 @@
-export declare class SceneWrapper {
-    scene: any;
-}
-/**
- * Required for position the camera
- * @param point [xp, yp, zp] - Camera target
- * @param diameter Defines bounding sphere diameter
- */
-export interface CameraOperationInput {
-    point: number[];
-    diameter: number;
-}
+export declare class SceneWrapper {
+    scene: any;
+}
+/**
+ * Required for position the camera
+ * @param point [xp, yp, zp] - Camera target
+ * @param diameter Defines bounding sphere diameter
+ */
+export interface CameraOperationInput {
+    point: number[];
+    diameter: number;
+}

package/fcs-core-viewer@types/Common/CommsChannels/BackendClient.d.ts

@@ -1,47 +1,47 @@
-import { IBackendEvents, ITaskUtilities } from '../../CloudViewer/CoreInterfaces';
-/**
- * Use this TaskRequest interface to forward tasks to the backend manager.
- */
-export interface TaskRequest {
-    taskId: number;
-    input: string;
-    blobInput: any;
-    event: Event;
-}
-/**
- * Proxy class for sending backend transactions.
- * All deepend related operations should be transferred through here.
- */
-export declare class BackendManager {
-    private _authToken;
-    private _taskUtilities;
-    private _backendEvents;
-    /**
-     * Constructor. Connects client to backend services.
-     * @param client
-     */
-    constructor(authToken: string, taskUtilities: ITaskUtilities, backendEvents: IBackendEvents);
-    /**
-     * Use this method to forward tasks to the backend WITHOUT blob input
-     * @param taskId This is the common lookup table for the operations. The purpose of this is
-     * that if the function signatures change, the task IDs remain as they were.
-     * @param onCompleteEvent When the task finishes it shall callback this event
-     * @param endpoint By default all tasks are sent to the '/viewer/toBackend' endpoint for now
-     */
-    sendTaskRequestToBackend(taskId: number, input?: null | any, blobInput?: File | null, onCompleteEvent?: Function, endpoint?: string): Promise<any>;
-    /**
-     * Always use this method send baseline computational requests.
-     * E.g. import of model, meshing task.
-     * @param message
-     * @param endpoint
-     * @returns
-     */
-    sendToBackend(message: any, endpoint: string): Promise<any>;
-    /**
-     * Along with a message also a binary file is uploaded.
-     * @param message
-     * @param endpoint
-     * @returns
-     */
-    sendToBackendWithBlobInput(message: any, file: File, endpoint: string): Promise<any>;
-}
+import { IBackendEvents, ITaskUtilities } from '../../CloudViewer/CoreInterfaces';
+/**
+ * Use this TaskRequest interface to forward tasks to the backend manager.
+ */
+export interface TaskRequest {
+    taskId: number;
+    input: string;
+    blobInput: any;
+    event: Event;
+}
+/**
+ * Proxy class for sending backend transactions.
+ * All deepend related operations should be transferred through here.
+ */
+export declare class BackendManager {
+    private _authToken;
+    private _taskUtilities;
+    private _backendEvents;
+    /**
+     * Constructor. Connects client to backend services.
+     * @param client
+     */
+    constructor(authToken: string, taskUtilities: ITaskUtilities, backendEvents: IBackendEvents);
+    /**
+     * Use this method to forward tasks to the backend WITHOUT blob input
+     * @param taskId This is the common lookup table for the operations. The purpose of this is
+     * that if the function signatures change, the task IDs remain as they were.
+     * @param onCompleteEvent When the task finishes it shall callback this event
+     * @param endpoint By default all tasks are sent to the '/viewer/toBackend' endpoint for now
+     */
+    sendTaskRequestToBackend(taskId: number, input?: null | any, blobInput?: File | null, onCompleteEvent?: Function, endpoint?: string): Promise<any>;
+    /**
+     * Always use this method send baseline computational requests.
+     * E.g. import of model, meshing task.
+     * @param message
+     * @param endpoint
+     * @returns
+     */
+    sendToBackend(message: any, endpoint: string): Promise<any>;
+    /**
+     * Along with a message also a binary file is uploaded.
+     * @param message
+     * @param endpoint
+     * @returns
+     */
+    sendToBackendWithBlobInput(message: any, file: File, endpoint: string): Promise<any>;
+}

package/fcs-core-viewer@types/Common/CommsChannels/Socket.d.ts

@@ -1,34 +1,34 @@
-import { Socket } from 'socket.io-client';
-/**
- * Socket Class
- */
-export declare class CurrentUserSocket {
-    private static _instance;
-    socket: Socket;
-    private static _authToken;
-    private static _activeModelPath;
-    /**
-     * By default, we allow and expect to get callbacks from the backend.
-     */
-    private static _allowBackendCallbacks;
-    private constructor();
-    static disallowSocketCallbacks(): void;
-    static getInstance(authToken?: string): CurrentUserSocket;
-    static getAuthToken(): string | null;
-    /**
-     * Handle socket errors and log them to console
-     */
-    private _handleErrors;
-    /**
-     * Get socket instance of socket
-     */
-    get server(): Socket<import("@socket.io/component-emitter").DefaultEventsMap, import("@socket.io/component-emitter").DefaultEventsMap>;
-    /**
-     * Set active model path for current user
-     */
-    static setActiveModelPath(path: string): void;
-    /**
-     * Get active model path for current user
-     */
-    get activeModelPath(): string;
-}
+import { Socket } from 'socket.io-client';
+/**
+ * Socket Class
+ */
+export declare class CurrentUserSocket {
+    private static _instance;
+    socket: Socket;
+    private static _authToken;
+    private static _activeModelPath;
+    /**
+     * By default, we allow and expect to get callbacks from the backend.
+     */
+    private static _allowBackendCallbacks;
+    private constructor();
+    static disallowSocketCallbacks(): void;
+    static getInstance(authToken?: string): CurrentUserSocket;
+    static getAuthToken(): string | null;
+    /**
+     * Handle socket errors and log them to console
+     */
+    private _handleErrors;
+    /**
+     * Get socket instance of socket
+     */
+    get server(): Socket<import("@socket.io/component-emitter").DefaultEventsMap, import("@socket.io/component-emitter").DefaultEventsMap>;
+    /**
+     * Set active model path for current user
+     */
+    static setActiveModelPath(path: string): void;
+    /**
+     * Get active model path for current user
+     */
+    get activeModelPath(): string;
+}