teleportxr 1.0.0 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
-# teleport-nodejs
-A minimal Teleport server on node.js
+# TeleportXR
+Teleport virtual reality server for node.js
 
 1. Ensure node.js is installed.
-2. Run npm install in this directory to create the node_modules folder.
-3. Run server.js using the provided .vscode/launch.json
+2. Run npm install teleportxr.
+3. See https://github.com/teleportxr/teleport-nodejs-server-example.git for example usage.

package/client/client.js

@@ -8,6 +8,7 @@ const node_encoder= require("../protocol/encoders/node_encoder.js");
 const resource_encoder= require("../protocol/encoders/resource_encoder.js");
 const WebRtcConnectionManager = require('../connections/webrtcconnectionmanager');
 const resources= require("../scene/resources.js");
+const { BackgroundMode } = require("../core/core.js");
 
 
 class OriginState
@@ -110,6 +111,14 @@ class Client {
     Start()
     {
         this.setupCommand=new command.SetupCommand();
+		if(this.scene)
+		{
+			if(this.scene.backgroundTexturePath&&this.scene.backgroundTexturePath!="")
+			{
+				this.setupCommand.BackgroundMode_backgroundMode=BackgroundMode.TEXTURE;
+				this.setupCommand.uid_backgroundTexture=resources.AddTexture(this.scene.backgroundTexturePath);
+			}
+		}
         this.SendCommand(this.setupCommand);
     }
     SendCommand(command){
@@ -223,27 +232,30 @@ class Client {
 		console.log("Sending node "+uid+" "+node.name+" to Client "+this.clientID+", size: "+nodeSize+" bytes");
 		this.webRtcConnection.sendGeometry(view2);
 	}
-	SendMesh(uid)
-	{
-		var mesh=resources.GetResource(uid);
-	}
-	SendTexture(uid)
+	SendGenericResource(uid)
 	{
-		var texture=resources.GetResourceFromUid(uid);
-		if(!texture)
+		var resource=resources.GetResourceFromUid(uid);
+		if(!resource)
 		{
-			console.warn("No texture of uid ",uid," was found.")
+			console.warn("No resource of uid ",uid," was found.")
 			return;
 		}
-		const MAX_TEXTURE_SIZE=500;
-		const buffer = new ArrayBuffer(MAX_TEXTURE_SIZE);
-		const textureSize=resource_encoder.EncodeResource(texture,buffer);
+		const MAX_BUFFER_SIZE=500;
+		const buffer = new ArrayBuffer(MAX_BUFFER_SIZE);
+		const resourceSize=resource_encoder.EncodeResource(resource,buffer);
 		this.geometryService.EncodedResource(uid);
-		const view2 = new DataView(buffer, 0, textureSize); 
-		console.log("Sending texture "+uid+" "+texture.url+" to Client "+this.clientID+", size: "+textureSize+" bytes");
+		const view2 = new DataView(buffer, 0, resourceSize); 
+		console.log("Sending resource "+uid+" "+resource.url+" to Client "+this.clientID+", size: "+resourceSize+" bytes");
 		this.webRtcConnection.sendGeometry(view2);
 	}
-
+	SendMesh(uid)
+	{
+		this.SendGenericResource(uid);
+	}
+	SendTexture(uid)
+	{
+		this.SendGenericResource(uid);
+	}
     receiveHandshake(data)
     {
         if(data.length<message.HandshakeMessage.sizeof()) {

package/client/geometry_service.js

@@ -130,7 +130,22 @@ class GeometryService
 		this.streamedNodes.delete(uid);
 		// TODO: now reduce the counts for all the dependent resources.
 	}
-	
+	StreamOrUnstream(resourceMap,uid,diff)
+	{
+		if(uid==BigInt(0))
+			return;
+		if(uid==0)
+			return;
+		if(!resourceMap.has(uid))
+		{
+			resourceMap.set(uid,0);
+		}
+		resourceMap.set(uid,resourceMap.get(uid)+diff);
+	}
+	AddOrRemoveTexture(thisTextureUid,diff){
+		this.StreamOrUnstream(this.streamedTextures,thisTextureUid,diff);
+	}
+
 	AddMeshComponentResources(meshComponent,diff)
 	{
 		if (meshComponent.getType() != nd.NodeDataType.Mesh)
@@ -141,7 +156,7 @@ class GeometryService
 		{
 			return;
 		}
-		this.streamedMeshes.set(meshComponent.data_uid,this.streamedMeshes.get(meshComponent.data_uid)+diff);
+		this.StreamOrUnstream(this.streamedMeshes,meshComponent.data_uid,diff);
 		//meshNode.skeletonID = node.skeletonNodeID;
 
 		//Get joint/bone IDs, if the skeletonID is not zero.
@@ -154,7 +169,7 @@ class GeometryService
 		}
 		if(meshComponent.renderState.globalIlluminationUid != BigInt(0))
 		{
-			this.streamedTextures.set(meshComponent.renderState.globalIlluminationUid,this.streamedTextures.get(meshComponent.renderState.globalIlluminationUid)+diff);
+			this.StreamOrUnstream(this.streamedTextures,meshComponent.renderState.globalIlluminationUid,diff);
 		}
 	}
 
@@ -171,7 +186,7 @@ class GeometryService
 			{
 				continue;
 			}
-			this.streamedMaterials.set(material_uid,this.streamedMaterials.get(material_uid)+diff);
+			this.StreamOrUnstream(this.streamedMaterials,material_uid,diff);
 
 			var texture_uids =
 			[
@@ -184,7 +199,7 @@ class GeometryService
 			for(const tex_uid of texture_uids)
 			{
 				if(tex_uid!=0)
-					this.streamedTextures.set(tex_uid,this.streamedTextures.get(tex_uid)+diff);
+					this.StreamOrUnstream(this.streamedTextures,tex_uid,diff);
 			}
 		}
 	}
@@ -254,11 +269,11 @@ class GeometryService
 							if(f)
 							{
 								if(node.data_uid)
-									this.streamedTextCanvases.set(f.data_uid,this.streamedTextCanvases.get(f.data_uid)+diff);
+									this.StreamOrUnstream(this.streamedTextCanvases,f.data_uid,diff);
 								if(c.font_uid)
-									this.streamedFontAtlases.set(f.font_uid,this.streamedFontAtlases.get(f.font_uid)+diff);
+									this.StreamOrUnstream(this.streamedFontAtlases,f.font_uid,diff);
 								if(f.font_texture_uid)
-									this.streamedTextures.set(f.font_texture_uid,this.streamedTextures.get(f.font_texture_uid)+diff);
+									this.StreamOrUnstream(this.streamedTextures,f.font_texture_uid,diff);
 							}
 						}
 					}
@@ -303,22 +318,6 @@ class GeometryService
 			this.AddOrRemoveNodeAndResources(uid,1);
 		}
 	}
-	AddOrRemoveTexture(thisTextureUid,diff){
-		if(thisTextureUid==BigInt(0))
-			return;
-		if(thisTextureUid==0)
-			return;
-		if(this.streamedTextures.has(thisTextureUid))
-	 	{
-			
-		}
-		else
-		{
-			this.streamedTextures.set(thisTextureUid,0);
-		}
-		this.streamedTextures.set(thisTextureUid,this.streamedTextures.get(thisTextureUid)+diff);
-	}
-
 	UpdateTexturesToStream() {
 		// scene background?
 		var bg_uid=resources.GetResourceUidFromUrl(core.GeometryPayloadType.TexturePointer,this.scene.backgroundTexturePath);
@@ -375,10 +374,10 @@ class GeometryService
 	GetMeshesToStream()
 	{
 		var resource_uids=[];
-		this.streamedMeshes.forEach(uid => {
+		let time_now_us=core.getTimestampUs();
+		for(const [uid, count] of this.streamedMeshes)
+		 {
 			//is mesh streamed
-			if(!GeometryService.trackedResources.has(uid))
-				return;
 			var res=GeometryService.GetOrCreateTrackedResource(uid);
 			res.Sent(this.clientID,time_now_us);
 			if(res.WasSentToClient(this.clientID))
@@ -395,7 +394,7 @@ class GeometryService
 				// if it hasn't been sent at all to our client, we add its resources.
 				resource_uids.push(uid);
 			}
-		});
+		};
 		return resource_uids;
 	}
 	EncodedResource(resource_uid)

package/core/core.js

@@ -428,7 +428,7 @@ function put_vec4(dataView, byteOffset, value) {
 //! Insert a string to the dataView.
 function put_string(dataView, byteOffset, name) {
 	byteOffset = put_uint16(dataView, byteOffset, name.length);
-	//Push name.
+	// Push name.
 	for (var i = 0; i < name.length; i++) {
 		var char = name[i];
 		var code = char.charCodeAt(0);

package/package.json

@@ -13,7 +13,7 @@
   },
   "name": "teleportxr",
   "description": "A minimal Teleport server on node.js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/simul/teleport-nodejs.git"

package/scene/resources.js

@@ -56,7 +56,13 @@ function GetResourceFromUid(uid)
 //! Add the texture url as a resource.
 function AddTexture(url)
 {
-	GetResourceUidFromUrl(core.GeometryPayloadType.TexturePointer,url);
+	return GetResourceUidFromUrl(core.GeometryPayloadType.TexturePointer,url);
 }
 
-module.exports = {Resource,GetResourceFromUrl,GetResourceUidFromUrl,GetResourceFromUid,AddTexture};
+//! Add the texture url as a resource.
+function AddMesh(url)
+{
+	return GetResourceUidFromUrl(core.GeometryPayloadType.MeshPointer,url);
+}
+
+module.exports = {Resource,GetResourceFromUrl,GetResourceUidFromUrl,GetResourceFromUid,AddTexture,AddMesh};

package/scene/scene.js

@@ -65,7 +65,11 @@ class Scene {
 				if (components) {
 					for (let c of components) {
 						if (c["type"] == "mesh")
-							n.setMeshComponent(c["url"]);
+						{
+							var mesh_url=c["url"];
+							resources.AddMesh(mesh_url);
+							n.setMeshComponent(mesh_url);
+						}
 					}
 				}
 			}

package/server copy.js

@@ -0,0 +1,35 @@
+'use strict';
+ 
+const WebRtcConnectionManager = require('./connections/webrtcconnectionmanager');
+const cm = require('./client/client_manager.js');
+
+const signaling=require("./signaling.js");
+const scene=require("./scene/scene.js");
+
+var sc=new scene.Scene();
+
+const fs = require('fs');
+const path = require('path');
+
+const assetsPath = path.join(__dirname,'assets');
+
+sc.Load(path.join(assetsPath,'scene.json'));
+
+// This is our app's callback for when a new client is to be created.
+// It must return the origin uid for the client.
+function createNewClient(clientID) {
+	var origin_uid=sc.CreateNode();
+	return origin_uid;
+}
+
+// This will be called AFTER a client has been created, so we can access it from the clientManager.
+function onClientPostCreate(clientID) {
+	var client=cm.getInstance().GetClient(clientID);
+	client.SetScene(sc);
+}
+
+const webRtcConnectionManager = WebRtcConnectionManager.getInstance();
+webRtcConnectionManager.SetSendConfigMessage(signaling.sendConfigMessage);
+cm.getInstance().SetNewClientCallback(createNewClient);
+cm.getInstance().SetClientPostCreationCallback(onClientPostCreate);
+signaling.init(webRtcConnectionManager,cm.getInstance().newClient.bind(cm.getInstance()));