Refactor WebXR Rendering to vtkWebXRRenderWindowHelper
#2924
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tbirdso
force-pushed
the
refactor-webxr
branch
from
a9ad12a to
9f8fd5c
Compare
4 tasks
tbirdso
force-pushed
the
refactor-webxr
branch
3 times, most recently
from
6d2999e to
d360f3f
Compare
|
@floryst ping for review EDIT: Also rebased on |
Refactors WebXR rendering support. Under previous behavior WebXR rendering was embedded in vtkOpenGLRenderWindow. This change removes the dependency of vtkOpenGLRenderWindow on WebXR and moves XR components into vtkWebXRRenderWindowHelper. The helper class holds a reference to an underlying render window and is responsible to start/run/stop XR rendering. BREAKING CHANGE: Removes WebXR API from `vtkOpenGLRenderWindow`. Applications requiring XR support must instantiate `vtkWebXRRenderWindowHelper` instead.
Updates WebXR examples for refactoring to `vtkWebXRRenderWindowHelper`.
Replaces `global` definition of XRGLLayer with imported definition from `window`. Addresses observed issue in VolView development where the `global` definition is not yet available at call time.
…pplication logic Updates `vtkWebXRRenderWindowHelper` interface to expose the underlying XR session and to emit the VTK "modified" event when state changes. Motivated by subsequent VolView application development.
…nd public interface Improves TypeScript definitions and removes previous publicAPI methods for setting the XR session and rendering an XR frame. Motivated by subsequent application development in VolView.
Add WebXR TypeScript definitions to vtkWebXRRenderWindowHelper to resolve CI failures.
tbirdso
force-pushed
the
refactor-webxr
branch
from
d360f3f to
f400bf9
Compare
|
Since this is a breaking change, we will merge it along with the rest of v29 PRs. |
|
@floryst There is interest in making this available in a VTK.js release sooner rather than later. @aylward made the point this morning that breaking changes are limited to XR users, anyone who was previously using Would you be open to merging this today? Or, when do you expect v29 to release? |
|
I'll start work to cut a v29 release today. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Under previous experimentation WebXR rendering support was fully contained within the
vtkOpenGLRenderWindow. This refactoring encapsulates that support in the new classvtkWebXRRenderWindowHelper. That class accepts a reference to an underlying render window and is responsible for driving XR operations.Refactoring allows for better separation of concepts and could enable XR rendering with alternate rendering backends other than
vtkOpenGLRenderWindowin the future.Results
No feature changes. XR methods are removed from the
vtkOpenGLRenderWindowinterface. An application aiming to use WebXR with vtk.js must now instantiate avtkWebXRRenderWindowHelperto drive XR behavior.Changes
vtkWebXRRenderWindowHelpervtkOpenGLRenderWindowPR and Code Checklist
npm run reformatto have correctly formatted codeTesting
masterAdditional Notes
Additional effort may be required for refactoring WebXR interaction handling.