Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Merge pull request #73652 from KoBeWi/master_degree_in_maths

Browse source 
Clarify rotation degrees
This commit is contained in:
Rémi Verschelde 2023-02-21 08:22:45 +01:00 • committed by GitHub
commit 052d8d804e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/classes/Control.xml
View file

@ -1001,6 +1001,7 @@
</member> </member>
<member name="rotation" type="float" setter="set_rotation" getter="get_rotation" default="0.0"> <member name="rotation" type="float" setter="set_rotation" getter="get_rotation" default="0.0">
The node's rotation around its pivot, in radians. See [member pivot_offset] to change the pivot's position. The node's rotation around its pivot, in radians. See [member pivot_offset] to change the pivot's position.
[b]Note:[/b] This property is edited in the inspector in degrees. If you want to use degrees in a script, use [member rotation_degrees].
</member> </member>
<member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
Helper property to access [member rotation] in degrees instead of radians. Helper property to access [member rotation] in degrees instead of radians.

1
doc/classes/Node2D.xml
View file

@ -116,6 +116,7 @@
</member> </member>
<member name="rotation" type="float" setter="set_rotation" getter="get_rotation" default="0.0"> <member name="rotation" type="float" setter="set_rotation" getter="get_rotation" default="0.0">
Rotation in radians, relative to the node's parent. Rotation in radians, relative to the node's parent.
[b]Note:[/b] This property is edited in the inspector in degrees. If you want to use degrees in a script, use [member rotation_degrees].
</member> </member>
<member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
Helper property to access [member rotation] in degrees instead of radians. Helper property to access [member rotation] in degrees instead of radians.

1
doc/classes/Node3D.xml
View file

@ -289,6 +289,7 @@
<member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation" default="Vector3(0, 0, 0)"> <member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation" default="Vector3(0, 0, 0)">
Rotation part of the local transformation in radians, specified in terms of Euler angles. The angles construct a rotaton in the order specified by the [member rotation_order] property. Rotation part of the local transformation in radians, specified in terms of Euler angles. The angles construct a rotaton in the order specified by the [member rotation_order] property.
[b]Note:[/b] In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. [b]Note:[/b] In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.
[b]Note:[/b] This property is edited in the inspector in degrees. If you want to use degrees in a script, use [member rotation_degrees].
</member> </member>
<member name="rotation_degrees" type="Vector3" setter="set_rotation_degrees" getter="get_rotation_degrees"> <member name="rotation_degrees" type="Vector3" setter="set_rotation_degrees" getter="get_rotation_degrees">
Helper property to access [member rotation] in degrees instead of radians. Helper property to access [member rotation] in degrees instead of radians.