IModelData support (#189)

* Add IModelData

* Make IModelData a separate package

tesselateSmooth & tesselateFlat

* Fix MixinBlockRenderManager

* Impl MixinChunkRenderer

* Code clean up

* Fix license

* Patch ChunkRenderTask, IModelData supplier done

* Impl IForgeBakedModel.getParticleTexture and isAmbientOcclusion

* Finalize IModelData and IForgeBakedModel for 1.14.4

* Add comments and fix a naming problem

Author: rikka0w0

patchwork-extensions-bakedmodel/build.gradle

@@ -0,0 +1,7 @@
+archivesBaseName = "patchwork-extensions-bakedmodel"
+version = getSubprojectVersion(project, "0.1.0")
+
+dependencies {
+	implementation project(path: ':patchwork-api-base', configuration: 'dev')
+	implementation project(path: ':patchwork-extensions-blockentity', configuration: 'dev')
+}

patchwork-extensions-bakedmodel/src/main/java/net/minecraftforge/client/extensions/IForgeBakedModel.java

@@ -0,0 +1,64 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.client.extensions;
+
+import java.util.List;
+import java.util.Random;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+import net.minecraftforge.client.model.data.IModelData;
+
+import net.minecraft.block.BlockState;
+import net.minecraft.client.render.model.BakedModel;
+import net.minecraft.client.render.model.BakedQuad;
+import net.minecraft.client.texture.Sprite;
+import net.minecraft.util.math.BlockPos;
+import net.minecraft.util.math.Direction;
+import net.minecraft.world.BlockRenderView;
+
+/**
+ * Forge makes every BakeModel including vanilla BakedModels extend this interface.
+ * The handlePerspective and doesHandlePerspectives callback will be supported in a separated package.
+ */
+public interface IForgeBakedModel {
+	default BakedModel getBakedModel() {
+		return (BakedModel) this;
+	}
+
+	@Nonnull
+	default List<BakedQuad> getQuads(@Nullable BlockState state, @Nullable Direction side, @Nonnull Random rand, @Nonnull IModelData extraData) {
+		return getBakedModel().getQuads(state, side, rand);
+	}
+
+	default boolean isAmbientOcclusion(BlockState state) {
+		return getBakedModel().useAmbientOcclusion();
+	}
+
+	@Nonnull
+	default IModelData getModelData(@Nonnull BlockRenderView world, @Nonnull BlockPos pos, @Nonnull BlockState state, @Nonnull IModelData tileData) {
+		return tileData;
+	}
+
+	default Sprite getParticleTexture(@Nonnull IModelData data) {
+		return getBakedModel().getSprite();
+	}
+}

patchwork-extensions-bakedmodel/src/main/java/net/minecraftforge/client/model/ModelDataManager.java

@@ -0,0 +1,117 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.client.model;
+
+import java.lang.ref.WeakReference;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+
+import javax.annotation.Nullable;
+
+import com.google.common.base.Preconditions;
+import net.minecraftforge.client.model.data.IModelData;
+
+import net.minecraft.block.entity.BlockEntity;
+import net.minecraft.client.MinecraftClient;
+import net.minecraft.client.world.ClientWorld;
+import net.minecraft.util.math.BlockPos;
+import net.minecraft.util.math.ChunkPos;
+import net.minecraft.world.World;
+import net.minecraft.world.chunk.WorldChunk;
+
+import net.fabricmc.api.ClientModInitializer;
+import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientChunkEvents;
+
+import net.patchworkmc.impl.extensions.bakedmodel.ForgeModelDataProvider;
+
+public class ModelDataManager implements ClientModInitializer {
+	private static WeakReference<World> currentWorld = new WeakReference<>(null);
+
+	private static final Map<ChunkPos, Set<BlockPos>> needModelDataRefresh = new ConcurrentHashMap<>();
+
+	private static final Map<ChunkPos, Map<BlockPos, IModelData>> modelDataCache = new ConcurrentHashMap<>();
+
+	private static void cleanCaches(World world) {
+		Preconditions.checkNotNull(world, "World must not be null");
+		Preconditions.checkArgument(world == MinecraftClient.getInstance().world,
+				"Cannot use model data for a world other than the current client world");
+		if (world != currentWorld.get()) {
+			currentWorld = new WeakReference<>(world);
+			needModelDataRefresh.clear();
+			modelDataCache.clear();
+		}
+	}
+
+	public static void requestModelDataRefresh(BlockEntity te) {
+		Preconditions.checkNotNull(te, "Tile entity must not be null");
+		World world = te.getWorld();
+
+		cleanCaches(world);
+		needModelDataRefresh
+				.computeIfAbsent(new ChunkPos(te.getPos()), $ -> Collections.synchronizedSet(new HashSet<>()))
+				.add(te.getPos());
+	}
+
+	private static void refreshModelData(World world, ChunkPos chunk) {
+		cleanCaches(world);
+		Set<BlockPos> needUpdate = needModelDataRefresh.remove(chunk);
+
+		if (needUpdate != null) {
+			Map<BlockPos, IModelData> data = modelDataCache.computeIfAbsent(chunk, $ -> new ConcurrentHashMap<>());
+
+			for (BlockPos pos : needUpdate) {
+				BlockEntity toUpdate = world.getBlockEntity(pos);
+
+				if (toUpdate != null && !toUpdate.isRemoved()) {
+					data.put(pos, ((ForgeModelDataProvider) toUpdate).getModelData());
+				} else {
+					data.remove(pos);
+				}
+			}
+		}
+	}
+
+	@Override
+	public void onInitializeClient() {
+		ClientChunkEvents.CHUNK_UNLOAD.register(ModelDataManager::onClientChunkUnload);
+	}
+
+	/**
+	 * In Forge, this method handles ChunkEvent.Unload event on the FORGE bus(MinecraftForge.EVENT_BUS).
+	 */
+	public static void onClientChunkUnload(ClientWorld world, WorldChunk chunk) {
+		ChunkPos chunkPos = chunk.getPos();
+		needModelDataRefresh.remove(chunkPos);
+		modelDataCache.remove(chunkPos);
+	}
+
+	public static @Nullable IModelData getModelData(World world, BlockPos pos) {
+		return getModelData(world, new ChunkPos(pos)).get(pos);
+	}
+
+	public static Map<BlockPos, IModelData> getModelData(World world, ChunkPos pos) {
+		Preconditions.checkArgument(world.isClient, "Cannot request model data for server world");
+		refreshModelData(world, pos);
+		return modelDataCache.getOrDefault(pos, Collections.emptyMap());
+	}
+}

patchwork-extensions-bakedmodel/src/main/java/net/minecraftforge/client/model/data/EmptyModelData.java

@@ -0,0 +1,39 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.client.model.data;
+
+public enum EmptyModelData implements IModelData {
+	INSTANCE;
+
+	@Override
+	public boolean hasProperty(ModelProperty<?> prop) {
+		return false;
+	}
+
+	@Override
+	public <T> T getData(ModelProperty<T> prop) {
+		return null;
+	}
+
+	@Override
+	public <T> T setData(ModelProperty<T> prop, T data) {
+		return null;
+	}
+}

patchwork-extensions-bakedmodel/src/main/java/net/minecraftforge/client/model/data/IDynamicBakedModel.java

@@ -0,0 +1,49 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.client.model.data;
+
+import java.util.List;
+import java.util.Random;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+import net.minecraftforge.client.extensions.IForgeBakedModel;
+
+import net.minecraft.block.BlockState;
+import net.minecraft.client.render.model.BakedModel;
+import net.minecraft.client.render.model.BakedQuad;
+import net.minecraft.util.math.Direction;
+
+/**
+ * Convenience interface with default implementation of {@link IBakedModel#getQuads(net.minecraft.block.state.IBlockState, net.minecraft.util.EnumFacing, java.util.Random)}.
+ */
+public interface IDynamicBakedModel extends BakedModel, IForgeBakedModel {
+	@Override
+	default @Nonnull List<BakedQuad> getQuads(@Nullable BlockState state, @Nullable Direction side, @Nonnull Random rand) {
+		return getQuads(state, side, rand, EmptyModelData.INSTANCE);
+	}
+
+	// Force this to be overriden otherwise this introduces a default cycle between
+	// the two overloads.
+	@Override
+	@Nonnull
+	List<BakedQuad> getQuads(@Nullable BlockState state, @Nullable Direction side, @Nonnull Random rand, @Nonnull IModelData extraData);
+}

patchwork-extensions-bakedmodel/src/main/java/net/minecraftforge/client/model/data/IModelData.java

@@ -0,0 +1,44 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.client.model.data;
+
+import javax.annotation.Nullable;
+
+public interface IModelData {
+	/**
+	 * Check if this data has a property, even if the value is {@code null}. Can be
+	 * used by code that intends to fill in data for a render pipeline, such as the
+	 * forge animation system.
+	 *
+	 * <p>IMPORTANT: {@link #getData(ModelProperty)} <em>can</em> return {@code null}
+	 * even if this method returns {@code true}.
+	 *
+	 * @param prop The property to check for inclusion in this model data
+	 * @return {@code true} if this data has the given property, even if no value is
+	 *         present
+	 */
+	boolean hasProperty(ModelProperty<?> prop);
+
+	@Nullable
+	<T> T getData(ModelProperty<T> prop);
+
+	@Nullable
+	<T> T setData(ModelProperty<T> prop, T data);
+}

patchwork-extensions-bakedmodel/src/main/java/net/minecraftforge/client/model/data/ModelDataMap.java

@@ -0,0 +1,72 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.client.model.data;
+
+import java.util.IdentityHashMap;
+import java.util.Map;
+
+import com.google.common.base.Preconditions;
+
+public class ModelDataMap implements IModelData {
+	private final Map<ModelProperty<?>, Object> backingMap;
+
+	private ModelDataMap(Map<ModelProperty<?>, Object> map) {
+		this.backingMap = new IdentityHashMap<>(map);
+	}
+
+	protected ModelDataMap() {
+		this.backingMap = new IdentityHashMap<>();
+	}
+
+	@Override
+	public boolean hasProperty(ModelProperty<?> prop) {
+		return backingMap.containsKey(prop);
+	}
+
+	@SuppressWarnings("unchecked")
+	@Override
+	public <T> T getData(ModelProperty<T> prop) {
+		return (T) backingMap.get(prop);
+	}
+
+	@SuppressWarnings("unchecked")
+	@Override
+	public <T> T setData(ModelProperty<T> prop, T data) {
+		Preconditions.checkArgument(prop.test(data), "Value is invalid for this property");
+		return (T) backingMap.put(prop, data);
+	}
+
+	public static class Builder {
+		private final Map<ModelProperty<?>, Object> defaults = new IdentityHashMap<>();
+
+		public Builder withProperty(ModelProperty<?> prop) {
+			return withInitial(prop, null);
+		}
+
+		public <T> Builder withInitial(ModelProperty<T> prop, T data) {
+			this.defaults.put(prop, data);
+			return this;
+		}
+
+		public ModelDataMap build() {
+			return new ModelDataMap(defaults);
+		}
+	}
+}