Parcourir la source

Add cartesian to polar conversion functions

pablotato il y a 7 ans
Parent
commit
054a2ac579

+ 22 - 0
doc/classes/@GDScript.xml

@@ -138,6 +138,17 @@
 				Decodes a byte array back to a value.
 			</description>
 		</method>
+		<method name="cartesian2polar">
+			<return type="Vector2">
+			</return>
+			<argument index="0" name="x" type="float">
+			</argument>
+			<argument index="1" name="y" type="float">
+			</argument>
+			<description>
+				Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle).
+			</description>
+		</method>
 		<method name="ceil">
 			<return type="float">
 			</return>
@@ -604,6 +615,17 @@
 				[/codeblock]
 			</description>
 		</method>
+		<method name="polar2cartesian">
+			<return type="Vector2">
+			</return>
+			<argument index="0" name="r" type="float">
+			</argument>
+			<argument index="1" name="th" type="float">
+			</argument>
+			<description>
+				Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (x and y axis).
+			</description>
+		</method>
 		<method name="pow">
 			<return type="float">
 			</return>

+ 30 - 0
modules/gdscript/gdscript_functions.cpp

@@ -84,6 +84,8 @@ const char *GDScriptFunctions::get_func_name(Function p_func) {
 		"rad2deg",
 		"linear2db",
 		"db2linear",
+		"polar2cartesian",
+		"cartesian2polar",
 		"wrapi",
 		"wrapf",
 		"max",
@@ -408,6 +410,22 @@ void GDScriptFunctions::call(Function p_func, const Variant **p_args, int p_arg_
 			VALIDATE_ARG_NUM(0);
 			r_ret = Math::db2linear((double)*p_args[0]);
 		} break;
+		case MATH_POLAR2CARTESIAN: {
+			VALIDATE_ARG_COUNT(2);
+			VALIDATE_ARG_NUM(0);
+			VALIDATE_ARG_NUM(1);
+			double r = *p_args[0];
+			double th = *p_args[1];
+			r_ret = Vector2(r * Math::cos(th), r * Math::sin(th));
+		} break;
+		case MATH_CARTESIAN2POLAR: {
+			VALIDATE_ARG_COUNT(2);
+			VALIDATE_ARG_NUM(0);
+			VALIDATE_ARG_NUM(1);
+			double x = *p_args[0];
+			double y = *p_args[1];
+			r_ret = Vector2(Math::sqrt(x * x + y * y), Math::atan2(y, x));
+		} break;
 		case MATH_WRAP: {
 			VALIDATE_ARG_COUNT(3);
 			r_ret = Math::wrapi((int64_t)*p_args[0], (int64_t)*p_args[1], (int64_t)*p_args[2]);
@@ -1296,6 +1314,8 @@ bool GDScriptFunctions::is_deterministic(Function p_func) {
 		case MATH_RAD2DEG:
 		case MATH_LINEAR2DB:
 		case MATH_DB2LINEAR:
+		case MATH_POLAR2CARTESIAN:
+		case MATH_CARTESIAN2POLAR:
 		case MATH_WRAP:
 		case MATH_WRAPF:
 		case LOGIC_MAX:
@@ -1526,6 +1546,16 @@ MethodInfo GDScriptFunctions::get_info(Function p_func) {
 			mi.return_val.type = Variant::REAL;
 			return mi;
 		} break;
+		case MATH_POLAR2CARTESIAN: {
+			MethodInfo mi("polar2cartesian", PropertyInfo(Variant::REAL, "r"), PropertyInfo(Variant::REAL, "th"));
+			mi.return_val.type = Variant::VECTOR2;
+			return mi;
+		} break;
+		case MATH_CARTESIAN2POLAR: {
+			MethodInfo mi("cartesian2polar", PropertyInfo(Variant::REAL, "x"), PropertyInfo(Variant::REAL, "y"));
+			mi.return_val.type = Variant::VECTOR2;
+			return mi;
+		} break;
 		case MATH_WRAP: {
 			MethodInfo mi("wrapi", PropertyInfo(Variant::INT, "value"), PropertyInfo(Variant::INT, "min"), PropertyInfo(Variant::INT, "max"));
 			mi.return_val.type = Variant::INT;

+ 2 - 0
modules/gdscript/gdscript_functions.h

@@ -75,6 +75,8 @@ public:
 		MATH_RAD2DEG,
 		MATH_LINEAR2DB,
 		MATH_DB2LINEAR,
+		MATH_POLAR2CARTESIAN,
+		MATH_CARTESIAN2POLAR,
 		MATH_WRAP,
 		MATH_WRAPF,
 		LOGIC_MAX,

+ 10 - 0
modules/mono/glue/cs_files/Mathf.cs

@@ -35,6 +35,11 @@ namespace Godot
             return (float)Math.Atan2(x, y);
         }
 
+		public static Vector2 cartesian2polar(float x, float y)
+		{
+			return new Vector2(sqrt(x * x + y * y), atan2(y, x));
+		}
+
         public static float ceil(float s)
         {
             return (float)Math.Ceiling(s);
@@ -176,6 +181,11 @@ namespace Godot
             return val;
         }
 
+		public static Vector2 polar2cartesian(float r, float th)
+		{
+			return new Vector2(r * cos(th), r * sin(th));
+		}
+
         public static float pow(float x, float y)
         {
             return (float)Math.Pow(x, y);

+ 28 - 22
modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml

@@ -151,68 +151,74 @@
 		<constant name="MATH_DB2LINEAR" value="39">
 			Convert the input from decibel volume to linear volume.
 		</constant>
-		<constant name="MATH_WRAP" value="40">
+		<constant name="MATH_POLAR2CARTESIAN" value="40">
+			Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (x and y axis).
 		</constant>
-		<constant name="MATH_WRAPF" value="41">
+		<constant name="MATH_CARTESIAN2POLAR" value="41">
+			Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle).
 		</constant>
-		<constant name="LOGIC_MAX" value="42">
+		<constant name="MATH_WRAP" value="42">
+		</constant>
+		<constant name="MATH_WRAPF" value="43">
+		</constant>
+		<constant name="LOGIC_MAX" value="44">
 			Return the greater of the two numbers, also known as their maximum.
 		</constant>
-		<constant name="LOGIC_MIN" value="43">
+		<constant name="LOGIC_MIN" value="45">
 			Return the lesser of the two numbers, also known as their minimum.
 		</constant>
-		<constant name="LOGIC_CLAMP" value="44">
+		<constant name="LOGIC_CLAMP" value="46">
 			Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)`
 		</constant>
-		<constant name="LOGIC_NEAREST_PO2" value="45">
+		<constant name="LOGIC_NEAREST_PO2" value="46">
 			Return the nearest power of 2 to the input.
 		</constant>
-		<constant name="OBJ_WEAKREF" value="46">
+		<constant name="OBJ_WEAKREF" value="47">
 			Create a [WeakRef] from the input.
 		</constant>
-		<constant name="FUNC_FUNCREF" value="47">
+		<constant name="FUNC_FUNCREF" value="48">
 			Create a [FuncRef] from the input.
 		</constant>
-		<constant name="TYPE_CONVERT" value="48">
+		<constant name="TYPE_CONVERT" value="49">
 			Convert between types.
 		</constant>
-		<constant name="TYPE_OF" value="49">
+		<constant name="TYPE_OF" value="50">
 			Return 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="50">
+		<constant name="TYPE_EXISTS" value="51">
 			Checks if a type is registered in the [ClassDB].
 		</constant>
-		<constant name="TEXT_CHAR" value="51">
+		<constant name="TEXT_CHAR" value="52">
 			Return a character with the given ascii value.
 		</constant>
-		<constant name="TEXT_STR" value="52">
+		<constant name="TEXT_STR" value="53">
 			Convert the input to a string.
 		</constant>
-		<constant name="TEXT_PRINT" value="53">
+		<constant name="TEXT_PRINT" value="54">
 			Print the given string to the output window.
 		</constant>
-		<constant name="TEXT_PRINTERR" value="54">
+		<constant name="TEXT_PRINTERR" value="55">
 			Print the given string to the standard error output.
 		</constant>
-		<constant name="TEXT_PRINTRAW" value="55">
+		<constant name="TEXT_PRINTRAW" value="56">
 			Print the given string to the standard output, without adding a newline.
 		</constant>
-		<constant name="VAR_TO_STR" value="56">
+		<constant name="VAR_TO_STR" value="57">
 			Serialize a [Variant] to a string.
 		</constant>
-		<constant name="STR_TO_VAR" value="57">
+		<constant name="STR_TO_VAR" value="58">
 			Deserialize a [Variant] from a string serialized using [VAR_TO_STR].
 		</constant>
-		<constant name="VAR_TO_BYTES" value="58">
+		<constant name="VAR_TO_BYTES" value="59">
 			Serialize a [Variant] to a [PoolByteArray].
 		</constant>
-		<constant name="BYTES_TO_VAR" value="59">
+		<constant name="BYTES_TO_VAR" value="60">
 			Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES].
 		</constant>
-		<constant name="COLORN" value="60">
+		<constant name="COLORN" value="61">
 			Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
 		</constant>
-		<constant name="FUNC_MAX" value="61">
+		<constant name="FUNC_MAX" value="62">
 			The maximum value the [member function] property can have.
 		</constant>
 	</constants>

+ 38 - 0
modules/visual_script/visual_script_builtin_funcs.cpp

@@ -78,6 +78,8 @@ const char *VisualScriptBuiltinFunc::func_name[VisualScriptBuiltinFunc::FUNC_MAX
 	"rad2deg",
 	"linear2db",
 	"db2linear",
+	"polar2cartesian",
+	"cartesian2polar",
 	"wrapi",
 	"wrapf",
 	"max",
@@ -191,6 +193,8 @@ int VisualScriptBuiltinFunc::get_func_argument_count(BuiltinFunc p_func) {
 		case MATH_EASE:
 		case MATH_STEPIFY:
 		case MATH_RANDOM:
+		case MATH_POLAR2CARTESIAN:
+		case MATH_CARTESIAN2POLAR:
 		case LOGIC_MAX:
 		case LOGIC_MIN:
 		case FUNC_FUNCREF:
@@ -368,6 +372,18 @@ PropertyInfo VisualScriptBuiltinFunc::get_input_value_port_info(int p_idx) const
 		case MATH_DB2LINEAR: {
 			return PropertyInfo(Variant::REAL, "db");
 		} break;
+		case MATH_POLAR2CARTESIAN: {
+			if (p_idx == 0)
+				return PropertyInfo(Variant::REAL, "r");
+			else
+				return PropertyInfo(Variant::REAL, "th");
+		} break;
+		case MATH_CARTESIAN2POLAR: {
+			if (p_idx == 0)
+				return PropertyInfo(Variant::REAL, "x");
+			else
+				return PropertyInfo(Variant::REAL, "y");
+		} break;
 		case MATH_WRAP: {
 			if (p_idx == 0)
 				return PropertyInfo(Variant::INT, "value");
@@ -573,6 +589,10 @@ PropertyInfo VisualScriptBuiltinFunc::get_output_value_port_info(int p_idx) cons
 		case MATH_DB2LINEAR: {
 			t = Variant::REAL;
 		} break;
+		case MATH_POLAR2CARTESIAN:
+		case MATH_CARTESIAN2POLAR: {
+			t = Variant::VECTOR2;
+		} break;
 		case MATH_WRAP: {
 			t = Variant::INT;
 		} break;
@@ -922,6 +942,20 @@ void VisualScriptBuiltinFunc::exec_func(BuiltinFunc p_func, const Variant **p_in
 			VALIDATE_ARG_NUM(0);
 			*r_return = Math::db2linear((double)*p_inputs[0]);
 		} break;
+		case VisualScriptBuiltinFunc::MATH_POLAR2CARTESIAN: {
+			VALIDATE_ARG_NUM(0);
+			VALIDATE_ARG_NUM(1);
+			double r = *p_inputs[0];
+			double th = *p_inputs[1];
+			*r_return = Vector2(r * Math::cos(th), r * Math::sin(th));
+		} break;
+		case VisualScriptBuiltinFunc::MATH_CARTESIAN2POLAR: {
+			VALIDATE_ARG_NUM(0);
+			VALIDATE_ARG_NUM(1);
+			double x = *p_inputs[0];
+			double y = *p_inputs[1];
+			*r_return = Vector2(Math::sqrt(x * x + y * y), Math::atan2(y, x));
+		} break;
 		case VisualScriptBuiltinFunc::MATH_WRAP: {
 			VALIDATE_ARG_NUM(0);
 			VALIDATE_ARG_NUM(1);
@@ -1294,6 +1328,8 @@ void VisualScriptBuiltinFunc::_bind_methods() {
 	BIND_ENUM_CONSTANT(MATH_RAD2DEG);
 	BIND_ENUM_CONSTANT(MATH_LINEAR2DB);
 	BIND_ENUM_CONSTANT(MATH_DB2LINEAR);
+	BIND_ENUM_CONSTANT(MATH_POLAR2CARTESIAN);
+	BIND_ENUM_CONSTANT(MATH_CARTESIAN2POLAR);
 	BIND_ENUM_CONSTANT(MATH_WRAP);
 	BIND_ENUM_CONSTANT(MATH_WRAPF);
 	BIND_ENUM_CONSTANT(LOGIC_MAX);
@@ -1381,6 +1417,8 @@ void register_visual_script_builtin_func_node() {
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/rad2deg", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_RAD2DEG>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/linear2db", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_LINEAR2DB>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/db2linear", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_DB2LINEAR>);
+	VisualScriptLanguage::singleton->add_register_func("functions/built_in/polar2cartesian", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_POLAR2CARTESIAN>);
+	VisualScriptLanguage::singleton->add_register_func("functions/built_in/cartesian2polar", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_CARTESIAN2POLAR>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/wrapi", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_WRAP>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/wrapf", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_WRAPF>);
 

+ 2 - 0
modules/visual_script/visual_script_builtin_funcs.h

@@ -77,6 +77,8 @@ public:
 		MATH_RAD2DEG,
 		MATH_LINEAR2DB,
 		MATH_DB2LINEAR,
+		MATH_POLAR2CARTESIAN,
+		MATH_CARTESIAN2POLAR,
 		MATH_WRAP,
 		MATH_WRAPF,
 		LOGIC_MAX,