net.minecraftforge.client.model.generators

Class ConfiguredModel

java.lang.Object

net.minecraftforge.client.model.generators.ConfiguredModel

public final class ConfiguredModel
extends java.lang.Object

Represents a model with blockstate configurations, e.g. rotation, uvlock, and random weight.

Can be manually constructed, created by static factory such as allYRotations(ModelFile, int, boolean), or created by builder via builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfiguredModel.Builder<T> A builder for ConfiguredModels, which can contain a callback for processing the finished result.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_WEIGHT The default random weight of configured models, used by convenience overloads.
ModelFile	model
int	rotationX
int	rotationY
boolean	uvLock
int	weight

Constructor Summary

Constructors

Constructor and Description
ConfiguredModel(ModelFile model) Construct a new ConfiguredModel with the default rotation (0, 0), uvlock (false), and default random weight.
ConfiguredModel(ModelFile model, int rotationX, int rotationY, boolean uvLock) Construct a new ConfiguredModel with the default random weight.
ConfiguredModel(ModelFile model, int rotationX, int rotationY, boolean uvLock, int weight) Construct a new ConfiguredModel.

Method Summary

Modifier and Type	Method and Description
static ConfiguredModel[]	allRotations(ModelFile model, boolean uvlock)
static ConfiguredModel[]	allRotations(ModelFile model, boolean uvlock, int weight)
static ConfiguredModel[]	allYRotations(ModelFile model, int x, boolean uvlock)
static ConfiguredModel[]	allYRotations(ModelFile model, int x, boolean uvlock, int weight)
static ConfiguredModel.Builder<?>	builder() Create a new unowned ConfiguredModel.Builder.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WEIGHT

public static final int DEFAULT_WEIGHT

The default random weight of configured models, used by convenience overloads.

See Also:

Constant Field Values

model

public final ModelFile model

rotationX

public final int rotationX

rotationY

public final int rotationY

uvLock

public final boolean uvLock

weight

public final int weight

Constructor Detail

ConfiguredModel

public ConfiguredModel(ModelFile model,
                       int rotationX,
                       int rotationY,
                       boolean uvLock,
                       int weight)

Construct a new ConfiguredModel.

Parameters:

model - the underlying model

rotationX - x-rotation to apply to the model

rotationY - y-rotation to apply to the model

uvLock - if uvlock should be enabled

weight - the random weight of the model

Throws:

java.lang.NullPointerException - if model is null

java.lang.IllegalArgumentException - if x and/or y rotation are not valid (see ModelRotation)

java.lang.IllegalArgumentException - if weight is less than or equal to zero

ConfiguredModel

public ConfiguredModel(ModelFile model,
                       int rotationX,
                       int rotationY,
                       boolean uvLock)

Construct a new ConfiguredModel with the default random weight.

Parameters:

model - the underlying model

rotationX - x-rotation to apply to the model

rotationY - y-rotation to apply to the model

uvLock - if uvlock should be enabled

Throws:

java.lang.NullPointerException - if model is null

java.lang.IllegalArgumentException - if x and/or y rotation are not valid (see ModelRotation)

ConfiguredModel

public ConfiguredModel(ModelFile model)

Construct a new ConfiguredModel with the default rotation (0, 0), uvlock (false), and default random weight.

Throws:

java.lang.NullPointerException - if model is null

Method Detail

allYRotations

public static ConfiguredModel[] allYRotations(ModelFile model,
                                              int x,
                                              boolean uvlock)

allYRotations

public static ConfiguredModel[] allYRotations(ModelFile model,
                                              int x,
                                              boolean uvlock,
                                              int weight)

allRotations

public static ConfiguredModel[] allRotations(ModelFile model,
                                             boolean uvlock)

allRotations

public static ConfiguredModel[] allRotations(ModelFile model,
                                             boolean uvlock,
                                             int weight)

builder

public static ConfiguredModel.Builder<?> builder()

Create a new unowned ConfiguredModel.Builder.

Returns:

the builder

See Also:

ConfiguredModel.Builder