Alexandru Popovici
aa17a48533
* fix(viewer-lib): Transformed is no longer baked in if matrix is identity * fix(viewer-lib): Do not use uint32 indices unless we have to * fix(viewer-lib): Do not use Float64 array unless the batch needs RTE * feat(viewer-lib): Update on reducing memory allocation during startup: - Geometry data is now stored as separate DataChunks as they come - Dechunking now no longer allocates memory. It just returns the DataChunk array - Updated the SpeckleGeometryConverter to work with chunk arrays - Updated Geometry and triangulation to work with chunk arrays - All geometry type batches now work with chunk arrays instead of flattened arrays - Chunks are tracked by use and deleted after all render views are done with them. The chunks also track their usage across different render views so they aren't deleted until all render views that use tham are finished with them - In order to better support this new way of working with geometry data, VirtualArray and ChunkArray classes have been implemented. They make it easier to work with segmented data and offer a unified view on the array of array segments * chore(viewer-lib): Denormalized normals to keep parity, even though they should be normalized * feat(viewer-lib): Geometry transformation is now deferred until we build batches, and we transform the batched arrays leaving the original data chunks intact. Text and TextBatchObject now use the render view's 'transform' property to store it's final startup transformation and not 'bakeTransform' anymore * fix(viewer-lib): Fixed the issues caused by chunking geometry to the acceleration structures. * chore(viewer-lib): Made a pass on the entire viewer project and removed pointless typed array backing buffer re-allocations * feat(viewer-lib): Updates on better large model support: - Fixed an issue in LineBatach that broke building it - Improved VirtualArray performance and added some extra functionality - Already triangulated faces no longer allocate redundant memory, they get processed in place - Moved triangulation to SpeckleConverter so that processed index chunks get stored in local storage so we don't have to re-triangulate each time * feat(viewer-lib): Gave up on trying to cache triangulated indice. Too much hasle and edge cases to handle when only some chunks get saved as triangulated in a multi chunk setup * fix(viewer-lib): Fixed non triangulted geometry converter return * feat(viewer-lib): Glow-up to our triangulation implementation. Faster, zero allocation * fix(viewer-lib): Frontfacing not backfacing triangles * chore(viewer-lib): Fixed compile errors * fix(viewer-lib): Already processed chunks just copy over * fix(viewer-lib): Skip processed chunks when computing triangulation index size * fix(viewer-lib): Some fixes: - Fixed an issue where instances that will not be rendered as instanced geometry were not correctly transformed - Removed geometry duplication from instances that were de-instanced in the batcher - Fixed an issue with LineBatch and buffer type * fix(viewer-lib): Implemented box3 bounds generation from ChunkArray which takes care to respect inter-chunk bounds for vec3. Without this, box3s were incorrectly calculated by computing a box3 for each chunk * fix(viewer-lib): Fixed an issue where transformations that contain non-uniform scaling incorrectly produce node render views aabb values. So we recompute them based on the post-transform geometry when building batches * fix(viewer-lib): When mixing triangles with ngons we also need to increment total tris count for the triangle case as well * fix(viewer-lib): If geometry is invalid, clear it all * fix(viewer-lib): Instanced rvs no longer transform their aabbs when building the render tree because they don't need to * fix(viewer-lib): aabb for render views needs to be recomputed when de-instanced by the batcher
Speckle | Server
Speckle is the first AEC data hub that connects with your favorite AEC tools. Speckle exists to overcome the challenges of working in a fragmented industry where communication, creative workflows, and the exchange of data are often hindered by siloed software and processes. It is here to make the industry better.
Server and Web packages
Repo structure
This monorepo is the home of the Speckle v2 web packages:
packages/server: the Server, a nodejs app.packages/frontend-2: the Frontend, a Nuxt/Vue app.packages/viewer: a threejs extension that allows you to display 3D datapackages/objectloader: a small js utility class that helps you stream an object and all its sub-components from the Speckle Server API.packages/preview-service: generates object previews for Speckle Objects headlessly. This package is meant to be called on by the server.packages/webhook-service: making external webhook callspackages/fileimport-service: parsing and importing files
Other repos
Make sure to also check and ⭐️ these other Speckle repositories:
speckle-sharp-connectors: .NET connectors and desktop UIspeckle-sharp-sdk: .NET SDK, tests, and Objectsspecklepy: Python SDK 🐍speckle-sketchup: Sketchup connectorspeckle-excel: Excel connectorspeckle-unity: Unity 3D connectorspeckle-blender: Blender connectorspeckle-unreal: Unreal Engine connectorspeckle-qgis: QGIS connectorspeckle-powerbi: PowerBi connector- and more connectors & tooling!
Developing and Debugging
Have you checked our dev docs?
We have a detailed section on deploying a Speckle server. To get started developing locally, you can see the Local development environment page.
TL;DR;
We're using yarn and its workspaces functionalities to manage the monorepo. Make sure you are using Node version 22. To get started, run:
corepack enableyarnyarn build:publicyarn build
After this, you can use the scripts in the individual packages or run them all in dev mode:
yarn dev
For development you'll also want to run yarn dev:docker:up which will start up the docker containers you will need
to be able to run the apps on your machine.
IDE
The suggested IDE for working in this repo is VSCode, because the repo has special configs to improve the DX there (auto-format & auto-lint, recommended extensions etc.).
This repository relies on VSCode multi-root workspaces, so for the best DX and proper formatting/linting make sure you open the project using the workspace.code-workspace file instead of just opening the folder in VSCode.
Proper TypeScript support
To get proper TS support in standard TS files as well as Vue files, we rely on the Volar VSCode extension - not Vetur! When you open the workspace for the very first time, VSCode should already prompt you to install this extension. The default Volar setup can be quite resource intensive, however, because there end up being standard TS Language Server instances running as well as Vue TS Language server instances. To resolve this issue we rely on Volar's Take Over Mode.
Essentially, ensure you have Volar enabled, and the built in TypeScript and JavaScript Language Features extension disabled (for this workspace)!
Useful containers
Maildev
We have a Maildev container available that you can use to see all e-mails sent out from the app. Make sure your server .env file is configured properly to use it:
EMAIL=true
EMAIL_FROM="no-reply@example.org"
EMAIL_HOST="localhost"
EMAIL_PORT="1025"
The web portal is available at localhost:1080 and it's listening for mail on port 1025.
Minio (S3 storage)
Default credentials are: minioadmin:minioadmin
Main storage Web UI: http://localhost:9001/
Region1 storage Web UI: http://localhost:9021/
You can use the web UI to validate uploaded blobs
Contributing
Please make sure you read the contribution guidelines for an overview of the best practices we try to follow.
When pushing commits to this repo, please follow the following guidelines:
- When ready to commit, run
$ yarn cz& follow the prompts.
When committing to git, an automated script will run. This will check that your commit conforms to Speckle's guidelines.
-
To enable additional checks, you may wish to optionally install the following:
-
Please note that these additional checks will be run by Speckle's automated CI environment and non-conformances, if any, may prevent your Pull Request from being merged.
-
Please use the name of the package as the scope of your commit.
-
Note that
ggshieldrequires you to register an account and then authorise with GitGuardian before it can be used:ggshield auth login -
Then run to enable pre-commit. This will run on every commit you make:
pre-commit install
Security
For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.
License
Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.