Implement cubic_interpolate() as MathFunc for refactoring

6 files changed, 97 insertions, 68 deletions

diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs
index bfe9600084..ce213da6a7 100644
--- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs
+++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Mathf.cs
@@ -180,6 +180,24 @@ namespace Godot
         }
 
         /// <summary>
+        /// Cubic interpolates between two values by a normalized value with pre and post values.
+        /// </summary>
+        /// <param name="from">The start value for interpolation.</param>
+        /// <param name="to">The destination value for interpolation.</param>
+        /// <param name="pre">The value which before "from" value for interpolation.</param>
+        /// <param name="post">The value which after "to" value for interpolation.</param>
+        /// <param name="weight">A value on the range of 0.0 to 1.0, representing the amount of interpolation.</param>
+        /// <returns>The resulting value of the interpolation.</returns>
+        public static real_t CubicInterpolate(real_t from, real_t to, real_t pre, real_t post, real_t weight)
+        {
+            return 0.5f *
+                    ((from * 2.0f) +
+                            (-pre + to) * weight +
+                            (2.0f * pre - 5.0f * from + 4.0f * to - post) * (weight * weight) +
+                            (-pre + 3.0f * from - 3.0f * to + post) * (weight * weight * weight));
+        }
+
+        /// <summary>
         /// Converts an angle expressed in degrees to radians.
         /// </summary>
         /// <param name="deg">An angle expressed in degrees.</param>
diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Vector2.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Vector2.cs
index fa7838633c..8679f28132 100644
--- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Vector2.cs
+++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Vector2.cs
@@ -204,20 +204,10 @@ namespace Godot
         /// <returns>The interpolated vector.</returns>
         public Vector2 CubicInterpolate(Vector2 b, Vector2 preA, Vector2 postB, real_t weight)
         {
-            Vector2 p0 = preA;
-            Vector2 p1 = this;
-            Vector2 p2 = b;
-            Vector2 p3 = postB;
-
-            real_t t = weight;
-            real_t t2 = t * t;
-            real_t t3 = t2 * t;
-
-            return 0.5f * (
-                (p1 * 2.0f) +
-                ((-p0 + p2) * t) +
-                (((2.0f * p0) - (5.0f * p1) + (4 * p2) - p3) * t2) +
-                ((-p0 + (3.0f * p1) - (3.0f * p2) + p3) * t3)
+            return new Vector2
+            (
+                Mathf.CubicInterpolate(x, b.x, preA.x, postB.x, weight),
+                Mathf.CubicInterpolate(y, b.y, preA.y, postB.y, weight)
             );
         }
 
diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Vector3.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Vector3.cs
index 0faf13f8b7..1e60fb9523 100644
--- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Vector3.cs
+++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Vector3.cs
@@ -195,19 +195,11 @@ namespace Godot
         /// <returns>The interpolated vector.</returns>
         public Vector3 CubicInterpolate(Vector3 b, Vector3 preA, Vector3 postB, real_t weight)
         {
-            Vector3 p0 = preA;
-            Vector3 p1 = this;
-            Vector3 p2 = b;
-            Vector3 p3 = postB;
-
-            real_t t = weight;
-            real_t t2 = t * t;
-            real_t t3 = t2 * t;
-
-            return 0.5f * (
-                (p1 * 2.0f) + ((-p0 + p2) * t) +
-                (((2.0f * p0) - (5.0f * p1) + (4f * p2) - p3) * t2) +
-                ((-p0 + (3.0f * p1) - (3.0f * p2) + p3) * t3)
+            return new Vector3
+            (
+                Mathf.CubicInterpolate(x, b.x, preA.x, postB.x, weight),
+                Mathf.CubicInterpolate(y, b.y, preA.y, postB.y, weight),
+                Mathf.CubicInterpolate(z, b.z, preA.z, postB.z, weight)
             );
         }
 
diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
index 1ac5768755..55afacbea1 100644
--- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
+++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
@@ -96,123 +96,125 @@
 		<constant name="MATH_LERP" value="26" enum="BuiltinFunc">
 			Returns a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code].
 		</constant>
-		<constant name="MATH_INVERSE_LERP" value="27" enum="BuiltinFunc">
+		<constant name="MATH_CUBIC_INTERPOLATE" value="27" enum="BuiltinFunc">
 		</constant>
-		<constant name="MATH_RANGE_LERP" value="28" enum="BuiltinFunc">
+		<constant name="MATH_INVERSE_LERP" value="28" enum="BuiltinFunc">
 		</constant>
-		<constant name="MATH_MOVE_TOWARD" value="29" enum="BuiltinFunc">
+		<constant name="MATH_RANGE_LERP" value="29" enum="BuiltinFunc">
+		</constant>
+		<constant name="MATH_MOVE_TOWARD" value="30" enum="BuiltinFunc">
 			Moves the number toward a value, based on the third input.
 		</constant>
-		<constant name="MATH_RANDOMIZE" value="30" enum="BuiltinFunc">
+		<constant name="MATH_RANDOMIZE" value="31" enum="BuiltinFunc">
 			Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
 		</constant>
-		<constant name="MATH_RANDI" value="31" enum="BuiltinFunc">
+		<constant name="MATH_RANDI" value="32" enum="BuiltinFunc">
 			Returns a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function.
 		</constant>
-		<constant name="MATH_RANDF" value="32" enum="BuiltinFunc">
+		<constant name="MATH_RANDF" value="33" enum="BuiltinFunc">
 			Returns a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication.
 		</constant>
-		<constant name="MATH_RANDI_RANGE" value="33" enum="BuiltinFunc">
+		<constant name="MATH_RANDI_RANGE" value="34" enum="BuiltinFunc">
 			Returns a random 32-bit integer value between the two inputs.
 		</constant>
-		<constant name="MATH_RANDF_RANGE" value="34" enum="BuiltinFunc">
+		<constant name="MATH_RANDF_RANGE" value="35" enum="BuiltinFunc">
 			Returns a random floating-point value between the two inputs.
 		</constant>
-		<constant name="MATH_RANDFN" value="35" enum="BuiltinFunc">
+		<constant name="MATH_RANDFN" value="36" enum="BuiltinFunc">
 			Returns a normally-distributed pseudo-random number, using Box-Muller transform with the specified mean and a standard deviation. This is also called Gaussian distribution.
 		</constant>
-		<constant name="MATH_SEED" value="36" enum="BuiltinFunc">
+		<constant name="MATH_SEED" value="37" enum="BuiltinFunc">
 			Set the seed for the random number generator.
 		</constant>
-		<constant name="MATH_RANDSEED" value="37" enum="BuiltinFunc">
+		<constant name="MATH_RANDSEED" value="38" enum="BuiltinFunc">
 			Returns a random value from the given seed, along with the new seed.
 		</constant>
-		<constant name="MATH_DEG2RAD" value="38" enum="BuiltinFunc">
+		<constant name="MATH_DEG2RAD" value="39" enum="BuiltinFunc">
 			Convert the input from degrees to radians.
 		</constant>
-		<constant name="MATH_RAD2DEG" value="39" enum="BuiltinFunc">
+		<constant name="MATH_RAD2DEG" value="40" enum="BuiltinFunc">
 			Convert the input from radians to degrees.
 		</constant>
-		<constant name="MATH_LINEAR2DB" value="40" enum="BuiltinFunc">
+		<constant name="MATH_LINEAR2DB" value="41" enum="BuiltinFunc">
 			Convert the input from linear volume to decibel volume.
 		</constant>
-		<constant name="MATH_DB2LINEAR" value="41" enum="BuiltinFunc">
+		<constant name="MATH_DB2LINEAR" value="42" enum="BuiltinFunc">
 			Convert the input from decibel volume to linear volume.
 		</constant>
-		<constant name="MATH_WRAP" value="42" enum="BuiltinFunc">
+		<constant name="MATH_WRAP" value="43" enum="BuiltinFunc">
 		</constant>
-		<constant name="MATH_WRAPF" value="43" enum="BuiltinFunc">
+		<constant name="MATH_WRAPF" value="44" enum="BuiltinFunc">
 		</constant>
-		<constant name="MATH_PINGPONG" value="44" enum="BuiltinFunc">
+		<constant name="MATH_PINGPONG" value="45" enum="BuiltinFunc">
 			Returns the [code]value[/code] wrapped between [code]0[/code] and the [code]length[/code]. If the limit is reached, the next value the function returned is decreased to the [code]0[/code] side or increased to the [code]length[/code] side (like a triangle wave). If [code]length[/code] is less than zero, it becomes positive.
 		</constant>
-		<constant name="LOGIC_MAX" value="45" enum="BuiltinFunc">
+		<constant name="LOGIC_MAX" value="46" enum="BuiltinFunc">
 			Returns the greater of the two numbers, also known as their maximum.
 		</constant>
-		<constant name="LOGIC_MIN" value="46" enum="BuiltinFunc">
+		<constant name="LOGIC_MIN" value="47" enum="BuiltinFunc">
 			Returns the lesser of the two numbers, also known as their minimum.
 		</constant>
-		<constant name="LOGIC_CLAMP" value="47" enum="BuiltinFunc">
+		<constant name="LOGIC_CLAMP" value="48" enum="BuiltinFunc">
 			Returns the input clamped inside the given range, ensuring the result is never outside it. Equivalent to [code]min(max(input, range_low), range_high)[/code].
 		</constant>
-		<constant name="LOGIC_NEAREST_PO2" value="48" enum="BuiltinFunc">
+		<constant name="LOGIC_NEAREST_PO2" value="49" enum="BuiltinFunc">
 			Returns the nearest power of 2 to the input.
 		</constant>
-		<constant name="OBJ_WEAKREF" value="49" enum="BuiltinFunc">
+		<constant name="OBJ_WEAKREF" value="50" enum="BuiltinFunc">
 			Create a [WeakRef] from the input.
 		</constant>
-		<constant name="TYPE_CONVERT" value="50" enum="BuiltinFunc">
+		<constant name="TYPE_CONVERT" value="51" enum="BuiltinFunc">
 			Convert between types.
 		</constant>
-		<constant name="TYPE_OF" value="51" enum="BuiltinFunc">
+		<constant name="TYPE_OF" value="52" enum="BuiltinFunc">
 			Returns the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned.
 		</constant>
-		<constant name="TYPE_EXISTS" value="52" enum="BuiltinFunc">
+		<constant name="TYPE_EXISTS" value="53" enum="BuiltinFunc">
 			Checks if a type is registered in the [ClassDB].
 		</constant>
-		<constant name="TEXT_CHAR" value="53" enum="BuiltinFunc">
+		<constant name="TEXT_CHAR" value="54" enum="BuiltinFunc">
 			Returns a character with the given ascii value.
 		</constant>
-		<constant name="TEXT_STR" value="54" enum="BuiltinFunc">
+		<constant name="TEXT_STR" value="55" enum="BuiltinFunc">
 			Convert the input to a string.
 		</constant>
-		<constant name="TEXT_PRINT" value="55" enum="BuiltinFunc">
+		<constant name="TEXT_PRINT" value="56" enum="BuiltinFunc">
 			Print the given string to the output window.
 		</constant>
-		<constant name="TEXT_PRINTERR" value="56" enum="BuiltinFunc">
+		<constant name="TEXT_PRINTERR" value="57" enum="BuiltinFunc">
 			Print the given string to the standard error output.
 		</constant>
-		<constant name="TEXT_PRINTRAW" value="57" enum="BuiltinFunc">
+		<constant name="TEXT_PRINTRAW" value="58" enum="BuiltinFunc">
 			Print the given string to the standard output, without adding a newline.
 		</constant>
-		<constant name="TEXT_PRINT_VERBOSE" value="58" enum="BuiltinFunc">
+		<constant name="TEXT_PRINT_VERBOSE" value="59" enum="BuiltinFunc">
 		</constant>
-		<constant name="VAR_TO_STR" value="59" enum="BuiltinFunc">
+		<constant name="VAR_TO_STR" value="60" enum="BuiltinFunc">
 			Serialize a [Variant] to a string.
 		</constant>
-		<constant name="STR_TO_VAR" value="60" enum="BuiltinFunc">
+		<constant name="STR_TO_VAR" value="61" enum="BuiltinFunc">
 			Deserialize a [Variant] from a string serialized using [constant VAR_TO_STR].
 		</constant>
-		<constant name="VAR_TO_BYTES" value="61" enum="BuiltinFunc">
+		<constant name="VAR_TO_BYTES" value="62" enum="BuiltinFunc">
 			Serialize a [Variant] to a [PackedByteArray].
 		</constant>
-		<constant name="BYTES_TO_VAR" value="62" enum="BuiltinFunc">
+		<constant name="BYTES_TO_VAR" value="63" enum="BuiltinFunc">
 			Deserialize a [Variant] from a [PackedByteArray] serialized using [constant VAR_TO_BYTES].
 		</constant>
-		<constant name="MATH_SMOOTHSTEP" value="63" enum="BuiltinFunc">
+		<constant name="MATH_SMOOTHSTEP" value="64" enum="BuiltinFunc">
 			Returns a number smoothly interpolated between the first two inputs, based on the third input. Similar to [constant MATH_LERP], but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula:
 			[codeblock]
 			var t = clamp((weight - from) / (to - from), 0.0, 1.0)
 			return t * t * (3.0 - 2.0 * t)
 			[/codeblock]
 		</constant>
-		<constant name="MATH_POSMOD" value="64" enum="BuiltinFunc">
+		<constant name="MATH_POSMOD" value="65" enum="BuiltinFunc">
 		</constant>
-		<constant name="MATH_LERP_ANGLE" value="65" enum="BuiltinFunc">
+		<constant name="MATH_LERP_ANGLE" value="66" enum="BuiltinFunc">
 		</constant>
-		<constant name="TEXT_ORD" value="66" enum="BuiltinFunc">
+		<constant name="TEXT_ORD" value="67" enum="BuiltinFunc">
 		</constant>
-		<constant name="FUNC_MAX" value="67" enum="BuiltinFunc">
+		<constant name="FUNC_MAX" value="68" enum="BuiltinFunc">
 			Represents the size of the [enum BuiltinFunc] enum.
 		</constant>
 	</constants>
diff --git a/modules/visual_script/visual_script_builtin_funcs.cpp b/modules/visual_script/visual_script_builtin_funcs.cpp
index fd55796a66..f6bc855a50 100644
--- a/modules/visual_script/visual_script_builtin_funcs.cpp
+++ b/modules/visual_script/visual_script_builtin_funcs.cpp
@@ -65,6 +65,7 @@ const char *VisualScriptBuiltinFunc::func_name[VisualScriptBuiltinFunc::FUNC_MAX
 	"step_decimals",
 	"snapped",
 	"lerp",
+	"cubic_interpolate",
 	"inverse_lerp",
 	"range_lerp",
 	"move_toward",
@@ -212,6 +213,7 @@ int VisualScriptBuiltinFunc::get_func_argument_count(BuiltinFunc p_func) {
 		case MATH_WRAPF:
 		case LOGIC_CLAMP:
 			return 3;
+		case MATH_CUBIC_INTERPOLATE:
 		case MATH_RANGE_LERP:
 			return 5;
 		case FUNC_MAX: {
@@ -329,6 +331,19 @@ PropertyInfo VisualScriptBuiltinFunc::get_input_value_port_info(int p_idx) const
 				return PropertyInfo(Variant::FLOAT, "weight");
 			}
 		} break;
+		case MATH_CUBIC_INTERPOLATE: {
+			if (p_idx == 0) {
+				return PropertyInfo(Variant::FLOAT, "from");
+			} else if (p_idx == 1) {
+				return PropertyInfo(Variant::FLOAT, "to");
+			} else if (p_idx == 2) {
+				return PropertyInfo(Variant::FLOAT, "pre");
+			} else if (p_idx == 3) {
+				return PropertyInfo(Variant::FLOAT, "post");
+			} else {
+				return PropertyInfo(Variant::FLOAT, "weight");
+			}
+		} break;
 		case MATH_RANGE_LERP: {
 			if (p_idx == 0) {
 				return PropertyInfo(Variant::FLOAT, "value");
@@ -525,6 +540,7 @@ PropertyInfo VisualScriptBuiltinFunc::get_output_value_port_info(int p_idx) cons
 		} break;
 		case MATH_SNAPPED:
 		case MATH_LERP:
+		case MATH_CUBIC_INTERPOLATE:
 		case MATH_LERP_ANGLE:
 		case MATH_INVERSE_LERP:
 		case MATH_RANGE_LERP:
@@ -795,6 +811,14 @@ void VisualScriptBuiltinFunc::exec_func(BuiltinFunc p_func, const Variant **p_in
 			VALIDATE_ARG_NUM(2);
 			*r_return = Math::lerp((double)*p_inputs[0], (double)*p_inputs[1], (double)*p_inputs[2]);
 		} break;
+		case VisualScriptBuiltinFunc::MATH_CUBIC_INTERPOLATE: {
+			VALIDATE_ARG_NUM(0);
+			VALIDATE_ARG_NUM(1);
+			VALIDATE_ARG_NUM(2);
+			VALIDATE_ARG_NUM(3);
+			VALIDATE_ARG_NUM(4);
+			*r_return = Math::cubic_interpolate((double)*p_inputs[0], (double)*p_inputs[1], (double)*p_inputs[2], (double)*p_inputs[3], (double)*p_inputs[4]);
+		} break;
 		case VisualScriptBuiltinFunc::MATH_LERP_ANGLE: {
 			VALIDATE_ARG_NUM(0);
 			VALIDATE_ARG_NUM(1);
@@ -1220,6 +1244,7 @@ void VisualScriptBuiltinFunc::_bind_methods() {
 	BIND_ENUM_CONSTANT(MATH_STEP_DECIMALS);
 	BIND_ENUM_CONSTANT(MATH_SNAPPED);
 	BIND_ENUM_CONSTANT(MATH_LERP);
+	BIND_ENUM_CONSTANT(MATH_CUBIC_INTERPOLATE);
 	BIND_ENUM_CONSTANT(MATH_INVERSE_LERP);
 	BIND_ENUM_CONSTANT(MATH_RANGE_LERP);
 	BIND_ENUM_CONSTANT(MATH_MOVE_TOWARD);
@@ -1309,6 +1334,7 @@ void register_visual_script_builtin_func_node() {
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/step_decimals", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_STEP_DECIMALS>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/snapped", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_SNAPPED>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/lerp", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_LERP>);
+	VisualScriptLanguage::singleton->add_register_func("functions/built_in/cubic_interpolate", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_CUBIC_INTERPOLATE>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/lerp_angle", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_LERP_ANGLE>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/inverse_lerp", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_INVERSE_LERP>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/range_lerp", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_RANGE_LERP>);
diff --git a/modules/visual_script/visual_script_builtin_funcs.h b/modules/visual_script/visual_script_builtin_funcs.h
index d689296233..18935b9995 100644
--- a/modules/visual_script/visual_script_builtin_funcs.h
+++ b/modules/visual_script/visual_script_builtin_funcs.h
@@ -65,6 +65,7 @@ public:
 		MATH_STEP_DECIMALS,
 		MATH_SNAPPED,
 		MATH_LERP,
+		MATH_CUBIC_INTERPOLATE,
 		MATH_INVERSE_LERP,
 		MATH_RANGE_LERP,
 		MATH_MOVE_TOWARD,