Skip to content

Merge latest 1.17 fixes into develop #5531

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

Merged
kwvanderlinde merged 3 commits into from
Jun 4, 2025
Merged

Merge latest 1.17 fixes into develop #5531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1f9790
Update Path tests with mocked GridCapabilities
kwvanderlinde May 26, 2025
1712b3e
Also include grid capabilities when checking for STG tokens
kwvanderlinde May 26, 2025
91ef718
Merge pull request #5504 from kwvanderlinde/bugfix/5494-ClassCastExce…
cwisniew May 26, 2025
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
12 changes: 8 additions & 4 deletions src/main/java/net/rptools/maptool/model/Path.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,24 +98,28 @@ public List<T> getWayPointList() {

/** Create a related path that can be applied to a follower token. */
public Path<?> derive(Grid grid, Token keyToken, Token followerToken) {
if (keyToken.isSnapToGrid() && followerToken.isSnapToGrid()) {
final var gridSupportsStg = grid.getCapabilities().isSnapToGridSupported();
final var keyIsStg = keyToken.isSnapToGrid() && gridSupportsStg;
final var followerIsStg = followerToken.isSnapToGrid() && gridSupportsStg;

if (keyIsStg && followerIsStg) {
// Assume T = CellPoint.
var originCell = grid.convert(new ZonePoint(keyToken.getX(), keyToken.getY()));
var tokenCell = grid.convert(new ZonePoint(followerToken.getX(), followerToken.getY()));
return deriveSameSnapToGrid(this, originCell.x - tokenCell.x, originCell.y - tokenCell.y);
} else if (!keyToken.isSnapToGrid() && !followerToken.isSnapToGrid()) {
} else if (!keyIsStg && !followerIsStg) {
// Assume T = ZonePoint.
var originPoint = new ZonePoint(keyToken.getX(), keyToken.getY());
var tokenPoint = new ZonePoint(followerToken.getX(), followerToken.getY());
return deriveSameSnapToGrid(this, originPoint.x - tokenPoint.x, originPoint.y - tokenPoint.y);
} else if (keyToken.isSnapToGrid()) {
} else if (keyIsStg) { // && !followerIsStg
// Assume T = CellPoint.
return deriveFromSnapToGrid(
(Path<CellPoint>) this,
grid,
keyToken.getX() - followerToken.getX(),
keyToken.getY() - followerToken.getY());
} else /* (!keyToken.isSnapToGrid) */ {
} else /* (!keyIsStg && followerIsStg) */ {
// Assume T = ZonePoint.
return deriveFromNotSnapToGrid(
(Path<ZonePoint>) this,
Expand Down
99 changes: 92 additions & 7 deletions src/test/java/net/rptools/maptool/model/PathTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import static org.mockito.Mockito.*;

import java.util.List;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -328,10 +329,27 @@ public void testDtoCellPoint() {

@Nested
class DerivedPathTests {
private Grid grid;

@BeforeEach
public void setUp() {
var gridCapabilities = mock(GridCapabilities.class);
when(gridCapabilities.isSnapToGridSupported()).thenReturn(true);
when(gridCapabilities.isPathingSupported()).thenReturn(true);
when(gridCapabilities.isPathLineSupported()).thenReturn(true);
when(gridCapabilities.isSecondDimensionAdjustmentSupported()).thenReturn(false);
when(gridCapabilities.isCoordinatesSupported()).thenReturn(true);

grid = mock(Grid.class);
when(grid.getCapabilities()).thenReturn(gridCapabilities);
}

@Test
@DisplayName(
"Test that a non-snap-to-grid follower path is properly derived from a non-snap-to-grid leader path")
public void testDeriveNonStgFollowingNonStg() {
when(grid.getCapabilities().isSnapToGridSupported()).thenReturn(true);

var path = new Path<ZonePoint>();
path.appendWaypoint(new ZonePoint(52, 427));
path.appendPartialPath(
Expand All @@ -342,7 +360,7 @@ public void testDeriveNonStgFollowingNonStg() {
new ZonePoint(429, 65)));
path.appendPartialPath(
List.of(new ZonePoint(502, -91), new ZonePoint(628, -171), new ZonePoint(756, -272)));
var grid = mock(Grid.class);

var leaderToken = mock(Token.class);
when(leaderToken.isSnapToGrid()).thenReturn(false);
// Position agrees with start of path.
Expand Down Expand Up @@ -384,14 +402,16 @@ public void testDeriveNonStgFollowingNonStg() {
@DisplayName(
"Test that a snap-to-grid follower path is properly derived from a snap-to-grid leader path")
public void testDeriveStgFollowingStg() {
when(grid.getCapabilities().isSnapToGridSupported()).thenReturn(true);

var path = new Path<CellPoint>();
path.appendWaypoint(new CellPoint(0, 4));
path.appendPartialPath(
List.of(
new CellPoint(1, 3), new CellPoint(2, 2), new CellPoint(3, 1), new CellPoint(4, 0)));
path.appendPartialPath(
List.of(new CellPoint(5, -1), new CellPoint(6, -2), new CellPoint(7, -3)));
var grid = mock(Grid.class);

when(grid.convert(new ZonePoint(52, 427))).thenReturn(new CellPoint(0, 4));
when(grid.convert(new ZonePoint(1012, 1184))).thenReturn(new CellPoint(10, 11));

Expand Down Expand Up @@ -435,15 +455,18 @@ public void testDeriveStgFollowingStg() {
@Test
@DisplayName(
"Test that a non-snap-to-grid follower path is properly derived from a snap-to-grid leader path")
public void testDeriveNonStgFollowingStg() {
public void testDeriveNonStgFollowingStgOnStgGrid() {
when(grid.getCapabilities().isSnapToGridSupported()).thenReturn(true);

var path = new Path<CellPoint>();
path.appendWaypoint(new CellPoint(0, 4));
path.appendPartialPath(
List.of(
new CellPoint(1, 3), new CellPoint(2, 2), new CellPoint(3, 1), new CellPoint(4, 0)));
path.appendPartialPath(
List.of(new CellPoint(5, -1), new CellPoint(6, -2), new CellPoint(7, -3)));
var grid = mock(Grid.class);

when(grid.convert(new CellPoint(0, 0))).thenReturn(new ZonePoint(50, 50));
when(grid.convert(new CellPoint(0, 4))).thenReturn(new ZonePoint(0, 400));
when(grid.convert(new CellPoint(1, 3))).thenReturn(new ZonePoint(100, 300));
when(grid.convert(new CellPoint(2, 2))).thenReturn(new ZonePoint(200, 200));
Expand All @@ -452,6 +475,7 @@ public void testDeriveNonStgFollowingStg() {
when(grid.convert(new CellPoint(5, -1))).thenReturn(new ZonePoint(500, -100));
when(grid.convert(new CellPoint(6, -2))).thenReturn(new ZonePoint(600, -200));
when(grid.convert(new CellPoint(7, -3))).thenReturn(new ZonePoint(700, -300));

var leaderToken = mock(Token.class);
when(leaderToken.isSnapToGrid()).thenReturn(true);
// Position agrees with start of path.
Expand Down Expand Up @@ -480,10 +504,66 @@ public void testDeriveNonStgFollowingStg() {
}
}

@Test
@DisplayName(
"Test that a non-snap-to-grid follower path is properly derived from a snap-to-grid leader path when the grid does not support snap to grid")
public void testDeriveNonStgFollowingStgOnNonStgGrid() {
when(grid.getCapabilities().isSnapToGridSupported()).thenReturn(false);

var path = new Path<ZonePoint>();
path.appendWaypoint(new ZonePoint(52, 427));
path.appendPartialPath(
List.of(
new ZonePoint(116, 364),
new ZonePoint(231, 290),
new ZonePoint(342, 172),
new ZonePoint(429, 65)));
path.appendPartialPath(
List.of(new ZonePoint(502, -91), new ZonePoint(628, -171), new ZonePoint(756, -272)));

var leaderToken = mock(Token.class);
when(leaderToken.isSnapToGrid()).thenReturn(true);
// Position agrees with start of path.
when(leaderToken.getX()).thenReturn(52);
when(leaderToken.getY()).thenReturn(427);
var followerToken = mock(Token.class);
when(followerToken.isSnapToGrid()).thenReturn(false);
// Offset a bit from the leader.
when(followerToken.getX()).thenReturn(1012);
when(followerToken.getY()).thenReturn(1184);

var derived = path.derive(grid, leaderToken, followerToken);

// All points are used, even though in practice non-STG tokens only have waypoints.
var expectedCellPoints =
List.of(
new ZonePoint(1012, 1184),
new ZonePoint(1076, 1121),
new ZonePoint(1191, 1047),
new ZonePoint(1302, 929),
new ZonePoint(1389, 822),
new ZonePoint(1462, 666),
new ZonePoint(1588, 586),
new ZonePoint(1716, 485));
assertIterableEquals(expectedCellPoints, derived.getCellPath());
var expectedWaypoints =
List.of(new ZonePoint(1012, 1184), new ZonePoint(1389, 822), new ZonePoint(1716, 485));
assertIterableEquals(expectedWaypoints, derived.getWayPointList());

for (var cell : derived.getCellPath()) {
assertInstanceOf(ZonePoint.class, cell);
}
for (var waypoint : derived.getWayPointList()) {
assertInstanceOf(ZonePoint.class, waypoint);
}
}

@Test
@DisplayName(
"Test that a snap-to-grid follower path is properly derived from a non-snap-to-grid leader path")
public void testDeriveStgFollowingNonStg() {
when(grid.getCapabilities().isSnapToGridSupported()).thenReturn(true);

var path = new Path<ZonePoint>();
path.appendWaypoint(new ZonePoint(52, 427));
path.appendPartialPath(
Expand All @@ -494,10 +574,11 @@ public void testDeriveStgFollowingNonStg() {
new ZonePoint(429, 65)));
path.appendPartialPath(
List.of(new ZonePoint(502, -91), new ZonePoint(628, -171), new ZonePoint(756, -272)));
var grid = mock(Grid.class);

when(grid.convert(new ZonePoint(1012, 1184))).thenReturn(new CellPoint(10, 11));
when(grid.convert(new ZonePoint(1389, 822))).thenReturn(new CellPoint(13, 8));
when(grid.convert(new ZonePoint(1716, 485))).thenReturn(new CellPoint(17, 4));

var leaderToken = mock(Token.class);
when(leaderToken.isSnapToGrid()).thenReturn(false);
// Position agrees with start of path.
Expand Down Expand Up @@ -539,11 +620,13 @@ public void testDeriveStgFollowingNonStg() {
@DisplayName(
"Test that a snap-to-grid follower path is properly derived from a non-snap-to-grid leader path using the naive walk")
public void testDeriveStgFollowingNonStgWithDifferentSlope() {
when(grid.getCapabilities().isSnapToGridSupported()).thenReturn(true);

var path = new Path<ZonePoint>();
path.appendWaypoint(new ZonePoint(52, 427));
path.appendWaypoint(new ZonePoint(889, 838));
path.appendWaypoint(new ZonePoint(445, -238));
var grid = mock(Grid.class);

when(grid.convert(new ZonePoint(1012, 1184))).thenReturn(new CellPoint(10, 11));
when(grid.convert(new ZonePoint(1849, 1595))).thenReturn(new CellPoint(18, 15));
when(grid.convert(new ZonePoint(1405, 519))).thenReturn(new CellPoint(14, 5));
Expand Down Expand Up @@ -603,6 +686,8 @@ public void testStgPathCrossingItself() {
// position was a waypoint. So a path that crosses itself could be given many more waypoints
// than were actually set. We don't do that anymore, and this test ensures it.

when(grid.getCapabilities().isSnapToGridSupported()).thenReturn(true);

var path = new Path<CellPoint>();
path.appendWaypoint(new CellPoint(0, 0));
path.appendPartialPath(
Expand All @@ -625,8 +710,8 @@ public void testStgPathCrossingItself() {
new CellPoint(1, -1),
// Note: this last point crosses through the first partial path.
new CellPoint(2, 0)));
var grid = mock(Grid.class);
when(grid.convert(new ZonePoint(50, 50))).thenReturn(new CellPoint(0, 0));

var leaderToken = mock(Token.class);
when(leaderToken.isSnapToGrid()).thenReturn(true);
// Position agrees with start of path.
Expand Down
Loading