DreamArmorStandAnimator.java

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 Dreamfire Studio
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.dreamfirestudios.dreamcore.DreamArmorStand;
 
import lombok.Getter;
import org.bukkit.entity.ArmorStand;
import org.bukkit.util.EulerAngle;
 
import java.util.List;
import java.util.UUID;
import java.util.concurrent.CopyOnWriteArrayList;
 
public class DreamArmorStandAnimator {
    @Getter
    private UUID animatorID;
    @Getter
    private ArmorStand targetArmorStand;
    private List<ArmorStandAnimationFrameData> frames = new CopyOnWriteArrayList<>();
    private int currentFrameIndex = 0;
    private int currentFrameTick = 0;
    @Getter
    private volatile boolean paused = true;
 
    private DreamArmorStandAnimator() {
    }
 
    public boolean displayNextFrame() {
        if (frames.isEmpty() || targetArmorStand == null) return true;
        if (paused) return false;
 
        ArmorStandAnimationFrameData frame = frames.get(currentFrameIndex);
        double t = (double) currentFrameTick / frame.getDurationTicks();
        if (t > 1.0) t = 1.0;
 
        if (frame.getHeadStart() != null && frame.getHeadEnd() != null) {
            EulerAngle newHead = new EulerAngle(
                    interpolate(frame.getHeadStart().getX(), frame.getHeadEnd().getX(), t),
                    interpolate(frame.getHeadStart().getY(), frame.getHeadEnd().getY(), t),
                    interpolate(frame.getHeadStart().getZ(), frame.getHeadEnd().getZ(), t)
            );
            targetArmorStand.setHeadPose(newHead);
        }
 
        if (frame.getBodyStart() != null && frame.getBodyEnd() != null) {
            EulerAngle newBody = new EulerAngle(
                    interpolate(frame.getBodyStart().getX(), frame.getBodyEnd().getX(), t),
                    interpolate(frame.getBodyStart().getY(), frame.getBodyEnd().getY(), t),
                    interpolate(frame.getBodyStart().getZ(), frame.getBodyEnd().getZ(), t)
            );
            targetArmorStand.setBodyPose(newBody);
        }
 
        if (frame.getLeftArmStart() != null && frame.getLeftArmEnd() != null) {
            EulerAngle newLeftArm = new EulerAngle(
                    interpolate(frame.getLeftArmStart().getX(), frame.getLeftArmEnd().getX(), t),
                    interpolate(frame.getLeftArmStart().getY(), frame.getLeftArmEnd().getY(), t),
                    interpolate(frame.getLeftArmStart().getZ(), frame.getLeftArmEnd().getZ(), t)
            );
            targetArmorStand.setLeftArmPose(newLeftArm);
        }
 
        if (frame.getRightArmStart() != null && frame.getRightArmEnd() != null) {
            EulerAngle newRightArm = new EulerAngle(
                    interpolate(frame.getRightArmStart().getX(), frame.getRightArmEnd().getX(), t),
                    interpolate(frame.getRightArmStart().getY(), frame.getRightArmEnd().getY(), t),
                    interpolate(frame.getRightArmStart().getZ(), frame.getRightArmEnd().getZ(), t)
            );
            targetArmorStand.setRightArmPose(newRightArm);
        }
 
        if (frame.getLeftLegStart() != null && frame.getLeftLegEnd() != null) {
            EulerAngle newLeftLeg = new EulerAngle(
                    interpolate(frame.getLeftLegStart().getX(), frame.getLeftLegEnd().getX(), t),
                    interpolate(frame.getLeftLegStart().getY(), frame.getLeftLegEnd().getY(), t),
                    interpolate(frame.getLeftLegStart().getZ(), frame.getLeftLegEnd().getZ(), t)
            );
            targetArmorStand.setLeftLegPose(newLeftLeg);
        }
 
        if (frame.getRightLegStart() != null && frame.getRightLegEnd() != null) {
            EulerAngle newRightLeg = new EulerAngle(
                    interpolate(frame.getRightLegStart().getX(), frame.getRightLegEnd().getX(), t),
                    interpolate(frame.getRightLegStart().getY(), frame.getRightLegEnd().getY(), t),
                    interpolate(frame.getRightLegStart().getZ(), frame.getRightLegEnd().getZ(), t)
            );
            targetArmorStand.setRightLegPose(newRightLeg);
        }
 
        currentFrameTick++;
        if (currentFrameTick >= frame.getDurationTicks()) {
            currentFrameIndex = (currentFrameIndex + 1) % frames.size();
            currentFrameTick = 0;
        }
        return false;
    }
 
    private double interpolate(double start, double end, double t) {
        return start + (end - start) * t;
    }
 
    public void pause() {
        if (!paused) paused = true;
    }
 
    public void play() {
        if (paused) paused = false;
    }
 
    public void stop() {
        paused = true;
        frames.clear();
    }
 
    public static class Builder {
        private UUID animatorID = UUID.randomUUID();
        private final List<ArmorStandAnimationFrameData> frames = new CopyOnWriteArrayList<>();
        private ArmorStand targetArmorStand;
 
        public Builder animatorID(UUID animatorID) {
            if (animatorID != null) this.animatorID = animatorID;
            return this;
        }
 
        public Builder targetArmorStand(ArmorStand armorStand) {
            if (armorStand == null) throw new IllegalArgumentException("ArmorStand cannot be null");
            this.targetArmorStand = armorStand;
            return this;
        }
 
        public Builder addFrame(ArmorStandAnimationFrameData frame, int repeatFrames) {
            if (frame == null || repeatFrames <= 0) return this;
            for (int i = 0; i < repeatFrames; i++) {
                frames.add(frame);
            }
            return this;
        }
 
        public Builder addFrame(ArmorStandAnimationFrameData frame) {
            if (frame != null) frames.add(frame);
            return this;
        }
 
        public DreamArmorStandAnimator build() {
            if (targetArmorStand == null)
                throw new IllegalArgumentException("Target ArmorStand must be set");
            if (frames.isEmpty())
                throw new IllegalArgumentException("At least one frame must be added");
            DreamArmorStandAnimator animator = new DreamArmorStandAnimator();
            animator.animatorID = animatorID;
            animator.targetArmorStand = targetArmorStand;
            animator.frames = frames;
            return animator;
        }
    }
}