Add options to customize "MatchOutsideMap" behavior #2141

JoaoBaptMG · 2019-06-15T21:19:18Z

I decided to edit Tiled's source code after viewing this discussion about the behavior of automapping near the map's edges and I was not satified with the state of the art of automapping near the borders.

Normally, when you try to automap near the edges, the edges are seen as empty tiles, failing to apply, for example, Remex's auto-generated rules (the ones originated from RPG Maker):

This pull request add two options (as map properties) to customize the behavior of automapping near the edges.

OverflowBorder: this option makes the automapper treats the out-of-bounds areas of the map as if they were prolongations of the border tiles, thus applying the rules along the borders as if they used the same tiles as the nearest inbound tile. This is actually the default behavior of every RPG Maker since XP.
WrapBorder: this option makes the automapper wrap the map around the edges, effectively applying the rules also to the other side of the border; this can be useful to create looped maps, to make it seamless around the borders:

I coded those two features so that if both OverflowBorder and WrapBorder are true, WrapBorder takes precedence. And, of course, it will not work with infinite maps, since the notion of "border" in them has no sense.

…ideMap" behavior

bjorn

Thank you so much for this improvement! I think it will indeed help a lot dealing with these "edge cases".

I've left some inline comments. In addition, I wondered about the following:

Would it make sense to have the OverflowBorder and WrapBorder options imply MatchOutsideMap = true? It feels superfluous to require the user to specify both.
Maybe instead of passing in whether the map is infinite, we can make sure these options are never enabled for infinite maps.

bjorn · 2019-06-15T22:35:07Z

src/tiled/automapper.cpp

+                            xd = setLayer.size().width() - 1;
+                        if (yd < 0) yd = 0;
+                        else if (yd >= setLayer.size().height())
+                            yd = setLayer.size().height() - 1;


Please shorten this to:

xd = qBound(0, xd, setLayer.width() - 1); yd = qBound(0, yd, setLayer.height() - 1);

Thanks! I have never written a line of Qt code before, so I didn't know of that function. That could be very useful, indeed!

bjorn · 2019-06-15T22:35:58Z

src/tiled/automapper.cpp

+                if (!isMapInfinite) {
+                    if (options.wrapBorder) {
+                        int width = setLayer.size().width();
+                        int height = setLayer.size().height();


Please use setLayer.width() and setLayer.height(). :-)

src/tiled/automapper.cpp

JoaoBaptMG · 2019-06-15T22:56:02Z

* Would it make sense to have the OverflowBorder and WrapBorder options imply MatchOutsideMap = true? It feels superfluous to require the user to specify both.

I will incorporate this into my code as such, but I think it might be useful if the user disables MatchOutsideMap but forgets to do so with OverflowBorder/WrapBorder (well, that doesn't make any sense, but I guess it's a possible scenario?)

* Maybe instead of passing in whether the map is infinite, we can make sure these options are never enabled for infinite maps.

That could also be possible, and will remove excessive parameter passing.

JoaoBaptMG

I incorporated the changes you requested, so I guess it's a bit more "canonical" now. I hope those features are useful to solve the automapping quirks I pointed out.

src/tiled/automapper.cpp

bjorn

Looking good, I just had one additional request. :-)

bjorn · 2019-06-16T13:49:24Z

src/tiled/automapper.cpp

@@ -42,6 +42,11 @@

 using namespace Tiled;

+// Should i leave this function here?
+inline int wrap(int value, int bound) {


The location is fine for now, but please define the function static and put the { on the next line.

inline static or static inline? I know there's no difference, but maybe there is a convention in Tiled's code?

Actually I doubt there is any precedence here since I don't really see the point of defining a function both inline and static.

I actually only use inline when I need to use it. That is, to avoid multiple-definition problems for function definitions in header files that are outside class definitions. In any other case it's at best a hint that the compiler is free to ignore (and probably will, it'll inline only when it thinks it's a good idea anyway).

The static however is appropriate here, since we don't intend the function to be used from another translation unit. Defining it as static makes it inaccessible outside of its translation unit.

Actually I doubt there is any precedence here since I don't really see the point of defining a function both inline and static.

Maybe I should search the code before raising doubts. So, there's precedence for both inline static and static inline, with the latter a clear winner. However, of 9 total occurrences, 8 were inherited from 3rd party code. The one remaining one, I'm probably going to change to just static soon. :P

Not a problem, I will leave it just as static. Commiting the code again.

src/tiled/automapper.cpp

JoaoBaptMG

Done all changes needed to the code!

JoaoBaptMG

Removed the inline, since probably the compiler will not complain about its abscence (and maybe it would inline the code with optimizations anyway).

src/tiled/automapper.cpp

bjorn · 2019-06-20T07:42:19Z

@JoaoBaptMG Thanks again for this great improvement!

Would you like to have a go at updating the documentation for these attributes as well?

JoaoBaptMG · 2019-06-20T07:49:43Z

Yeah, I can do that. However, since the PR is already merged, should I open another PR for it or can I commit it to my fork?

bjorn · 2019-06-20T08:31:17Z

@JoaoBaptMG Yes, just open a new PR! :-)

the-simian · 2019-06-20T19:24:44Z

I'm late to the party here, but let me say this is awesome as can be, and I am so happy to see this work @JoaoBaptMG , @bjorn

So very cool! WhenI work on my project create-phaser-app I will include this change and make that how the levels work

JoaoBaptMG added 2 commits June 15, 2019 22:56

Add options "OverflowBorder" and "WrapBorder" to customize "MatchOuts…

9fcbc6e

…ideMap" behavior

Add forgotten check for infinite map in order not to produce bugs

1579d7b

bjorn requested changes Jun 15, 2019

View reviewed changes

Incorporate changes requested by bjorn on the pull request

4f0898f

JoaoBaptMG commented Jun 15, 2019

View reviewed changes

src/tiled/automapper.cpp Show resolved Hide resolved

src/tiled/automapper.cpp Show resolved Hide resolved

src/tiled/automapper.cpp Show resolved Hide resolved

JoaoBaptMG commented Jun 15, 2019

View reviewed changes

src/tiled/automapper.cpp Show resolved Hide resolved

bjorn requested changes Jun 16, 2019

View reviewed changes

Turned 'wrap' method static

9e4fb2d

JoaoBaptMG commented Jun 16, 2019

View reviewed changes

src/tiled/automapper.cpp Show resolved Hide resolved

JoaoBaptMG commented Jun 16, 2019

View reviewed changes

Turned 'wrap' function static

6441892

JoaoBaptMG commented Jun 16, 2019

View reviewed changes

src/tiled/automapper.cpp Show resolved Hide resolved

bjorn approved these changes Jun 17, 2019

View reviewed changes

Tweaks

c96a745

bjorn merged commit 063fe88 into mapeditor:master Jun 20, 2019

This was referenced Jun 20, 2019

Change documentation on automapping to reflect the newly-added properties #2143

Closed

Change documentation to reflect the addition of new features #2144

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add options to customize "MatchOutsideMap" behavior #2141

Add options to customize "MatchOutsideMap" behavior #2141

JoaoBaptMG commented Jun 15, 2019

bjorn left a comment

bjorn Jun 15, 2019

JoaoBaptMG Jun 15, 2019

bjorn Jun 15, 2019

JoaoBaptMG commented Jun 15, 2019

JoaoBaptMG left a comment •

edited

bjorn left a comment

bjorn Jun 16, 2019

JoaoBaptMG Jun 16, 2019

bjorn Jun 16, 2019

bjorn Jun 16, 2019

JoaoBaptMG Jun 16, 2019

JoaoBaptMG left a comment

JoaoBaptMG left a comment

bjorn commented Jun 20, 2019

JoaoBaptMG commented Jun 20, 2019

bjorn commented Jun 20, 2019

the-simian commented Jun 20, 2019

Add options to customize "MatchOutsideMap" behavior #2141

Add options to customize "MatchOutsideMap" behavior #2141

Conversation

JoaoBaptMG commented Jun 15, 2019

bjorn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoaoBaptMG commented Jun 15, 2019

JoaoBaptMG left a comment • edited

Choose a reason for hiding this comment

bjorn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoaoBaptMG left a comment

Choose a reason for hiding this comment

JoaoBaptMG left a comment

Choose a reason for hiding this comment

bjorn commented Jun 20, 2019

JoaoBaptMG commented Jun 20, 2019

bjorn commented Jun 20, 2019

the-simian commented Jun 20, 2019

JoaoBaptMG left a comment •

edited