godot-steering-ai-framework/project/src/GSTUtils.gd

class_name GSTUtils
# Math and vector utility functions.


# Returns the `vector` with its length capped to `limit`.
static func clampedv3(vector: Vector3, limit: float) -> Vector3:
	var length_squared := vector.length_squared()
	var limit_squared := limit * limit
	if length_squared > limit_squared:
		vector *= sqrt(limit_squared / length_squared)
	return vector


# Returns an angle in radians between the positive X axis and the `vector`.
#
# This assumes orientation for 2D agents or 3D agents that are upright and
# rotate around the Y axis.
static func vector_to_angle(vector: Vector3) -> float:
	return atan2(vector.x, -vector.y)
Clean up and improve group behaviors' code The first pass was somewhat obtuse and lacked a common class that differentiated them from behaviors that didn't use Proximities. 2020-01-10 18:15:50 +01:00			`class_name GSTUtils`
Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			`# Math and vector utility functions.`
Reorganize project The GST namespace has been added to prevent class name conflicts, and the project has been reorganized to make extensions and purpose easier. 2019-12-19 20:04:08 +01:00

Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			# Returns the `vector` with its length capped to `limit`.
Add Blend and Priority behaviors 2019-12-21 03:32:21 +01:00			`static func clampedv3(vector: Vector3, limit: float) -> Vector3:`
Update project to follow GDScript guidelines closer Used `var variable := 0.0` as discussed in the Godot issue, instead of `var variable: = 0.0`. Mostly these are minor/cosmetic changes, but I've also reorganized the folder structure (naming of folders) to reflect our guidelines, plus made some minor changes to the demo codes. Still work in progress. 2020-01-16 09:44:44 +01:00			`var length_squared := vector.length_squared()`
			`var limit_squared := limit * limit`
Implement review suggestions to code Razvan reviewed the code and suggested a number of changes to improve readability and make facets of the code more explicit and consistent. 2019-12-23 17:38:27 +01:00			`if length_squared > limit_squared:`
			`vector *= sqrt(limit_squared / length_squared)`
Reorganize project The GST namespace has been added to prevent class name conflicts, and the project has been reorganized to make extensions and purpose easier. 2019-12-19 20:04:08 +01:00			`return vector`
Add documentation strings for base types 2020-01-27 18:57:51 +01:00

Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			# Returns an angle in radians between the positive X axis and the `vector`.
			`#`
			`# This assumes orientation for 2D agents or 3D agents that are upright and`
			`# rotate around the Y axis.`
Add documentation strings for base types 2020-01-27 18:57:51 +01:00			`static func vector_to_angle(vector: Vector3) -> float:`
			`return atan2(vector.x, -vector.y)`