Skip to content

fix(FullScreenRenderWindow): add warning that this class is for examples only #3369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
daker wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(FullScreenRenderWindow): add warning that this class is for examples only #3369

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 0 deletions Sources/Rendering/Misc/FullScreenRenderWindow/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import 'vtk.js/Sources/Rendering/Core/Actor';
import 'vtk.js/Sources/Rendering/Core/Mapper';
import 'vtk.js/Sources/Rendering/Misc/RenderingAPIs';

const { vtkWarningMacro } = macro;

// Process arguments from URL
const userParams = vtkURLExtract.extractURLParameters();

Expand Down Expand Up @@ -221,6 +223,10 @@ export function extend(publicAPI, model, initialValues = {}) {
'controlContainer',
]);

vtkWarningMacro(
Copy link
Member

@finetjul finetjul Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't really prevent (i.e. bother with a warning message) anyone from using FullScreenRenderWindow.

We could think of conditionally testing if hostname is not "localhost" to decide to print a message.

An alternative is to simply document the class that resizing is not possible.

'The vtkFullScreenRenderWindow class is intended only for example development. Please use vtkGenericRenderWindow instead.'
);

// Object specific methods
vtkFullScreenRenderWindow(publicAPI, model);
}
Expand Down