Use ScaleAndTranslateTransform in everything using WorldEditExpressionEnvironment

Author: TomyLobo

worldedit-core/src/main/java/com/sk89q/worldedit/EditSession.java

@@ -95,6 +95,8 @@
 import com.sk89q.worldedit.math.interpolation.Node;
 import com.sk89q.worldedit.math.noise.RandomNoise;
 import com.sk89q.worldedit.math.transform.AffineTransform;
+import com.sk89q.worldedit.math.transform.ScaleAndTranslateTransform;
+import com.sk89q.worldedit.math.transform.Transform;
 import com.sk89q.worldedit.regions.CuboidRegion;
 import com.sk89q.worldedit.regions.CylinderRegion;
 import com.sk89q.worldedit.regions.EllipsoidRegion;
@@ -2311,6 +2313,7 @@ public List<Countable<BlockState>> getBlockDistribution(Region region, @Nullable
      * @throws ExpressionException if there is a problem with the expression
      * @throws MaxChangedBlocksException if the maximum block change limit is exceeded
      */
+    @Deprecated
     public int makeShape(final Region region, final Vector3 zero, final Vector3 unit,
                          final Pattern pattern, final String expressionString, final boolean hollow)
             throws ExpressionException, MaxChangedBlocksException {
@@ -2331,12 +2334,32 @@ public int makeShape(final Region region, final Vector3 zero, final Vector3 unit
      * @throws ExpressionException if there is a problem with the expression
      * @throws MaxChangedBlocksException if the maximum block change limit is exceeded
      */
+    @Deprecated
     public int makeShape(final Region region, final Vector3 zero, final Vector3 unit,
                          final Pattern pattern, final String expressionString, final boolean hollow, final int timeout)
             throws ExpressionException, MaxChangedBlocksException {
+        return makeShape(region, new ScaleAndTranslateTransform(zero, unit), pattern, expressionString, hollow, timeout);
+    }
+
+    /**
+     * Generate a shape for the given expression.
+     *
+     * @param region           the region to generate the shape in
+     * @param transform        the transformation for x/y/z variables
+     * @param pattern          the default material to make the shape from
+     * @param expressionString the expression defining the shape
+     * @param hollow           whether the shape should be hollow
+     * @param timeout          the time, in milliseconds, to wait for each expression evaluation before halting it. -1 to disable
+     * @return number of blocks changed
+     * @throws ExpressionException       if there is a problem with the expression
+     * @throws MaxChangedBlocksException if the maximum block change limit is exceeded
+     */
+    public int makeShape(final Region region,
+                         Transform transform, final Pattern pattern, final String expressionString, final boolean hollow, final int timeout)
+            throws ExpressionException, MaxChangedBlocksException {
         final Expression expression = Expression.compile(expressionString, "x", "y", "z", "type", "data");
         expression.optimize();
-        return makeShape(region, zero, unit, pattern, expression, hollow, timeout);
+        return makeShape(region, transform, pattern, expression, hollow, timeout);
     }
 
     /**
@@ -2346,9 +2369,23 @@ public int makeShape(final Region region, final Vector3 zero, final Vector3 unit
      * The Expression class is subject to change. Expressions should be provided via the string overload.
      * </p>
      */
+    @Deprecated
     public int makeShape(final Region region, final Vector3 zero, final Vector3 unit,
                          final Pattern pattern, final Expression expression, final boolean hollow, final int timeout)
             throws ExpressionException, MaxChangedBlocksException {
+        return makeShape(region, new ScaleAndTranslateTransform(zero, unit), pattern, expression, hollow, timeout);
+    }
+
+    /**
+     * Internal version of {@link EditSession#makeShape(Region, Vector3, Vector3, Pattern, String, boolean, int)}.
+     *
+     * <p>
+     * The Expression class is subject to change. Expressions should be provided via the string overload.
+     * </p>
+     */
+    public int makeShape(final Region region, Transform transform,
+                         final Pattern pattern, final Expression expression, final boolean hollow, final int timeout)
+            throws ExpressionException, MaxChangedBlocksException {
 
         expression.getSlots().getVariable("x")
             .orElseThrow(IllegalStateException::new);
@@ -2362,16 +2399,17 @@ public int makeShape(final Region region, final Vector3 zero, final Vector3 unit
         final Variable dataVariable = expression.getSlots().getVariable("data")
             .orElseThrow(IllegalStateException::new);
 
-        final WorldEditExpressionEnvironment environment = new WorldEditExpressionEnvironment(this, unit, zero);
+        final WorldEditExpressionEnvironment environment = new WorldEditExpressionEnvironment(this, transform);
         expression.setEnvironment(environment);
 
         final int[] timedOut = {0};
+        final Transform transformInverse = transform.inverse();
         final ArbitraryShape shape = new ArbitraryShape(region) {
             @Override
             protected BaseBlock getMaterial(int x, int y, int z, BaseBlock defaultMaterial) {
                 final Vector3 current = Vector3.at(x, y, z);
                 environment.setCurrentBlock(current);
-                final Vector3 inputPosition = current.subtract(zero).divide(unit);
+                final Vector3 inputPosition = transformInverse.apply(current);
 
                 try {
                     int[] legacy = LegacyMapper.getInstance().getLegacyFromBlock(defaultMaterial.toImmutableState());
@@ -2428,9 +2466,10 @@ protected BaseBlock getMaterial(int x, int y, int z, BaseBlock defaultMaterial)
      * @throws ExpressionException thrown on invalid expression input
      * @throws MaxChangedBlocksException thrown if too many blocks are changed
      */
+    @Deprecated
     public int deformRegion(final Region region, final Vector3 zero, final Vector3 unit, final String expressionString)
             throws ExpressionException, MaxChangedBlocksException {
-        return deformRegion(region, zero, unit, expressionString, WorldEdit.getInstance().getConfiguration().calculationTimeout);
+        return deformRegion(region, new ScaleAndTranslateTransform(zero, unit), expressionString, WorldEdit.getInstance().getConfiguration().calculationTimeout);
     }
 
     /**
@@ -2449,11 +2488,31 @@ public int deformRegion(final Region region, final Vector3 zero, final Vector3 u
      * @throws ExpressionException thrown on invalid expression input
      * @throws MaxChangedBlocksException thrown if too many blocks are changed
      */
+    @Deprecated
     public int deformRegion(final Region region, final Vector3 zero, final Vector3 unit, final String expressionString,
                             final int timeout) throws ExpressionException, MaxChangedBlocksException {
+        final Transform transform = new ScaleAndTranslateTransform(zero, unit);
+        return deformRegion(region, transform, expressionString, timeout);
+    }
+
+    /**
+     * Deforms the region by a given expression. A deform provides a block's x, y, and z coordinates (possibly scaled)
+     * to an expression, and then sets the block to the block given by the resulting values of the variables, if they
+     * have changed.
+     *
+     * @param region           the region to deform
+     * @param transform        the coordinate system
+     * @param expressionString the expression to evaluate for each block
+     * @param timeout          maximum time for the expression to evaluate for each block. -1 for unlimited.
+     * @return number of blocks changed
+     * @throws ExpressionException       thrown on invalid expression input
+     * @throws MaxChangedBlocksException thrown if too many blocks are changed
+     */
+    public int deformRegion(final Region region, final Transform transform, final String expressionString,
+                            final int timeout) throws ExpressionException, MaxChangedBlocksException {
         final Expression expression = Expression.compile(expressionString, "x", "y", "z");
         expression.optimize();
-        return deformRegion(region, zero, unit, expression, timeout);
+        return deformRegion(region, transform, expression, timeout);
     }
 
     /**
@@ -2463,32 +2522,47 @@ public int deformRegion(final Region region, final Vector3 zero, final Vector3 u
      * The Expression class is subject to change. Expressions should be provided via the string overload.
      * </p>
      */
+    @Deprecated
     public int deformRegion(final Region region, final Vector3 zero, final Vector3 unit, final Expression expression,
                             final int timeout) throws ExpressionException, MaxChangedBlocksException {
+        return deformRegion(region, new ScaleAndTranslateTransform(zero, unit), expression, timeout);
+    }
+
+    /**
+     * Internal version of {@link EditSession#deformRegion(Region, Vector3, Vector3, String, int)}.
+     *
+     * <p>
+     * The Expression class is subject to change. Expressions should be provided via the string overload.
+     * </p>
+     */
+    public int deformRegion(final Region region, final Transform transform, final Expression expression,
+                            final int timeout) throws ExpressionException, MaxChangedBlocksException {
         final Variable x = expression.getSlots().getVariable("x")
             .orElseThrow(IllegalStateException::new);
         final Variable y = expression.getSlots().getVariable("y")
             .orElseThrow(IllegalStateException::new);
         final Variable z = expression.getSlots().getVariable("z")
             .orElseThrow(IllegalStateException::new);
 
-        final WorldEditExpressionEnvironment environment = new WorldEditExpressionEnvironment(this, unit, zero);
+        final WorldEditExpressionEnvironment environment = new WorldEditExpressionEnvironment(this, transform);
         expression.setEnvironment(environment);
 
         final DoubleArrayList<BlockVector3, BaseBlock> queue = new DoubleArrayList<>(false);
 
+        final Transform transformInverse = transform.inverse();
         for (BlockVector3 targetBlockPosition : region) {
             final Vector3 targetPosition = targetBlockPosition.toVector3();
             environment.setCurrentBlock(targetPosition);
 
             // transform from target coordinates
-            final Vector3 inputPosition = targetPosition.subtract(zero).divide(unit);
+            final Vector3 inputPosition = transformInverse.apply(targetPosition);
 
             // deform
             expression.evaluate(new double[]{ inputPosition.x(), inputPosition.y(), inputPosition.z() }, timeout);
+            final Vector3 outputPosition = Vector3.at(x.value(), y.value(), z.value());
 
             // transform to source coordinates, round-nearest
-            final BlockVector3 sourcePosition = environment.toWorld(x.value(), y.value(), z.value());
+            final BlockVector3 sourcePosition = transform.apply(outputPosition).add(0.5, 0.5, 0.5).toBlockPoint();
 
             // read block from world
             final BaseBlock material = world.getFullBlock(sourcePosition);
@@ -2796,28 +2870,36 @@ private void recurseHollow(Region region, BlockVector3 origin, Set<BlockVector3>
         }
     }
 
+    @Deprecated
     public int makeBiomeShape(final Region region, final Vector3 zero, final Vector3 unit, final BiomeType biomeType,
                               final String expressionString, final boolean hollow) throws ExpressionException {
         return makeBiomeShape(region, zero, unit, biomeType, expressionString, hollow, WorldEdit.getInstance().getConfiguration().calculationTimeout);
     }
 
+    @Deprecated
     public int makeBiomeShape(final Region region, final Vector3 zero, final Vector3 unit, final BiomeType biomeType,
                               final String expressionString, final boolean hollow, final int timeout) throws ExpressionException {
+        return makeBiomeShape(region, new ScaleAndTranslateTransform(zero, unit), biomeType, expressionString, hollow, timeout);
+    }
+
+    public int makeBiomeShape(final Region region, Transform transform, final BiomeType biomeType,
+                              final String expressionString, final boolean hollow, final int timeout) throws ExpressionException {
 
         final Expression expression = Expression.compile(expressionString, "x", "y", "z");
         expression.optimize();
 
         final EditSession editSession = this;
-        final WorldEditExpressionEnvironment environment = new WorldEditExpressionEnvironment(editSession, unit, zero);
+        final WorldEditExpressionEnvironment environment = new WorldEditExpressionEnvironment(editSession, transform);
         expression.setEnvironment(environment);
 
         AtomicInteger timedOut = new AtomicInteger();
+        final Transform transformInverse = transform.inverse();
         final ArbitraryBiomeShape shape = new ArbitraryBiomeShape(region) {
             @Override
             protected BiomeType getBiome(int x, int y, int z, BiomeType defaultBiomeType) {
                 final Vector3 current = Vector3.at(x, y, z);
                 environment.setCurrentBlock(current);
-                final Vector3 inputPosition = current.subtract(zero).divide(unit);
+                final Vector3 inputPosition = transformInverse.apply(current);
 
                 try {
                     if (expression.evaluate(new double[]{ inputPosition.x(), inputPosition.y(), inputPosition.z() }, timeout) <= 0) {

worldedit-core/src/main/java/com/sk89q/worldedit/command/GenerationCommands.java

@@ -32,8 +32,9 @@
 import com.sk89q.worldedit.internal.annotation.Radii;
 import com.sk89q.worldedit.internal.annotation.Selection;
 import com.sk89q.worldedit.internal.expression.ExpressionException;
+import com.sk89q.worldedit.internal.util.TransformUtil;
 import com.sk89q.worldedit.math.BlockVector3;
-import com.sk89q.worldedit.math.Vector3;
+import com.sk89q.worldedit.math.transform.Transform;
 import com.sk89q.worldedit.regions.Region;
 import com.sk89q.worldedit.util.TreeGenerator.TreeType;
 import com.sk89q.worldedit.util.formatting.text.TextComponent;
@@ -373,42 +374,10 @@ public int generate(Actor actor, LocalSession session, EditSession editSession,
                             boolean offsetPlacement,
                         @Switch(name = 'c', desc = "Use the selection's center as origin")
                             boolean offsetCenter) throws WorldEditException {
-
-        final Vector3 zero;
-        Vector3 unit;
-
-        if (useRawCoords) {
-            zero = Vector3.ZERO;
-            unit = Vector3.ONE;
-        } else if (offsetPlacement) {
-            zero = session.getPlacementPosition(actor).toVector3();
-            unit = Vector3.ONE;
-        } else if (offsetCenter) {
-            final Vector3 min = region.getMinimumPoint().toVector3();
-            final Vector3 max = region.getMaximumPoint().toVector3();
-
-            zero = max.add(min).multiply(0.5);
-            unit = Vector3.ONE;
-        } else {
-            final Vector3 min = region.getMinimumPoint().toVector3();
-            final Vector3 max = region.getMaximumPoint().toVector3();
-
-            zero = max.add(min).multiply(0.5);
-            unit = max.subtract(zero);
-
-            if (unit.x() == 0) {
-                unit = unit.withX(1.0);
-            }
-            if (unit.y() == 0) {
-                unit = unit.withY(1.0);
-            }
-            if (unit.z() == 0) {
-                unit = unit.withZ(1.0);
-            }
-        }
+        final Transform transform = TransformUtil.createTransformForExpressionCommand(actor, session, region, useRawCoords, offsetPlacement, offsetCenter);
 
         try {
-            final int affected = editSession.makeShape(region, zero, unit, pattern, String.join(" ", expression), hollow, session.getTimeout());
+            final int affected = editSession.makeShape(region, transform, pattern, String.join(" ", expression), hollow, session.getTimeout());
             if (actor instanceof Player) {
                 ((Player) actor).findFreePosition();
             }
@@ -442,41 +411,10 @@ public int generateBiome(Actor actor, LocalSession session, EditSession editSess
                                  boolean offsetPlacement,
                              @Switch(name = 'c', desc = "Use the selection's center as origin")
                                  boolean offsetCenter) throws WorldEditException {
-        final Vector3 zero;
-        Vector3 unit;
-
-        if (useRawCoords) {
-            zero = Vector3.ZERO;
-            unit = Vector3.ONE;
-        } else if (offsetPlacement) {
-            zero = session.getPlacementPosition(actor).toVector3();
-            unit = Vector3.ONE;
-        } else if (offsetCenter) {
-            final Vector3 min = region.getMinimumPoint().toVector3();
-            final Vector3 max = region.getMaximumPoint().toVector3();
-
-            zero = max.add(min).multiply(0.5);
-            unit = Vector3.ONE;
-        } else {
-            final Vector3 min = region.getMinimumPoint().toVector3();
-            final Vector3 max = region.getMaximumPoint().toVector3();
-
-            zero = max.add(min).multiply(0.5);
-            unit = max.subtract(zero);
-
-            if (unit.x() == 0) {
-                unit = unit.withX(1.0);
-            }
-            if (unit.y() == 0) {
-                unit = unit.withY(1.0);
-            }
-            if (unit.z() == 0) {
-                unit = unit.withZ(1.0);
-            }
-        }
+        final Transform transform = TransformUtil.createTransformForExpressionCommand(actor, session, region, useRawCoords, offsetPlacement, offsetCenter);
 
         try {
-            final int affected = editSession.makeBiomeShape(region, zero, unit, target, String.join(" ", expression), hollow, session.getTimeout());
+            final int affected = editSession.makeBiomeShape(region, transform, target, String.join(" ", expression), hollow, session.getTimeout());
             actor.printInfo(TranslatableComponent.of("worldedit.generatebiome.changed", TextComponent.of(affected)));
             return affected;
         } catch (ExpressionException e) {