Skip to content

campaign halo render order fix #5948

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
Baaaaaz wants to merge 6 commits into
base: develop
Choose a base branch
from
+61 −37
Open

campaign halo render order fix #5948

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
092325d
Fix comments, counter
Baaaaaz Mar 21, 2026
004f1c4
Reinstate correct render order for halos (reversed) and haloparts (no…
Baaaaaz Mar 21, 2026
03c4939
More comments and remove logger
Baaaaaz Mar 22, 2026
9a952f5
Another comment tweak (primarily to enable rerunning Build Verificati…
Baaaaaz Mar 23, 2026
9fd1461
Resolve flipH and flipV not flipping halos due to XOR precedence
Baaaaaz Mar 25, 2026
7f29a33
resolve feedback and correct some more typos
Baaaaaz Apr 3, 2026
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
98 changes: 61 additions & 37 deletions src/main/java/net/rptools/maptool/client/ui/zone/renderer/HaloRenderer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,11 @@ public void renderHalos(

timer.start("HaloRenderer-renderHalos:prepareToRender");
// Loop through the token's halos and first determine whether they actually need to be rendered.
// If so, get the halos associated halo parts and establish where concentrically they need to be
// rendered and store them for later as we will render these halos in reverse order.
var renderableHaloParts = new ArrayList<RenderablePart>();
// If so, get the halo's associated halo parts and establish where concentrically they need to
// be
// rendered and store them for later as we will render these halos in reverse order and their
// respective halo parts in order.
var renderableHalos = new ArrayList<ArrayList<RenderablePart>>();
if (!tokenHalos.isEmpty()) {
// loop through the halos attached to the token
for (GUID id : tokenHalos) {
Expand All @@ -125,7 +127,7 @@ public void renderHalos(
|| (halo.isOwnerOnly() && AppUtil.playerOwns(token))
|| (!halo.isOwnerOnly() && !halo.isGMOnly())) {

timer.increment("HaloRenderer-renderHalos:tokensWithRenderableHalos");
timer.increment("HaloRenderer-renderHalos:renderableHalos");

double haloScaleFactor;
if (halo.isScaleWithToken()) {
Expand All @@ -140,6 +142,7 @@ public void renderHalos(

// loop through the individual halo parts in each halo
var haloParts = halo.getHaloParts();
var renderableHaloParts = new ArrayList<RenderablePart>();
for (HaloPart hp : haloParts) {

/*
Expand Down Expand Up @@ -189,6 +192,7 @@ public void renderHalos(
maxHaloPartWidth,
(int) Math.ceil((width * hp.getScaleY() + hp.getOffset()) * haloScaleFactor));
}
renderableHalos.add(renderableHaloParts);

// add to the relevant max width accumulators
if (maxHaloPartWidth != 0) {
Expand All @@ -205,35 +209,38 @@ public void renderHalos(
}
timer.stop("HaloRenderer-renderHalos:prepareToRender");

// Render the halos in reverse order, but their respective halos in order. This is so
// any filled outer-concentric halos do not graffiti over inner-concentric halos.
// Render the halos in reverse order but their respective halo parts in order. This is so
// any filled outer-concentric halos do not graffiti over inner-concentric halos and also
// halo parts are rendered in the order in which they are written in the halo syntax.
timer.start("HaloRenderer-renderHalos:orderedRendering");
for (var renderableHalo : renderableHaloParts.reversed()) {
var halo = renderableHalo.halo();
for (var renderableHaloParts : renderableHalos.reversed()) {
for (var renderableHaloPart : renderableHaloParts) {
var halo = renderableHaloPart.halo();

int offsetConcentricByInner;
if (halo.isInner() || renderableInnerHaloMaxWidth <= 0) {
offsetConcentricByInner = 0;
} else {
offsetConcentricByInner = 2 * (renderableInnerHaloMaxWidth + haloLineWidthPreference);
}

int offsetConcentricByInner;
if (halo.isInner() || renderableInnerHaloMaxWidth <= 0) {
offsetConcentricByInner = 0;
} else {
offsetConcentricByInner = 2 * (renderableInnerHaloMaxWidth + haloLineWidthPreference);
renderHaloPart(
g2d,
token,
position,
grid,
renderableHaloPart.part(),
renderableHaloPart.shapeType(),
renderableHaloPart.lineWidth(),
renderableHaloPart.facingAngle(),
renderableHaloPart.scaleFactor(),
renderableHaloPart.concentricOffset() + offsetConcentricByInner,
halo.isFlipWithToken());
}

renderHaloPart(
g2d,
token,
position,
grid,
renderableHalo.part(),
renderableHalo.shapeType(),
renderableHalo.lineWidth(),
renderableHalo.facingAngle(),
renderableHalo.scaleFactor(),
renderableHalo.concentricOffset() + offsetConcentricByInner,
halo.isFlipWithToken());
}
timer.stop("HaloRenderer-renderHalos:orderedRendering");

// finally, render any legacy halo in the innermost position
// finally, render any legacy halo in the outermost position
if (token.getHaloColor() != null) {
timer.start("HaloRenderer-renderHalos:renderSimpleHalo");
DrawableColorPaint dcp = new DrawableColorPaint(token.getHaloColor());
Expand Down Expand Up @@ -293,6 +300,10 @@ public void renderHalos(
* @param position the token's position
* @param grid the map's grid
* @param haloPart the haloPart itself
* @param haloShapeType the halo shape type
* @param lineWidth the halo line width
* @param haloFacingAngle the halo facing angle
* @param haloScaleFactor the halo scale factor
* @param concentricOffset the distance to offset the next haloPart
* @param flipWithToken {@code true} if the halo should be flipped as the token is flipped.
*/
Expand Down Expand Up @@ -415,8 +426,8 @@ private AffineTransform getHaloGeometricTransform(
double translateX = position.transformedBounds().getBounds2D().getCenterX();
double translateY = position.transformedBounds().getBounds2D().getCenterY();

boolean flipH = flipWithToken && position.token().isFlippedX() ^ haloPart.getFlipHorizontal();
boolean flipV = flipWithToken && position.token().isFlippedY() ^ haloPart.getFlipVertical();
boolean flipH = (flipWithToken && position.token().isFlippedX()) ^ haloPart.getFlipHorizontal();
boolean flipV = (flipWithToken && position.token().isFlippedY()) ^ haloPart.getFlipVertical();

double rotate;
boolean rotateBeforeScale = false;
Expand Down Expand Up @@ -447,6 +458,19 @@ private AffineTransform getHaloGeometricTransform(
return at;
}

/**
* Build and apply all the transforms we need for basic shapes
*
* @param scaleX scale in the x dimension
* @param scaleY scale in the y dimension
* @param flipH flip horizontally
* @param flipV flip vertically
* @param rotate rotate
* @param translateX translate in the x dimension
* @param translateY translate in the x dimension
* @param rotateBeforeScale controls sequencing of scale and rotation (for isometric)
* @return the combined transforms
*/
private AffineTransform buildTransform(
double scaleX,
double scaleY,
Expand All @@ -456,14 +480,13 @@ private AffineTransform buildTransform(
double translateX,
double translateY,
boolean rotateBeforeScale) {
// build and apply all the transforms we need for basic shapes
// (*) note that transforms are applied in the reverse order to which they are added below
AffineTransform at = new AffineTransform();
// (*) the transform below this comment will be applied last
if (translateX != 0 || translateY != 0) {
at.translate(translateX, translateY);
}
// for isometric rotate before(*) scale , otherwise scale before (*) rotate
// for isometric rotate before (*) scale , otherwise scale before (*) rotate
if (rotateBeforeScale) {
if (scaleX != 0 || scaleY != 0) {
at.scale(scaleX, scaleY);
Expand Down Expand Up @@ -506,11 +529,11 @@ private Shape getUnitPolygonShape(boolean isStar, Integer vertices) {
var timer = CodeTimer.get();
timer.start("HaloRenderer-getUnitPolygonShape");

timer.increment("HaloRenderer-getUnitPolygonShape:computeIfAbsent");
double inRadius = 1 / 2d;
timer.increment("HaloRenderer-getUnitPolygonShape");
double inradius = 1 / 2d;
// a circumscribed circle passes through all polygon outer-vertices
double circumRadius = inRadius / Math.cos(Math.PI / vertices);
double radius = circumRadius;
double circumradius = inradius / Math.cos(Math.PI / vertices);
double radius = circumradius;

double orientationAngle = 0d;
// orientate regular polygons to have a flat top, otherwise a pointy top for stars
Expand Down Expand Up @@ -552,7 +575,7 @@ private Shape getUnitPolygonShape(boolean isStar, Integer vertices) {
}

/**
* Get a scaled and positioned haloPart minishape, composed of a number of miniature shapes
* Get a scaled and positioned haloPart mini-shape, composed of a number of miniature shapes
* rotated and spread equidistant around a circle.
*
* @return the polygon shape
Expand Down Expand Up @@ -800,6 +823,7 @@ private Shape getHaloFootprintShape(Token token, Grid grid, double concentricAdj
* @param grid the grid
* @param haloPart the haloPart
* @param concentricAdjustment offset from the centre
* @param haloFacingAngle the halo facing angle
* @return the grid shape, or a circle for gridless
*/
private Shape getHaloGridShape(
Expand Down Expand Up @@ -862,7 +886,7 @@ private Shape getHaloGridShape(
* @return Area as a Shape
*/
private Shape getHaloOutlineShape(Token token) {
// no concentricAdjustment for HaloPart Topolopy shapes currently...
// no concentricAdjustment for HaloPart Outline shapes currently...

var timer = CodeTimer.get();
timer.start("HaloRenderer-getHaloOutlineShape");
Expand Down
Loading