Package net.neoforged.neoforge.client.model

Class BakedModelWrapper<T extends BakedModel>

java.lang.Object

net.neoforged.neoforge.client.model.BakedModelWrapper<T>

All Implemented Interfaces:

BakedModel, IBakedModelExtension

Direct Known Subclasses:

FullPotsAccessorDemo.ClientHandler.DioritePotModel, MegaModelTest.TransformingModelWrapper

public abstract class BakedModelWrapper<T extends BakedModel>
extends Object
implements BakedModel

Wrapper for BakedModel which delegates all operations to its parent.

Useful for creating wrapper baked models which only override certain properties.

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	originalModel

Constructor Summary

Constructors

Constructor	Description
BakedModelWrapper(T originalModel)

Method Summary

Modifier and Type	Method	Description
BakedModel	applyTransform(ItemDisplayContext cameraTransformType, PoseStack poseStack, boolean applyLeftHandTransform)	Applies a transform for the given invalid reference ItemTransforms.TransformType and applyLeftHandTransform, and returns the model to be rendered.
ModelData	getModelData(BlockAndTintGetter level, BlockPos pos, BlockState state, ModelData modelData)
ItemOverrides	getOverrides()
TextureAtlasSprite	getParticleIcon()
TextureAtlasSprite	getParticleIcon(ModelData data)
List<BakedQuad>	getQuads(@Nullable BlockState state, @Nullable Direction side, RandomSource rand)
List<BakedQuad>	getQuads(@Nullable BlockState state, @Nullable Direction side, RandomSource rand, ModelData extraData, @Nullable RenderType renderType)	A null RenderType is used for the breaking overlay as well as non-standard rendering, so models should return all their quads.
List<BakedModel>	getRenderPasses(ItemStack itemStack, boolean fabulous)	Gets an ordered list of baked models used to render this model as an item.
List<RenderType>	getRenderTypes(ItemStack itemStack, boolean fabulous)	Gets an ordered list of render types to use when drawing this item.
ChunkRenderTypeSet	getRenderTypes(BlockState state, RandomSource rand, ModelData data)	Gets the set of render types to use when drawing this block in the level.
ItemTransforms	getTransforms()
boolean	isCustomRenderer()
boolean	isGui3d()
boolean	useAmbientOcclusion()
TriState	useAmbientOcclusion(BlockState state, ModelData data, RenderType renderType)	Controls the AO behavior for all quads of this model.
boolean	usesBlockLight()

Methods inherited from class java.lang.Object

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

Field Details

originalModel

protected final T extends BakedModel originalModel

Constructor Details

BakedModelWrapper

public BakedModelWrapper(T originalModel)

Method Details

getQuads

public List<BakedQuad> getQuads(@Nullable
 @Nullable BlockState state,
 @Nullable
 @Nullable Direction side,
 RandomSource rand)

Specified by:

getQuads in interface BakedModel

useAmbientOcclusion

public boolean useAmbientOcclusion()

Specified by:

useAmbientOcclusion in interface BakedModel

useAmbientOcclusion

public TriState useAmbientOcclusion(BlockState state,
 ModelData data,
 RenderType renderType)

Description copied from interface: IBakedModelExtension

Controls the AO behavior for all quads of this model. The default behavior is to use AO unless the block emits light, TriState.TRUE and TriState.FALSE force AO to be enabled and disabled respectively, regardless of the block emitting light or not. BakedQuad.hasAmbientOcclusion() can be used to disable AO for a specific quad even if this method says otherwise.

This method cannot force AO if the global smooth lighting video setting is disabled.

Specified by:

useAmbientOcclusion in interface IBakedModelExtension

Parameters:

state - the block state this model is being rendered for

data - the model data used to render this model

renderType - the render type the model is being rendered with

Returns:

TriState.TRUE to force-enable AO, TriState.FALSE to force-disable AO or TriState.DEFAULT to use vanilla AO behavior

isGui3d

public boolean isGui3d()

Specified by:

isGui3d in interface BakedModel

usesBlockLight

public boolean usesBlockLight()

Specified by:

usesBlockLight in interface BakedModel

isCustomRenderer

public boolean isCustomRenderer()

Specified by:

isCustomRenderer in interface BakedModel

getParticleIcon

public TextureAtlasSprite getParticleIcon()

Specified by:

getParticleIcon in interface BakedModel

getTransforms

public ItemTransforms getTransforms()

Specified by:

getTransforms in interface BakedModel

getOverrides

public ItemOverrides getOverrides()

Specified by:

getOverrides in interface BakedModel

applyTransform

public BakedModel applyTransform(ItemDisplayContext cameraTransformType,
 PoseStack poseStack,
 boolean applyLeftHandTransform)

Description copied from interface: IBakedModelExtension

Applies a transform for the given

invalid reference

ItemTransforms.TransformType

and applyLeftHandTransform, and returns the model to be rendered.

Specified by:

applyTransform in interface IBakedModelExtension

getParticleIcon

public TextureAtlasSprite getParticleIcon(ModelData data)

Specified by:

getParticleIcon in interface IBakedModelExtension

getQuads

public List<BakedQuad> getQuads(@Nullable
 @Nullable BlockState state,
 @Nullable
 @Nullable Direction side,
 RandomSource rand,
 ModelData extraData,
 @Nullable
 @Nullable RenderType renderType)

Description copied from interface: IBakedModelExtension

A null RenderType is used for the breaking overlay as well as non-standard rendering, so models should return all their quads.

Specified by:

getQuads in interface IBakedModelExtension

getModelData

public ModelData getModelData(BlockAndTintGetter level,
 BlockPos pos,
 BlockState state,
 ModelData modelData)

Specified by:

getModelData in interface IBakedModelExtension

getRenderTypes

public ChunkRenderTypeSet getRenderTypes(BlockState state,
 RandomSource rand,
 ModelData data)

Description copied from interface: IBakedModelExtension

Gets the set of render types to use when drawing this block in the level. Supported types are those returned by RenderType.chunkBufferLayers().

By default, defers query to ItemBlockRenderTypes.

Specified by:

getRenderTypes in interface IBakedModelExtension

getRenderTypes

public List<RenderType> getRenderTypes(ItemStack itemStack,
 boolean fabulous)

Description copied from interface: IBakedModelExtension

Gets an ordered list of render types to use when drawing this item. All render types using the DefaultVertexFormat.NEW_ENTITY format are supported.

This method will only be called on the models returned by IBakedModelExtension.getRenderPasses(ItemStack, boolean).

By default, defers query to ItemBlockRenderTypes.

Specified by:

getRenderTypes in interface IBakedModelExtension

See Also:

• IBakedModelExtension.getRenderPasses(ItemStack, boolean)

getRenderPasses

public List<BakedModel> getRenderPasses(ItemStack itemStack,
 boolean fabulous)

Description copied from interface: IBakedModelExtension

Gets an ordered list of baked models used to render this model as an item. Each of those models' render types will be queried via IBakedModelExtension.getRenderTypes(ItemStack, boolean).

By default, returns the model itself.

Specified by:

getRenderPasses in interface IBakedModelExtension

See Also:

• IBakedModelExtension.getRenderTypes(ItemStack, boolean)