Merge pull request #348 from refinedmods/feat/GH-77/crafting-matrix-s…

…lot-filter feat: add crafting matrix item filter
refinedmods · Mar 4, 2023 · 672f3f2 · 672f3f2
2 parents 1ce1460 + 1967c8b
commit 672f3f2
Show file tree

Hide file tree

Showing 19 changed files with 153 additions and 37 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,8 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
     The keybinding is only available on Forge.
 -   A config option to clear items from the Crafting Grid crafting matrix to the player or network inventory.
 -   Support for collapsable entries for REI.
+-   Pressing CTRL + SHIFT on the crafting result slot filters the Grid view based on the items in the crafting matrix.
+    The reason for this is that you can quickly see how much you have left in the storage network.
 
 ### Changed
 

diff --git a/...orage2-grid-api/src/main/java/com/refinedmods/refinedstorage2/api/grid/view/GridView.java b/...orage2-grid-api/src/main/java/com/refinedmods/refinedstorage2/api/grid/view/GridView.java
@@ -35,8 +35,9 @@ public interface GridView {
 
     /**
      * @param predicate the filter
+     * @return the previous filtering predicate
      */
-    void setFilterAndSort(Predicate<GridResource> predicate);
+    Predicate<GridResource> setFilterAndSort(Predicate<GridResource> predicate);
 
     /**
      * Preventing sorting means that the changes will still arrive at the backing list and view list, but,

diff --git a/...e2-grid-api/src/main/java/com/refinedmods/refinedstorage2/api/grid/view/GridViewImpl.java b/...e2-grid-api/src/main/java/com/refinedmods/refinedstorage2/api/grid/view/GridViewImpl.java
@@ -70,9 +70,11 @@ public void setSortingType(final GridSortingType sortingType) {
     }
 
     @Override
-    public void setFilterAndSort(final Predicate<GridResource> predicate) {
+    public Predicate<GridResource> setFilterAndSort(final Predicate<GridResource> predicate) {
+        final Predicate<GridResource> previousPredicate = filter;
         this.filter = predicate;
         sort();
+        return previousPredicate;
     }
 
     @Override

diff --git a/...rid-api/src/test/java/com/refinedmods/refinedstorage2/api/grid/view/GridViewImplTest.java b/...rid-api/src/test/java/com/refinedmods/refinedstorage2/api/grid/view/GridViewImplTest.java
@@ -6,6 +6,7 @@
 
 import java.util.Comparator;
 import java.util.Optional;
+import java.util.function.Predicate;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -24,8 +25,8 @@ class GridViewImplTest {
     void setUp() {
         viewBuilder = new GridViewBuilderImpl(
             resourceAmount -> Optional.of(new GridResourceImpl(resourceAmount)),
-            (view) -> Comparator.comparing(GridResource::getName),
-            (view) -> Comparator.comparing(GridResource::getAmount)
+            view -> Comparator.comparing(GridResource::getName),
+            view -> Comparator.comparing(GridResource::getAmount)
         );
     }
 
@@ -149,6 +150,29 @@ void shouldInsertNewResource() {
         verify(listener, times(1)).run();
     }
 
+    @Test
+    void shouldSetFilterAndSort() {
+        // Arrange
+        final GridView view = viewBuilder
+            .withResource("A", 10, null)
+            .withResource("B", 10, null)
+            .build();
+
+        final Predicate<GridResource> filterA = resource -> resource.getName().equals("A");
+        final Predicate<GridResource> filterB = resource -> resource.getName().equals("B");
+
+        // Act
+        final Predicate<GridResource> previousFilter1 = view.setFilterAndSort(filterA);
+        final Predicate<GridResource> previousFilter2 = view.setFilterAndSort(filterB);
+
+        // Assert
+        assertThat(previousFilter1).isNotNull();
+        assertThat(previousFilter2).isEqualTo(filterA);
+        assertThat(view.getViewList()).usingRecursiveFieldByFieldElementComparator().containsExactly(
+            new GridResourceImpl("B", 10)
+        );
+    }
+
     @Test
     void shouldNotInsertNewResourceWhenFilteringProhibitsIt() {
         // Arrange

diff --git a/...nedmods/refinedstorage2/platform/common/containermenu/grid/CraftingGridContainerMenu.java b/...nedmods/refinedstorage2/platform/common/containermenu/grid/CraftingGridContainerMenu.java
@@ -1,12 +1,18 @@
 package com.refinedmods.refinedstorage2.platform.common.containermenu.grid;
 
+import com.refinedmods.refinedstorage2.api.grid.view.GridResource;
 import com.refinedmods.refinedstorage2.api.resource.list.ResourceList;
 import com.refinedmods.refinedstorage2.platform.api.resource.ItemResource;
 import com.refinedmods.refinedstorage2.platform.common.block.entity.grid.CraftingGridBlockEntity;
 import com.refinedmods.refinedstorage2.platform.common.content.Menus;
+import com.refinedmods.refinedstorage2.platform.common.internal.grid.view.ItemGridResource;
 
+import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 import java.util.function.Consumer;
+import java.util.function.Predicate;
 import javax.annotation.Nullable;
 
 import net.minecraft.network.FriendlyByteBuf;
@@ -21,9 +27,12 @@ public class CraftingGridContainerMenu extends AbstractGridContainerMenu {
 
     private final Player player;
     private final CraftingGridSource source;
+    private final List<Slot> craftingMatrixSlots = new ArrayList<>();
 
     @Nullable
     private Consumer<Boolean> activenessListener;
+    @Nullable
+    private Predicate<GridResource> filterBeforeFilteringBasedOnCraftingMatrixItems;
 
     public CraftingGridContainerMenu(final int syncId, final Inventory playerInventory, final FriendlyByteBuf buf) {
         super(Menus.INSTANCE.getCraftingGrid(), syncId, playerInventory, buf);
@@ -72,13 +81,14 @@ public ItemStack quickMoveStack(final Player actor, final int slotIndex) {
     @Override
     public void addSlots(final int playerInventoryY) {
         super.addSlots(playerInventoryY);
+        craftingMatrixSlots.clear();
         for (int y = 0; y < 3; ++y) {
             for (int x = 0; x < 3; ++x) {
                 final int slotX = 26 + ((x % 3) * 18);
                 final int slotY = playerInventoryY
                     - Y_OFFSET_BETWEEN_PLAYER_INVENTORY_AND_FIRST_CRAFTING_MATRIX_SLOT
                     + ((y % 3) * 18);
-                addSlot(new Slot(source.getCraftingMatrix(), x + y * 3, slotX, slotY));
+                craftingMatrixSlots.add(addSlot(new Slot(source.getCraftingMatrix(), x + y * 3, slotX, slotY)));
             }
         }
         addSlot(new CraftingGridResultSlot(
@@ -89,6 +99,10 @@ public void addSlots(final int playerInventoryY) {
         ));
     }
 
+    public List<Slot> getCraftingMatrixSlots() {
+        return craftingMatrixSlots;
+    }
+
     public void clear(final boolean toPlayerInventory) {
         source.clearMatrix(player, toPlayerInventory);
     }
@@ -113,4 +127,32 @@ private void addContainerToList(final Container container, final ResourceList<Ob
     public void transferRecipe(final List<List<ItemResource>> recipe) {
         source.transferRecipe(player, recipe);
     }
+
+    public void filterBasedOnCraftingMatrixItems() {
+        final Set<ItemResource> craftingMatrixItems = getCraftingMatrixItems();
+        filterBeforeFilteringBasedOnCraftingMatrixItems = getView().setFilterAndSort(
+            gridResource -> gridResource instanceof ItemGridResource itemGridResource
+                && craftingMatrixItems.contains(itemGridResource.getResource())
+        );
+    }
+
+    private Set<ItemResource> getCraftingMatrixItems() {
+        final Set<ItemResource> craftingMatrixItems = new HashSet<>();
+        for (int i = 0; i < source.getCraftingMatrix().getContainerSize(); ++i) {
+            final ItemStack craftingMatrixStack = source.getCraftingMatrix().getItem(i);
+            if (craftingMatrixStack.isEmpty()) {
+                continue;
+            }
+            craftingMatrixItems.add(ItemResource.ofItemStack(craftingMatrixStack));
+        }
+        return craftingMatrixItems;
+    }
+
+    public void stopFilteringBasedOnCraftingMatrixItems() {
+        if (filterBeforeFilteringBasedOnCraftingMatrixItems == null) {
+            return;
+        }
+        getView().setFilterAndSort(filterBeforeFilteringBasedOnCraftingMatrixItems);
+        filterBeforeFilteringBasedOnCraftingMatrixItems = null;
+    }
 }
diff --git a/...ommon/src/main/java/com/refinedmods/refinedstorage2/platform/common/content/ColorMap.java b/...ommon/src/main/java/com/refinedmods/refinedstorage2/platform/common/content/ColorMap.java
@@ -7,7 +7,6 @@
 import java.util.function.BiConsumer;
 import java.util.function.Function;
 import java.util.function.Supplier;
-import java.util.stream.Collectors;
 
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.chat.MutableComponent;
@@ -62,7 +61,7 @@ public T getDefault() {
     }
 
     public Collection<T> values() {
-        return map.values().stream().map(Supplier::get).collect(Collectors.toList());
+        return map.values().stream().map(Supplier::get).toList();
     }
 
     private record ColoredSorter<T>(DyeColor defaultColor) implements Comparator<Map.Entry<DyeColor, T>> {

diff --git a/...edstorage2/platform/common/integration/recipemod/jei/GridResourceIngredientConverter.java b/...edstorage2/platform/common/integration/recipemod/jei/GridResourceIngredientConverter.java
@@ -27,9 +27,9 @@ public Optional<Object> convertToIngredient(final Object resource) {
         }
         if (resource instanceof FluidGridResource fluidGridResource) {
             return Optional.of(fluidHelper.create(
-                fluidGridResource.getFluidResource().fluid(),
+                fluidGridResource.getResource().fluid(),
                 fluidHelper.bucketVolume(),
-                fluidGridResource.getFluidResource().tag()
+                fluidGridResource.getResource().tag()
             ));
         }
         return Optional.empty();

diff --git a/.../refinedmods/refinedstorage2/platform/common/internal/grid/view/AbstractGridResource.java b/.../refinedmods/refinedstorage2/platform/common/internal/grid/view/AbstractGridResource.java
@@ -25,9 +25,13 @@ protected AbstractGridResource(final ResourceAmount<T> resourceAmount,
         this.attributes = attributes;
     }
 
+    public T getResource() {
+        return resourceAmount.getResource();
+    }
+
     @Override
     public Optional<TrackedResource> getTrackedResource(final GridView view) {
-        return view.getTrackedResource(resourceAmount.getResource());
+        return view.getTrackedResource(getResource());
     }
 
     @Override

diff --git a/...s/refinedstorage2/platform/common/internal/grid/view/AbstractItemGridResourceFactory.java b/...s/refinedstorage2/platform/common/internal/grid/view/AbstractItemGridResourceFactory.java
@@ -43,7 +43,7 @@ public Optional<GridResource> apply(final ResourceAmount<?> resourceAmount) {
 
     private String getTooltip(final ItemStack itemStack) {
         return itemStack
-            .getTooltipLines(null, TooltipFlag.Default.ADVANCED)
+            .getTooltipLines(null, TooltipFlag.ADVANCED)
             .stream()
             .map(Component::getString)
             .collect(Collectors.joining("\n"));

diff --git a/...com/refinedmods/refinedstorage2/platform/common/internal/grid/view/FluidGridResource.java b/...com/refinedmods/refinedstorage2/platform/common/internal/grid/view/FluidGridResource.java
@@ -39,10 +39,6 @@ public FluidGridResource(final ResourceAmount<FluidResource> resourceAmount,
         this.fluidResource = resourceAmount.getResource();
     }
 
-    public FluidResource getFluidResource() {
-        return fluidResource;
-    }
-
     @Override
     public int getRegistryId() {
         return id;

diff --git a/.../java/com/refinedmods/refinedstorage2/platform/common/screen/grid/AbstractGridScreen.java b/.../java/com/refinedmods/refinedstorage2/platform/common/screen/grid/AbstractGridScreen.java
@@ -58,11 +58,11 @@ public abstract class AbstractGridScreen<T extends AbstractGridContainerMenu> ex
     private static final List<String> SEARCH_FIELD_HISTORY = new ArrayList<>();
 
     protected final int bottomHeight;
+    @Nullable
+    protected GridSearchBoxWidget searchField;
 
     @Nullable
     private ScrollbarWidget scrollbar;
-    @Nullable
-    private GridSearchBoxWidget searchField;
     private int totalRows;
     private int visibleRows;
     private int gridSlotNumber;

diff --git a/.../java/com/refinedmods/refinedstorage2/platform/common/screen/grid/CraftingGridScreen.java b/.../java/com/refinedmods/refinedstorage2/platform/common/screen/grid/CraftingGridScreen.java
@@ -2,10 +2,12 @@
 
 import com.refinedmods.refinedstorage2.platform.common.Platform;
 import com.refinedmods.refinedstorage2.platform.common.containermenu.grid.CraftingGridContainerMenu;
+import com.refinedmods.refinedstorage2.platform.common.containermenu.grid.CraftingGridResultSlot;
 import com.refinedmods.refinedstorage2.platform.common.content.KeyMappings;
 
 import javax.annotation.Nullable;
 
+import com.mojang.blaze3d.vertex.PoseStack;
 import net.minecraft.ChatFormatting;
 import net.minecraft.client.KeyMapping;
 import net.minecraft.client.gui.components.ImageButton;
@@ -14,6 +16,7 @@
 import net.minecraft.network.chat.MutableComponent;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.entity.player.Inventory;
+import net.minecraft.world.inventory.Slot;
 
 import static com.refinedmods.refinedstorage2.platform.common.util.IdentifierUtil.createIdentifier;
 
@@ -24,6 +27,8 @@ public class CraftingGridScreen extends AbstractGridScreen<CraftingGridContainer
     @Nullable
     private ImageButton clearToNetworkButton;
 
+    private boolean filteringBasedOnCraftingMatrixItems;
+
     public CraftingGridScreen(final CraftingGridContainerMenu menu, final Inventory inventory, final Component title) {
         super(menu, inventory, title, 156);
         this.inventoryLabelY = 134;
@@ -46,6 +51,48 @@ protected void init() {
         addRenderableWidget(createClearButton(clearToInventoryButtonX, clearButtonY, 249, true));
     }
 
+    @Override
+    protected void renderBg(final PoseStack poseStack, final float delta, final int mouseX, final int mouseY) {
+        super.renderBg(poseStack, delta, mouseX, mouseY);
+        if (filteringBasedOnCraftingMatrixItems) {
+            renderCraftingMatrixFilteringHighlights(poseStack);
+        }
+    }
+
+    private void renderCraftingMatrixFilteringHighlights(final PoseStack poseStack) {
+        for (final Slot slot : getMenu().getCraftingMatrixSlots()) {
+            if (!slot.hasItem()) {
+                continue;
+            }
+            renderCraftingMatrixFilteringHighlight(poseStack, slot);
+        }
+    }
+
+    private void renderCraftingMatrixFilteringHighlight(final PoseStack poseStack, final Slot slot) {
+        blit(poseStack, leftPos + slot.x - 1, topPos + slot.y - 1, 224, 238, 18, 18);
+    }
+
+    @Override
+    protected void containerTick() {
+        super.containerTick();
+        final boolean mayFilterOnCraftingMatrixItems = hoveredSlot instanceof CraftingGridResultSlot
+            && hasShiftDown()
+            && hasControlDown();
+        if (mayFilterOnCraftingMatrixItems && !filteringBasedOnCraftingMatrixItems) {
+            filteringBasedOnCraftingMatrixItems = true;
+            getMenu().filterBasedOnCraftingMatrixItems();
+            if (searchField != null) {
+                searchField.setEditable(false);
+            }
+        } else if (!mayFilterOnCraftingMatrixItems && filteringBasedOnCraftingMatrixItems) {
+            getMenu().stopFilteringBasedOnCraftingMatrixItems();
+            filteringBasedOnCraftingMatrixItems = false;
+            if (searchField != null) {
+                searchField.setEditable(true);
+            }
+        }
+    }
+
     private void setClearToNetworkButtonActive(final boolean active) {
         if (clearToNetworkButton == null) {
             return;

diff --git a/...common/src/main/resources/assets/refinedstorage2/textures/gui/crafting_grid.png b/...common/src/main/resources/assets/refinedstorage2/textures/gui/crafting_grid.png
diff --git a/...efinedstorage2/platform/fabric/integration/recipemod/rei/CraftingGridTransferHandler.java b/...efinedstorage2/platform/fabric/integration/recipemod/rei/CraftingGridTransferHandler.java
@@ -100,16 +100,16 @@ private TransferHandlerRenderer createMissingItemsRenderer(final MissingIngredie
         return (matrices, mouseX, mouseY, delta, widgets, bounds, display) -> {
             int index = 0;
             for (final Widget widget : widgets) {
-                if (widget instanceof Slot slot && slot.getNoticeMark() == Slot.INPUT) {
-                    if (missingIngredients.isMissing(index++)) {
-                        renderMissingOverlay(matrices, slot);
-                    }
+                if (widget instanceof Slot slot
+                    && slot.getNoticeMark() == Slot.INPUT
+                    && missingIngredients.isMissing(index++)) {
+                    renderMissingItemOverlay(matrices, slot);
                 }
             }
         };
     }
 
-    private void renderMissingOverlay(final PoseStack poseStack, final Slot slot) {
+    private void renderMissingItemOverlay(final PoseStack poseStack, final Slot slot) {
         poseStack.pushPose();
         poseStack.translate(0, 0, 400);
         final Rectangle innerBounds = slot.getInnerBounds();

diff --git a/...edstorage2/platform/fabric/integration/recipemod/rei/GridResourceIngredientConverter.java b/...edstorage2/platform/fabric/integration/recipemod/rei/GridResourceIngredientConverter.java
@@ -22,9 +22,9 @@ public Optional<Object> convertToIngredient(final Object resource) {
         }
         if (resource instanceof FluidGridResource fluidGridResource) {
             final FluidStack fluidStack = FluidStack.create(
-                fluidGridResource.getFluidResource().fluid(),
+                fluidGridResource.getResource().fluid(),
                 FluidStack.bucketAmount(),
-                fluidGridResource.getFluidResource().tag()
+                fluidGridResource.getResource().tag()
             );
             return Optional.of(EntryStacks.of(fluidStack));
         }

diff --git a/...ava/com/refinedmods/refinedstorage2/platform/fabric/render/FluidVariantFluidRenderer.java b/...ava/com/refinedmods/refinedstorage2/platform/fabric/render/FluidVariantFluidRenderer.java
@@ -42,8 +42,8 @@ public List<Component> getTooltip(final FluidResource fluidResource) {
         return FluidVariantRendering.getTooltip(
             getFluidVariantFromCache(fluidResource),
             Minecraft.getInstance().options.advancedItemTooltips
-                ? TooltipFlag.Default.ADVANCED
-                : TooltipFlag.Default.NORMAL
+                ? TooltipFlag.ADVANCED
+                : TooltipFlag.NORMAL
         );
     }
 }