Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/components/vtk/VtkSliceView.vue
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ import {
} from 'vue';
import { storeToRefs } from 'pinia';
import vtkInteractorStyleManipulator from '@kitware/vtk.js/Interaction/Style/InteractorStyleManipulator';
import { onVTKEvent } from '@/src/composables/onVTKEvent';
import { useVtkView } from '@/src/core/vtk/useVtkView';
import { useImage } from '@/src/composables/useCurrentImage';
import { useVtkInteractorStyle } from '@/src/core/vtk/useVtkInteractorStyle';
import { LPSAxisDir } from '@/src/types/lps';
import { useResizeObserver, watchImmediate } from '@vueuse/core';
import { watchImmediate } from '@vueuse/core';
import { resetCameraToImage, resizeToFitImage } from '@/src/utils/camera';
import { usePersistCameraConfig } from '@/src/composables/usePersistCameraConfig';
import { useAutoFitState } from '@/src/composables/useAutoFitState';
Expand Down Expand Up @@ -104,7 +105,8 @@ function autoFitImage() {
});
}

useResizeObserver(vtkContainerRef, () => {
// Fit on the view's own resize, so the render that follows shows the fit.
onVTKEvent(view.renderWindowView, 'onWindowResizeEvent', () => {
if (disableCameraAutoReset.value) return;
autoFitImage();
});
Expand Down
37 changes: 18 additions & 19 deletions src/components/vtk/__tests__/VtkSliceView.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ beforeEach(() => setActivePinia(createPinia()));
enableAutoUnmount(afterEach);
afterEach(async () => {
vi.restoreAllMocks();
vi.unstubAllGlobals();
views.splice(0).forEach((view) => {
view.interactor.delete();
view.renderer.delete();
Expand All @@ -38,12 +37,19 @@ function create() {
useImageCacheStore().addVTKImageData(image, 'Volume', { id: 'image' });
const metadata = { name: 'Volume', ...metadataFromVtkImageData(image) };
const renderer = vtkRenderer.newInstance();
let resizeView = () => {};
const view = {
renderer,
imageRenderer: renderer,
interactor: vtkRenderWindowInteractor.newInstance(),
requestRender: vi.fn(),
renderWindowView: { getSize: () => [400, 400] },
renderWindowView: {
getSize: () => [400, 400],
onWindowResizeEvent: (callback: () => void) => {
resizeView = callback;
return { unsubscribe: () => undefined };
},
},
} as unknown as View;
views.push(view);
vi.spyOn(vtkViews, 'useVtkView').mockReturnValue(view);
Expand All @@ -58,7 +64,14 @@ function create() {
},
});
const camera = renderer.getActiveCamera();
return { wrapper, camera, metadata, cameras: useViewCameraStore(), viewId };
return {
wrapper,
camera,
metadata,
cameras: useViewCameraStore(),
viewId,
resizeView: () => resizeView(),
};
}

it.each([false, true])(
Expand Down Expand Up @@ -117,20 +130,7 @@ it.each([
])(
'preserves resize-to-fit after $name wheel input only when zoom is not handled',
async ({ modifiers, zoomOnScroll, fits }) => {
let resize: (() => void) | undefined;
vi.stubGlobal(
'ResizeObserver',
class implements ResizeObserver {
constructor(callback: ResizeObserverCallback) {
resize = () => callback([], this);
}

observe = () => undefined;
unobserve = () => undefined;
disconnect = () => undefined;
}
);
const { wrapper, camera } = create();
const { wrapper, camera, resizeView } = create();
await wrapper.setProps({ zoomOnScroll });
const before = camera.getParallelScale();
await wrapper.get('.view').trigger('wheel', {
Expand All @@ -140,8 +140,7 @@ it.each([
vi.spyOn(views.at(-1)!.renderWindowView, 'getSize').mockReturnValue([
100, 400,
]);
expect(resize).toBeDefined();
resize!();
resizeView();
if (fits) expect(camera.getParallelScale()).not.toBe(before);
else expect(camera.getParallelScale()).toBe(before);
}
Expand Down
61 changes: 49 additions & 12 deletions src/core/vtk/__tests__/useVtkView.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import vtkRenderWindow from '@kitware/vtk.js/Rendering/Core/RenderWindow';
import vtkOpenGLRenderWindow from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow';
import { VtkRenderWindowParentContext } from '@/src/components/vtk/context';
import { VtkRenderWindowParentApi } from '@/src/types/vtk-types';
import { View } from '@/src/core/vtk/types';
import { useVtkView, useWebGLRenderWindow } from '@/src/core/vtk/useVtkView';

function createParent() {
Expand Down Expand Up @@ -54,7 +55,17 @@ function mountViewUnder(parent: VtkRenderWindowParentApi) {
});
}

describe('useVtkView teardown', () => {
// Each render draws the view's widgets first, which modifies the widget manager.
function countRenders(view: View, duringRender = () => {}) {
let count = 0;
const sub = view.widgetManager.onModified(() => {
count++;
duringRender();
});
return { count: () => count, stop: () => sub?.unsubscribe() };
}

describe('useVtkView', () => {
beforeEach(() => {
vi.useFakeTimers();
});
Expand All @@ -68,14 +79,7 @@ describe('useVtkView teardown', () => {
(state) => {
const scope = effectScope(true);
const view = scope.run(() => useVtkView(ref(null)))!;
// With no container, the interactor emits render events without drawing.
const events: string[] = [];
const rendered = view.interactor.onRenderEvent(() =>
events.push('render')
);
const widgetsModified = view.widgetManager.onModified(() =>
events.push('widgets')
);
const renders = countRenders(view);

try {
view.requestRender();
Expand Down Expand Up @@ -104,10 +108,9 @@ describe('useVtkView teardown', () => {

vi.runAllTimers();

expect(events).toEqual(state === 'live' ? ['widgets', 'render'] : []);
expect(renders.count()).toBe(state === 'live' ? 1 : 0);
} finally {
rendered.unsubscribe();
widgetsModified?.unsubscribe();
renders.stop();
scope.stop();
// A throwing scope cleanup does not resume on a second stop().
[
Expand All @@ -122,6 +125,40 @@ describe('useVtkView teardown', () => {
}
);

it('renders once per frame, however many renders vtk and the app ask for', () => {
const scope = effectScope(true);
const view = scope.run(() => useVtkView(ref(null)))!;
const renders = countRenders(view);

try {
view.requestRender();
view.renderWindow.render();
view.interactor.render();
expect(renders.count()).toBe(0);

vi.runAllTimers();

expect(renders.count()).toBe(1);
} finally {
scope.stop();
}
});

it('does not render again for a request made while rendering', () => {
const scope = effectScope(true);
const view = scope.run(() => useVtkView(ref(null)))!;
const renders = countRenders(view, () => view.requestRender());

try {
view.requestRender();
vi.runAllTimers();

expect(renders.count()).toBe(1);
} finally {
scope.stop();
}
});

it('queues no render work once the view scope is disposed', () => {
const container = document.createElement('div');
const scope = effectScope(true);
Expand Down
4 changes: 2 additions & 2 deletions src/core/vtk/useOrientationMarker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ function extendMarker(publicAPI: any, model: any, initialValues = {}) {
const viewport = model.enabled && publicAPI.computeViewport();
return !!viewport && publicAPI.getRenderer().setViewport(...viewport);
};
// The stock widget renders the whole view on every canvas resize, though the
// view renders after resizing anyway.
// The stock widget requests a render on every canvas resize, though the view
// renders after resizing anyway.
publicAPI.updateViewport = () => {
if (publicAPI.fitViewport()) model._interactor.render();
};
Expand Down
61 changes: 42 additions & 19 deletions src/core/vtk/useVtkView.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,15 @@ import { Maybe } from '@/src/types';
import { VtkRenderWindowParentApi } from '@/src/types/vtk-types';
import { releaseOpenGLRenderWindow } from '@/src/core/vtk/releaseRenderWindow';
import { deleteInteractor } from '@/src/core/vtk/deleteInteractor';
import { batchForNextTask } from '@/src/utils/batchForNextTask';
import { batchAfterNextFrame } from '@/src/utils/batchAfterNextFrame';
import vtkRenderWindow from '@kitware/vtk.js/Rendering/Core/RenderWindow';
import vtkRenderWindowInteractor from '@kitware/vtk.js/Rendering/Core/RenderWindowInteractor';
import vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
import vtkRenderWindowInteractor from '@kitware/vtk.js/Rendering/Core/RenderWindowInteractor';
import vtkOpenGLRenderWindow from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow';
import vtkWidgetManager from '@kitware/vtk.js/Widgets/Core/WidgetManager';
import type { Bounds } from '@kitware/vtk.js/types';
import { useElementSize } from '@vueuse/core';
import {
inject,
MaybeRef,
onScopeDispose,
unref,
watch,
watchPostEffect,
} from 'vue';
import { useResizeObserver } from '@vueuse/core';
import { inject, MaybeRef, onScopeDispose, unref, watchPostEffect } from 'vue';

export function useWebGLRenderWindow(
renderWindow: vtkRenderWindow,
Expand Down Expand Up @@ -133,7 +126,10 @@ export function useVtkView(
);

// interactor
const interactor = vtkRenderWindowInteractor.newInstance();
const interactor = vtkRenderWindowInteractor.newInstance({
// The view decides when to draw, so vtk's renders only emit RenderEvent.
enableRender: false,
});
renderWindow.setInteractor(interactor);
interactor.setView(renderWindowView);

Expand All @@ -152,14 +148,35 @@ export function useVtkView(
const widgetManager = useWidgetManager(renderer);

// render API
// vtk modifies what it draws while drawing it, which needs no second render.
let rendering = false;
const whileRendering = (draw: () => void) => {
rendering = true;
try {
draw();
} finally {
rendering = false;
}
};
const drawPasses = () => {
// the interactor is enabled once it has a container to draw into
if (interactor.getEnabled()) renderWindowView.traverseAllPasses();
};

let hasArea = false;
const render = () => {
// don't need to re-render during animation
// animation frames draw as vtk asks for them
if (interactor.isAnimating()) return;
widgetManager.renderWidgets();
renderWindow.render();
// A container without area shows nothing, and gaining area renders.
if (unref(container) && !hasArea) return;
whileRendering(() => {
widgetManager.renderWidgets();
renderWindow.preRender();
drawPasses();
});
};

const deferredRender = batchForNextTask(() => {
const deferredRender = batchAfterNextFrame(() => {
// Cleanup can throw before the queued render is cancelled.
if (disposed) return;
render();
Expand All @@ -168,7 +185,7 @@ export function useVtkView(
// requests outlive the view: vtk event handlers and promises that settle
// after dispose has deleted the scene graph nodes a render would traverse
const requestRender = ({ immediate } = { immediate: false }) => {
if (disposed) return;
if (disposed || rendering) return;
if (!immediate) {
deferredRender();
return;
Expand All @@ -178,6 +195,10 @@ export function useVtkView(
render();
};

onVTKEvent(interactor, 'onRenderEvent', () => {
if (interactor.isAnimating()) whileRendering(drawPasses);
else requestRender();
});
onVTKEvent(renderer, 'onModified', () => {
requestRender();
});
Expand All @@ -202,8 +223,10 @@ export function useVtkView(
requestRender({ immediate: true });
};

const { width, height } = useElementSize(container);
watch([width, height], ([w, h]) => setSize(w, h), { immediate: true });
useResizeObserver(container, ([{ contentRect }]) => {
hasArea = contentRect.width > 0 && contentRect.height > 0;
setSize(contentRect.width, contentRect.height);
});

// cleanup
onScopeDispose(() => {
Expand Down
28 changes: 28 additions & 0 deletions src/utils/batchAfterNextFrame.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/**
* Batches calls into one invocation per animation frame, run in a task after
* the frame so queued input is handled first.
*/
export function batchAfterNextFrame(fn: () => void) {
let frame: number | null = null;
let task: ReturnType<typeof setTimeout> | null = null;

const wrapper = () => {
if (frame != null || task != null) return;
frame = requestAnimationFrame(() => {
frame = null;
task = setTimeout(() => {
task = null;
fn();
}, 0);
});
};

wrapper.cancel = () => {
if (frame != null) cancelAnimationFrame(frame);
if (task != null) clearTimeout(task);
frame = null;
task = null;
};

return wrapper;
}
Loading