init

addons/godot-xr-tools/player/poke/poke.gd

@@ -0,0 +1,222 @@
+@tool
+class_name XRToolsPoke
+extends Node3D
+
+
+## XR Tools Poke Script
+##
+## This node a finger push mechanism that can be attached to a finger bone
+## using a [BoneAttachment3D].
+##
+## The poke can interact with user interfaces, and can optionally push rigid
+## bodies.
+
+
+## Signal emitted when this object pokes another object
+signal pointing_event(event)
+
+
+# Default layer of 18:player-hands
+const DEFAULT_LAYER := 0b0000_0000_0000_0010_0000_0000_0000_0000
+
+# Default mask [1..16] and 23:ui-objects
+const DEFAULT_MASK := 0b0000_0000_0100_0000_1111_1111_1111_1111
+
+
+## Enables or disables the poke functionality
+@export var enabled : bool = true: set = set_enabled
+
+## Sets the radius of the poke mesh and collision
+@export var radius : float = 0.005: set = set_radius
+
+## Set the color of the poke mesh
+@export var color : Color = Color(0.8, 0.8, 1.0, 0.5): set = set_color
+
+## Set the poke teleport distance
+@export var teleport_distance : float = 0.1: set = set_teleport_distance
+
+@export_category("Poke Collison")
+
+## Sets the collision layer
+@export_flags_3d_physics var layer : int = DEFAULT_LAYER: set = set_layer
+
+## Sets the collision mask
+@export_flags_3d_physics var mask : int = DEFAULT_MASK: set = set_mask
+
+## Enables or disables pushing bodies
+@export var push_bodies : bool = true: set = set_push_bodies
+
+## Control the stiffness of the finger
+@export var stiffness : float = 10.0: set = set_stiffness
+
+## Control the maximum force the finger can push with
+@export var maximum_force : float = 1.0: set = set_maximum_force
+
+
+var is_ready = false
+var material : StandardMaterial3D
+var target : Node ## Node we last started touching
+var last_collided_at : Vector3
+
+
+func set_enabled(new_enabled : bool) -> void:
+	enabled = new_enabled
+	if is_ready:
+		_update_enabled()
+
+func _update_enabled():
+	$PokeBody/CollisionShape.disabled = !enabled
+
+func set_radius(new_radius : float) -> void:
+	radius = new_radius
+	if is_ready:
+		_update_radius()
+
+func _update_radius() -> void:
+	# Calculate the user-scaled radius
+	var sr := radius * XRServer.world_scale
+
+	# Update the collision shape
+	var shape : SphereShape3D = $PokeBody/CollisionShape.shape
+	if shape:
+		shape.radius = sr
+
+	# Update the mesh shape
+	var mesh : SphereMesh = $PokeBody/MeshInstance.mesh
+	if mesh:
+		mesh.radius = sr
+		mesh.height = sr * 2.0
+
+func set_teleport_distance(new_distance : float) -> void:
+	teleport_distance = new_distance
+	if is_ready:
+		_update_teleport_distance()
+
+func _update_teleport_distance() -> void:
+	$PokeBody.teleport_distance = teleport_distance
+
+func set_push_bodies(new_push_bodies : bool) -> void:
+	push_bodies = new_push_bodies
+	if is_ready:
+		_update_push_bodies()
+
+func _update_push_bodies() -> void:
+	$PokeBody.push_bodies = push_bodies
+
+func set_layer(new_layer : int) -> void:
+	layer = new_layer
+	if is_ready:
+		_update_layer()
+
+func _update_layer() -> void:
+	$PokeBody.collision_layer = layer
+
+func set_mask(new_mask : int) -> void:
+	mask = new_mask
+	if is_ready:
+		_update_mask()
+
+func _update_mask() -> void:
+	$PokeBody.collision_mask = mask
+
+func set_stiffness(new_stiffness : float) -> void:
+	stiffness = new_stiffness
+	if is_ready:
+		_update_stiffness()
+
+func _update_stiffness() -> void:
+	$PokeBody.stiffness = stiffness
+
+func set_maximum_force(new_maximum_force : float) -> void:
+	maximum_force = new_maximum_force
+	if is_ready:
+		_update_maximum_force()
+
+func _update_maximum_force() -> void:
+	$PokeBody.maximum_force = maximum_force
+
+func set_color(new_color : Color) -> void:
+	color = new_color
+	if is_ready:
+		_update_color()
+
+func _update_color() -> void:
+	if material:
+		material.albedo_color = color
+
+
+# Add support for is_xr_class on XRTools classes
+func is_xr_class(xr_name:  String) -> bool:
+	return xr_name == "XRToolsPoke"
+
+
+# Called when the node enters the scene tree for the first time.
+func _ready():
+	# Set as top level ensures we're placing this object in global space
+	$PokeBody.set_as_top_level(true)
+
+	is_ready = true
+
+	# Construct the poke material
+	material = StandardMaterial3D.new()
+	material.flags_unshaded = true
+	material.flags_transparent = true
+	$PokeBody/MeshInstance.set_surface_override_material(0, material)
+
+	_update_enabled()
+	_update_radius()
+	_update_teleport_distance()
+	_update_layer()
+	_update_mask()
+	_update_push_bodies()
+	_update_stiffness()
+	_update_maximum_force()
+	_update_color()
+
+	# Detect hand scale changing
+	var hand := XRToolsHand.find_instance(self)
+	if hand:
+		hand.hand_scale_changed.connect(_on_hand_scale_changed)
+
+
+func _process(_delta):
+	# If no target then disable processing
+	if not is_instance_valid(target):
+		set_process(false)
+		return
+
+	# Update moving on the target
+	var new_at : Vector3 = $PokeBody.global_transform.origin
+	XRToolsPointerEvent.moved(self, target, new_at, last_collided_at)
+	last_collided_at = new_at
+
+
+func _on_hand_scale_changed(_scale : float) -> void:
+	# Update the radius to account for the new hand scale
+	_update_radius()
+
+
+func _on_PokeBody_body_contact_start(body):
+	# We are going to poke this body at our current position.
+	# This will be slightly above the object but since this
+	# mostly targets Viewport2Din3D, this will work
+
+	# Report body pressed
+	target = body
+	last_collided_at = $PokeBody.global_transform.origin
+	XRToolsPointerEvent.entered(self, body, last_collided_at)
+	XRToolsPointerEvent.pressed(self, body, last_collided_at)
+
+	# Enable processing to track movement
+	set_process(true)
+
+
+func _on_PokeBody_body_contact_end(body):
+	# Skip if not current target
+	if body != target:
+		return
+
+	# Report release
+	XRToolsPointerEvent.released(self, target, last_collided_at)
+	XRToolsPointerEvent.exited(self, target, last_collided_at)
+	target = null

addons/godot-xr-tools/player/poke/poke.gd.uid

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

addons/godot-xr-tools/player/poke/poke.tscn

@@ -0,0 +1,47 @@
+[gd_scene load_steps=8 format=3 uid="uid://bjcxf427un2wp"]
+
+[ext_resource type="Script" uid="uid://dbxa71yertw7v" path="res://addons/godot-xr-tools/player/poke/poke.gd" id="1"]
+[ext_resource type="Script" uid="uid://bsrl2m5idli7k" path="res://addons/godot-xr-tools/player/poke/poke_body.gd" id="2"]
+[ext_resource type="Script" uid="uid://dff408qq7s26e" path="res://addons/godot-xr-tools/rumble/rumbler.gd" id="3_41fwo"]
+[ext_resource type="Resource" uid="uid://brci6umrcd157" path="res://addons/godot-xr-tools/rumble/tap_rumble.tres" id="4_mskmk"]
+
+[sub_resource type="SphereShape3D" id="1"]
+resource_local_to_scene = true
+radius = 0.005
+
+[sub_resource type="SphereMesh" id="2"]
+resource_local_to_scene = true
+radius = 0.005
+height = 0.01
+radial_segments = 32
+rings = 16
+
+[sub_resource type="StandardMaterial3D" id="StandardMaterial3D_uvdwq"]
+transparency = 1
+shading_mode = 0
+albedo_color = Color(0.8, 0.8, 1, 0.5)
+
+[node name="Poke" type="Node3D"]
+script = ExtResource("1")
+
+[node name="PokeBody" type="AnimatableBody3D" parent="."]
+top_level = true
+collision_layer = 131072
+collision_mask = 4259839
+sync_to_physics = false
+script = ExtResource("2")
+
+[node name="CollisionShape" type="CollisionShape3D" parent="PokeBody"]
+shape = SubResource("1")
+
+[node name="MeshInstance" type="MeshInstance3D" parent="PokeBody"]
+mesh = SubResource("2")
+surface_material_override/0 = SubResource("StandardMaterial3D_uvdwq")
+
+[node name="Rumbler" type="Node" parent="."]
+script = ExtResource("3_41fwo")
+event = ExtResource("4_mskmk")
+
+[connection signal="pointing_event" from="." to="Rumbler" method="rumble_pointer"]
+[connection signal="body_contact_end" from="PokeBody" to="." method="_on_PokeBody_body_contact_end"]
+[connection signal="body_contact_start" from="PokeBody" to="." method="_on_PokeBody_body_contact_start"]

addons/godot-xr-tools/player/poke/poke_body.gd

@@ -0,0 +1,96 @@
+@tool
+extends XRToolsForceBody
+
+
+## Signal called when we start to contact an object
+signal body_contact_start(node)
+
+## Signal called when we end contact with an object
+signal body_contact_end(node)
+
+
+## Distance at which we teleport our poke body
+@export var teleport_distance : float = 0.1
+
+
+# Node currently in contact with
+var _contact : Node3D = null
+
+# Target XRToolsPoke
+@onready var _target : XRToolsPoke = get_parent()
+
+
+# Add support for is_xr_class on XRTools classes
+func is_xr_class(xr_name:  String) -> bool:
+	return xr_name == "XRToolsPokeBody" or super(xr_name)
+
+
+func _validate_property(property):
+	if property.name == "top_level":
+		property.usage = PROPERTY_USAGE_NONE
+
+
+func _ready():
+	# Do not initialise if in the editor
+	if Engine.is_editor_hint():
+		# In editor, show it at its start location
+		top_level = false
+		transform = Transform3D()
+		return
+
+	# In runtime, we control the position
+	top_level = true
+
+	# Connect to player body signals (if applicable)
+	var player_body = XRToolsPlayerBody.find_instance(self)
+	if player_body:
+		player_body.player_moved.connect(_on_player_moved)
+		player_body.player_teleported.connect(_on_player_teleported)
+
+
+# Try moving to the parent Poke node
+func _physics_process(_delta):
+	# Do not process if in the editor
+	if Engine.is_editor_hint():
+		return
+
+	# Calculate the movement to perform
+	var target := _target.global_position
+	var to_target := target - global_position
+
+	# Decide whether to teleport or slide
+	var old_contact := _contact
+	if to_target.length() > teleport_distance:
+		# Teleport to the target
+		global_position = target
+	else:
+		# Move and slide to the target
+		var collision := move_and_slide(to_target)
+		_contact = collision.collider if collision else null
+
+	# Report when we stop being in contact with the current object
+	if old_contact and old_contact != _contact:
+		body_contact_end.emit(old_contact)
+
+	# Report when we start touching a new object
+	if _contact and _contact != old_contact:
+		body_contact_start.emit(_contact)
+
+
+# If our player moved, attempt to move our poke.
+func _on_player_moved(delta_transform : Transform3D):
+	var target : Transform3D = delta_transform * global_transform
+
+	# Rotate
+	global_basis = target.basis
+
+	# And attempt to move (we'll detect contact change in physics process).
+	move_and_slide(target.origin - global_position)
+
+	force_update_transform()
+
+
+# If our player teleported, just move.
+func _on_player_teleported(delta_transform : Transform3D):
+	global_transform = delta_transform * global_transform
+	force_update_transform()

addons/godot-xr-tools/player/poke/poke_body.gd.uid

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