diff options
| author | Mel Collins <mel@raumkraut.net> | 2018-04-29 15:44:07 +0200 |
|---|---|---|
| committer | Mel Collins <mel@raumkraut.net> | 2018-04-29 15:44:07 +0200 |
| commit | b431264f773f250a580d6c61fa7858fca3833bf0 (patch) | |
| tree | ba85816fb4a354c47aeb58bc297a33f4f12bad83 | |
| parent | d0183effe02edb973e44e5ad8b3608d861f86490 (diff) | |
[DOCS] Clarify look_at and looking_at
| -rw-r--r-- | doc/classes/Spatial.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Transform.xml | 4 |
2 files changed, 7 insertions, 3 deletions
diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 822a699984..9ef60109de 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -99,7 +99,9 @@ <argument index="1" name="up" type="Vector3"> </argument> <description> - Rotates itself to point into direction of target position. Operations take place in global space. + Rotates itself so that the local -Z axis points towards the [code]target[/code] position. + The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors. + Operations take place in global space. </description> </method> <method name="look_at_from_position"> @@ -112,7 +114,7 @@ <argument index="2" name="up" type="Vector3"> </argument> <description> - Moves the node to specified position and then rotates itself to point into direction of target position. Operations take place in global space. + Moves the node to the specified [code]position[/code], and then rotates itself to point toward the [code]target[/code] as per [method look_at]. Operations take place in global space. </description> </method> <method name="orthonormalize"> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index d9f9d8cc73..4567f1681c 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -99,7 +99,9 @@ <argument index="1" name="up" type="Vector3"> </argument> <description> - Rotate the transform around the up vector to face the target. + Returns a copy of the transform rotated such that its -Z axis points towards the [code]target[/code] position. + The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors. + Operations take place in global space. </description> </method> <method name="orthonormalized"> |