Make Scale read-only

[kwvanderlinde]

Identify the Bug or Feature request

Resolves #5849

Description of the Change

Changes the interface of Scale so its properties can no longer be modified. The fields are not final so that serialization continues to work, but they are effectively immutable. As a proper value type, Scale now has #equals(Object) and #hashCode() methods. This also means Scale is no longer reponsible for pumping events when modified, so the PropertyChangeSupport has been removed.

Scale is now the only place that defines transformations between world and screen space. It provides general AffineTransforms in both directions via #toWorldTransform() and #toScreenTransform(). Also, most conversion methods on ScreenPoint have been removed in favour of using the Scale for conversions. Those conversion methods that remain in ScreenPoint are wrappers around the ones in Scale for specific circumstances, and they all accept a simple Scale rather than an entire ZoneRenderer.

The ZoneViewModel now manages the Scale for a Zone (used to be in ZoneRenderer). This is just one more step along the road of removing dependencies on ZoneRenderer, though for now most components still look up the view model from the renderer. ZoneRenderer now longer offers methods to directly change the current Scale, though it does offer a few convenience methods that may do so among other things.

A few Scale-related improvements as well:

• The new RepaintZoneRequested event gives a way for any component to trigger a repaint via the event bus. For now only ZoneViewModel uses it when the Scale is changed, but there are plenty of other places that will benefit from this as well.
• HexGrid#getOffV(ZoneRenderer) and HexGrid#getOffU(ZoneRenderer) now accept a Scale instead of a ZoneRenderer. Similarly, HexGrid#getRendererSizeV(ZoneRenderer) and HexGrid#getRendererSizeU(ZoneRenderer) are now HexGrid#getSizeV(Dimension2D) and HexGrid#getSizeU(Dimension2D).
• DrawablePaint and DrawableNoise now accept a full Scale when getting the AWT paint. This isn't used much now, but will be more common with some upcoming rendering changes.

Possible Drawbacks

Some scaling operations are more verbose to write now, though that will improve as ZoneRenderer is pushed out of the limelight.

Documentation Notes

N/A

Release Notes

• Refactored zone scale

---

This change is 

[sentry]

Issues attributed to commits in this pull request

This pull request was merged and Sentry observed the following issues:

• ‼️ NullPointerException: Cannot invoke "net.rptools.m... in Nightly

[Baaaaaz]

Was just going to raise a bug ticket to say that MapTool-nightly-20251109 is broken, as when trying to run the win exe I get the following error:

java.lang.NullPointerException: Cannot invoke "net.rptools.maptool.client.ui.Scale.equals(Object)" because "this.lastZoneScale" is null
	at net.rptools.maptool.client.ui.zone.renderer.ZoneRenderer.renderBoard(ZoneRenderer.java:1057)
	at net.rptools.maptool.client.ui.zone.renderer.ZoneRenderer.renderZone(ZoneRenderer.java:829)
	at net.rptools.maptool.client.ui.zone.renderer.ZoneRenderer.lambda$paintComponent$2(ZoneRenderer.java:679)
	at net.rptools.lib.CodeTimer.using(CodeTimer.java:50)
	at net.rptools.maptool.client.ui.zone.renderer.ZoneRenderer.paintComponent(ZoneRenderer.java:656)
	at java.desktop/javax.swing.JComponent.paint(Unknown Source)
	at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
	at java.desktop/javax.swing.JComponent.paint(Unknown Source)
	...

[kwvanderlinde]

Whoops, I'll get this fixed up ASAP.

[kwvanderlinde]

On the plus side, I think this is the first time sentry has correctly identified the source of a problem 😅

[cwisniew]

On the plus side, I think this is the first time sentry has correctly identified the source of a problem 😅

You know what they say about broken clocks :)