diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2022-05-05 13:25:04 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-05-05 14:17:39 +0200 |
| commit | e7a58a7eb6d45b530eeaea88cfa29adcd8df02f3 (patch) | |
| tree | 7bdab2e625224871428f5f363146e674730adb59 /doc | |
| parent | b05fbb21e5ea5852b36923e40228936f78a5723e (diff) | |
Core: Rename math 'phi' arguments to 'angle'
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Basis.xml | 8 | ||||
| -rw-r--r-- | doc/classes/Transform2D.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Transform3D.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Vector2.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Vector3.xml | 6 |
5 files changed, 13 insertions, 13 deletions
diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 3b703884a5..0af482d654 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -35,9 +35,9 @@ <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="phi" type="float" /> + <argument index="1" name="angle" type="float" /> <description> - Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector. + Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]angle[/code] (in radians). The axis must be a normalized vector. </description> </constructor> <constructor name="Basis"> @@ -136,9 +136,9 @@ <method name="rotated" qualifiers="const"> <return type="Basis" /> <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="phi" type="float" /> + <argument index="1" name="angle" type="float" /> <description> - Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector. + Introduce an additional rotation around the given axis by [code]angle[/code] (in radians). The axis must be a normalized vector. </description> </method> <method name="scaled" qualifiers="const"> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 7d289b2ef5..8c2a5aa6d9 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -139,9 +139,9 @@ </method> <method name="rotated" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="phi" type="float" /> + <argument index="0" name="angle" type="float" /> <description> - Returns a copy of the transform rotated by the given [code]phi[/code] angle (in radians), using matrix multiplication. + Returns a copy of the transform rotated by the given [code]angle[/code] (in radians), using matrix multiplication. </description> </method> <method name="scaled" qualifiers="const"> diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index 4a08ab3bc7..afd11b6c77 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -94,9 +94,9 @@ <method name="rotated" qualifiers="const"> <return type="Transform3D" /> <argument index="0" name="axis" type="Vector3" /> - <argument index="1" name="phi" type="float" /> + <argument index="1" name="angle" type="float" /> <description> - Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]phi[/code] angle (in radians), using matrix multiplication. The [code]axis[/code] must be a normalized vector. + Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians), using matrix multiplication. The [code]axis[/code] must be a normalized vector. </description> </method> <method name="scaled" qualifiers="const"> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index f9ef126658..6ccc0fc6a6 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -278,9 +278,9 @@ </method> <method name="rotated" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="phi" type="float" /> + <argument index="0" name="angle" type="float" /> <description> - Returns the vector rotated by [code]phi[/code] radians. See also [method @GlobalScope.deg2rad]. + Returns the vector rotated by [code]angle[/code] (in radians). See also [method @GlobalScope.deg2rad]. </description> </method> <method name="round" qualifiers="const"> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 18204943fd..d907ceb52b 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -258,10 +258,10 @@ </method> <method name="rotated" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="by_axis" type="Vector3" /> - <argument index="1" name="phi" type="float" /> + <argument index="0" name="axis" type="Vector3" /> + <argument index="1" name="angle" type="float" /> <description> - Rotates this vector around a given axis by [code]phi[/code] radians. The axis must be a normalized vector. + Rotates this vector around a given axis by [code]angle[/code] (in radians). The axis must be a normalized vector. </description> </method> <method name="round" qualifiers="const"> |