init

addons/godot-xr-tools/interactables/interactable_hinge.gd

@@ -0,0 +1,155 @@
+@tool
+class_name XRToolsInteractableHinge
+extends XRToolsInteractableHandleDriven
+
+
+## XR Tools Interactable Hinge script
+##
+## The interactable hinge is a hinge transform node controlled by the
+## player through one or more [XRToolsInteractableHandle] instances.
+##
+## The hinge rotates itelf around its local X axis, and so should be
+## placed as a child of a node to translate and rotate as appropriate.
+##
+## The interactable hinge is not a [RigidBody3D], and as such will not react
+## to any collisions.
+
+
+## Signal for hinge moved
+signal hinge_moved(angle)
+
+
+## Hinge minimum limit
+@export var hinge_limit_min : float = -45.0: set = _set_hinge_limit_min
+
+## Hinge maximum limit
+@export var hinge_limit_max : float = 45.0: set = _set_hinge_limit_max
+
+## Hinge step size (zero for no steps)
+@export var hinge_steps : float = 0.0: set = _set_hinge_steps
+
+## Hinge position
+@export var hinge_position : float = 0.0: set = _set_hinge_position
+
+## Default position
+@export var default_position : float = 0.0: set = _set_default_position
+
+## If true, the hinge moves to the default position when releases
+@export var default_on_release : bool = false
+
+
+# Hinge values in radians
+@onready var _hinge_limit_min_rad : float = deg_to_rad(hinge_limit_min)
+@onready var _hinge_limit_max_rad : float = deg_to_rad(hinge_limit_max)
+@onready var _hinge_steps_rad : float = deg_to_rad(hinge_steps)
+@onready var _hinge_position_rad : float = deg_to_rad(hinge_position)
+@onready var _default_position_rad : float = deg_to_rad(default_position)
+
+
+# Add support for is_xr_class on XRTools classes
+func is_xr_class(xr_name:  String) -> bool:
+	return xr_name == "XRToolsInteractableHinge" or super(xr_name)
+
+
+# Called when the node enters the scene tree for the first time.
+func _ready():
+	# In Godot 4 we must now manually call our super class ready function
+	super()
+
+	# Set the initial position to match the initial hinge position value
+	transform = Transform3D(
+		Basis.from_euler(Vector3(_hinge_position_rad, 0, 0)),
+		Vector3.ZERO
+	)
+
+	# Connect signals
+	if released.connect(_on_hinge_released):
+		push_error("Cannot connect hinge released signal")
+
+
+# Called every frame when one or more handles are held by the player
+func _process(_delta: float) -> void:
+	# Get the total handle angular offsets
+	var offset_sum := 0.0
+	for item in grabbed_handles:
+		var handle := item as XRToolsInteractableHandle
+		var to_handle: Vector3 = handle.global_transform.origin * global_transform
+		var to_handle_origin: Vector3 = handle.handle_origin.global_transform.origin * global_transform
+		to_handle.x = 0.0
+		to_handle_origin.x = 0.0
+		offset_sum += to_handle_origin.signed_angle_to(to_handle, Vector3.RIGHT)
+
+	# Average the angular offsets
+	var offset := offset_sum / grabbed_handles.size()
+
+	# Move the hinge by the requested offset
+	move_hinge(_hinge_position_rad + offset)
+
+
+# Move the hinge to the specified position
+func move_hinge(pos: float) -> void:
+	# Do the hinge move
+	pos = _do_move_hinge(pos)
+	if pos == _hinge_position_rad:
+		return
+
+	# Update the current positon
+	_hinge_position_rad = pos
+	hinge_position = rad_to_deg(pos)
+
+	# Emit the moved signal
+	emit_signal("hinge_moved", hinge_position)
+
+
+# Handle release of hinge
+func _on_hinge_released(_interactable: XRToolsInteractableHinge):
+	if default_on_release:
+		move_hinge(_default_position_rad)
+
+
+# Called when hinge_limit_min is set externally
+func _set_hinge_limit_min(value: float) -> void:
+	hinge_limit_min = value
+	_hinge_limit_min_rad = deg_to_rad(value)
+
+
+# Called when hinge_limit_max is set externally
+func _set_hinge_limit_max(value: float) -> void:
+	hinge_limit_max = value
+	_hinge_limit_max_rad = deg_to_rad(value)
+
+
+# Called when hinge_steps is set externally
+func _set_hinge_steps(value: float) -> void:
+	hinge_steps = value
+	_hinge_steps_rad = deg_to_rad(value)
+
+
+# Called when hinge_position is set externally
+func _set_hinge_position(value: float) -> void:
+	var pos = _do_move_hinge(deg_to_rad(value))
+	hinge_position = rad_to_deg(pos)
+	_hinge_position_rad = pos
+
+
+# Called when default_position is set externally
+func _set_default_position(value: float) -> void:
+	default_position = value
+	_default_position_rad = deg_to_rad(value)
+
+
+# Do the hinge move
+func _do_move_hinge(pos: float) -> float:
+	# Apply hinge step-quantization
+	if _hinge_steps_rad:
+		pos = round(pos / _hinge_steps_rad) * _hinge_steps_rad
+
+	# Apply hinge limits
+	pos = clamp(pos, _hinge_limit_min_rad, _hinge_limit_max_rad)
+
+	# Move if necessary
+	if pos != _hinge_position_rad:
+		transform.basis = Basis.from_euler(Vector3(pos, 0.0, 0.0))
+
+	# Return the updated position
+	return pos