fcs-core-viewer 0.2.2 → 0.2.4

package/fcs-core-viewer@types/Addins/CustomScript.d.ts

@@ -1,11 +1,11 @@
-import { TaskUtils } from "../TaskHandler/TaskUtils";
-/**
- * Serves to host additional development functionalities.
- */
-export declare namespace Addins {
-    /**
-     * By registering addins we hook up event listeners and path them to the correct
-     * method defined in this class.
-     */
-    function registerAddins(taskUtils: TaskUtils): void;
-}
+import { TaskUtils } from "../TaskHandler/TaskUtils";
+/**
+ * Serves to host additional development functionalities.
+ */
+export declare namespace Addins {
+    /**
+     * By registering addins we hook up event listeners and path them to the correct
+     * method defined in this class.
+     */
+    function registerAddins(taskUtils: TaskUtils): void;
+}

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

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

package/fcs-core-viewer@types/Api.d.ts

@@ -1,10 +1,10 @@
-/**
- * Contains all usable exports to build custom frontend applications
- * that leverage the FCS Cloud Viewer and Editor.
- */
-export * from './Foundations/Index';
-export * from './ViewerEntities/Index';
-export * from './CloudViewer/Settings/Index';
-export * from './Model/Index';
-export * from './CloudViewer/Index';
-export * from './Common/Index';
+/**
+ * Contains all usable exports to build custom frontend applications
+ * that leverage the FCS Cloud Viewer and Editor.
+ */
+export * from './Foundations/Index';
+export * from './ViewerEntities/Index';
+export * from './CloudViewer/Settings/Index';
+export * from './Model/Index';
+export * from './CloudViewer/Index';
+export * from './Common/Index';

package/fcs-core-viewer@types/BackendEvents/BackendEvents.d.ts

@@ -1,218 +1,218 @@
-import { MeshWrapper } from '../Model/MeshWrapper';
-import { SceneWrapper } from '../Model/SceneWrapper';
-import { Appearance } from '../TaskHandler/Context/Context';
-import { Loader } from '../Loader/Loader';
-import { TreeOperations } from '../TaskHandler/Tree/Tree';
-import { TreeView } from '../UserInterface/UIComponents/TreeView';
-import { TaskUtils } from '../TaskHandler/TaskUtils';
-import { CloudViewer } from '../CloudViewer/FcsViewer';
-import { Translate } from '../TaskHandler/Topbar/Tools/Transformation';
-import { Measurement } from '../TaskHandler/Topbar/Tools/Measurement';
-import { Options } from '../TaskHandler/Options/Options';
-import { TaskExecutionResponse } from './TaskExecutionResponse';
-import { IBackendEvents } from '../CloudViewer/CoreInterfaces';
-import { AddTreeItem } from '../TaskHandler/Tree/ResponseHandler/AddTreeItem';
-/**
- * This is the format of the backend received data.
- */
-interface BackendInstructions {
-    operation: string;
-    arguments: any;
-    finished?: boolean;
-    /**
-     * Task callback arguments
-     */
-    callback_guid_id?: string;
-    /**
-     * Optional addin arguments
-     */
-    addin_command?: string;
-    addin?: string;
-    on_finished_arguments?: {};
-}
-/**
- * All events that were triggered by the backend.
- * Normally, everything is first run by the backend to make sure if the
- * changes can take affect in the model file. Once successful, it is returned
- * back with sockets.
- */
-export declare class BackendEvents implements IBackendEvents {
-    licenseToken: string;
-    meshWrapper: MeshWrapper;
-    sceneWrapper: SceneWrapper;
-    appearance: Appearance;
-    loader: Loader;
-    treeView: TreeView;
-    treeOps: TreeOperations;
-    taskUtils: TaskUtils;
-    options: Options;
-    translate: Translate;
-    measurement: Measurement;
-    addTreeItem: AddTreeItem;
-    name: string;
-    tName: string;
-    operation: string;
-    stlPath: string;
-    stlPathStatic: string;
-    t2gPathStatic: string;
-    scene: any;
-    controls: any;
-    renderer: any;
-    currentCamera: any;
-    grEntityLabel: any;
-    requestArray: any[];
-    requestIndex: number;
-    response: any;
-    status: string;
-    backendInstructionData: {};
-    components: {};
-    wereListenersRegistered: boolean;
-    readonly operationToFunction: {
-        show_progress_tracker: any;
-        finish_progress_tracker: any;
-        show_status_message: any;
-        translate_two_points: any;
-        measure_distance: any;
-        WhatIs: any;
-        hide: any;
-        show: any;
-        hide_all: any;
-        show_all: any;
-        set_transparency: any;
-        center_view: any;
-        set_object_color: any;
-        refresh_viewer: any;
-        clear_document: any;
-        commit_to_document: any;
-        remove_from_document: any;
-        add_new_container: any;
-        add_new_container_under: any;
-        add_to_document: any;
-        add_to_document_under: any;
-        export_STEP_for_selection: any;
-        generic_callback_middleware: any;
-    };
-    /**
-     * Contains guid to backend service mappings.
-     */
-    attachedServices: {
-        [key: string]: CloudViewer.BackendService;
-    };
-    /**
-     * Contains all approved guids
-     */
-    registeredAddinGuids: string[];
-    /**
-     * Callback function GUIDs
-     */
-    guidCallbackDictionary: {
-        [key: string]: Function;
-    };
-    /**
-     * Constructor.
-     */
-    constructor(licenseToken: string, sceneWrapper: SceneWrapper, meshWrapper: MeshWrapper, loader: Loader, appearance: Appearance, treeView: TreeView, treeOperations: TreeOperations, taskUtilities: TaskUtils, options: Options, translate: Translate, measurement: Measurement, addTreeItem: AddTreeItem);
-    /**
-     * Saves the backend service and will be able to invoke the
-     * 'OnFinished' method on call back from backend service.
-     * @param service
-     * @param serviceMethod
-     */
-    attachService(service: CloudViewer.BackendService): void;
-    /**
-     * We pass in a function that will be called when the backend task finishes.
-     * We save this method in a dictionary where it will receive a GUID.
-     * When the method finishes it will search in the through the
-     * 'guidCallbackDictionary' to look if there are any methods that need to be run.
-     * @param callbackFn Method to be run after the task is finished
-     * @returns created Guid that will be used to identify the callback function
-     */
-    attachCallbackMethodToTask(callbackFn: Function): string;
-    /**
-     * Registers all available event listeners.
-     */
-    private _registerEventListeners;
-    /**
-     * Miutan egyszer elinditottuk a scheduler funkciot, while ciklussal menjunk vegig a array-en,
-     * melyet a backend-bol jovo request-ek folyamatosan toltenek fel feladatokkal.
-     * Ha i = N akkor kuldje a response-t.
-     * @returns Response from called backend method.
-     */
-    private scheduler;
-    /**
-     * Dummy placeholder method that serves as a generic middleware to all methods.
-     * @returns
-     */
-    private generic_callback_middleware;
-    /**
-     * Centers the view.
-     * @param data Does not matter, because it centers everything that's visible
-     */
-    private center_view;
-    /**
-     * Renders latest document (whatever was added/removed/modified)
-     */
-    private refresh_viewer;
-    /**
-     * Clears all entities in the document. Basically, a new empty document is open.
-     */
-    private clear_document;
-    /**
-     * This method is called both times when we are spawning the progress
-     * tracker or updating an existing one. To close down the progress tracker,
-     * we need to call a different method from the API, called `finish_progress_tracker`.
-     * @param data Contains 'progress_percentage' and 'current_process_name'
-     */
-    show_progress_tracker(instructions: BackendInstructions): Promise<TaskExecutionResponse>;
-    /**
-     * Stops the progress tracker and presents the exit status, unless
-     * immediate shutdown was requested.
-     * @param data Passes on an `exit_message`, `exit_status`, `immediate_shutdown`.
-     */
-    finish_progress_tracker(data: BackendInstructions): Promise<TaskExecutionResponse>;
-    /**
-     * If there was an already running progress dialog, it is reset.
-     * This is not ideal, but we really only want to keep a single instance
-     * of a pop-up status window.
-     * @param data
-     */
-    show_status_message(backendInstruction: BackendInstructions): Promise<TaskExecutionResponse>;
-    private remove_from_document;
-    /**
-     * Add empty file, folder or container to the viewer
-     * @param data
-     * @returns
-     */
-    private add_empty_item;
-    add_to_document(data: BackendInstructions): Promise<TaskExecutionResponse>;
-    set_object_color(data: BackendInstructions): Promise<TaskExecutionResponse>;
-    /**
-     * Sets the transparency of an object.
-     * @param instructions Contains ID and opacity
-     */
-    set_transparency(instructions: BackendInstructions): TaskExecutionResponse | "Finished: set_transparency";
-    /**
-     * Will set visibility toggle on for all passed in entity_ids.
-     * @param instructions Contains entity_ids only
-     */
-    private _show;
-    private _hide;
-    set_object_visibility(instructions: BackendInstructions): Promise<TaskExecutionResponse>;
-    /**
-     * Saves the currently active model's path, it will mark it as saveable.
-     * ToDo: For any other changes that were not committed to, we will need to
-     * disable the ability to export the model.
-     * @param instructions
-     * @returns 'Finished' message
-     */
-    commit_to_document(instructions: BackendInstructions): Promise<TaskExecutionResponse>;
-    /**
-     *
-     * @param instructions Contains exported STEP file path
-     */
-    private export_STEP_for_selection;
-    translate_two_points(data: BackendInstructions): Promise<TaskExecutionResponse>;
-    measure_distance(data: BackendInstructions): Promise<TaskExecutionResponse>;
-    WhatIs(data: BackendInstructions): Promise<TaskExecutionResponse>;
-}
-export {};
+import { MeshWrapper } from '../Model/MeshWrapper';
+import { SceneWrapper } from '../Model/SceneWrapper';
+import { Appearance } from '../TaskHandler/Context/Context';
+import { Loader } from '../Loader/Loader';
+import { TreeOperations } from '../TaskHandler/Tree/Tree';
+import { TreeView } from '../UserInterface/UIComponents/TreeView';
+import { TaskUtils } from '../TaskHandler/TaskUtils';
+import { CloudViewer } from '../CloudViewer/FcsViewer';
+import { Translate } from '../TaskHandler/Topbar/Tools/Transformation';
+import { Measurement } from '../TaskHandler/Topbar/Tools/Measurement';
+import { Options } from '../TaskHandler/Options/Options';
+import { TaskExecutionResponse } from './TaskExecutionResponse';
+import { IBackendEvents } from '../CloudViewer/CoreInterfaces';
+import { AddTreeItem } from '../TaskHandler/Tree/ResponseHandler/AddTreeItem';
+/**
+ * This is the format of the backend received data.
+ */
+interface BackendInstructions {
+    operation: string;
+    arguments: any;
+    finished?: boolean;
+    /**
+     * Task callback arguments
+     */
+    callback_guid_id?: string;
+    /**
+     * Optional addin arguments
+     */
+    addin_command?: string;
+    addin?: string;
+    on_finished_arguments?: {};
+}
+/**
+ * All events that were triggered by the backend.
+ * Normally, everything is first run by the backend to make sure if the
+ * changes can take affect in the model file. Once successful, it is returned
+ * back with sockets.
+ */
+export declare class BackendEvents implements IBackendEvents {
+    licenseToken: string;
+    meshWrapper: MeshWrapper;
+    sceneWrapper: SceneWrapper;
+    appearance: Appearance;
+    loader: Loader;
+    treeView: TreeView;
+    treeOps: TreeOperations;
+    taskUtils: TaskUtils;
+    options: Options;
+    translate: Translate;
+    measurement: Measurement;
+    addTreeItem: AddTreeItem;
+    name: string;
+    tName: string;
+    operation: string;
+    stlPath: string;
+    stlPathStatic: string;
+    t2gPathStatic: string;
+    scene: any;
+    controls: any;
+    renderer: any;
+    currentCamera: any;
+    grEntityLabel: any;
+    requestArray: any[];
+    requestIndex: number;
+    response: any;
+    status: string;
+    backendInstructionData: {};
+    components: {};
+    wereListenersRegistered: boolean;
+    readonly operationToFunction: {
+        show_progress_tracker: any;
+        finish_progress_tracker: any;
+        show_status_message: any;
+        translate_two_points: any;
+        measure_distance: any;
+        WhatIs: any;
+        hide: any;
+        show: any;
+        hide_all: any;
+        show_all: any;
+        set_transparency: any;
+        center_view: any;
+        set_object_color: any;
+        refresh_viewer: any;
+        clear_document: any;
+        commit_to_document: any;
+        remove_from_document: any;
+        add_new_container: any;
+        add_new_container_under: any;
+        add_to_document: any;
+        add_to_document_under: any;
+        export_STEP_for_selection: any;
+        generic_callback_middleware: any;
+    };
+    /**
+     * Contains guid to backend service mappings.
+     */
+    attachedServices: {
+        [key: string]: CloudViewer.BackendService;
+    };
+    /**
+     * Contains all approved guids
+     */
+    registeredAddinGuids: string[];
+    /**
+     * Callback function GUIDs
+     */
+    guidCallbackDictionary: {
+        [key: string]: Function;
+    };
+    /**
+     * Constructor.
+     */
+    constructor(licenseToken: string, sceneWrapper: SceneWrapper, meshWrapper: MeshWrapper, loader: Loader, appearance: Appearance, treeView: TreeView, treeOperations: TreeOperations, taskUtilities: TaskUtils, options: Options, translate: Translate, measurement: Measurement, addTreeItem: AddTreeItem);
+    /**
+     * Saves the backend service and will be able to invoke the
+     * 'OnFinished' method on call back from backend service.
+     * @param service
+     * @param serviceMethod
+     */
+    attachService(service: CloudViewer.BackendService): void;
+    /**
+     * We pass in a function that will be called when the backend task finishes.
+     * We save this method in a dictionary where it will receive a GUID.
+     * When the method finishes it will search in the through the
+     * 'guidCallbackDictionary' to look if there are any methods that need to be run.
+     * @param callbackFn Method to be run after the task is finished
+     * @returns created Guid that will be used to identify the callback function
+     */
+    attachCallbackMethodToTask(callbackFn: Function): string;
+    /**
+     * Registers all available event listeners.
+     */
+    private _registerEventListeners;
+    /**
+     * Miutan egyszer elinditottuk a scheduler funkciot, while ciklussal menjunk vegig a array-en,
+     * melyet a backend-bol jovo request-ek folyamatosan toltenek fel feladatokkal.
+     * Ha i = N akkor kuldje a response-t.
+     * @returns Response from called backend method.
+     */
+    private scheduler;
+    /**
+     * Dummy placeholder method that serves as a generic middleware to all methods.
+     * @returns
+     */
+    private generic_callback_middleware;
+    /**
+     * Centers the view.
+     * @param data Does not matter, because it centers everything that's visible
+     */
+    private center_view;
+    /**
+     * Renders latest document (whatever was added/removed/modified)
+     */
+    private refresh_viewer;
+    /**
+     * Clears all entities in the document. Basically, a new empty document is open.
+     */
+    private clear_document;
+    /**
+     * This method is called both times when we are spawning the progress
+     * tracker or updating an existing one. To close down the progress tracker,
+     * we need to call a different method from the API, called `finish_progress_tracker`.
+     * @param data Contains 'progress_percentage' and 'current_process_name'
+     */
+    show_progress_tracker(instructions: BackendInstructions): Promise<TaskExecutionResponse>;
+    /**
+     * Stops the progress tracker and presents the exit status, unless
+     * immediate shutdown was requested.
+     * @param data Passes on an `exit_message`, `exit_status`, `immediate_shutdown`.
+     */
+    finish_progress_tracker(data: BackendInstructions): Promise<TaskExecutionResponse>;
+    /**
+     * If there was an already running progress dialog, it is reset.
+     * This is not ideal, but we really only want to keep a single instance
+     * of a pop-up status window.
+     * @param data
+     */
+    show_status_message(backendInstruction: BackendInstructions): Promise<TaskExecutionResponse>;
+    private remove_from_document;
+    /**
+     * Add empty file, folder or container to the viewer
+     * @param data
+     * @returns
+     */
+    private add_empty_item;
+    add_to_document(data: BackendInstructions): Promise<TaskExecutionResponse>;
+    set_object_color(data: BackendInstructions): Promise<TaskExecutionResponse>;
+    /**
+     * Sets the transparency of an object.
+     * @param instructions Contains ID and opacity
+     */
+    set_transparency(instructions: BackendInstructions): TaskExecutionResponse | "Finished: set_transparency";
+    /**
+     * Will set visibility toggle on for all passed in entity_ids.
+     * @param instructions Contains entity_ids only
+     */
+    private _show;
+    private _hide;
+    set_object_visibility(instructions: BackendInstructions): Promise<TaskExecutionResponse>;
+    /**
+     * Saves the currently active model's path, it will mark it as saveable.
+     * ToDo: For any other changes that were not committed to, we will need to
+     * disable the ability to export the model.
+     * @param instructions
+     * @returns 'Finished' message
+     */
+    commit_to_document(instructions: BackendInstructions): Promise<TaskExecutionResponse>;
+    /**
+     *
+     * @param instructions Contains exported STEP file path
+     */
+    private export_STEP_for_selection;
+    translate_two_points(data: BackendInstructions): Promise<TaskExecutionResponse>;
+    measure_distance(data: BackendInstructions): Promise<TaskExecutionResponse>;
+    WhatIs(data: BackendInstructions): Promise<TaskExecutionResponse>;
+}
+export {};

package/fcs-core-viewer@types/BackendEvents/TaskExecutionResponse.d.ts

@@ -1,22 +1,22 @@
-export declare enum TaskExecutionOutcome {
-    Successful = 0,
-    SuccessfulWithWarnings = 1,
-    FailureButCanContinue = 2,
-    CompleteFailure = 3
-}
-export declare class TaskExecutionResponse {
-    private _functionName;
-    private _executionOutcome;
-    private _errorMessage;
-    private _warningMessage;
-    constructor(functionName: string);
-    /**
-     * Uses the stack trace to create a default
-     * @returns A default execution response with successful outcome.
-     */
-    static ConstructDefaultResponse(): TaskExecutionResponse;
-    getOutcome(): TaskExecutionOutcome;
-    setOutcome(outcome: TaskExecutionOutcome): void;
-    setWarningMessage(_warningMessage: string): void;
-    setErrorMessage(errorMessages: string): void;
-}
+export declare enum TaskExecutionOutcome {
+    Successful = 0,
+    SuccessfulWithWarnings = 1,
+    FailureButCanContinue = 2,
+    CompleteFailure = 3
+}
+export declare class TaskExecutionResponse {
+    private _functionName;
+    private _executionOutcome;
+    private _errorMessage;
+    private _warningMessage;
+    constructor(functionName: string);
+    /**
+     * Uses the stack trace to create a default
+     * @returns A default execution response with successful outcome.
+     */
+    static ConstructDefaultResponse(): TaskExecutionResponse;
+    getOutcome(): TaskExecutionOutcome;
+    setOutcome(outcome: TaskExecutionOutcome): void;
+    setWarningMessage(_warningMessage: string): void;
+    setErrorMessage(errorMessages: string): void;
+}

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

@@ -1,12 +1,12 @@
-import { BackendManager } from "../Common/CommsChannels/BackendClient";
-/**
- * Core interfaces serve to declare types that are used in
- * code that is not directly accessible via the API.
- */
-export interface ITaskUtilities {
-    setBackendManager(backendManager: BackendManager): void;
-    getDataFromSelected(): any | null;
-}
-export interface IBackendEvents {
-    attachCallbackMethodToTask(callbackFn: Function): string;
-}
+import { BackendManager } from "../Common/CommsChannels/BackendClient";
+/**
+ * Core interfaces serve to declare types that are used in
+ * code that is not directly accessible via the API.
+ */
+export interface ITaskUtilities {
+    setBackendManager(backendManager: BackendManager): void;
+    getDataFromSelected(): any | null;
+}
+export interface IBackendEvents {
+    attachCallbackMethodToTask(callbackFn: Function): string;
+}