diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-11-10 08:28:08 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-10 08:28:08 +0100 |
| commit | 8e056ba2034caa9f69d242eb97eff54ce3760813 (patch) | |
| tree | 4fa6ebf28401601e03b0ce2b387f60c32b771fb5 /doc/classes/Basis.xml | |
| parent | efc4d217d61f592a16ebab30731ff9f595dee2cf (diff) | |
| parent | 0f249f5c0aa2c3a89848f03f155b76e834e4c32a (diff) | |
Merge pull request #43417 from akien-mga/variant-default-constructors-docs
Variant: Sync docs with new constructors, fixes to #43403
Diffstat (limited to 'doc/classes/Basis.xml')
| -rw-r--r-- | doc/classes/Basis.xml | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 4201a31402..908f316e4e 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -22,20 +22,17 @@ <method name="Basis"> <return type="Basis"> </return> - <argument index="0" name="from" type="Quat"> - </argument> <description> - Constructs a pure rotation basis matrix from the given quaternion. + Constructs a default-initialized [Basis] set to [constant IDENTITY]. </description> </method> <method name="Basis"> <return type="Basis"> </return> - <argument index="0" name="from" type="Vector3"> + <argument index="0" name="from" type="Basis"> </argument> <description> - Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle). - Consider using the [Quat] constructor instead, which uses a quaternion instead of Euler angles. + Constructs a [Basis] as a copy of the given [Basis]. </description> </method> <method name="Basis"> @@ -52,6 +49,25 @@ <method name="Basis"> <return type="Basis"> </return> + <argument index="0" name="euler" type="Vector3"> + </argument> + <description> + Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle). + Consider using the [Quat] constructor instead, which uses a quaternion instead of Euler angles. + </description> + </method> + <method name="Basis"> + <return type="Basis"> + </return> + <argument index="0" name="from" type="Quat"> + </argument> + <description> + Constructs a pure rotation basis matrix from the given quaternion. + </description> + </method> + <method name="Basis"> + <return type="Basis"> + </return> <argument index="0" name="x_axis" type="Vector3"> </argument> <argument index="1" name="y_axis" type="Vector3"> |