PacketShapeData.php

<?php
 
/*
 * This file is part of BedrockProtocol.
 * Copyright (C) 2014-2022 PocketMine Team <https://github.com/pmmp/BedrockProtocol>
 *
 * BedrockProtocol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 */
 
declare(strict_types=1);
 
namespace pocketmine\network\mcpe\protocol\types;
 
use pmmp\encoding\Byte;
use pmmp\encoding\ByteBufferReader;
use pmmp\encoding\ByteBufferWriter;
use pmmp\encoding\LE;
use pmmp\encoding\VarInt;
use pocketmine\color\Color;
use pocketmine\math\Vector3;
use pocketmine\network\mcpe\protocol\PacketDecodeException;
use pocketmine\network\mcpe\protocol\PrimitiveShapesPacket;
use pocketmine\network\mcpe\protocol\serializer\CommonTypes;
 
final class PacketShapeData{
 
    public function __construct(
        private int $networkId,
        private ?ScriptDebugShapeType $type,
        private ?Vector3 $location,
        private ?float $scale,
        private ?Vector3 $rotation,
        private ?float $totalTimeLeft,
        private ?float $maximumRenderDistance,
        private ?Color $color,
        private ?string $text,
        private ?bool $useRotation,
        private ?Color $backgroundColor,
        private ?bool $depthTest,
        private ?bool $showBackface,
        private ?bool $showTextBackface,
        private ?Vector3 $boxBound,
        private ?Vector3 $lineEndLocation,
        private ?float $arrowHeadLength,
        private ?float $arrowHeadRadius,
        private ?int $segments,
        private ?int $dimensionId,
        private ?int $attachedToEntityId,
    ){}
 
    public static function remove(int $networkId, ?int $dimensionId = null) : self{
        return new self($networkId, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, $dimensionId, null);
    }
 
    public static function line(int $networkId, Vector3 $location, Vector3 $lineEndLocation, ?Color $color = null, ?int $dimensionId = null, ?int $attachedToEntityId = null) : self{
        return new self(
            networkId: $networkId,
            type: ScriptDebugShapeType::LINE,
            location: $location,
            scale: null,
            rotation: null,
            totalTimeLeft: null,
            maximumRenderDistance: null,
            color: $color,
            text: null,
            useRotation: null,
            backgroundColor: null,
            depthTest: null,
            showBackface: null,
            showTextBackface: null,
            boxBound: null,
            lineEndLocation: $lineEndLocation,
            arrowHeadLength: null,
            arrowHeadRadius: null,
            segments: null,
            dimensionId: $dimensionId,
            attachedToEntityId: $attachedToEntityId
        );
    }
 
    public static function box(int $networkId, Vector3 $location, Vector3 $boxBound, ?float $scale = null, ?Color $color = null, ?int $dimensionId = null, ?int $attachedToEntityId = null) : self{
        return new self(
            networkId: $networkId,
            type: ScriptDebugShapeType::BOX,
            location: $location,
            scale: $scale,
            rotation: null,
            totalTimeLeft: null,
            maximumRenderDistance: null,
            color: $color,
            text: null,
            useRotation: null,
            backgroundColor: null,
            depthTest: null,
            showBackface: null,
            showTextBackface: null,
            boxBound: $boxBound,
            lineEndLocation: null,
            arrowHeadLength: null,
            arrowHeadRadius: null,
            segments: null,
            dimensionId: $dimensionId,
            attachedToEntityId: $attachedToEntityId
        );
    }
 
    public static function sphere(int $networkId, Vector3 $location, ?float $scale = null, ?Color $color = null, ?int $segments = null, ?int $dimensionId = null, ?int $attachedToEntityId = null) : self{
        return new self(
            networkId: $networkId,
            type: ScriptDebugShapeType::SPHERE,
            location: $location,
            scale: $scale,
            rotation: null,
            totalTimeLeft: null,
            maximumRenderDistance: null,
            color: $color,
            text: null,
            useRotation: null,
            backgroundColor: null,
            depthTest: null,
            showBackface: null,
            showTextBackface: null,
            boxBound: null,
            lineEndLocation: null,
            arrowHeadLength: null,
            arrowHeadRadius: null,
            segments: $segments,
            dimensionId: $dimensionId,
            attachedToEntityId: $attachedToEntityId
        );
    }
 
    public static function circle(int $networkId, Vector3 $location, ?float $scale = null, ?Color $color = null, ?int $segments = null, ?int $dimensionId = null, ?int $attachedToEntityId = null) : self{
        return new self(
            networkId: $networkId,
            type: ScriptDebugShapeType::CIRCLE,
            location: $location,
            scale: $scale,
            rotation: null,
            totalTimeLeft: null,
            maximumRenderDistance: null,
            color: $color,
            text: null,
            useRotation: null,
            backgroundColor: null,
            depthTest: null,
            showBackface: null,
            showTextBackface: null,
            boxBound: null,
            lineEndLocation: null,
            arrowHeadLength: null,
            arrowHeadRadius: null,
            segments: $segments,
            dimensionId: $dimensionId,
            attachedToEntityId: $attachedToEntityId
        );
    }
 
    public static function text(int $networkId, Vector3 $location, string $text, bool $useRotation = false, ?Color $backgroundColor = null, bool $depthTest = true, bool $showBackface = true, bool $showTextBackface = true, ?Color $color = null, ?int $dimensionId = null, ?int $attachedToEntityId = null) : self{
        return new self(
            networkId: $networkId,
            type: ScriptDebugShapeType::TEXT,
            location: $location,
            scale: null,
            rotation: null,
            totalTimeLeft: null,
            maximumRenderDistance: null,
            color: $color,
            text: $text,
            useRotation: $useRotation,
            backgroundColor: $backgroundColor,
            depthTest: $depthTest,
            showBackface: $showBackface,
            showTextBackface: $showTextBackface,
            boxBound: null,
            lineEndLocation: null,
            arrowHeadLength: null,
            arrowHeadRadius: null,
            segments: null,
            dimensionId: $dimensionId,
            attachedToEntityId: $attachedToEntityId
        );
    }
 
    public static function arrow(int $networkId, Vector3 $location, Vector3 $lineEndLocation, ?float $scale = null, ?Color $color = null, ?float $arrowHeadLength = null, ?float $arrowHeadRadius = null, ?int $segments = null, ?int $dimensionId = null, ?int $attachedToEntityId = null) : self{
        return new self(
            networkId: $networkId,
            type: ScriptDebugShapeType::ARROW,
            location: $location,
            scale: $scale,
            rotation: null,
            totalTimeLeft: null,
            maximumRenderDistance: null,
            color: $color,
            text: null,
            useRotation: null,
            backgroundColor: null,
            depthTest: null,
            showBackface: null,
            showTextBackface: null,
            boxBound: null,
            lineEndLocation: $lineEndLocation,
            arrowHeadLength: $arrowHeadLength,
            arrowHeadRadius: $arrowHeadRadius,
            segments: $segments,
            dimensionId: $dimensionId,
            attachedToEntityId: $attachedToEntityId
        );
    }
 
    public function getNetworkId() : int{ return $this->networkId; }
 
    public function getType() : ?ScriptDebugShapeType{ return $this->type; }
 
    public function getLocation() : ?Vector3{ return $this->location; }
 
    public function getScale() : ?float{ return $this->scale; }
 
    public function getRotation() : ?Vector3{ return $this->rotation; }
 
    public function getTotalTimeLeft() : ?float{ return $this->totalTimeLeft; }
 
    public function getMaximumRenderDistance() : ?float{ return $this->maximumRenderDistance; }
 
    public function getColor() : ?Color{ return $this->color; }
 
    public function getDimensionId() : ?int{ return $this->dimensionId; }
 
    public function getAttachedToEntityId() : ?int{ return $this->attachedToEntityId; }
 
    public function getText() : ?string{ return $this->text; }
 
    public function getUseRotation() : ?bool{ return $this->useRotation; }
 
    public function getBackgroundColor() : ?Color{ return $this->backgroundColor; }
 
    public function getDepthTest() : ?bool{ return $this->depthTest; }
 
    public function getShowBackface() : ?bool{ return $this->showBackface; }
 
    public function getShowTextBackface() : ?bool{ return $this->showTextBackface; }
 
    public function getBoxBound() : ?Vector3{ return $this->boxBound; }
 
    public function getLineEndLocation() : ?Vector3{ return $this->lineEndLocation; }
 
    public function getArrowHeadLength() : ?float{ return $this->arrowHeadLength; }
 
    public function getArrowHeadRadius() : ?float{ return $this->arrowHeadRadius; }
 
    public function getSegments() : ?int{ return $this->segments; }
 
    public static function read(ByteBufferReader $in) : self{
        $networkId = VarInt::readUnsignedLong($in);
        $shapeType = CommonTypes::readOptional($in, fn() => ScriptDebugShapeType::fromPacket(Byte::readUnsigned($in)));
        $location = CommonTypes::readOptional($in, CommonTypes::getVector3(...));
        $scale = CommonTypes::readOptional($in, LE::readFloat(...));
        $rotation = CommonTypes::readOptional($in, CommonTypes::getVector3(...));
        $totalTimeLeft = CommonTypes::readOptional($in, LE::readFloat(...));
        $maximumRenderDistance = CommonTypes::readOptional($in, LE::readFloat(...));
        $color = CommonTypes::readOptional($in, fn() => Color::fromARGB(LE::readUnsignedInt($in)));
        $dimensionId = CommonTypes::readOptional($in, fn() => VarInt::readSignedInt($in));
        $attachedToEntityId = CommonTypes::readOptional($in, fn() => CommonTypes::getActorRuntimeId($in));
 
        $payloadType = VarInt::readUnsignedInt($in);
        //WTF IS THIS HORROR SHOW
        if(
            ($shapeType !== null && $payloadType !== $shapeType->getPayloadType() && $payloadType !== ScriptDebugShapeType::PAYLOAD_TYPE_NONE) ||
            ($shapeType === null && $payloadType !== ScriptDebugShapeType::PAYLOAD_TYPE_NONE)
        ){
            throw new PacketDecodeException("Unexpected payload type $payloadType for provided shape type " . ($shapeType->name ?? "(not set)"));
        }
        $text = null;
        $useRotation = null;
        $backgroundColor = null;
        $depthTest = null;
        $showBackface = null;
        $showTextBackface = null;
        $boxBound = null;
        $lineEndLocation = null;
        $arrowHeadLength = null;
        $arrowHeadRadius = null;
        $segments = null;
        switch($payloadType){
            case ScriptDebugShapeType::PAYLOAD_TYPE_NONE:
                break;
            case ScriptDebugShapeType::PAYLOAD_TYPE_ARROW:
                $lineEndLocation = CommonTypes::readOptional($in, CommonTypes::getVector3(...));
                $arrowHeadLength = CommonTypes::readOptional($in, LE::readFloat(...));
                $arrowHeadRadius = CommonTypes::readOptional($in, LE::readFloat(...));
                $segments = CommonTypes::readOptional($in, Byte::readUnsigned(...));
                break;
            case ScriptDebugShapeType::PAYLOAD_TYPE_TEXT:
                $text = CommonTypes::getString($in);
                $useRotation = CommonTypes::getBool($in);
                $backgroundColor = CommonTypes::readOptional($in, fn() => Color::fromARGB(LE::readUnsignedInt($in)));
                $depthTest = CommonTypes::getBool($in);
                $showBackface = CommonTypes::getBool($in);
                $showTextBackface = CommonTypes::getBool($in);
                break;
            case ScriptDebugShapeType::PAYLOAD_TYPE_BOX:
                $boxBound = CommonTypes::getVector3($in);
                break;
            case ScriptDebugShapeType::PAYLOAD_TYPE_LINE:
                $lineEndLocation = CommonTypes::getVector3($in);
                break;
            case ScriptDebugShapeType::PAYLOAD_TYPE_CIRCLE_OR_SPHERE:
                $segments = Byte::readUnsigned($in);
                break;
            default:
                throw new PacketDecodeException("Unexpected shape payload type $payloadType");
        }
 
        return new self(
            $networkId,
            $shapeType,
            $location,
            $scale,
            $rotation,
            $totalTimeLeft,
            $maximumRenderDistance,
            $color,
            $text,
            $useRotation,
            $backgroundColor,
            $depthTest,
            $showBackface,
            $showTextBackface,
            $boxBound,
            $lineEndLocation,
            $arrowHeadLength,
            $arrowHeadRadius,
            $segments,
            $dimensionId,
            $attachedToEntityId
        );
    }
 
    public function write(ByteBufferWriter $out) : void{
        VarInt::writeUnsignedLong($out, $this->networkId);
        CommonTypes::writeOptional($out, $this->type, fn(ByteBufferWriter $out, ScriptDebugShapeType $type) => Byte::writeUnsigned($out, $type->value));
        CommonTypes::writeOptional($out, $this->location, CommonTypes::putVector3(...));
        CommonTypes::writeOptional($out, $this->scale, LE::writeFloat(...));
        CommonTypes::writeOptional($out, $this->rotation, CommonTypes::putVector3(...));
        CommonTypes::writeOptional($out, $this->totalTimeLeft, LE::writeFloat(...));
        CommonTypes::writeOptional($out, $this->maximumRenderDistance, LE::writeFloat(...));
        CommonTypes::writeOptional($out, $this->color, fn(ByteBufferWriter $out, Color $color) => LE::writeUnsignedInt($out, $color->toARGB()));
        CommonTypes::writeOptional($out, $this->dimensionId, fn(ByteBufferWriter $out, int $dimensionId) => VarInt::writeSignedInt($out, $dimensionId));
        CommonTypes::writeOptional($out, $this->attachedToEntityId, fn(ByteBufferWriter $out, int $entityId) => CommonTypes::putActorRuntimeId($out, $entityId));
 
        //A godawful hack for a godawful packet
        $payloadType = $this->type?->getPayloadType() ?? ScriptDebugShapeType::PAYLOAD_TYPE_NONE;
        if($this->type === null){
            VarInt::writeUnsignedInt($out, ScriptDebugShapeType::PAYLOAD_TYPE_NONE);
        }else{
            switch($this->type){
                case ScriptDebugShapeType::ARROW:
                    VarInt::writeUnsignedInt($out, $this->type->getPayloadType());
                    CommonTypes::writeOptional($out, $this->lineEndLocation, CommonTypes::putVector3(...));
                    CommonTypes::writeOptional($out, $this->arrowHeadLength, LE::writeFloat(...));
                    CommonTypes::writeOptional($out, $this->arrowHeadRadius, LE::writeFloat(...));
                    CommonTypes::writeOptional($out, $this->segments, Byte::writeUnsigned(...));
                    break;
                case ScriptDebugShapeType::TEXT:
                    if($this->text !== null){
                        VarInt::writeUnsignedInt($out, $this->type->getPayloadType());
                        CommonTypes::putString($out, $this->text);
                        CommonTypes::putBool($out, $this->useRotation ?? false);
                        CommonTypes::writeOptional($out, $this->backgroundColor, fn(ByteBufferWriter $out, Color $color) => LE::writeUnsignedInt($out, $color->toARGB()));
                        CommonTypes::putBool($out, $this->depthTest ?? true);
                        CommonTypes::putBool($out, $this->showBackface ?? true);
                        CommonTypes::putBool($out, $this->showTextBackface ?? true);
                    }else{
                        VarInt::writeUnsignedInt($out, ScriptDebugShapeType::PAYLOAD_TYPE_NONE);
                    }
                    break;
                case ScriptDebugShapeType::BOX:
                    if($this->boxBound !== null){
                        VarInt::writeUnsignedInt($out, $this->type->getPayloadType());
                        CommonTypes::putVector3($out, $this->boxBound);
                    }else{
                        VarInt::writeUnsignedInt($out, ScriptDebugShapeType::PAYLOAD_TYPE_NONE);
                    }
                    break;
                case ScriptDebugShapeType::LINE:
                    if($this->lineEndLocation !== null){
                        VarInt::writeUnsignedInt($out, $this->type->getPayloadType());
                        CommonTypes::putVector3($out, $this->lineEndLocation);
                    }else{
                        VarInt::writeUnsignedInt($out, ScriptDebugShapeType::PAYLOAD_TYPE_NONE);
                    }
                    break;
                case ScriptDebugShapeType::CIRCLE:
                case ScriptDebugShapeType::SPHERE:
                    if($this->segments !== null){
                        VarInt::writeUnsignedInt($out, $this->type->getPayloadType());
                        Byte::writeUnsigned($out, $this->segments);
                    }else{
                        VarInt::writeUnsignedInt($out, ScriptDebugShapeType::PAYLOAD_TYPE_NONE);
                    }
                    break;
                default:
                    throw new \LogicException("Unknown payload type $payloadType");
            }
        }
    }
}