Internet Engineering Task Force L.R. van Kammen Internet-Draft 7 September 2023 Intended status: Informational XR Fragments draft-XRFRAGMENTS-leonvankammen-00 Abstract This draft offers a specification for 4D URLs & navigation, to link 3D scenes and text together with- or without a network-connection. The specification promotes spatial addressibility, sharing, navigation, query-ing and tagging interactive (text)objects across for (XR) Browsers. XR Fragments allows us to enrich existing dataformats, by recursive use of existing proven technologies like URI Fragments (https://en.wikipedia.org/wiki/URI_fragment) and BibTags notation. Almost every idea in this document is demonstrated at https://xrfragment.org (https://xrfragment.org) Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on 10 March 2024. Copyright Notice Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/ license-info) in effect on the date of publication of this document. van Kammen Expires 10 March 2024 [Page 1] Internet-Draft XR Fragments September 2023 Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Core principle . . . . . . . . . . . . . . . . . . . . . . . 3 3. Conventions and Definitions . . . . . . . . . . . . . . . . . 3 4. List of URI Fragments . . . . . . . . . . . . . . . . . . . . 4 5. List of metadata for 3D nodes . . . . . . . . . . . . . . . . 5 6. Navigating 3D . . . . . . . . . . . . . . . . . . . . . . . . 5 7. Embedding 3D content . . . . . . . . . . . . . . . . . . . . 6 8. XR Fragment queries . . . . . . . . . . . . . . . . . . . . . 7 8.1. including/excluding . . . . . . . . . . . . . . . . . . . 8 8.2. Query Parser . . . . . . . . . . . . . . . . . . . . . . 8 8.3. XR Fragment URI Grammar . . . . . . . . . . . . . . . . . 9 9. Text in XR (tagging,linking to spatial objects) . . . . . . . 9 9.1. Default Data URI mimetype . . . . . . . . . . . . . . . . 12 9.2. URL and Data URI . . . . . . . . . . . . . . . . . . . . 13 9.3. Bibs & BibTeX: lowest common denominator for linking data . . . . . . . . . . . . . . . . . . . . . . . . . . 14 9.4. XR Text example parser . . . . . . . . . . . . . . . . . 16 10. HYPER copy/paste . . . . . . . . . . . . . . . . . . . . . . 18 11. Security Considerations . . . . . . . . . . . . . . . . . . . 18 12. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 19 13. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 19 1. Introduction How can we add more features to existing text & 3D scenes, without introducing new dataformats? Historically, there's many attempts to create the ultimate markuplanguage or 3D fileformat. However, thru the lens of authoring, their lowest common denominator is still: plain text. XR Fragments allows us to enrich/connect existing dataformats, by recursive use of existing technologies: 1. addressibility and navigation of 3D scenes/objects: URI Fragments (https://en.wikipedia.org/wiki/URI_fragment) + src/href spatial metadata 2. hasslefree tagging across text and spatial objects using BibTags (https://en.wikipedia.org/wiki/BibTeX) as appendix (see visual- meta (https://visual-meta.info) e.g.) van Kammen Expires 10 March 2024 [Page 2] Internet-Draft XR Fragments September 2023 | NOTE: The chapters in this document are ordered from highlevel to | lowlevel (technical) as much as possible 2. Core principle XR Fragments strives to serve (nontechnical/fuzzy) humans first, and machine(implementations) later, by ensuring hasslefree text-vs- thought feedback loops. This also means that the repair-ability of machine-matters should be human friendly too (not too complex). | "When a car breaks down, the ones *without* turbosupercharger are | easier to fix" Let's always focus on average humans: the 'fuzzy symbolical mind' must be served first, before serving the greater 'categorized typesafe RDF hive mind' (https://en.wikipedia.org/wiki/Borg)). | Humans first, machines (AI) later. 3. Conventions and Definitions +===============+=============================================+ | definition | explanation | +===============+=============================================+ | human | a sentient being who thinks fuzzy, absorbs, | | | and shares thought (by plain text, not | | | markuplanguage) | +---------------+---------------------------------------------+ | scene | a (local/remote) 3D scene or 3D file | | | (index.gltf e.g.) | +---------------+---------------------------------------------+ | 3D object | an object inside a scene characterized by | | | vertex-, face- and customproperty data. | +---------------+---------------------------------------------+ | metadata | custom properties of text, 3D Scene or | | | Object(nodes), relevant to machines and a | | | human minority (academics/developers) | +---------------+---------------------------------------------+ | XR fragment | URI Fragment with spatial hints like | | | #pos=0,0,0&t=1,100 e.g. | +---------------+---------------------------------------------+ | src | (HTML-piggybacked) metadata of a 3D object | | | which instances content | +---------------+---------------------------------------------+ | href | (HTML-piggybacked) metadata of a 3D object | | | which links to content | +---------------+---------------------------------------------+ van Kammen Expires 10 March 2024 [Page 3] Internet-Draft XR Fragments September 2023 | query | an URI Fragment-operator which queries | | | object(s) from a scene like #q=cube | +---------------+---------------------------------------------+ | visual-meta | visual-meta (https://visual.meta.info) data | | | appended to text/books/papers which is | | | indirectly visible/editable in XR. | +---------------+---------------------------------------------+ | requestless | opposite of networked metadata (RDF/HTML | | metadata | requests can easily fan out into framerate- | | | dropping, hence not used a lot in games). | +---------------+---------------------------------------------+ | FPS | frames per second in spatial experiences | | | (games,VR,AR e.g.), should be as high as | | | possible | +---------------+---------------------------------------------+ | introspective | inward sensemaking ("I feel this belongs to | | | that") | +---------------+---------------------------------------------+ | extrospective | outward sensemaking ("I'm fairly sure John | | | is a person who lives in oklahoma") | +---------------+---------------------------------------------+ | ◻ | ascii representation of an 3D object/mesh | +---------------+---------------------------------------------+ | (un)obtrusive | obtrusive: wrapping human text/thought in | | | XML/HTML/JSON obfuscates human text into a | | | salad of machine-symbols and words | +---------------+---------------------------------------------+ | BibTeX | simple tagging/citing/referencing standard | | | for plaintext | +---------------+---------------------------------------------+ | BibTag | a BibTeX tag | +---------------+---------------------------------------------+ Table 1 4. List of URI Fragments +==========+=========+==============+============================+ | fragment | type | example | info | +==========+=========+==============+============================+ | #pos | vector3 | #pos=0.5,0,0 | positions camera to xyz- | | | | | coord 0.5,0,0 | +----------+---------+--------------+----------------------------+ | #rot | vector3 | #rot=0,90,0 | rotates camera to xyz- | | | | | coord 0.5,0,0 | +----------+---------+--------------+----------------------------+ | #t | vector2 | #t=500,1000 | sets animation-loop range | | | | | between frame 500 and 1000 | van Kammen Expires 10 March 2024 [Page 4] Internet-Draft XR Fragments September 2023 +----------+---------+--------------+----------------------------+ | #...... | string | #.cubes | object(s) of interest | | | | #cube | (fragment to object name | | | | | or class mapping) | +----------+---------+--------------+----------------------------+ Table 2 | xyz coordinates are similar to ones found in SVG Media Fragments 5. List of metadata for 3D nodes +=======+========+================+============================+ | key | type | example (JSON) | info | +=======+========+================+============================+ | name | string | "name": "cube" | available in all 3D | | | | | fileformats & scenes | +-------+--------+----------------+----------------------------+ | class | string | "class": | available through custom | | | | "cubes" | property in 3D fileformats | +-------+--------+----------------+----------------------------+ | href | string | "href": | available through custom | | | | "b.gltf" | property in 3D fileformats | +-------+--------+----------------+----------------------------+ | src | string | "src": | available through custom | | | | "#q=cube" | property in 3D fileformats | +-------+--------+----------------+----------------------------+ Table 3 Popular compatible 3D fileformats: .gltf, .obj, .fbx, .usdz, .json (THREEjs), COLLADA and so on. | NOTE: XR Fragments are file-agnostic, which means that the | metadata exist in programmatic 3D scene(nodes) too. 6. Navigating 3D Here's an ascii representation of a 3D scene-graph which contains 3D objects ◻ and their metadata: van Kammen Expires 10 March 2024 [Page 5] Internet-Draft XR Fragments September 2023 +--------------------------------------------------------+ | | | index.gltf | | │ | | ├── ◻ buttonA | | │ └ href: #pos=1,0,1&t=100,200 | | │ | | └── ◻ buttonB | | └ href: other.fbx | <-- file-agnostic (can be .gltf .obj etc) | | +--------------------------------------------------------+ An XR Fragment-compatible browser viewing this scene, allows the end- user to interact with the buttonA and buttonB. In case of buttonA the end-user will be teleported to another location and time in the *current loaded scene*, but buttonB will *replace the current scene* with a new one, like other.fbx. 7. Embedding 3D content Here's an ascii representation of a 3D scene-graph with 3D objects ◻ which embeds remote & local 3D objects ◻ (without) using queries: +--------------------------------------------------------+ +-------------------------+ | | | | | index.gltf | | ocean.com/aquarium.fbx | | │ | | │ | | ├── ◻ canvas | | └── ◻ fishbowl | | │ └ src: painting.png | | ├─ ◻ bass | | │ | | └─ ◻ tuna | | ├── ◻ aquariumcube | | | | │ └ src: ://rescue.com/fish.gltf#q=bass%20tuna | +-------------------------+ | │ | | ├── ◻ bedroom | | │ └ src: #q=canvas | | │ | | └── ◻ livingroom | | └ src: #q=canvas | | | +--------------------------------------------------------+ van Kammen Expires 10 March 2024 [Page 6] Internet-Draft XR Fragments September 2023 An XR Fragment-compatible browser viewing this scene, lazy-loads and projects painting.png onto the (plane) object called canvas (which is copy-instanced in the bed and livingroom). Also, after lazy-loading ocean.com/aquarium.gltf, only the queried objects bass and tuna will be instanced inside aquariumcube. Resizing will be happen accordingly to its placeholder object aquariumcube, see chapter Scaling. 8. XR Fragment queries Include, exclude, hide/shows objects using space-separated strings: * #q=cube * #q=cube -ball_inside_cube * #q=* -sky * #q=-.language .english * #q=cube&rot=0,90,0 * #q=price:>2 price:<5 It's simple but powerful syntax which allows css-like class/ id-selectors with a searchengine prompt-style feeling: 1. queries are showing/hiding objects *only* when defined as src value (prevents sharing of scene-tampered URL's). 2. queries are highlighting objects when defined in the top-Level (browser) URL (bar). 3. search words like cube and foo in #q=cube foo are matched against 3D object names or custom metadata-key(values) 4. search words like cube and foo in #q=cube foo are matched against tags (BibTeX) inside plaintext src values like @cube{redcube, ... e.g. 5. # equals #q=* 6. words starting with . like .german match class-metadata of 3D objects like "class":"german" 7. words starting with . like .german match class-metadata of (BibTeX) tags in XR Text objects like @german{KarlHeinz, ... e.g. | *For example*: #q=.foo is a shorthand for #q=class:foo, which will | select objects with custom property class:foo. Just a simple | #q=cube will simply select an object named cube. * see an example video here (https://coderofsalvation.github.io/xrfragment.media/queries.mp4) van Kammen Expires 10 March 2024 [Page 7] Internet-Draft XR Fragments September 2023 8.1. including/excluding +==========+=================================================+ | operator | info | +==========+=================================================+ | * | select all objects (only useful in src custom | | | property) | +----------+-------------------------------------------------+ | - | removes/hides object(s) | +----------+-------------------------------------------------+ | : | indicates an object-embedded custom property | | | key/value | +----------+-------------------------------------------------+ | . | alias for "class" :".foo" equals class:foo | +----------+-------------------------------------------------+ | > < | compare float or int number | +----------+-------------------------------------------------+ | / | reference to root-scene. | | | Useful in case of (preventing) showing/hiding | | | objects in nested scenes (instanced by src) (*) | +----------+-------------------------------------------------+ Table 4 | * = #q=-/cube hides object cube only in the root-scene (not nested | cube objects) | #q=-cube hides both object cube in the root-scene AND | nested skybox objects | » example implementation (https://github.com/coderofsalvation/xrfragment/blob/main/src/3rd/js/ three/xrf/q.js) » example 3D asset (https://github.com/coderofsalvation/xrfragment/blob/main/example/ assets/query.gltf#L192) » discussion (https://github.com/coderofsalvation/xrfragment/issues/3) 8.2. Query Parser Here's how to write a query parser: 1. create an associative array/object to store query-arguments as objects 2. detect object id's & properties foo:1 and foo (reference regex: /^.*:[><=!]?/ ) 3. detect excluders like -foo,-foo:1,-.foo,-/foo (reference regex: /^-/ ) 4. detect root selectors like /foo (reference regex: /^[-]?\// ) van Kammen Expires 10 March 2024 [Page 8] Internet-Draft XR Fragments September 2023 5. detect class selectors like .foo (reference regex: /^[-]?class$/ ) 6. detect number values like foo:1 (reference regex: /^[0-9\.]+$/ ) 7. expand aliases like .foo into class:foo 8. for every query token split string on : 9. create an empty array rules 10. then strip key-operator: convert "-foo" into "foo" 11. add operator and value to rule-array 12. therefore we we set id to true or false (false=excluder -) 13. and we set root to true or false (true=/ root selector is present) 14. we convert key '/foo' into 'foo' 15. finally we add the key/value to the store like store.foo = {id:false,root:true} e.g. | An example query-parser (which compiles to many languages) can be | found here | (https://github.com/coderofsalvation/xrfragment/blob/main/src/ | xrfragment/Query.hx) 8.3. XR Fragment URI Grammar reserved = gen-delims / sub-delims gen-delims = "#" / "&" sub-delims = "," / "=" | Example: ://foo.com/my3d.gltf#pos=1,0,0&prio=-5&t=0,100 +=============================+=================================+ | Demo | Explanation | +=============================+=================================+ | pos=1,2,3 | vector/coordinate argument e.g. | +-----------------------------+---------------------------------+ | pos=1,2,3&rot=0,90,0&q=.foo | combinators | +-----------------------------+---------------------------------+ Table 5 9. Text in XR (tagging,linking to spatial objects) We still think and speak in simple text, not in HTML or RDF. The most advanced human will probably not shout