MessageSpatial2D::In::wrap()

[Robadob]

Python Circles 2D wrapped example here.

Currently operator++() only returns messages within the search radius, this is different to regular spatial messages.
I'm kind of torn on whether to keep this behaviour which adds a redundant extra load of each location variable and caches the distance, or to revert back to non-wrapped behaviour and provide a distance function which users must pass 2-4 floats to for the result.

Not to sure what else can be tested, just feels like it probably needs more.

Docs might need some minor redrafting, didn't feel too clean.

Haven't added an example to the main repo (there's already too much bloat with multiple versions of circles).

Docs PR: FLAMEGPU/FLAMEGPU2-docs#90

Closes #185

[Robadob]

Have just updated this to work with current master (post shared mem curve), also updated the gist example as it was using old dependency graph API.

[Robadob]

Now working on this again, to summarise current status.

The wrapped iterator's Message object has these additional methods distinct from the normal iterator.

• getDistance(): Returns the shortest distance to message in wrapped environment
• getVirtualX(float x1): Returns the closest x coordinate in a wrapped environment (so if it wraps over the left edge, this will return a coordinate beyond the left edge)
• getVirtualY(float y1)

This is different from the regular iterator, that the wrapped iterator only returns messages which are within the radius. This was setup that way when I initially developed the example (presumably in an attempt to minimise users doing stuff wrong), and could easily be tweaked to match the regular iterator's behaviour.

I now need to come up with some thorough tests for this and document, then repeat for 3D.

[ptheywood]

We should think about how we can control wrapping in some but not all dimensions if required (i.e. wrapping in 3 dimensions creates a shape which can't be represented in 3D space, with FLAME GPU 1 only warpping in X and Y but never Z to form a torus)

Will try and get this reviewed in the net few days otherwise

[Robadob]

As discussed in meeting, I've now removed the wrapped distance function entirely. It works more like regular spatial. With additional getVirtualX() and getVirtualX(float) methods for each axis, these provide the 'wrapped' coordinate relative to the search origin or a user specified coordinate respectively (the latter is probably not required, but probably harmless.

These methods internally call getVariable<float>("x"), it's intended that users call them, rather than loading the variables themselves.

P.S. Haven't addressed Pete's partial axis wrapping, don't believe Paul wanted it from the discussion (I might be wrong).

[mondus]

I am happy with the changes. Think the interface for this is really nice.

[mondus]

Delay merging to have a discussion about iterator for spatial messaging. There is a fairly good argument that this should do distance checking.