Implement meshlet-gen algorithm

* eb82518 Better parameters (tttsaurus)
* 1ab177f le algorithm (tttsaurus)
* 63ad4ba Meshlet-gen helper method setup (tttsaurus)
* 263f1fe Start over (tttsaurus)
* ecac10a Fix some issues with KDTree building/deletion/KNN (#477) (jchung01)
* 6f51422 Draw meshlet overlap warning (tttsaurus)
* 4745bd1 Better logging (tttsaurus)
* 4f1eb48 Meshlet-gen visualized test env setup (tttsaurus)
* eb3fd71 Re-added faces to Block (Kuba663)
* e6d9984 Merge remote-tracking branch 'origin/proposal/render-system-meshlet' into proposal/render-system-meshlet (Kuba663)
* 37d5046 Re-added faces to Block (Kuba663)
* 73e2a49 Merge remote-tracking branch 'origin/proposal/render-system-meshlet' into proposal/render-system-meshlet (tttsaurus)
* d376a07 Meshlet-gen test setup (tttsaurus)
* d00ae9a Move all the block queries to a single place to reduce latency. (Kuba663)
* 1ae1876 Fix a ecs-component flattening npe issue (tttsaurus)
* b8e808d Merge branch 'proposal/render-system' into proposal/render-system-meshlet (tttsaurus)
* c563cfe Fixed the broken algorithm written by a retard (me) (Kuba663)
* 4cdf487 Fixed errors in kD-tree (Kuba663)
* ca8e4f9 what? (Kuba663)
* 8ed71c4 Band-aid solution before the median is fixed (Kuba663)
* dee6f19 kD-Tree construction test. (Kuba663)
* ad7aa29 Added preconditions to every median related function to make finding errors easier. (Kuba663)
* 5e47b49 Added a limited size random probe to the median to reduce lag. (Kuba663)
* dbcffcc More extensive median testing (Kuba663)
* 36d686e Attempted to fix the median (Kuba663)
* 95d1e08 Better looking debug visuals (tttsaurus)
* 64c0a01 Update GizmosManager to draw block faces (tttsaurus)
* 218014d Separated Meshlets into transparent and opaque (Kuba663)
* 6f67be5 Quantile Utils Tests (Kuba663)
* 7e88ec8 Mild mistake in unused function (Kuba663)
* d298fc1 Merge remote-tracking branch 'origin/proposal/render-system-meshlet' into proposal/render-system-meshlet (Kuba663)
* 33821d1 Fixed absurd median mistake (Kuba663)
* 99ee070 Meshlet algorithm test env setup (tttsaurus)
* 3d37b3b Merge branch 'proposal/render-system' into proposal/render-system-meshlet (tttsaurus)
* bbbedf6 Moved the sub-chunk division into the system for threadmaxxing (Kuba663)
* e30395d Remove unchanged chunks from the algorithm (Kuba663)
* 01280f4 kD-tree deletion test (Kuba663)
* 8b26d96 Remove Octree as it's not necessary anymore (Kuba663)
* 8ad051f Avoid call EntityManager#flush manually (tttsaurus)
* 6b05a18 Remove stray TODO (Kuba663)
* 0be8f2e Errors fixed (Kuba663)
* 8a4a2f1 Merge branch 'CleanroomMC:proposal/render-system' into proposal/render-system (Eerie)
* d4b75aa Forgot I have to flush (Kuba663)
* 2b6ddbc Create Entities (Kuba663)
* ac2214a Function to set values in MeshletComponent (Kuba663)
* 44f8d38 Remove unused imports (Kuba663)
* e018a8a Switch set to list (Kuba663)
* c302ad8 Normal getter function (Kuba663)
* d3e4674 Incomplete chunk meshlet entity creation (misclicked and commited with the same message twice) (Kuba663)
* 72a652c Transfer of Blocks from Meshlet to a Set to be used in MeshletComponent (Kuba663)
* 3637d4a Removed faces from Block (maybe temporarily) (Kuba663)
* 2021987 Meshlet clustering (Kuba663)
* d7948a8 Selection of optimal starting points for Meshlet building (Kuba663)
* cab3c82 k-nearest neighbour search test (Kuba663)
* 18d8835 buildKDTree (Kuba663)
* 9892112 Altered the knn function for easier vector lookups (Kuba663)
* b07b6f4 Expanding Meshlet bounding box (Kuba663)
* 4ae0b1c Replace magic number bitmasks with variables (Kuba663)
* 7326639 Move FSM tests to it's own package (Kuba663)
* 6384324 kD-tree point deletion (Kuba663)
* be32697 kD-tree rewrite (Kuba663)
* ec6cd56 Mistake (Kuba663)
* 707ff5e Make Meshlet Comparable for utility (Kuba663)
* f168d2b Use vectors instead of numbers you retard (Kuba663)
* 3374474 Forgot this was a thing (IntelliJ does not commit file content) (Kuba663)
* 1ad931b Meshlet class for operations in system + package rename (Kuba663)
* 4f79acb getChildren function (Kuba663)
* b432340 Forgot something in the KDTree (Kuba663)
* 746d815 Adding fields to the MeshletComponent (Kuba663)
* 94347c4 Fix (Kuba663)
* e35aca5 Fix (Kuba663)
* e132650 Building the k-d tree (Kuba663)
* a824648 isEmpty on KDTree (Kuba663)
* 50fe384 Documentation on compress (Kuba663)
* 2ce0320 k-d tree (Kuba663)
* cfb70ba Median of medians (Kuba663)
* 9a01610 Median of medians (Kuba663)
* 658c194 Not sure about bitfields being available for CleanStructs (Kuba663)
* ea3fd89 Fix warnings (Kuba663)
* e71e62e Octree implementation (Kuba663)
* fbfd327 Block CleanStruct (Kuba663)

Author: tttsaurus

src/main/java/com/cleanroommc/kirino/KirinoCore.java

@@ -172,7 +172,7 @@ public static void updateAndRender(long finishTimeNano) {
         //</editor-fold>
 
         KIRINO_ENGINE.renderingCoordinator.update();
-//        KIRINO_ENGINE.renderingCoordinator.updateWorld(MINECRAFT.world);
+        KIRINO_ENGINE.renderingCoordinator.updateWorld(MINECRAFT.world);
 //        KIRINO_ENGINE.renderingCoordinator.runChunkPass();
 
         //<editor-fold desc="vanilla logic">

src/main/java/com/cleanroommc/kirino/ecs/component/ComponentRegistry.java

@@ -10,6 +10,7 @@
 import com.google.common.collect.BiMap;
 import com.google.common.collect.HashBiMap;
 import com.google.common.collect.ImmutableMap;
+import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
 
 import java.util.*;
@@ -317,7 +318,8 @@ public ICleanComponent newComponent(String name, Object... args) {
     // -----Component Deconstruction-----
 
     @SuppressWarnings("DataFlowIssue")
-    public Object[] flattenComponent(ICleanComponent component) {
+    public @NonNull Object[] flattenComponent(@NonNull ICleanComponent component) {
+        Preconditions.checkNotNull(component);
         Preconditions.checkArgument(componentExists(component.getClass()),
                 "Component class %s isn't registered.", component.getClass().getName());
 

src/main/java/com/cleanroommc/kirino/ecs/component/schema/def/field/FieldRegistry.java

@@ -1,12 +1,15 @@
 package com.cleanroommc.kirino.ecs.component.schema.def.field;
 
+import com.cleanroommc.kirino.KirinoCore;
 import com.cleanroommc.kirino.ecs.component.schema.def.field.scalar.ScalarConstructor;
 import com.cleanroommc.kirino.ecs.component.schema.def.field.scalar.ScalarDeconstructor;
 import com.cleanroommc.kirino.ecs.component.schema.def.field.struct.StructRegistry;
+import com.cleanroommc.kirino.engine.render.geometry.AABB;
 import com.cleanroommc.kirino.utils.TypeUtils;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.BiMap;
 import com.google.common.collect.HashBiMap;
+import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
 
 import java.util.HashMap;
@@ -109,10 +112,15 @@ public Object newField(String name, Object... args) {
     // -----Field Deconstruction-----
 
     @SuppressWarnings("DataFlowIssue")
-    public Object[] flattenField(Object fieldInstance) {
-        // force primitive types cuz we use primitive types by default
-        // see CleanECSRuntime's constructor
-        Class<?> fieldClass = TypeUtils.toPrimitive(fieldInstance.getClass());
+    public @NonNull Object[] flattenField(@NonNull Object fieldInstance) {
+        Preconditions.checkNotNull(fieldInstance);
+
+        Class<?> fieldClass = fieldInstance.getClass();
+        if (TypeUtils.isWrappedPrimitive(fieldClass)) {
+            // force primitive types cuz we use primitive types by default
+            // see CleanECSRuntime's constructor
+            fieldClass = TypeUtils.toPrimitive(fieldInstance.getClass());
+        }
 
         Preconditions.checkArgument(fieldTypeExists(fieldClass),
                 "Field class %s isn't registered.", fieldInstance.getClass().getName());

src/main/java/com/cleanroommc/kirino/ecs/component/schema/def/field/scalar/ScalarDeconstructor.java

@@ -8,8 +8,9 @@ public final class ScalarDeconstructor {
     private ScalarDeconstructor() {
     }
 
-    public static Object[] flattenScalar(@NonNull ScalarType scalarType, @NonNull Object scalarInstance) {
-        Preconditions.checkNotNull(scalarInstance, "Scalar instance is null.");
+    public static @NonNull Object[] flattenScalar(@NonNull ScalarType scalarType, @NonNull Object scalarInstance) {
+        Preconditions.checkNotNull(scalarType);
+        Preconditions.checkNotNull(scalarInstance);
 
         switch (scalarType) {
             case INT -> {

src/main/java/com/cleanroommc/kirino/ecs/component/schema/def/field/struct/StructRegistry.java

@@ -12,6 +12,7 @@
 import com.google.common.collect.BiMap;
 import com.google.common.collect.HashBiMap;
 import com.google.common.collect.ImmutableMap;
+import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
 
 import java.util.*;
@@ -325,7 +326,8 @@ public Object newStruct(String name, Object... args) {
     // -----Struct Deconstruction-----
 
     @SuppressWarnings("DataFlowIssue")
-    public Object[] flattenStruct(Object structInstance) {
+    public @NonNull Object[] flattenStruct(@NonNull Object structInstance) {
+        Preconditions.checkNotNull(structInstance);
         Preconditions.checkArgument(structTypeExists(structInstance.getClass()),
                 "Struct class %s isn't registered.", structInstance.getClass().getName());
 

src/main/java/com/cleanroommc/kirino/ecs/entity/EntityManager.java

@@ -67,6 +67,13 @@ public EntityQuery newQuery() {
         return result;
     }
 
+    // test only for now
+    public synchronized void abort() {
+        synchronized (commandBuffer) {
+            commandBuffer.clear();
+        }
+    }
+
     /**
      * Consume all buffered commands.
      * </br></br>

src/main/java/com/cleanroommc/kirino/ecs/job/JobRegistry.java

@@ -69,8 +69,8 @@ public void registerParallelJob(Class<? extends IParallelJob> clazz) {
         for (Field field : clazz.getDeclaredFields()) {
             // scan JobDataQuery
             if (field.isAnnotationPresent(JobDataQuery.class) && !Modifier.isStatic(field.getModifiers())) {
-                if (!IPrimitiveArray.class.isAssignableFrom(field.getType())) {
-                    throw new RuntimeException(exceptionText, new IllegalStateException("INativeArray must be assignable from the JobDataQuery-annotated field " + field.getName() + "."));
+                if (IPrimitiveArray.class != field.getType()) {
+                    throw new RuntimeException(exceptionText, new IllegalStateException("IPrimitiveArray must be the type of the JobDataQuery-annotated field " + field.getName() + "."));
                 }
 
                 JobDataQuery jobDataQuery = field.getAnnotation(JobDataQuery.class);

src/main/java/com/cleanroommc/kirino/ecs/job/JobScheduler.java

@@ -6,6 +6,7 @@
 import com.cleanroommc.kirino.ecs.storage.ArchetypeDataPool;
 import com.cleanroommc.kirino.ecs.storage.ArrayRange;
 import com.cleanroommc.kirino.ecs.storage.IPrimitiveArray;
+import com.google.common.base.Preconditions;
 import org.jspecify.annotations.Nullable;
 
 import java.util.ArrayList;
@@ -29,6 +30,16 @@ public void executeParallel(EntityManager entityManager, Class<? extends IParall
             throw new IllegalStateException("Parallel job class " + clazz.getName() + " isn't registered.");
         }
 
+        if (!parallelJobExternalDataQueries.isEmpty()) {
+            Preconditions.checkArgument(externalData != null,
+                    "Argument \"externalData\" must not be null since there are %d external data queries.", parallelJobExternalDataQueries.size());
+
+            for (String key : parallelJobExternalDataQueries.keySet()) {
+                Preconditions.checkArgument(externalData.containsKey(key),
+                        "Missing the entry \"%s\" from \"externalData\".", key);
+            }
+        }
+
         EntityQuery query = entityManager.newQuery();
         ((IParallelJob) instantiator.instantiate()).query(query);
         List<ArchetypeDataPool> archetypes = entityManager.startQuery(query);

src/main/java/com/cleanroommc/kirino/engine/render/RenderingCoordinator.java

@@ -98,9 +98,6 @@ public RenderingCoordinator(EventBus eventBus, Logger logger, CleanECSRuntime ec
 
         stateBackup = new GLStateBackup();
 
-        scene = new MinecraftScene(ecsRuntime.entityManager, ecsRuntime.jobScheduler);
-        camera = new MinecraftCamera();
-
         cullingPatch = new MinecraftCulling();
         entityRenderingPatch = new MinecraftEntityRendering(cullingPatch);
         tesrRenderingPatch = new MinecraftTESRRendering(cullingPatch);
@@ -126,6 +123,9 @@ public RenderingCoordinator(EventBus eventBus, Logger logger, CleanECSRuntime ec
 
         gizmosManager = new GizmosManager(graphicResourceManager);
 
+        scene = new MinecraftScene(ecsRuntime.entityManager, ecsRuntime.jobScheduler, gizmosManager);
+        camera = new MinecraftCamera();
+
 //        stagingBufferManager.genPersistentBuffers("default", 256, 256);
 
         ShaderProgram shaderProgram = shaderRegistry.newShaderProgram("forge:shaders/gizmos.vert", "forge:shaders/gizmos.frag");

src/main/java/com/cleanroommc/kirino/engine/render/geometry/Block.java

@@ -0,0 +1,96 @@
+package com.cleanroommc.kirino.engine.render.geometry;
+
+import com.cleanroommc.kirino.ecs.component.scan.CleanStruct;
+import org.joml.Vector3i;
+
+@CleanStruct
+public class Block {
+    public Vector3i position;
+    public int faceMask;
+
+    public Block() {
+        position = new Vector3i();
+        faceMask = 0b111111;
+    }
+
+    public Block(int x, int y, int z, int faceMask) {
+        position = new Vector3i(x, y, z);
+        this.faceMask = faceMask;
+    }
+
+    /**
+     * <p>Compresses the block rendering record into an integer</p>
+     * <p>
+     *     The integer is formatted as: <table>
+     *         <tr>
+     *             <th>17</th>
+     *             <th>16</th>
+     *             <th>15</th>
+     *             <th>14</th>
+     *             <th>13</th>
+     *             <th>12</th>
+     *             <th>11</th>
+     *             <th>10</th>
+     *             <th>9</th>
+     *             <th>8</th>
+     *             <th>7</th>
+     *             <th>6</th>
+     *             <th>5</th>
+     *             <th>4</th>
+     *             <th>3</th>
+     *             <th>2</th>
+     *             <th>1</th>
+     *             <th>0</th>
+     *         </tr>
+     *         <tr>
+     *             <th>z</th>
+     *             <th>z</th>
+     *             <th>z</th>
+     *             <th>z</th>
+     *             <th>y</th>
+     *             <th>y</th>
+     *             <th>y</th>
+     *             <th>y</th>
+     *             <th>x</th>
+     *             <th>x</th>
+     *             <th>x</th>
+     *             <th>x</th>
+     *             <th>f</th>
+     *             <th>f</th>
+     *             <th>f</th>
+     *             <th>f</th>
+     *             <th>f</th>
+     *             <th>f</th>
+     *         </tr>
+     *     </table>
+     * </p>
+     * <p>
+     *     Where:
+     *     <table>
+     *         <tr>
+     *             <th>x</th>
+     *             <th>the x position of the block in the 16x16x16 cutout of the chunk</th>
+     *         </tr>
+     *         <tr>
+     *             <th>y</th>
+     *             <th>the y position of the block in the 16x16x16 cutout of the chunk</th>
+     *         </tr>
+     *         <tr>
+     *             <th>z</th>
+     *             <th>the z position of the block in the 16x16x16 cutout of the chunk</th>
+     *         </tr>
+     *         <tr>
+     *             <th>f</th>
+     *             <th>A bitfield of the sides to be rendered. From the right in order:
+     *             Down, Up, North, South, West, East</th>
+     *         </tr>
+     *     </table>
+     * </p>
+     * @return The integer as described above
+     */
+    int compress() {
+        return (position.x & 0b1111) << 14
+                | (position.y & 0b1111) << 10
+                | (position.z & 0b1111) << 6;
+    }
+}