bettermodel-api/kr.toxicity.model.api.tracker/ModelRotator

ModelRotator

interface ModelRotator : BiFunction<Tracker, ModelRotation, ModelRotation>

Defines how a model's rotation is calculated and applied.

Rotators can modify the base rotation (e.g., only applying yaw, smoothing rotation) and can be chained together.

Since

1.15.2

Inheritors

SourcedRotator

Types

Builder

interface Builder

Builder interface for creating Getters from JSON.

BuiltInDeserializer

interface BuiltInDeserializer : Function<JsonElement, ModelRotator>

Helper interface for built-in deserializers.

Deserializer

class Deserializer

Registry and factory for rotators.

Getter

interface Getter

Functional interface for calculating rotation.

SourcedRotator

class SourcedRotator : Record, ModelRotator

Implementation of a chained rotator.

Properties

DEFAULT

@NotNull

val DEFAULT: @NotNull ModelRotator

Default rotator (applies rotation as-is).

DESERIALIZER

val DESERIALIZER: ModelRotator.Deserializer

The global deserializer instance for rotators.

EMPTY

@NotNull

val EMPTY: @NotNull ModelRotator

Empty rotator (returns zero rotation).

PITCH

@NotNull

val PITCH: @NotNull ModelRotator

Pitch-only rotator.

YAW

@NotNull

val YAW: @NotNull ModelRotator

Yaw-only rotator.

Functions

andThen

open fun <V> andThen(after: (in R) -> out V): BiFunction<T, U, V>

apply

@NotNull

open fun apply(@NotNull tracker: @NotNull Tracker): @NotNull ModelRotation

Applies the rotator to a tracker with default rotation.

@NotNull

abstract fun apply(@NotNull tracker: @NotNull Tracker, @NotNull rotation: @NotNull ModelRotation): @NotNull ModelRotation

Applies the rotator to a tracker with a base rotation.

data

@Nullable

abstract fun data(): @Nullable JsonElement

Returns the configuration data for this rotator.

deserialize

@NotNull

open fun deserialize(@NotNull object: @NotNull JsonObject): @NotNull ModelRotator

Deserializes a rotator from a JSON object.

lazy

@NotNull

open fun lazy(mills: Long): @NotNull ModelRotator

Creates a lazy rotator that smooths rotation over time.

name

@NotNull

abstract fun name(): @NotNull String

Returns the name of this rotator type.

root

@NotNull

open fun root(): @NotNull ModelRotator

Returns the root rotator in the chain.

serialize

@NotNull

open fun serialize(): @NotNull JsonObject

Serializes this rotator to a JSON object.

source

@Nullable

abstract fun source(): @Nullable ModelRotator

Returns the source rotator if this is a chained rotator.

then

@NotNull

open fun then(@NotNull rotator: @NotNull ModelRotator): @NotNull ModelRotator

Chains this rotator with another one.