Package net.fabricmc.fabric.api.renderer.v1.model

Class ModelHelper

java.lang.Object

net.fabricmc.fabric.api.renderer.v1.model.ModelHelper

public abstract class ModelHelper
extends Object

Collection of utilities for model implementations.

Field Summary

Fields

Modifier and Type	Field	Description
static net.minecraft.client.render.model.json.ModelTransformation	MODEL_TRANSFORM_BLOCK	Mimics the vanilla model transformation used for most vanilla blocks, and should be suitable for most custom block-like models.
static int	NULL_FACE_ID	Result from toFaceIndex(Direction) for null values.
static net.minecraft.client.render.model.json.Transformation	TRANSFORM_BLOCK_1ST_PERSON_LEFT
static net.minecraft.client.render.model.json.Transformation	TRANSFORM_BLOCK_1ST_PERSON_RIGHT
static net.minecraft.client.render.model.json.Transformation	TRANSFORM_BLOCK_3RD_PERSON_RIGHT
static net.minecraft.client.render.model.json.Transformation	TRANSFORM_BLOCK_FIXED
static net.minecraft.client.render.model.json.Transformation	TRANSFORM_BLOCK_GROUND
static net.minecraft.client.render.model.json.Transformation	TRANSFORM_BLOCK_GUI

Method Summary

Modifier and Type	Method	Description
static net.minecraft.util.math.Direction	faceFromIndex(int faceIndex)	Use to decode a result from toFaceIndex(Direction).
static int	toFaceIndex(net.minecraft.util.math.Direction face)	Convenient way to encode faces that may be null.
static List<net.minecraft.client.render.model.BakedQuad>[]	toQuadLists(Mesh mesh)	Converts a mesh into an array of lists of vanilla baked quads.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NULL_FACE_ID

public static final int NULL_FACE_ID

Result from toFaceIndex(Direction) for null values.

See Also:

Constant Field Values

TRANSFORM_BLOCK_GUI

public static final net.minecraft.client.render.model.json.Transformation TRANSFORM_BLOCK_GUI

TRANSFORM_BLOCK_GROUND

public static final net.minecraft.client.render.model.json.Transformation TRANSFORM_BLOCK_GROUND

TRANSFORM_BLOCK_FIXED

public static final net.minecraft.client.render.model.json.Transformation TRANSFORM_BLOCK_FIXED

TRANSFORM_BLOCK_3RD_PERSON_RIGHT

public static final net.minecraft.client.render.model.json.Transformation TRANSFORM_BLOCK_3RD_PERSON_RIGHT

TRANSFORM_BLOCK_1ST_PERSON_RIGHT

public static final net.minecraft.client.render.model.json.Transformation TRANSFORM_BLOCK_1ST_PERSON_RIGHT

TRANSFORM_BLOCK_1ST_PERSON_LEFT

public static final net.minecraft.client.render.model.json.Transformation TRANSFORM_BLOCK_1ST_PERSON_LEFT

MODEL_TRANSFORM_BLOCK

public static final net.minecraft.client.render.model.json.ModelTransformation MODEL_TRANSFORM_BLOCK

Mimics the vanilla model transformation used for most vanilla blocks, and should be suitable for most custom block-like models.

Method Details

toFaceIndex

public static int toFaceIndex(net.minecraft.util.math.Direction face)

Convenient way to encode faces that may be null. Null is returned as NULL_FACE_ID. Use faceFromIndex(int) to retrieve encoded face.

faceFromIndex

@Contract("null -> null")
public static net.minecraft.util.math.Direction faceFromIndex(int faceIndex)

Use to decode a result from toFaceIndex(Direction). Return value will be null if encoded value was null. Can also be used for no-allocation iteration of Direction.values(), optionally including the null face. (Use < or <= NULL_FACE_ID to exclude or include the null value, respectively.)

toQuadLists

public static List<net.minecraft.client.render.model.BakedQuad>[] toQuadLists(Mesh mesh)

Converts a mesh into an array of lists of vanilla baked quads. Useful for creating vanilla baked models when required for compatibility. The array indexes correspond to Direction.getId() with the addition of NULL_FACE_ID.

Retrieves sprites from the block texture atlas via SpriteFinder.