Merge pull request #1218 from BastiaanOlij/openxr_render_models_demo

Added an OpenXR render models demo

Author: skyace65

xr/openxr_render_models/.gitattributes

@@ -0,0 +1,2 @@
+# Normalize EOL for all files that Git considers text files.
+* text=auto eol=lf

xr/openxr_render_models/.gitignore

@@ -0,0 +1,4 @@
+# Godot 4+ specific ignores
+.godot/
+.editorconfig
+/android/

xr/openxr_render_models/README.md

@@ -0,0 +1,50 @@
+# OpenXR Render models demo
+
+This is a demo showing OpenXR's render models implementation.
+
+Language: GDScript
+
+Renderer: Compatibility
+
+> [!NOTE]
+>
+> This demo requires Godot 4.5 or later
+
+## Screenshots
+
+![Screenshot](screenshots/render_model_demo.png)
+
+## How does it work?
+
+OpenXR allows us to run our application without having knowledge of the hardware being used,
+or that we as developers have access too at the time of developing our application.
+
+As a result we don't have direct information telling us what hardware is being used,
+however there are situations where we want to visually show this hardware.
+
+This specifically applies to the controllers used by the user, as showing the correct hardware
+improves the user's sense of immersion.
+
+The render model API allows us to enumerate the devices currently in use and then query
+information such as its 3D asset, its position and orientation in space, and the position
+and orientation of individual components of the asset.
+
+Godot's implementation hides most of the complexity of this through the OpenXRRenderModelManager
+node as a child of the XROrigin3D node. You can add just this node by itself and let it show
+all render models that are currently active, or like we do in this demo, you can add nodes
+in the tree of each controller to show render models related to that controller.
+
+## Action map
+
+This demo project has a barebones action map as we're only dealing with positioning.
+
+## Running on PCVR
+
+This project can be run as normal for PCVR. Ensure that an OpenXR runtime has been installed.
+
+## Running on standalone VR
+
+You must install the Android build templates and OpenXR loader plugin and configure an export template for your device.
+Please follow [the instructions for deploying on Android in the manual](https://docs.godotengine.org/en/stable/tutorials/xr/deploying_to_android.html).
+
+

xr/openxr_render_models/assets/pattern.png

@@ -0,0 +1,41 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://btobyv4xjhltq"
+path.s3tc="res://.godot/imported/pattern.png-cf6f03dfd1cdd4bc35da3414e912103d.s3tc.ctex"
+metadata={
+"imported_formats": ["s3tc_bptc"],
+"vram_texture": true
+}
+
+[deps]
+
+source_file="res://assets/pattern.png"
+dest_files=["res://.godot/imported/pattern.png-cf6f03dfd1cdd4bc35da3414e912103d.s3tc.ctex"]
+
+[params]
+
+compress/mode=2
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/uastc_level=0
+compress/rdo_quality_loss=0.0
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=true
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/channel_remap/red=0
+process/channel_remap/green=1
+process/channel_remap/blue=2
+process/channel_remap/alpha=3
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=0

xr/openxr_render_models/assets/pattern.png.import

@@ -0,0 +1,21 @@
+[gd_scene load_steps=5 format=3 uid="uid://cfgfwisj8m2mg"]
+
+[ext_resource type="Texture2D" uid="uid://btobyv4xjhltq" path="res://assets/pattern.png" id="1_g2tbl"]
+
+[sub_resource type="BoxShape3D" id="BoxShape3D_oq5cr"]
+
+[sub_resource type="StandardMaterial3D" id="StandardMaterial3D_bqn3j"]
+albedo_color = Color(0.16217351, 0.546357, 0.5366536, 1)
+albedo_texture = ExtResource("1_g2tbl")
+uv1_scale = Vector3(3, 3, 3)
+
+[sub_resource type="BoxMesh" id="BoxMesh_3n43a"]
+material = SubResource("StandardMaterial3D_bqn3j")
+
+[node name="Box" type="RigidBody3D"]
+
+[node name="CollisionShape3D" type="CollisionShape3D" parent="."]
+shape = SubResource("BoxShape3D_oq5cr")
+
+[node name="MeshInstance3D" type="MeshInstance3D" parent="."]
+mesh = SubResource("BoxMesh_3n43a")

xr/openxr_render_models/box.tscn

@@ -0,0 +1,19 @@
+class_name CollisionHands3D
+extends AnimatableBody3D
+
+func _ready():
+	# Make sure these are set correctly.
+	top_level = true
+	sync_to_physics = false
+	process_physics_priority = -90
+
+
+func _physics_process(_delta):
+	# Follow our parent node around.
+	var dest_transform = get_parent().global_transform
+
+	# We just apply rotation for this example.
+	global_basis = dest_transform.basis
+
+	# Attempt to move to where our tracked hand is.
+	move_and_collide(dest_transform.origin - global_position)

xr/openxr_render_models/collision_hands.gd

@@ -0,0 +1 @@
+uid://c5bnmb8grcumh

xr/openxr_render_models/collision_hands.gd.uid

@@ -0,0 +1,43 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://bi6bu4ng584fq"
+path="res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://icon.svg"
+dest_files=["res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/uastc_level=0
+compress/rdo_quality_loss=0.0
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/channel_remap/red=0
+process/channel_remap/green=1
+process/channel_remap/blue=2
+process/channel_remap/alpha=3
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1
+svg/scale=1.0
+editor/scale_with_editor_scale=false
+editor/convert_colors_with_editor_theme=false