Package dev.kosmx.playerAnim.core.data

Class KeyframeAnimation

java.lang.Object

dev.kosmx.playerAnim.core.data.KeyframeAnimation

All Implemented Interfaces:

IPlayable, Supplier<UUID>

@Immutable
public final class KeyframeAnimation
extends Object
implements IPlayable

Used to store Emote data

Animation data
Notable key points in time:
begin: probably the first keyframe, before this, the default model can move to starting pose
end: last animation keyframe
stop: animating ends, after end the character can go back to its default pose

isInfinite:
if true, the animation will jump back to returnToTick after endTick inclusive

To play an animation use KeyframeAnimationPlayer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyframeAnimation.AnimationBuilder
static final class	KeyframeAnimation.KeyFrame
static final class	KeyframeAnimation.StateCollection

Field Summary

Fields

Modifier and Type	Field	Description
final AnimationFormat	animationFormat	Where is the animation from, not used in equals or hash.
final int	beginTick
static final KeyframeAnimation.StateCollection.State	EMPTY_STATE
final int	endTick
final HashMap<String,Object>	extraData	Mutable extra members for extra information store
final boolean	isEasingBefore
final boolean	isInfinite
final boolean	isUUIDGenerated	Is the uuid generated when loading or was loaded from a file
final boolean	nsfw
final int	returnToTick
final int	stopTick

Method Summary

Modifier and Type	Method	Description
KeyframeAnimation	copy()
boolean	equals(Object o)	ExtraData from source are ignored
UUID	get()
@NotNull Map<String,KeyframeAnimation.StateCollection>	getBodyParts()	The old string to part map getter, it may be the only method that does not get removed after the PartKey refactor.
int	getLength()	Will return invalid information if isInfinite is true
@NotNull String	getName()
@Nullable KeyframeAnimation.StateCollection	getPart(@NotNull PartKey partID)
@Nullable KeyframeAnimation.StateCollection	getPart(String partID)	Deprecated. use getPart(PartKey) instead.
@NotNull Optional<KeyframeAnimation.StateCollection>	getPartOptional(@NotNull PartKey id)
@NotNull Optional<KeyframeAnimation.StateCollection>	getPartOptional(@NotNull String id)	Deprecated. use getPartOptional(PartKey) instead.
int	hashCode()
boolean	isInfinite()
boolean	isPlayingAt(int tick)
KeyframeAnimation.AnimationBuilder	mutableCopy()
@NotNull IActualAnimation<KeyframeAnimationPlayer>	playAnimation()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY_STATE

public static final KeyframeAnimation.StateCollection.State EMPTY_STATE

beginTick

public final int beginTick

endTick

public final int endTick

stopTick

public final int stopTick

isInfinite

public final boolean isInfinite

returnToTick

public final int returnToTick

isEasingBefore

public final boolean isEasingBefore

nsfw

public final boolean nsfw

isUUIDGenerated

public final boolean isUUIDGenerated

Is the uuid generated when loading or was loaded from a file

extraData

public final HashMap<String,Object> extraData

Mutable extra members for extra information store

animationFormat

public final AnimationFormat animationFormat

Where is the animation from, not used in equals or hash.

Method Details

equals

public boolean equals(Object o)

ExtraData from source are ignored

Overrides:

equals in class Object

Parameters:

o - other

Returns:

are the object equals or the same

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copy

public KeyframeAnimation copy()

mutableCopy

public KeyframeAnimation.AnimationBuilder mutableCopy()

isPlayingAt

public boolean isPlayingAt(int tick)

get

public UUID get()

Specified by:

get in interface Supplier<UUID>

getLength

public int getLength()

Will return invalid information if isInfinite is true

Returns:

The length of the emote in ticks (20 t/s)

isInfinite

public boolean isInfinite()

getPart

@Nullable
@Deprecated
public @Nullable KeyframeAnimation.StateCollection getPart(String partID)

Deprecated.

use getPart(PartKey) instead. that is faster if you know the key. (PartKey.HEAD) for example

Parameters:

partID - part ID string

getPart

@Nullable
public @Nullable KeyframeAnimation.StateCollection getPart(@NotNull
 @NotNull PartKey partID)

getPartOptional

@NotNull
public @NotNull Optional<KeyframeAnimation.StateCollection> getPartOptional(@NotNull
 @NotNull String id)

Deprecated.

use getPartOptional(PartKey) instead. that is faster if you know the key.

Parameters:

id - part ID string

getPartOptional

@NotNull
public @NotNull Optional<KeyframeAnimation.StateCollection> getPartOptional(@NotNull
 @NotNull PartKey id)

playAnimation

@NotNull
public @NotNull IActualAnimation<KeyframeAnimationPlayer> playAnimation()

Specified by:

playAnimation in interface IPlayable

getName

@NotNull
public @NotNull String getName()

Specified by:

getName in interface IPlayable

getBodyParts

@NotNull
public @NotNull Map<String,KeyframeAnimation.StateCollection> getBodyParts()

The old string to part map getter, it may be the only method that does not get removed after the PartKey refactor. It is still used by network an many other tools.

Returns:

Parts in string to part map

toString

public String toString()

Overrides:

toString in class Object