x_ite-off-parser 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2009 Holger Seelig and other contributors
+
+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/README.md

@@ -0,0 +1,31 @@
+# x_ite-off-parser
+
+OFF 3D File Format Parser for [X_ITE](https://create3000.github.io/x_ite/)
+
+## Usage
+
+Include the script after X_ITE:
+
+```html
+<script defer src="https://cdn.jsdelivr.net/npm/x_ite@15.0.3/dist/x_ite.min.js"></script>
+<script defer src="https://cdn.jsdelivr.net/npm/x_ite-off-parser@1.0.0/dist/x_ite-off-parser.js"></script>
+<!-- or as ES module -->
+<script type="module" src="https://cdn.jsdelivr.net/npm/x_ite@15.0.3/dist/x_ite.min.mjs"></script>
+<script type="module" src="../dist/x_ite-off-parser.js"></script>
+```
+
+Now you can load OFF files:
+
+```html
+<x3d-canvas src="cube.off"></x3d-canvas>
+```
+
+You can also install it from npm:
+
+```sh
+npm i x_ite-off-parser
+```
+
+## License
+
+x_ite-off-parser is free software and licensed under the [MIT License](LICENSE.md).

package/dist/x_ite-off-parser.js

@@ -0,0 +1,279 @@
+const X3D = window [Symbol .for ("X_ITE.X3D")];
+
+/*
+ *  Grammar
+ */
+
+// Lexical elements
+const Grammar = X3D .Expressions ({
+   // General
+   whitespaces: /[\x20\n\t\r,]+/y,
+   comment: /#[^\r\n]*(?=[\r\n]|$)/y,
+   header: /OFF/y,
+
+   // Values
+   int32:  /(?:0[xX][\da-fA-F]+)|(?:[+-]?\d+)/y,
+   double: /[+-]?(?:(?:(?:\d*\.\d+)|(?:\d+(?:\.)?))(?:[eE][+-]?\d+)?)/y,
+});
+
+/*
+ * Parser
+ */
+
+class OffParser extends X3D .X3DParser
+{
+   constructor (scene)
+   {
+      super (scene);
+
+      this .coordIndex = [ ];
+      this .colors     = [ ];
+      this .points     = [ ];
+   }
+
+   getEncoding ()
+   {
+      return "STRING";
+   }
+
+   setInput (input)
+   {
+      this .input = input;
+   }
+
+   isValid ()
+   {
+      return this .input .match (/OFF\r?\n/);
+   }
+
+   parseIntoScene (resolve, reject)
+   {
+      this .off ()
+         .then (resolve)
+         .catch (reject);
+   }
+
+   async off ()
+   {
+      const
+         browser = this .getBrowser (),
+         scene   = this .getScene ();
+
+      if (!this .statements ())
+         throw new Error ("Invalid file structure.");
+
+      scene .setEncoding ("OFF");
+      scene .setProfile (browser .getProfile ("Interchange"));
+
+      await this .loadComponents ();
+
+      // Geometry
+
+      const
+         shapeNode      = scene .createNode ("Shape"),
+         appearanceNode = scene .createNode ("Appearance"),
+         materialNode   = scene .createNode ("Material"),
+         geometry       = scene .createNode ("IndexedFaceSet"),
+         coordinate     = scene .createNode ("Coordinate");
+
+      if (this .colors .length)
+      {
+         const color = scene .createNode ("Color");
+
+         color .color             = this .colors;
+         geometry .colorPerVertex = false;
+         geometry .color          = color;
+      }
+
+      coordinate .point    = this .points;
+      geometry .coordIndex = this .coordIndex;
+      geometry .coord      = coordinate;
+
+      appearanceNode .material = materialNode;
+
+      shapeNode .appearance = appearanceNode;
+      shapeNode .geometry   = geometry;
+
+      scene .rootNodes .push (shapeNode);
+
+      return scene;
+   }
+
+   statements ()
+   {
+      this .header ();
+
+      if (this .counts ())
+      {
+         if (this .listOfVertices ())
+         {
+            if (this .listOfFaces ())
+               return true;
+         }
+      }
+
+      return false;
+   }
+
+   comments ()
+   {
+      while (this .comment ())
+         ;
+   }
+
+   comment ()
+   {
+      this .whitespaces ();
+
+      if (Grammar .comment .parse (this))
+         return true;
+
+      return false;
+   }
+
+   whitespaces ()
+   {
+      Grammar .whitespaces .parse (this);
+   }
+
+   header ()
+   {
+      return Grammar .header .parse (this);
+   }
+
+   counts ()
+   {
+      this .comments ();
+
+      if (this .int32 ())
+      {
+         this .numVertices = this .value;
+
+         if (this .int32 ())
+         {
+            this .numFaces = this .value;
+
+            if (this .int32 ())
+            {
+               this .numEdges = this .value;
+
+               return true;
+            }
+         }
+      }
+
+      return false;
+   }
+
+   listOfVertices ()
+   {
+      const
+         numVertices = this .numVertices,
+         points      = this .points;
+
+      for (let v = 0; v < numVertices; ++ v)
+      {
+         this .comments ();
+
+         if (this .double ())
+         {
+            points .push (this .value);
+
+            if (this .double ())
+            {
+               points .push (this .value);
+
+               if (this .double ())
+               {
+                  points .push (this .value);
+                  continue;
+               }
+            }
+         }
+
+         return false;
+      }
+
+      return true;
+   }
+
+   listOfFaces ()
+   {
+      const
+         coordIndex = this .coordIndex,
+         colors     = this .colors,
+         numFaces   = this .numFaces;
+
+      for (let f = 0; f < numFaces; ++ f)
+      {
+         this .comments ();
+
+         if (this .int32 ())
+         {
+            const numIndices = this .value;
+
+            for (let i = 0; i < numIndices; ++ i)
+            {
+               if (this .int32 ())
+               {
+                  coordIndex .push (this .value);
+                  continue;
+               }
+
+               return false;
+            }
+
+            coordIndex .push (-1);
+
+            if (this .int32 ())
+            {
+               colors .push (this .value / 255);
+
+               if (this .int32 ())
+               {
+                  colors .push (this .value / 255);
+
+                  if (this .int32 ())
+                     colors .push (this .value / 255);
+               }
+            }
+
+            continue;
+         }
+
+         return false;
+      }
+
+      return true;
+   }
+
+   int32 ()
+   {
+      this .whitespaces ();
+
+      if (Grammar .int32 .parse (this))
+      {
+         this .value = parseInt (this .result [0]);
+
+         return true;
+      }
+
+      return false;
+   }
+
+   double ()
+   {
+      this .whitespaces ();
+
+      if (Grammar .double .parse (this))
+      {
+         this .value = parseFloat (this .result [0]);
+
+         return true;
+      }
+
+      return false;
+   }
+}
+
+X3D .GoldenGate .addParsers (OffParser);

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "x_ite-off-parser",
+  "version": "1.0.0",
+  "description": "OFF 3D File Format Parser for X_ITE",
+  "main": "dist/x_ite-off-parser.js",
+  "module": "dist/x_ite-off-parser.js",
+  "files": [
+    "dist/*"
+  ],
+  "scripts": {
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/create3000/x_ite-off-parser.git"
+  },
+  "keywords": [
+    "3D",
+    "Browser",
+    "JavaScript",
+    "Node",
+    "OFF",
+    "x_ite",
+    "X3D"
+  ],
+  "author": "Holger Seelig <holger.seelig@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/create3000/x_ite-off-parser/issues"
+  },
+  "homepage": "https://github.com/create3000/x_ite-off-parser#readme",
+  "funding": {
+    "type": "patreon",
+    "url": "https://patreon.com/X_ITE"
+  }
+}