Entity edit packets.

example/interface.js

@@ -707,6 +707,36 @@ import { Vircadia, DomainServer, Camera, AudioMixer, AvatarMixer, EntityServer,
                     td.innerHTML = position.z.toFixed(POS_DECIMAL_PLACES);
                     tr.appendChild(td);
                     entityListBody.appendChild(tr);
+
+                    td = document.createElement("td");
+                    const eraseButton = document.createElement("button");
+                    eraseButton.innerHTML = "Erase";
+                    eraseButton.onclick = () => {
+                        const id = e.entityItemID;
+                        console.log("ERASING: ", id.stringify());
+                        entityServer.sendEntityErasePacket(id);
+                    };
+                    td.appendChild(eraseButton);
+                    tr.appendChild(td);
+
+                    td = document.createElement("td");
+                    const nudgeButton = document.createElement("button");
+                    nudgeButton.innerHTML = "Nudge";
+                    nudgeButton.onclick = () => {
+                        const id = e.entityItemID;
+                        const e2 = {
+                            entityItemID: e.entityItemID,
+                            entityType: e.entityType,
+                            lastEdited: BigInt(Date.now()) * 1000n,
+                            updateDelta: 0,
+                            position: e.position
+                        };
+                        console.log("EDITING: ", id.stringify(), e2);
+                        e2.position.x += 1;
+                        entityServer.sendEntityEditPacket(e2);
+                    };
+                    td.appendChild(nudgeButton);
+                    tr.appendChild(td);
                 }
             });
 

src/EntityServer.ts

@@ -20,6 +20,10 @@ import Camera from "./domain/shared/Camera";
 import ContextManager from "./domain/shared/ContextManager";
 import SignalEmitter, { Signal } from "./domain/shared/SignalEmitter";
 import AssignmentClient from "./domain/AssignmentClient";
+import EntityEditPacketSender from "./domain/entities/EntityEditPacketSender";
+import Uuid from "./domain/shared/Uuid";
+import PacketType from "./domain/networking/udt/PacketHeaders";
+import { EntityProperties } from "./domain/networking/packets/EntityData"
 
 
 /*@sdkdoc
@@ -98,6 +102,7 @@ class EntityServer extends AssignmentClient {
 
     #_octreeQuery = new OctreeQuery(true);
     #_octreeProcessor;
+    #_entityEditpacketSender;
     #_maxOctreePPS = OctreeConstants.DEFAULT_MAX_OCTREE_PPS;
     #_queryExpiry = 0;
     #_physicsEnabled = true;
@@ -112,11 +117,14 @@ class EntityServer extends AssignmentClient {
         this.#_nodeList = ContextManager.get(contextID, NodeList) as NodeList;
 
         ContextManager.set(contextID, OctreePacketProcessor, contextID);
+        ContextManager.set(contextID, EntityEditPacketSender, contextID);
         this.#_octreeProcessor = ContextManager.get(contextID, OctreePacketProcessor) as OctreePacketProcessor;
         this.#_octreeProcessor.entityData.connect((data) => {
             this.#_entityData.emit(data);
         });
 
+        this.#_entityEditpacketSender = ContextManager.get(contextID, EntityEditPacketSender) as EntityEditPacketSender;
+
         // C++  Application::Application()
         this.#_nodeList.nodeActivated.connect(this.#nodeActivated);
         this.#_nodeList.nodeKilled.connect(this.#nodeKilled);
@@ -156,6 +164,17 @@ class EntityServer extends AssignmentClient {
         }
     }
 
+    sendEntityErasePacket(packetID: Uuid) {
+        this.#_entityEditpacketSender.sendErasePacket(packetID);
+    }
+
+    sendEntityAddPacket(properties: EntityProperties) {
+        this.#_entityEditpacketSender.sendEditPacket(PacketType.EntityAdd, properties);
+    }
+
+    sendEntityEditPacket(properties: EntityProperties) {
+        this.#_entityEditpacketSender.sendEditPacket(PacketType.EntityEdit, properties);
+    }
 
     // Sends an EntityQuery packet to the entity server.
     #queryOctree(serverType: NodeTypeValue): void {

src/domain/entities/EntityEditPacketSender.ts

@@ -0,0 +1,120 @@
+//
+//  EntityData.ts
+//
+//  Created by Nshan G. on 17 Dec 2022.
+//  Copyright 2022 Vircadia contributors.
+//  Copyright 2022 DigiSomni LLC.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+import Uuid from "../shared/Uuid";
+import ContextManager from "../shared/ContextManager";
+import NodeList from "../networking/NodeList";
+import NLPacket from "../networking/NLPacket"
+import NodeType from "../networking/NodeType";
+import { PacketTypeValue } from "../networking/udt/PacketHeaders";
+import EntityData, { EntityProperties } from "../networking/packets/EntityData"
+import UDT from "../networking/udt/UDT";
+
+class EntityEditPacketSender
+{
+    static readonly contextItemType = "EntityEditPacketSender";
+
+    #_outgoingSequenceNumbers = new Map<string, number>();
+    //TODO: native client maintains a history of sent packets per node, and resends them upon receiving a NACK packet
+    // TODO: native client has a two stage message queue to pack multiple edit messages in one packet
+    #_nodeList: NodeList;
+
+    constructor(contextID: number) {
+        this.#_nodeList = ContextManager.get(contextID, NodeList) as NodeList;
+    }
+
+    sendErasePacket(id: Uuid) {
+        const packet = NLPacket.create(PacketTypeValue.EntityErase);
+        const messageData = packet.getMessageData();
+        const data = messageData.data;
+        let dataPosition = messageData.dataPosition;
+
+        // write sequence number
+        const node = this.#_nodeList.soloNodeOfType(NodeType.EntityServer);
+        if (node == null) {
+            // TODO: native client buffers packets until entity server becomes available
+            console.warn("EntityEditPacketSender: EntityErase packet not sent because Entity Server is not available.");
+            return;
+        }
+        const nodeUUID = node.getUUID()
+        let sequenceNumber = this.#_outgoingSequenceNumbers.get(nodeUUID.stringify());
+        sequenceNumber = undefined !== sequenceNumber ? sequenceNumber + 1 : 0;
+        this.#_outgoingSequenceNumbers.set(nodeUUID.stringify(), sequenceNumber);
+        data.setUint16(dataPosition, sequenceNumber, UDT.LITTLE_ENDIAN);
+        dataPosition += 2;
+
+        // write timestamp in microseconds
+        // TODO: the native client maintains an average packet travel time to the node (called clock skew) and adjust the timestamp
+        data.setBigUint64(dataPosition, BigInt(Date.now()) * 1000n, UDT.LITTLE_ENDIAN);
+        dataPosition += 8;
+
+        // write erase message data
+        const messageBytesWritten = EntityData.encodeEraseEntityMessage(id, new DataView(data.buffer, data.byteOffset + dataPosition));
+        if (messageBytesWritten === 0) {
+            console.warn("EntityEditPacketSender: EntityErase packet not sent because message data didn't fit in the packet.");
+            return;
+        }
+        dataPosition += messageBytesWritten;
+
+        messageData.dataPosition = dataPosition;
+        messageData.packetSize = dataPosition;
+
+        this.#_nodeList.broadcastToNodes(packet, new Set([NodeType.EntityServer]));
+    }
+
+    sendEditPacket(type: PacketTypeValue.EntityAdd | PacketTypeValue.EntityEdit, properties: EntityProperties) {
+        const packet = type === PacketTypeValue.EntityAdd ?
+            NLPacket.create(PacketTypeValue.EntityAdd, UDT.MAX_PACKET_SIZE * 10, true) :
+            NLPacket.create(PacketTypeValue.EntityEdit) ;
+
+        const messageData = packet.getMessageData();
+        const data = messageData.data;
+        let dataPosition = messageData.dataPosition;
+
+        // write sequence number
+        const node = this.#_nodeList.soloNodeOfType(NodeType.EntityServer);
+        if (node == null) {
+            // TODO: native client buffers packets until entity server becomes available
+            console.warn("EntityEditPacketSender: EntityErase packet not sent because Entity Server is not available.");
+            return;
+        }
+        const nodeUUID = node.getUUID()
+        let sequenceNumber = this.#_outgoingSequenceNumbers.get(nodeUUID.stringify());
+        sequenceNumber = undefined !== sequenceNumber ? sequenceNumber + 1 : 0;
+        this.#_outgoingSequenceNumbers.set(nodeUUID.stringify(), sequenceNumber);
+        data.setUint16(dataPosition, sequenceNumber, UDT.LITTLE_ENDIAN);
+        dataPosition += 2;
+
+        // write timestamp in microseconds
+        // TODO: the native client maintains an average packet travel time to the node (called clock skew) and adjust the timestamp
+        data.setBigUint64(dataPosition, BigInt(Date.now()) * 1000n, UDT.LITTLE_ENDIAN);
+        dataPosition += 8;
+
+        console.log(dataPosition);
+        // write erase message data
+        const messageBytesWritten = EntityData.encodeEntityEditPacket(properties, new DataView(data.buffer, data.byteOffset + dataPosition));
+        if (messageBytesWritten === 0) {
+            console.warn("EntityEditPacketSender: EntityErase packet not sent because message data didn't fit in the packet.");
+            return;
+        }
+        dataPosition += messageBytesWritten;
+
+        messageData.dataPosition = dataPosition;
+        messageData.packetSize = dataPosition;
+
+        this.#_nodeList.broadcastToNodes(packet, new Set([NodeType.EntityServer]));
+    }
+
+    // TODO: in native client the properties of EntityAdd packet that didn't fit are sent after it in EntityEdit packets.
+}
+
+
+export default EntityEditPacketSender;

src/domain/entities/ParticleEffectEntityItem.ts

@@ -47,8 +47,8 @@ type ParticleEffectEntitySubclassProperties = {
     radiusStart: number | undefined,
     radiusFinish: number | undefined,
     colorSpread: color | undefined,
-    colorStart: color | undefined,
-    colorFinish: color | undefined,
+    colorStart: vec3 | undefined,
+    colorFinish: vec3 | undefined,
     alphaSpread: number | undefined,
     alphaStart: number | undefined,
     alphaFinish: number | undefined,
@@ -400,22 +400,22 @@ class ParticleEffectEntityItem {
             dataPosition += 3;
         }
 
-        let colorStart: color | undefined = undefined;
+        let colorStart: vec3 | undefined = undefined;
         if (propertyFlags.getHasProperty(EntityPropertyFlags.PROP_COLOR_START)) {
             colorStart = {
-                red: data.getFloat32(dataPosition, UDT.LITTLE_ENDIAN),
-                green: data.getFloat32(dataPosition + 4, UDT.LITTLE_ENDIAN),
-                blue: data.getFloat32(dataPosition + 8, UDT.LITTLE_ENDIAN)
+                x: data.getFloat32(dataPosition, UDT.LITTLE_ENDIAN),
+                y: data.getFloat32(dataPosition + 4, UDT.LITTLE_ENDIAN),
+                z: data.getFloat32(dataPosition + 8, UDT.LITTLE_ENDIAN)
             };
             dataPosition += 12;
         }
 
-        let colorFinish: color | undefined = undefined;
+        let colorFinish: vec3 | undefined = undefined;
         if (propertyFlags.getHasProperty(EntityPropertyFlags.PROP_COLOR_FINISH)) {
             colorFinish = {
-                red: data.getFloat32(dataPosition, UDT.LITTLE_ENDIAN),
-                green: data.getFloat32(dataPosition + 4, UDT.LITTLE_ENDIAN),
-                blue: data.getFloat32(dataPosition + 8, UDT.LITTLE_ENDIAN)
+                x: data.getFloat32(dataPosition, UDT.LITTLE_ENDIAN),
+                y: data.getFloat32(dataPosition + 4, UDT.LITTLE_ENDIAN),
+                z: data.getFloat32(dataPosition + 8, UDT.LITTLE_ENDIAN)
             };
             dataPosition += 12;
         }