Cynthia Yantis / Bukkit / 5f027d2d1a2

Commits

Parker Hawke authored and md_5 committed 5f027d2d1a2 19 Dec 2023

#949: Add Vector#fromJOML() overloads for read-only vector types

src/main/java/org/bukkit/util/Vector.java

Modified

-5
+import java.util.LinkedHashMap;
-6
+import java.util.Map;
-7
+import java.util.Random;
-8
+import org.bukkit.Location;
-9
+import org.bukkit.World;
-10
+import org.bukkit.configuration.serialization.ConfigurationSerializable;
-11
+import org.bukkit.configuration.serialization.SerializableAs;
-12
+import org.jetbrains.annotations.NotNull;
-13
+import org.joml.RoundingMode;
-14
+import org.joml.Vector3d;
-+
+import org.joml.Vector3dc;
-16
+import org.joml.Vector3f;
-+
+import org.joml.Vector3fc;
-18
+import org.joml.Vector3i;
-+
+import org.joml.Vector3ic;
-20
-21
+/**
-22
+ * Represents a mutable vector. Because the components of Vectors are mutable,
-23
+ * storing Vectors long term may be dangerous if passing code modifies the
-24
+ * Vector later. If you want to keep around a Vector, it may be wise to call
-25
+ * <code>clone()</code> in order to get a copy.
-26
+ */
-27
+@SerializableAs("Vector")
-28
+public class Vector implements Cloneable, ConfigurationSerializable {
-29
+    private static final long serialVersionUID = -2657651106777219169L;
-944
+     * Gets a vector with components that match the provided JOML {@link Vector3i}.
-945
+     *
-946
+     * @param vector the vector to match
-947
+     * @return the new vector
-948
+     */
-949
+    @NotNull
-950
+    public static Vector fromJOML(@NotNull Vector3i vector) {
-951
+        return new Vector(vector.x(), vector.y(), vector.z());
-952
+    }
-953
-+
+    /**
-+
+     * Gets a vector with components that match the provided JOML {@link Vector3fc}.
-+
+     *
-+
+     * @param vector the vector to match
-+
+     * @return the new vector
-+
+     */
-+
+    @NotNull
-+
+    public static Vector fromJOML(@NotNull Vector3fc vector) {
-+
+        return new Vector(vector.x(), vector.y(), vector.z());
-+
+    }
-+
-+
+    /**
-+
+     * Gets a vector with components that match the provided JOML {@link Vector3dc}.
-+
+     *
-+
+     * @param vector the vector to match
-+
+     * @return the new vector
-+
+     */
-+
+    @NotNull
-+
+    public static Vector fromJOML(@NotNull Vector3dc vector) {
-+
+        return new Vector(vector.x(), vector.y(), vector.z());
-+
+    }
-+
-+
+    /**
-+
+     * Gets a vector with components that match the provided JOML {@link Vector3ic}.
-+
+     *
-+
+     * @param vector the vector to match
-+
+     * @return the new vector
-+
+     */
-+
+    @NotNull
-+
+    public static Vector fromJOML(@NotNull Vector3ic vector) {
-+
+        return new Vector(vector.x(), vector.y(), vector.z());
-+
+    }
-+
-987
+    @Override
-988
+    @NotNull
-989
+    public Map<String, Object> serialize() {
-990
+        Map<String, Object> result = new LinkedHashMap<String, Object>();
-991
-992
+        result.put("x", getX());
-993
+        result.put("y", getY());
-994
+        result.put("z", getZ());
-995
-996
+        return result;

Bukkit

Commits

Jira Issues

Add shortcut