Skip to content

Commit

Permalink
Implement hole punch functionality for fb geometry passthrough
Browse files Browse the repository at this point in the history
  • Loading branch information
@devloglogan
devloglogan committed May 8, 2024
1 parent 543009f commit da501fa
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 21 deletions.
104 changes: 88 additions & 16 deletions common/src/main/cpp/classes/openxr_fb_passthrough_geometry.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,21 @@
#include "extensions/openxr_fb_passthrough_extension_wrapper.h"

#include <godot_cpp/classes/engine.hpp>
#include <godot_cpp/classes/shader.hpp>
#include <godot_cpp/classes/shader_material.hpp>
#include <godot_cpp/classes/standard_material3d.hpp>
#include <godot_cpp/variant/utility_functions.hpp>

using namespace godot;

const Color PREVIEW_COLOR = Color(1.0, 0.0, 1.0);
static const char *HOLE_PUNCH_SHADER_CODE =
"shader_type spatial;\n"
"render_mode blend_mix, depth_draw_opaque, cull_back, shadow_to_opacity, shadows_disabled;\n"
"void fragment() {\n"
"\tALBEDO = vec3(0.0, 0.0, 0.0);\n"
"}\n";

void OpenXRFbPassthroughGeometry::set_mesh(const Ref<Mesh> &p_mesh) {
if (p_mesh == mesh) {
return;
Expand All @@ -49,27 +59,18 @@ void OpenXRFbPassthroughGeometry::set_mesh(const Ref<Mesh> &p_mesh) {
mesh = p_mesh;

if (mesh.is_null()) {
if (preview_mesh != nullptr) {
preview_mesh->queue_free();
preview_mesh = nullptr;
if (opaque_mesh != nullptr) {
delete_opaque_mesh();
}
return;
}

if (Engine::get_singleton()->is_editor_hint()) {
if (preview_mesh == nullptr) {
const Color PREVIEW_COLOR = Color(1.0, 0.0, 1.0);

Ref<StandardMaterial3D> material;
material.instantiate();
material->set_shading_mode(BaseMaterial3D::SHADING_MODE_UNSHADED);
material->set_albedo(PREVIEW_COLOR);

preview_mesh = memnew(MeshInstance3D);
preview_mesh->set_material_override(material);
add_child(preview_mesh, false, Node::INTERNAL_MODE_BACK);
if (opaque_mesh == nullptr) {
instatiate_opaque_mesh();
} else {
opaque_mesh->set_mesh(mesh);
}
preview_mesh->set_mesh(mesh);
}

if (OpenXRFbPassthroughExtensionWrapper::get_singleton()->is_passthrough_started()) {
Expand All @@ -81,8 +82,35 @@ Ref<Mesh> OpenXRFbPassthroughGeometry::get_mesh() const {
return mesh;
}

void OpenXRFbPassthroughGeometry::set_enable_hole_punch(bool p_enable) {
if (enable_hole_punch == p_enable) {
return;
}

enable_hole_punch = p_enable;

if (!OpenXRFbPassthroughExtensionWrapper::get_singleton()->is_passthrough_started()) {
return;
}

if (opaque_mesh == nullptr && mesh.is_valid() && enable_hole_punch) {
instatiate_opaque_mesh();
} else if (opaque_mesh != nullptr && !enable_hole_punch) {
delete_opaque_mesh();
}
}

bool OpenXRFbPassthroughGeometry::get_enable_hole_punch() const {
return enable_hole_punch;
}

void OpenXRFbPassthroughGeometry::create_passthrough_geometry() {
geometry_instance = OpenXRFbPassthroughExtensionWrapper::get_singleton()->create_geometry_instance(mesh, get_transform());

if (opaque_mesh == nullptr && enable_hole_punch) {
instatiate_opaque_mesh();
}

set_notify_local_transform(true);
}

Expand All @@ -91,6 +119,46 @@ void OpenXRFbPassthroughGeometry::destroy_passthrough_geometry() {
OpenXRFbPassthroughExtensionWrapper::get_singleton()->destroy_geometry_instance(geometry_instance);
geometry_instance = XR_NULL_HANDLE;
}

if (opaque_mesh != nullptr) {
delete_opaque_mesh();
}
}

void OpenXRFbPassthroughGeometry::instatiate_opaque_mesh() {
ERR_FAIL_COND_MSG(opaque_mesh != nullptr, "Opaque mesh child node already exists");
ERR_FAIL_COND_MSG(mesh.is_null(), "Mesh resource is null");

opaque_mesh = memnew(MeshInstance3D);
opaque_mesh->set_mesh(mesh);
add_child(opaque_mesh, false, Node::INTERNAL_MODE_BACK);

if (Engine::get_singleton()->is_editor_hint()) {
Ref<StandardMaterial3D> standard_material;
standard_material.instantiate();
standard_material->set_shading_mode(BaseMaterial3D::SHADING_MODE_UNSHADED);
standard_material->set_albedo(PREVIEW_COLOR);

opaque_mesh->set_surface_override_material(0, standard_material);
} else {
Ref<Shader> shader;
shader.instantiate();
shader->set_code(HOLE_PUNCH_SHADER_CODE);

Ref<ShaderMaterial> shader_material;
shader_material.instantiate();
shader_material->set_shader(shader);

opaque_mesh->set_surface_override_material(0, shader_material);
}
}

void OpenXRFbPassthroughGeometry::delete_opaque_mesh() {
ERR_FAIL_COND_MSG(opaque_mesh == nullptr, "Opaque mesh child node does not exist");

remove_child(opaque_mesh);
opaque_mesh->queue_free();
opaque_mesh = nullptr;
}

void OpenXRFbPassthroughGeometry::_notification(int p_what) {
Expand Down Expand Up @@ -127,8 +195,12 @@ void OpenXRFbPassthroughGeometry::_notification(int p_what) {
}

void OpenXRFbPassthroughGeometry::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_mesh"), &OpenXRFbPassthroughGeometry::set_mesh);
ClassDB::bind_method(D_METHOD("set_mesh", "mesh"), &OpenXRFbPassthroughGeometry::set_mesh);
ClassDB::bind_method(D_METHOD("get_mesh"), &OpenXRFbPassthroughGeometry::get_mesh);

ClassDB::bind_method(D_METHOD("set_enable_hole_punch", "enable"), &OpenXRFbPassthroughGeometry::set_enable_hole_punch);
ClassDB::bind_method(D_METHOD("get_enable_hole_punch"), &OpenXRFbPassthroughGeometry::get_enable_hole_punch);

ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "mesh", PROPERTY_HINT_RESOURCE_TYPE, "Mesh"), "set_mesh", "get_mesh");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "enable_hole_punch", PROPERTY_HINT_NONE, ""), "set_enable_hole_punch", "get_enable_hole_punch");
}
11 changes: 9 additions & 2 deletions common/src/main/cpp/include/classes/openxr_fb_passthrough_geometry.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,13 @@ class OpenXRFbPassthroughGeometry : public Node3D {
void create_passthrough_geometry();
void destroy_passthrough_geometry();

XrGeometryInstanceFB geometry_instance = XR_NULL_HANDLE;
void instatiate_opaque_mesh();
void delete_opaque_mesh();

Ref<Mesh> mesh;
MeshInstance3D *preview_mesh = nullptr;
bool enable_hole_punch = true;
XrGeometryInstanceFB geometry_instance = XR_NULL_HANDLE;
MeshInstance3D *opaque_mesh = nullptr;

protected:
void _notification(int p_what);
Expand All @@ -56,6 +60,9 @@ class OpenXRFbPassthroughGeometry : public Node3D {
public:
void set_mesh(const Ref<Mesh> &p_mesh);
Ref<Mesh> get_mesh() const;

void set_enable_hole_punch(bool p_enable);
bool get_enable_hole_punch() const;
};
} //namespace godot

Expand Down
2 changes: 1 addition & 1 deletion demo/main.gd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,11 @@ func update_passthrough_mode() -> void:
xr_interface.environment_blend_mode = XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND
passthrough_mode_info.text = STRING_BASE + "Full"
OpenXRFbPassthroughExtensionWrapper.LAYER_PURPOSE_RECONSTRUCTION:
enable_passthrough_environment(false)
xr_interface.environment_blend_mode = XRInterface.XR_ENV_BLEND_MODE_OPAQUE
open_xr_fb_passthrough_geometry.show()
passthrough_mode_info.text = STRING_BASE + "Geometry"
OpenXRFbPassthroughExtensionWrapper.LAYER_PURPOSE_PROJECTED:
enable_passthrough_environment(false)
open_xr_fb_passthrough_geometry.hide()
passthrough_mode_info.text = STRING_BASE + "None"

Expand Down
4 changes: 2 additions & 2 deletions demo/main.tscn
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ tracker = &"/user/hand_tracker/right"

[node name="RightHandModel" type="OpenXRFbHandTrackingMesh" parent="XROrigin3D/RightHandTracker"]
hand = 1
material = ExtResource("7_tpkib")
bones/0/name = "RightPalm"
bones/1/name = "RightHand"
bones/2/name = "RightThumbMetacarpal"
Expand All @@ -188,7 +189,6 @@ bones/22/name = "RightLittleProximal"
bones/23/name = "RightLittleIntermediate"
bones/24/name = "RightLittleDistal"
bones/25/name = "RightLittleTip"
material = ExtResource("7_tpkib")

[node name="RightXRHandModifier3D" type="XRHandModifier3D" parent="XROrigin3D/RightHandTracker/RightHandModel"]
hand_tracker = &"/user/hand_tracker/right"
Expand All @@ -205,7 +205,7 @@ tracker = &"/user/body_tracker"
[node name="Test-Kun" parent="Floor/AvatarOffset/Avatar" instance=ExtResource("4_b317s")]
transform = Transform3D(-1, 0, 8.74228e-08, 0, 1, 0, -8.74228e-08, 0, -1, 0, 0, 0)

[node name="XRBodyModifier3D" type="XRBodyModifier3D" parent="Floor/AvatarOffset/Avatar/Test-Kun/Armature/GeneralSkeleton" index="3"]
[node name="XRBodyModifier3D" type="XRBodyModifier3D" parent="Floor/AvatarOffset/Avatar/Test-Kun/Armature/GeneralSkeleton" index="2"]
transform = Transform3D(1, 0, 1.74846e-07, 0, 1, 0, -1.74846e-07, 0, 1, -8.74228e-08, 0, -1)
bone_update = 1

Expand Down

0 comments on commit da501fa

Please sign in to comment.