fix: use a holder to allow "upgrading" LocalBV3Set to a full fat one (#3051)

dordsor21 · web-flow · commit 69d8543d4b51 · 2025-01-18T17:56:42.000Z
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/ScatterBrush.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/ScatterBrush.java
@@ -121,7 +121,7 @@ public BlockVector3 getDirection(BlockVector3 pt) {
     @Deprecated(forRemoval = true, since = "2.9.2")
     public void apply(EditSession editSession, LocalBlockVectorSet placed, BlockVector3 pt, Pattern p, double size) throws
             MaxChangedBlocksException {
-        apply(editSession, (BlockVector3Set) placed, pt, p, size);
+        apply(editSession, LocalBlockVectorSet.wrap(placed), pt, p, size);
     }
 
     /**
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/ScatterCommand.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/ScatterCommand.java
@@ -3,6 +3,7 @@
 import com.fastasyncworldedit.core.FaweCache;
 import com.fastasyncworldedit.core.math.LocalBlockVectorSet;
 import com.fastasyncworldedit.core.util.StringMan;
+import com.fastasyncworldedit.core.util.collection.BlockVector3Set;
 import com.fastasyncworldedit.core.wrappers.AsyncPlayer;
 import com.fastasyncworldedit.core.wrappers.LocationMaskedPlayerWrapper;
 import com.fastasyncworldedit.core.wrappers.SilentPlayerWrapper;
@@ -31,10 +32,22 @@ public ScatterCommand(int count, int distance, String command, boolean print) {
     }
 
     @Override
+    @Deprecated(forRemoval = true, since = "TODO")
     public void apply(
             EditSession editSession,
             LocalBlockVectorSet placed,
             BlockVector3 position,
+            Pattern p,
+            double size
+    ) throws MaxChangedBlocksException {
+        apply(editSession, LocalBlockVectorSet.wrap(placed), position, p, size);
+    }
+
+    @Override
+    public void apply(
+            EditSession editSession,
+            BlockVector3Set placed,
+            BlockVector3 position,
             Pattern pattern,
             double size
     ) throws
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/ScatterOverlayBrush.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/ScatterOverlayBrush.java
@@ -2,6 +2,7 @@
 
 import com.fastasyncworldedit.core.math.LocalBlockVectorSet;
 import com.fastasyncworldedit.core.math.MutableBlockVector3;
+import com.fastasyncworldedit.core.util.collection.BlockVector3Set;
 import com.sk89q.worldedit.EditSession;
 import com.sk89q.worldedit.MaxChangedBlocksException;
 import com.sk89q.worldedit.function.pattern.Pattern;
@@ -14,7 +15,25 @@ public ScatterOverlayBrush(int count, int distance) {
     }
 
     @Override
-    public void apply(EditSession editSession, LocalBlockVectorSet placed, BlockVector3 pt, Pattern p, double size) throws
+    @Deprecated(forRemoval = true, since = "TODO")
+    public void apply(
+            EditSession editSession,
+            LocalBlockVectorSet placed,
+            BlockVector3 position,
+            Pattern p,
+            double size
+    ) throws MaxChangedBlocksException {
+        apply(editSession, LocalBlockVectorSet.wrap(placed), position, p, size);
+    }
+
+    @Override
+    public void apply(
+            EditSession editSession,
+            BlockVector3Set placed,
+            BlockVector3 pt,
+            Pattern p,
+            double size
+    ) throws
             MaxChangedBlocksException {
         final int x = pt.x();
         final int y = pt.y();
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/ShatterBrush.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/ShatterBrush.java
@@ -23,6 +23,7 @@ public ShatterBrush(int count) {
     }
 
     @Override
+    @Deprecated(forRemoval = true, since = "TODO")
     public void apply(
             final EditSession editSession,
             final BlockVector3Set placed,
@@ -51,7 +52,7 @@ public void finish(
             LocalBlockVectorSet set = new LocalBlockVectorSet();
             set.add(pos);
             frontiers[i] = set;
-            frontiersVisited[i] = set.clone();
+            frontiersVisited[i] = set.copy();
             i++;
         }
         // Mask
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/SplatterBrush.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/SplatterBrush.java
@@ -3,6 +3,7 @@
 import com.fastasyncworldedit.core.function.mask.SplatterBrushMask;
 import com.fastasyncworldedit.core.function.mask.SurfaceMask;
 import com.fastasyncworldedit.core.math.LocalBlockVectorSet;
+import com.fastasyncworldedit.core.util.collection.BlockVector3Set;
 import com.sk89q.worldedit.EditSession;
 import com.sk89q.worldedit.MaxChangedBlocksException;
 import com.sk89q.worldedit.function.operation.Operations;
@@ -25,12 +26,24 @@ public SplatterBrush(int count, int distance, boolean solid) {
     }
 
     @Override
+    @Deprecated(forRemoval = true, since = "TODO")
     public void apply(
             final EditSession editSession,
             final LocalBlockVectorSet placed,
             final BlockVector3 position,
             Pattern p,
             double size
+    ) throws MaxChangedBlocksException {
+        apply(editSession, LocalBlockVectorSet.wrap(placed), position, p, size);
+    }
+
+    @Override
+    public void apply(
+            final EditSession editSession,
+            final BlockVector3Set placed,
+            final BlockVector3 position,
+            Pattern p,
+            double size
     ) throws MaxChangedBlocksException {
         final Pattern finalPattern;
         if (solid) {
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/SurfaceSpline.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/brush/SurfaceSpline.java
@@ -4,6 +4,7 @@
 import com.fastasyncworldedit.core.math.LocalBlockVectorSet;
 import com.fastasyncworldedit.core.math.MutableBlockVector3;
 import com.fastasyncworldedit.core.util.MathMan;
+import com.fastasyncworldedit.core.util.collection.BlockVector3Set;
 import com.sk89q.worldedit.EditSession;
 import com.sk89q.worldedit.MaxChangedBlocksException;
 import com.sk89q.worldedit.command.tool.brush.Brush;
@@ -66,7 +67,7 @@ public void build(EditSession editSession, BlockVector3 pos, Pattern pattern, do
         MutableBlockVector3 mutable = MutableBlockVector3.at(0, 0, 0);
         interpol.setNodes(nodes);
         final double splinelength = interpol.arcLength(0, 1);
-        LocalBlockVectorSet vset = new LocalBlockVectorSet();
+        BlockVector3Set vset = LocalBlockVectorSet.wrapped();
         for (double loop = 0; loop <= 1; loop += 1D / splinelength / quality) {
             final Vector3 tipv = interpol.getPosition(loop);
             final int tipx = MathMan.roundInt(tipv.x());
@@ -85,7 +86,7 @@ public void build(EditSession editSession, BlockVector3 pos, Pattern pattern, do
         }
         if (radius != 0) {
             double radius2 = radius * radius;
-            LocalBlockVectorSet newSet = new LocalBlockVectorSet();
+            BlockVector3Set newSet = LocalBlockVectorSet.wrapped();
             final int ceilrad = (int) Math.ceil(radius);
             for (BlockVector3 v : vset) {
                 final int tipx = v.x();
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/sweep/ClipboardSpline.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/command/tool/sweep/ClipboardSpline.java
@@ -2,6 +2,7 @@
 
 import com.fastasyncworldedit.core.math.LocalBlockVectorSet;
 import com.fastasyncworldedit.core.math.transform.RoundedTransform;
+import com.fastasyncworldedit.core.util.collection.BlockVector3Set;
 import com.sk89q.worldedit.EditSession;
 import com.sk89q.worldedit.MaxChangedBlocksException;
 import com.sk89q.worldedit.extent.clipboard.Clipboard;
@@ -28,7 +29,7 @@ public class ClipboardSpline extends Spline {
 
     private BlockVector3 center;
     private final BlockVector3 centerOffset;
-    private final LocalBlockVectorSet buffer;
+    private final BlockVector3Set buffer;
 
     /**
      * Constructor without position-correction. Use this constructor for an interpolation
@@ -87,7 +88,7 @@ public ClipboardSpline(
         this.centerOffset = center.subtract(center.round());
         this.center = center.subtract(centerOffset);
         this.transform = transform;
-        this.buffer = new LocalBlockVectorSet();
+        this.buffer = LocalBlockVectorSet.wrapped();
     }
 
     @Override
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/mask/CachedMask.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/mask/CachedMask.java
@@ -27,12 +27,13 @@ public CachedMask(Mask mask) {
      * @param local If the area will be small
      * @since 2.4.0
      */
+    @Deprecated(forRemoval = true, since = "TODO")
     public CachedMask(Mask mask, boolean local) {
         super(mask);
         hasExtent = mask instanceof AbstractExtentMask;
         if (local) {
-            cache_checked = new LocalBlockVectorSet();
-            cache_results = new LocalBlockVectorSet();
+            cache_checked = LocalBlockVectorSet.wrapped();
+            cache_results = LocalBlockVectorSet.wrapped();
         } else {
             cache_checked = new BlockVectorSet();
             cache_results = new BlockVectorSet();
@@ -63,25 +64,15 @@ public boolean test(BlockVector3 vector) {
         int x = vector.x();
         int y = vector.y();
         int z = vector.z();
-        try {
-            boolean check = cache_checked.add(x, y, z);
-            if (!check) {
-                return cache_results.contains(x, y, z);
-            }
-            boolean result = getMask().test(vector);
-            if (result) {
-                cache_results.add(x, y, z);
-            }
-            return result;
-        } catch (UnsupportedOperationException ignored) {
-            boolean result = getMask().test(vector);
-            resetCache();
-            cache_checked.add(x, y, z);
-            if (result) {
-                cache_results.add(x, y, z);
-            }
-            return result;
+        boolean check = cache_checked.add(x, y, z);
+        if (!check) {
+            return cache_results.contains(x, y, z);
         }
+        boolean result = getMask().test(vector);
+        if (result) {
+            cache_results.add(x, y, z);
+        }
+        return result;
     }
 
     public boolean test(@Nullable Extent extent, BlockVector3 vector) {
@@ -92,25 +83,15 @@ public boolean test(@Nullable Extent extent, BlockVector3 vector) {
         int y = vector.y();
         int z = vector.z();
         AbstractExtentMask mask = (AbstractExtentMask) getMask();
-        try {
-            boolean check = cache_checked.add(x, y, z);
-            if (!check) {
-                return cache_results.contains(x, y, z);
-            }
-            boolean result = mask.test(extent, vector);
-            if (result) {
-                cache_results.add(x, y, z);
-            }
-            return result;
-        } catch (UnsupportedOperationException ignored) {
-            boolean result = mask.test(extent, vector);
-            resetCache();
-            cache_checked.add(x, y, z);
-            if (result) {
-                cache_results.add(x, y, z);
-            }
-            return result;
+        boolean check = cache_checked.add(x, y, z);
+        if (!check) {
+            return cache_results.contains(x, y, z);
+        }
+        boolean result = mask.test(extent, vector);
+        if (result) {
+            cache_results.add(x, y, z);
         }
+        return result;
     }
 
     @Override
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/mask/SplatterBrushMask.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/mask/SplatterBrushMask.java
@@ -1,6 +1,7 @@
 package com.fastasyncworldedit.core.function.mask;
 
 import com.fastasyncworldedit.core.math.LocalBlockVectorSet;
+import com.fastasyncworldedit.core.util.collection.BlockVector3Set;
 import com.sk89q.worldedit.EditSession;
 import com.sk89q.worldedit.extent.Extent;
 import com.sk89q.worldedit.function.mask.AbstractExtentMask;
@@ -14,14 +15,38 @@ public class SplatterBrushMask extends AbstractExtentMask {
     private final BlockVector3 position;
     private final int size2;
     private final Mask surface;
-    private final LocalBlockVectorSet placed;
+    private final BlockVector3Set placed;
 
+    /**
+     * @deprecated in favour of {@link SplatterBrushMask#SplatterBrushMask(EditSession, BlockVector3, int, Mask, BlockVector3Set)}
+     */
+    @Deprecated(forRemoval = true, since = "TODO")
     public SplatterBrushMask(
             EditSession editSession,
             BlockVector3 position,
             int size2,
             Mask surface,
             LocalBlockVectorSet placed
+    ) {
+        this(editSession, position, size2, surface, LocalBlockVectorSet.wrap(placed));
+    }
+
+    /**
+     * Create a new instance
+     *
+     * @param editSession Editsession to use
+     * @param position    position applied to
+     * @param size2       radius squared
+     * @param surface     surface mask
+     * @param placed      {@link BlockVector3Set} of placed blocks
+     * @since TODO
+     */
+    public SplatterBrushMask(
+            EditSession editSession,
+            BlockVector3 position,
+            int size2,
+            Mask surface,
+            BlockVector3Set placed
     ) {
         super(editSession);
         this.position = position;
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/BufferedPattern.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/function/pattern/BufferedPattern.java
@@ -50,7 +50,9 @@ public BufferedPattern(Actor actor, Pattern parent, @Nullable Region region) {
         this.pattern = parent;
         this.timer = Fawe.instance().getTimer();
         // Assume brush is used if no region provided, i.e. unlikely to required BlockVectorSet
-        set = region == null ? new LocalBlockVectorSet() : BlockVector3Set.getAppropriateVectorSet(region);
+        set = region == null
+            ? LocalBlockVectorSet.wrapped()
+            : BlockVector3Set.getAppropriateVectorSet(region);
     }
 
     @Override
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/math/BlockVectorSet.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/math/BlockVectorSet.java
@@ -12,8 +12,10 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Iterator;
+import java.util.Map;
 import java.util.NoSuchElementException;
 import java.util.Objects;
+import java.util.stream.Collectors;
 
 /**
  * The BlockVectorSet is a memory optimized Set for storing {@link BlockVector3}'s.
@@ -27,6 +29,26 @@ public class BlockVectorSet extends AbstractCollection<BlockVector3> implements
 
     private final Long2ObjectLinkedOpenHashMap<LocalBlockVectorSet> localSets = new Long2ObjectLinkedOpenHashMap<>(4);
 
+    public BlockVectorSet() {
+    }
+
+    public BlockVectorSet(LocalBlockVectorSet localSet) {
+        if (localSet != null && localSet.isInitialised()) {
+            int offsetX = localSet.offsetX();
+            int offsetY = localSet.offsetY();
+            int offsetZ = localSet.offsetZ();
+            if ((offsetX & 2047) == 0 && (offsetY & 511) == 0 && (offsetZ & 2047) == 0) { // Can plug and play
+                localSets.put(MathMan.tripleWorldCoord(offsetX >> 11, offsetY >> 9, offsetZ >> 11), localSet);
+            } else {
+                localSet.forEach((x, y, z, index) -> this.add(x, y, z));
+            }
+        }
+    }
+
+    private BlockVectorSet(Map<Long, ? extends LocalBlockVectorSet> sets) {
+        localSets.putAll(sets);
+    }
+
     @Override
     public int size() {
         int size = 0;
@@ -257,10 +279,17 @@ public boolean removeAll(Collection<?> c) {
         return result;
     }
 
-
     @Override
     public void clear() {
         localSets.clear();
     }
 
+    @Override
+    public BlockVectorSet copy() {
+        return new BlockVectorSet(localSets
+                .long2ObjectEntrySet()
+                .stream()
+                .collect(Collectors.toMap(Long2ObjectMap.Entry::getLongKey, e -> e.getValue().copy())));
+    }
+
 }
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/math/LocalBlockVectorSet.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/math/LocalBlockVectorSet.java
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/util/collection/BlockVector3Set.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/util/collection/BlockVector3Set.java
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/EditSession.java b/worldedit-core/src/main/java/com/sk89q/worldedit/EditSession.java

Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ public BlockVector3 getDirection(BlockVector3 pt) {`
`121`	`121`	`@Deprecated(forRemoval = true, since = "2.9.2")`
`122`	`122`	`public void apply(EditSession editSession, LocalBlockVectorSet placed, BlockVector3 pt, Pattern p, double size) throws`
`123`	`123`	`MaxChangedBlocksException {`
`124`		`- apply(editSession, (BlockVector3Set) placed, pt, p, size);`
	`124`	`+ apply(editSession, LocalBlockVectorSet.wrap(placed), pt, p, size);`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`/**`