godot-steering-ai-framework/project/src/behaviors/GSTMatchOrientation.gd

extends GSTSteeringBehavior
class_name GSTMatchOrientation
"""
Calculates an angular acceleration to match an agent's orientation to its target's.
The calculation will attempt to arrive with zero remaining angular velocity.
"""


var target: GSTAgentLocation
var alignment_tolerance: float
var deceleration_radius: float
var time_to_reach: float = 0.1


func _init(agent: GSTSteeringAgent, target: GSTAgentLocation).(agent) -> void:
	self.target = target


func _match_orientation(acceleration: GSTTargetAcceleration, desired_orientation: float) -> GSTTargetAcceleration:
	var rotation: = wrapf(desired_orientation - agent.orientation, -PI, PI)

	var rotation_size: = -rotation if rotation < 0 else rotation

	if rotation_size <= alignment_tolerance:
		acceleration.set_zero()
	else:
		var desired_rotation: = agent.max_angular_speed
	
		if rotation_size <= deceleration_radius:
			desired_rotation *= rotation_size / deceleration_radius
		
		desired_rotation *= rotation / rotation_size
	
		acceleration.angular = (desired_rotation - agent.angular_velocity) / time_to_reach
	
		var limited_acceleration: = -acceleration.angular if acceleration.angular < 0 else acceleration.angular
		if limited_acceleration > agent.max_angular_acceleration:
			acceleration.angular *= agent.max_angular_acceleration / limited_acceleration
		
		acceleration.linear = Vector3.ZERO
	
	return acceleration


func _calculate_steering(acceleration: GSTTargetAcceleration) -> GSTTargetAcceleration:
	return _match_orientation(acceleration, target.orientation)