fix(handleWheel): mouse scrolling behavior for out-of-focus windows

[jadh4v]

Brief Description

When rebinding events with a different container, make sure all timeouts and state variables from previous container are cleared.

This PR is part of a react-vtk-js fix for out-of-focus wheel events (Kitware/react-vtk-js#125)

Context

Results

Changes

• Documentation and TypeScript definitions were updated to match those changes

PR and Code Checklist

• semantic-release commit messages
• Run npm run reformat to have correctly formatted code

Testing

• This change adds or fixes unit tests
• Tested environment:
  • vtk.js: latest master
  • OS: Windows 11, macOS Sonoma
  • Browser: Chrome 120

[finetjul]

While that works, I find the logic quite convoluted.
How about the following:

unbindEvents() {
  ...
  // Kept for backward compatibility purpose
  publicAPI.setContainer(null);
}
setContainer(newContainer) {
  if (newContainer === model.container) {
     return false;
  }
  unbindEvents();
  model.container = newContainer;
  bindEvents();
  return true;
}

// container parameter is for backward compatibility purpose
bindEvents(container = model.container){
  if (model.container != container) {
    setContainer(container)
    return;
  }
  ...
}
...
publicAPI.delete(
  ...
  setContainer(null);
}

And to not forget about modified() and _onContainerChanged() (see macro.js::findSetter(),

setContainer(newContainer) {
  if (newContainer === model.container) {
     return false;
  }
  unbindEvents();
  const res = superclass.setContainer(newContainer);
  bindEvents(model.container);
  return res;
}
...
macro.setGet(...[container]);

[jadh4v]

Oh yes, thanks for reminding about onChanged and modified.

I don't agree on the new call tree you suggested. It is more complex to my eyes. Specially since setContainer() calls both bindEvents and unbindEvents and then bind\unbindEvents again call setContainer. It makes the code hard to read since there is a possible circular call which can only be disentangled through reasoning about the values of arguments/variables.

[finetjul]

LGTM

[floryst]

One last change needed: the getContainer() type needs to be updated to be getContainer(): Nullable<HTMLElement>. You can also update the setContainer type to use Nullable for consistency.

[floryst]

LGTM

[github-actions]

🎉 This PR is included in version 29.4.5 🎉

The release is available on:

• npm package (@latest dist-tag)
• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀