Renamed WorldMouse to ProjectedCoordinates and Cursor to ClipPosition, added unsafe Identity types

Author: LatvianModder

src/main/java/dev/latvian/mods/klib/data/DataTypes.java

@@ -17,6 +17,7 @@
 import dev.latvian.mods.klib.color.Gradient;
 import dev.latvian.mods.klib.interpolation.Interpolation;
 import dev.latvian.mods.klib.interpolation.InterpolationType;
+import dev.latvian.mods.klib.math.ClipPosition;
 import dev.latvian.mods.klib.math.InterpolatedDouble;
 import dev.latvian.mods.klib.math.InterpolatedFloat;
 import dev.latvian.mods.klib.math.Line;
@@ -144,5 +145,6 @@ static void register() {
 		DataType.register(KLibMod.id("line"), Line.DATA_TYPE);
 		DataType.register(KLibMod.id("interpolated_float"), InterpolatedFloat.DATA_TYPE);
 		DataType.register(KLibMod.id("interpolated_double"), InterpolatedDouble.DATA_TYPE);
+		DataType.register(KLibMod.id("clip_position"), ClipPosition.DATA_TYPE);
 	}
 }

src/main/java/dev/latvian/mods/klib/math/ClipPosition.java

@@ -0,0 +1,47 @@
+package dev.latvian.mods.klib.math;
+
+import com.mojang.serialization.Codec;
+import com.mojang.serialization.codecs.RecordCodecBuilder;
+import dev.latvian.mods.klib.codec.CompositeStreamCodec;
+import dev.latvian.mods.klib.codec.MCCodecs;
+import dev.latvian.mods.klib.codec.MCStreamCodecs;
+import dev.latvian.mods.klib.data.DataType;
+import io.netty.buffer.ByteBuf;
+import net.minecraft.core.BlockPos;
+import net.minecraft.core.Direction;
+import net.minecraft.network.codec.StreamCodec;
+import net.minecraft.world.phys.BlockHitResult;
+import net.minecraft.world.phys.Vec3;
+
+public record ClipPosition(Vec3 position, BlockPos blockPosition, Direction side) {
+	public static final Codec<ClipPosition> CODEC = RecordCodecBuilder.create(instance -> instance.group(
+		MCCodecs.VEC3.fieldOf("position").forGetter(ClipPosition::position),
+		BlockPos.CODEC.fieldOf("block").forGetter(ClipPosition::blockPosition),
+		Direction.CODEC.fieldOf("side").forGetter(ClipPosition::side)
+	).apply(instance, ClipPosition::new));
+
+	public static final StreamCodec<ByteBuf, ClipPosition> STREAM_CODEC = CompositeStreamCodec.of(
+		MCStreamCodecs.VEC3, ClipPosition::position,
+		BlockPos.STREAM_CODEC, ClipPosition::blockPosition,
+		Direction.STREAM_CODEC, ClipPosition::side,
+		ClipPosition::new
+	);
+
+	public static final DataType<ClipPosition> DATA_TYPE = DataType.of(CODEC, STREAM_CODEC, ClipPosition.class);
+
+	public ClipPosition(BlockHitResult hit) {
+		this(hit.getLocation(), hit.getBlockPos(), hit.getDirection());
+	}
+
+	public BlockPos getOffsetBlockPosition() {
+		return blockPosition.relative(side);
+	}
+
+	public Vec3 getBottomCenter() {
+		return Vec3.atBottomCenterOf(getOffsetBlockPosition());
+	}
+
+	public Vec3 getCenter() {
+		return Vec3.atCenterOf(getOffsetBlockPosition());
+	}
+}

src/main/java/dev/latvian/mods/klib/math/Cursor.java

@@ -50,31 +50,59 @@
 import org.joml.Vector4ic;
 
 public interface Identity {
-	Vector2fc VEC_2 = new Vector2f();
-	Vector3fc VEC_3 = new Vector3f();
-	Vector4fc VEC_4 = new Vector4f();
-	Matrix2fc MAT_2 = new Matrix2f();
-	Matrix3fc MAT_3 = new Matrix3f();
-	Matrix3x2fc MAT_3x2 = new Matrix3x2f();
-	Matrix4fc MAT_4 = new Matrix4f();
-	Matrix4x3fc MAT_4x3 = new Matrix4x3f();
-	Quaternionfc QUATERNION = new Quaternionf();
+	Vector2f UNSAFE_VEC_2 = new Vector2f();
+	Vector3f UNSAFE_VEC_3 = new Vector3f();
+	Vector4f UNSAFE_VEC_4 = new Vector4f();
+	Matrix2f UNSAFE_MAT_2 = new Matrix2f();
+	Matrix3f UNSAFE_MAT_3 = new Matrix3f();
+	Matrix3x2f UNSAFE_MAT_3x2 = new Matrix3x2f();
+	Matrix4f UNSAFE_MAT_4 = new Matrix4f();
+	Matrix4x3f UNSAFE_MAT_4x3 = new Matrix4x3f();
+	Quaternionf UNSAFE_QUATERNION = new Quaternionf();
 
-	Vector2dc DVEC_2 = new Vector2d();
-	Vector3dc DVEC_3 = new Vector3d();
-	Vector4dc DVEC_4 = new Vector4d();
-	Matrix2dc DMAT_2 = new Matrix2d();
-	Matrix3dc DMAT_3 = new Matrix3d();
-	Matrix3x2dc DMAT_3x2 = new Matrix3x2d();
-	Matrix4dc DMAT_4 = new Matrix4d();
-	Matrix4x3dc DMAT_4x3 = new Matrix4x3d();
-	Quaterniondc DQUATERNION = new Quaterniond();
+	Vector2fc VEC_2 = UNSAFE_VEC_2;
+	Vector3fc VEC_3 = UNSAFE_VEC_3;
+	Vector4fc VEC_4 = UNSAFE_VEC_4;
+	Matrix2fc MAT_2 = UNSAFE_MAT_2;
+	Matrix3fc MAT_3 = UNSAFE_MAT_3;
+	Matrix3x2fc MAT_3x2 = UNSAFE_MAT_3x2;
+	Matrix4fc MAT_4 = UNSAFE_MAT_4;
+	Matrix4x3fc MAT_4x3 = UNSAFE_MAT_4x3;
+	Quaternionfc QUATERNION = UNSAFE_QUATERNION;
 
-	Vector2ic IVEC_2 = new Vector2i();
-	Vector3ic IVEC_3 = new Vector3i();
-	Vector4ic IVEC_4 = new Vector4i();
+	Vector2d UNSAFE_DVEC_2 = new Vector2d();
+	Vector3d UNSAFE_DVEC_3 = new Vector3d();
+	Vector4d UNSAFE_DVEC_4 = new Vector4d();
+	Matrix2d UNSAFE_DMAT_2 = new Matrix2d();
+	Matrix3d UNSAFE_DMAT_3 = new Matrix3d();
+	Matrix3x2d UNSAFE_DMAT_3x2 = new Matrix3x2d();
+	Matrix4d UNSAFE_DMAT_4 = new Matrix4d();
+	Matrix4x3d UNSAFE_DMAT_4x3 = new Matrix4x3d();
+	Quaterniond UNSAFE_DQUATERNION = new Quaterniond();
 
-	Vector2Lc LVEC_2 = new Vector2L();
-	Vector3Lc LVEC_3 = new Vector3L();
-	Vector4Lc LVEC_4 = new Vector4L();
+	Vector2dc DVEC_2 = UNSAFE_DVEC_2;
+	Vector3dc DVEC_3 = UNSAFE_DVEC_3;
+	Vector4dc DVEC_4 = UNSAFE_DVEC_4;
+	Matrix2dc DMAT_2 = UNSAFE_DMAT_2;
+	Matrix3dc DMAT_3 = UNSAFE_DMAT_3;
+	Matrix3x2dc DMAT_3x2 = UNSAFE_DMAT_3x2;
+	Matrix4dc DMAT_4 = UNSAFE_DMAT_4;
+	Matrix4x3dc DMAT_4x3 = UNSAFE_DMAT_4x3;
+	Quaterniondc DQUATERNION = UNSAFE_DQUATERNION;
+
+	Vector2i UNSAFE_IVEC_2 = new Vector2i();
+	Vector3i UNSAFE_IVEC_3 = new Vector3i();
+	Vector4i UNSAFE_IVEC_4 = new Vector4i();
+
+	Vector2ic IVEC_2 = UNSAFE_IVEC_2;
+	Vector3ic IVEC_3 = UNSAFE_IVEC_3;
+	Vector4ic IVEC_4 = UNSAFE_IVEC_4;
+
+	Vector2L UNSAFE_LVEC_2 = new Vector2L();
+	Vector3L UNSAFE_LVEC_3 = new Vector3L();
+	Vector4L UNSAFE_LVEC_4 = new Vector4L();
+
+	Vector2Lc LVEC_2 = UNSAFE_LVEC_2;
+	Vector3Lc LVEC_3 = UNSAFE_LVEC_3;
+	Vector4Lc LVEC_4 = UNSAFE_LVEC_4;
 }

src/main/java/dev/latvian/mods/klib/math/Identity.java

@@ -7,37 +7,40 @@
 import net.minecraft.world.phys.HitResult;
 import net.minecraft.world.phys.Vec3;
 import org.jetbrains.annotations.Nullable;
+import org.joml.Vector2d;
+import org.joml.Vector2dc;
+import org.joml.Vector2f;
 import org.joml.Vector4d;
 import org.joml.Vector4f;
 
-public record WorldMouse(
+public record ProjectedCoordinates(
 	Minecraft mc,
 	Vec3 cameraPos,
 	float width,
 	float height,
-	Vec2d defaultScreenPos
+	Vector2dc defaultScreenPos
 ) {
-	public static WorldMouse of(Minecraft mc, Vec3 cameraPos) {
+	public static ProjectedCoordinates of(Minecraft mc, Vec3 cameraPos) {
 		var width = mc.getWindow().getGuiScaledWidth();
 		var height = mc.getWindow().getGuiScaledHeight();
 
-		return new WorldMouse(
+		return new ProjectedCoordinates(
 			mc,
 			cameraPos,
 			width,
 			height,
-			mc.screen == null ? new Vec2d(
+			mc.screen == null ? new Vector2d(
 				width * 0.5D,
 				height * 0.5D
-			) : new Vec2d(
+			) : new Vector2d(
 				mc.mouseHandler.xpos() * width / (double) mc.getWindow().getWidth(),
 				mc.mouseHandler.ypos() * height / (double) mc.getWindow().getHeight()
 			)
 		);
 	}
 
 	@Nullable
-	public Cursor clip(double maxDistance, ClipContext.Block blockClipContext, ClipContext.Fluid fluidClipContext, @Nullable Vec2d screenPos, @Nullable Entity clipEntity) {
+	public ClipPosition clip(double maxDistance, ClipContext.Block blockClipContext, ClipContext.Fluid fluidClipContext, @Nullable Vector2dc screenPos, @Nullable Entity clipEntity) {
 		if (screenPos == null) {
 			screenPos = defaultScreenPos;
 		}
@@ -63,16 +66,16 @@ public Cursor clip(double maxDistance, ClipContext.Block blockClipContext, ClipC
 			return null;
 		}
 
-		return new Cursor(hit);
+		return new ClipPosition(hit);
 	}
 
 	@Nullable
-	public Cursor clipOutline() {
+	public ClipPosition clipOutline() {
 		return clip(1000D, ClipContext.Block.OUTLINE, ClipContext.Fluid.ANY, null, null);
 	}
 
 	@Nullable
-	public Cursor clipCollision() {
+	public ClipPosition clipCollision() {
 		return clip(1000D, ClipContext.Block.COLLIDER, ClipContext.Fluid.SOURCE_ONLY, null, null);
 	}
 
@@ -86,7 +89,7 @@ public Cursor clipCollision() {
 	 * @return Screen coordinates, or null if outside the screen
 	 */
 	@Nullable
-	public Vec2f screen(double worldX, double worldY, double worldZ, boolean allowOutside) {
+	public Vector2f screen(double worldX, double worldY, double worldZ, boolean allowOutside) {
 		double rx = worldX - cameraPos.x;
 		double ry = worldY - cameraPos.y;
 		double rz = worldZ - cameraPos.z;
@@ -97,7 +100,7 @@ public Vec2f screen(double worldX, double worldY, double worldZ, boolean allowOu
 		v.div(v.w);
 
 		if (allowOutside || v.z > 0F && v.z < 1F) {
-			return new Vec2f(
+			return new Vector2f(
 				(0.5F + v.x * 0.5F) * width,
 				(0.5F - v.y * 0.5F) * height
 			);
@@ -110,34 +113,34 @@ public Vec2f screen(double worldX, double worldY, double worldZ, boolean allowOu
 	 * @param worldX X position
 	 * @param worldY Y position
 	 * @param worldZ Z position
-	 * @see WorldMouse#screen(double, double, double, boolean)
+	 * @see ProjectedCoordinates#screen(double, double, double, boolean)
 	 */
 	@Nullable
-	public Vec2f screen(double worldX, double worldY, double worldZ) {
+	public Vector2f screen(double worldX, double worldY, double worldZ) {
 		return screen(worldX, worldY, worldZ, false);
 	}
 
 	/**
 	 * @param worldPos     XYZ position
 	 * @param allowOutside Allow outside the screen
-	 * @see WorldMouse#screen(double, double, double, boolean)
+	 * @see ProjectedCoordinates#screen(double, double, double, boolean)
 	 */
 	@Nullable
-	public Vec2f screen(Position worldPos, boolean allowOutside) {
+	public Vector2f screen(Position worldPos, boolean allowOutside) {
 		return screen(worldPos.x(), worldPos.y(), worldPos.z(), allowOutside);
 	}
 
 	/**
 	 * @param worldPos XYZ position
-	 * @see WorldMouse#screen(double, double, double, boolean)
+	 * @see ProjectedCoordinates#screen(double, double, double, boolean)
 	 */
 	@Nullable
-	public Vec2f screen(Position worldPos) {
+	public Vector2f screen(Position worldPos) {
 		return screen(worldPos.x(), worldPos.y(), worldPos.z(), false);
 	}
 
 	/**
-	 * Convert screen coordinates to world position. Use {@link WorldMouse#clip(double, ClipContext.Block, ClipContext.Fluid, Vec2d, Entity)} if you only care about current mouse position
+	 * Convert screen coordinates to world position. Use {@link ProjectedCoordinates#clip(double, ClipContext.Block, ClipContext.Fluid, Vector2dc, Entity)} if you only care about current mouse position
 	 *
 	 * @param x screen coordinate x-position
 	 * @param y screen coordinate y-position