@inweb/viewer-visualize 25.3.13

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+All rights reserved.
+
+This software and its documentation and related materials are owned by
+the Alliance. The software may only be incorporated into application
+programs owned by members of the Alliance, subject to a signed
+Membership Agreement and Supplemental Software License Agreement with the
+Alliance. The structure and organization of this software are the valuable
+trade secrets of the Alliance and its suppliers. The software is also
+protected by copyright law and international treaty provisions. Application
+programs incorporating this software must include the following statement
+with their copyright notices:
+
+  This application incorporates Open Design Alliance software pursuant to a
+  license agreement with Open Design Alliance.
+  Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+  All rights reserved.
+
+By use of this software, its documentation or related materials, you
+acknowledge and accept the above terms.

package/README.md

@@ -0,0 +1,63 @@
+# Viewer.visualize
+
+`Viewer.visualize` is a JavaScript library for visualization of 3D CAD and BIM data from `VSFX` files stored on the [Open Cloud Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server), on the web, or in local files.
+
+This library enables you to integrate advanced [Visualize](https://www.opendesign.com/products/visualize) capabilities into your applications, including user interaction with scenes and objects, and collaboration using the [inWEB Open Cloud](https://www.opendesign.com/products/open-cloud) platform.
+
+> `VSFX` is an internal [Visualize SDK](https://cloud.opendesign.com/docs/index.html#/visualizejs) file format with support for streaming and partial viewing.
+
+## Installation
+
+### CDN or static hosting
+
+For CDN, you can use [unpkg](https://unpkg.com/) or [jsDelivr](https://www.jsdelivr.com/) (replace `25.2` with a version you need):
+
+```javascript
+<script src="https://unpkg.com/@inweb/viewer-visualize@25.2/dist/viewer-visualize.js"></script>
+```
+
+The global namespace for `Viewer.visualize` is `ODA.Visualize`.
+
+### Install via [npm](https://npmjs.org)
+
+Open a terminal in your project folder and run:
+
+```sh
+npm install @inweb/viewer-visualize
+```
+
+The `Viewer.visualize` package will be downloaded and installed. Then you're ready to import it in your code:
+
+```javascript
+import { Viewer } from "@inweb/viewer-visualize";
+```
+
+## Example
+
+Download and render file from the `Open Cloud Server`:
+
+```javascript
+// create instance of the Client class for working with server
+const client = new ODA.Api.Client({ serverUrl: "https://cloud.opendesign.com/api" });
+
+// login to the server
+await client.signInWithEmail("email", "password");
+
+// get file list from the server
+const files = await client.getFiles();
+
+// create instance of Viewer class for rendering drawing files
+const viewer = new ODA.Visualize.Viewer(client);
+
+// initialize Viewer it with the specified <canvas> element
+await viewer.initialize(canvas);
+
+// open the first file in the list
+await viewer.open(files.result[0]);
+```
+
+To learn more, see [First application guide](https://cloud.opendesign.com/docs/index.html#/guide).
+
+## Copyright and license
+
+Code and documentation copyright 2002-2024 the [Open Design Alliance](https://opendesign.com). Code is distributed under a proprietary license, see [LICENSE](./LICENSE) for more information.