Changelog¤
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Unreleased¤
Added¤
Changed¤
Removed¤
[2.0.0] - 2026-11-17¤
Added¤
Pluginand@actionincompas_threejs.viewer: a toolbar plugin's Python half, talking to its frontend buttons with@actionhandlers andsend().App.plugins: the viewer's plugins, in toolbar order. The App serves each plugin's built frontend and lists them at/plugins.json.Plugin.hide/show/disable/enable: hide or disable a plugin's button groups, buttons or object actions by id.Plugin.attached(), called once a plugin is added to an App, andApp.find_geometry(guid).- Workspace-aware plugins:
@actionhandlers get(data, workspace), theWorkspaceof the browser tab that sent the message; inside a handlerPlugin.sendanswers that tab,send(..., workspace=)picks one, andPlugin.send_allreaches every tab. Button state reaches every tab. Workspace.plugins: the subset ofApp.pluginsa workspace's tabs show, served at/plugins.json?workspace=<id>.Workspace.url.App.on_new_workspace(callback)andPlugin.new_workspace(workspace): set up a workspace a browser tab asks for before it exists (e.g. one a plugin opened withviewer.workspaceUrl), before the tab loads its plugins.- Plugin panels:
hide/show/disable/enablealso take the ids of a plugin's docked panels. Plugin.notify(message, kind): a short message for the user, at the bottom of the view.App.show_geometry_edges(geometry, show=True)/Workspace.show_geometry_edges: outline one object's edges, whatever the scene-wideshow_edges.
Fixed¤
- A picked object's metadata shows its fields in order (sent along as
"__order__"); sending it no longer writes into the registeredMetadata. App.startsends the theme before the background color, so a background set with dark mode on is kept.
Changed¤
- The viewer has no toolbar unless plugins add one, e.g.
app.plugins = [Essentials(), Views()]fromcompas_threejs_essentialsandcompas_threejs_views. - The transform gizmo and object locking are plugin behaviour (
Essentialsincompas_threejs_essentials); the viewer applies a gizmo edit to the geometry as before.
Removed¤
[1.1.2] - 2026-10-13¤
Added¤
Changed¤
- Fixed the spinner getting stuck after a WebSocket reconnect: spinner messages are now persisted (under a stable
obj_id="spinner") like other viewer state, so a reconnecting client sees the current spinner state instead of missing a "stop" it never received.
Removed¤
[1.1.1] - 2026-09-07¤
Added¤
Changed¤
Removed¤
[1.1.0] - 2026-09-07¤
Added¤
- Bidirectional sync between the frontend and live backend COMPAS objects: gizmo drags/rotations (
object_transform), toolbar-added geometry (create_geometry), and material edits (material_edit) now mutate the same live objects a running script sees, instead of only flowing updates one way. Seesrc/compas_threejs/viewer/BIDIRECTIONAL_SYNC.md. Workspace.transform_geometry(geometry, transformation): applies acompas.geometry.Transformation(orTranslation/Rotation) to an existing geometry and sends only the small transform matrix to the frontend, instead of re-sending the full geometry - useful for moving/rotating large meshes without a full re-serialize on every update.
Changed¤
- Bumped
compas-pbto 1.2.0 (within the existing>=1,<2constraint), matching the version the bundled frontend'scompas-pb-tswas upgraded to. - Fixed
Workspace.remove_object()never clearing an object'sInbox-side registrations (geometry_registry,metadata_registry,object_actions_registry, the guid-keyedbuttonscallback map, and a removedBrep'sbrep_viewmesh_registryentry) - only theOutbox's persisted material/visibility slots were forgotten, so any workflow that repeatedly removes and re-adds objects under the same guid (e.g. a viewer that rebuilds part of its own scene, or an object action whose geometry gets refreshed to pick up a new default value) leaked a growing set of stale entries, unbounded, for the life of the process. - The bundled frontend is no longer committed to the repository. It's now built automatically at release time from the
compas_threejs_tsversion pinned inFRONTEND_VERSION, via a newinvoke pre-buildtask wired into the release pipeline (run-prebuildonprepare-release@v1).pip install compas_threejsstill requires no Node.js. SeeFRONTEND_WORKFLOW.md.
Removed¤
scripts/sync-frontend.pyandsync-frontend.bat, superseded by theinvoke sync-frontendtask.
[1.0.1] - 2026-08-13¤
Added¤
Changed¤
- Aligned the release pipeline with
compas_pbso publishing frommaincan proceed to GitHub release creation and documentation deployment - Added package, Python, license, build, documentation, and COMPAS badges to the README
- Consolidated documentation automation in the release workflow
Removed¤
[1.0.0] - 2026-08-13¤
Added¤
- Public package documentation and release-oriented README
- Continuous integration for tests, documentation, and changelog verification
Changed¤
- Migrated CI, documentation, and trusted publishing to
compas-actions@v1and repository-owned release pull requests - Transferred project ownership and copyright to the COMPAS Association
- Updated the bundled TypeScript viewer to the current public-release build
- Made the default physical-material attenuation distance JSON-safe
- Standardized version bumping, Ruff checks, contributor guidance, documentation metadata, and Trusted Publishing releases
Removed¤
[0.1.0] - 2026-05-26¤
Added¤
- Initial release of COMPAS ThreeJS
- Core viewer component for visualizing COMPAS geometry in Three.js
- Support for multiple material types:
- Generic Material
- Physical Material
- Point Material
- Line Material
- Lighting support:
- Point Light
- Spot Light
- Rect Light
- Sky (environment lighting)
- Sun (directional light)
- UI Components:
- Button
- Slider
- Number Field
- Metadata support for geometry annotation
- Text rendering capabilities
- WebSocket-based server for live updates using FastAPI
- Protobuf serialization for efficient data transfer
- Comprehensive documentation with MkDocs
- Python and frontend build automation with GitHub Actions