team.unnamed.creative.model

Interface ItemTransform

All Superinterfaces:

net.kyori.examination.Examinable

public interface ItemTransform
extends net.kyori.examination.Examinable

Place where an item or block model is displayed. Holds its rotation, translation and scale for the specified situation

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ItemTransform.Builder Builder implementation for creating ItemTransform instances
static class	ItemTransform.Type Enum of all possible model displays

Field Summary

Fields

Modifier and Type	Field and Description
static Vector3Float	DEFAULT_ROTATION
static Vector3Float	DEFAULT_SCALE
static Vector3Float	DEFAULT_TRANSLATION
static float	MAX_SCALE
static float	MAX_TRANSLATION
static float	MIN_SCALE
static float	MIN_TRANSLATION

Method Summary

Modifier and Type	Method and Description
static @NotNull ItemTransform.Builder	builder() Deprecated. Use transform() instead
static @NotNull ItemTransform	of(@NotNull Vector3Float rotation, @NotNull Vector3Float translation, @NotNull Vector3Float scale) Deprecated. Use transform(Vector3Float, Vector3Float, Vector3Float) instead
@NotNull Vector3Float	rotation() Returns the rotation for this model display
@NotNull Vector3Float	scale() Returns the scale of the mode
static @NotNull ItemTransform.Builder	transform() Static factory method for instantiating our builder implementation, which eases the creation of ItemTransform instances
static @NotNull ItemTransform	transform(@NotNull Vector3Float rotation, @NotNull Vector3Float translation, @NotNull Vector3Float scale) Creates a new ItemTransform instance from the given values
@NotNull Vector3Float	translation() Returns the position of the model

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

MIN_TRANSLATION

static final float MIN_TRANSLATION

See Also:

Constant Field Values

MAX_TRANSLATION

static final float MAX_TRANSLATION

See Also:

Constant Field Values

MIN_SCALE

static final float MIN_SCALE

See Also:

Constant Field Values

MAX_SCALE

static final float MAX_SCALE

See Also:

Constant Field Values

DEFAULT_ROTATION

static final Vector3Float DEFAULT_ROTATION

DEFAULT_TRANSLATION

static final Vector3Float DEFAULT_TRANSLATION

DEFAULT_SCALE

static final Vector3Float DEFAULT_SCALE

Method Detail

rotation

@NotNull
@NotNull Vector3Float rotation()

Returns the rotation for this model display

Returns:

The model display rotation

Since:

1.0.0

translation

@NotNull
@NotNull Vector3Float translation()

Returns the position of the model

Components are always between MIN_TRANSLATION and MAX_TRANSLATION

Returns:

The model display translation

Since:

1.0.0

scale

@NotNull
@NotNull Vector3Float scale()

Returns the scale of the mode

Components are always between MIN_SCALE and MAX_SCALE constants

Returns:

The model display scale

Since:

1.0.0

transform

@NotNull
static @NotNull ItemTransform transform(@NotNull
                                                  @NotNull Vector3Float rotation,
                                                  @NotNull
                                                  @NotNull Vector3Float translation,
                                                  @NotNull
                                                  @NotNull Vector3Float scale)

Creates a new ItemTransform instance from the given values

Parameters:

rotation - The display rotation

translation - The display translation [-80, 80]

scale - The display scale [0, 4]

Returns:

A new ItemTransform instance

Since:

1.0.0

transform

@NotNull
static @NotNull ItemTransform.Builder transform()

Static factory method for instantiating our builder implementation, which eases the creation of ItemTransform instances

Returns:

A new builder instance

Since:

1.0.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull ItemTransform of(@NotNull
                                                                                                             @NotNull Vector3Float rotation,
                                                                                                             @NotNull
                                                                                                             @NotNull Vector3Float translation,
                                                                                                             @NotNull
                                                                                                             @NotNull Vector3Float scale)

Deprecated. Use transform(Vector3Float, Vector3Float, Vector3Float) instead

Creates a new ItemTransform instance from the given values

Parameters:

rotation - The display rotation

translation - The display translation [-80, 80]

scale - The display scale [0, 4]

Returns:

A new ItemTransform instance

Since:

1.0.0

builder

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull ItemTransform.Builder builder()

Deprecated. Use transform() instead

Static factory method for instantiating our builder implementation, which eases the creation of ItemTransform instances

Returns:

A new builder instance

Since:

1.0.0