hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move the docs for constructors and operators out of methods section

Browse source
This commit is contained in:
Aaron Franke 2021-09-20 21:49:02 -05:00
parent f7d852b532
commit 6772ebcea0
No known key found for this signature in database
GPG key ID: 40A1750B977E56BF
40 changed files with 2511 additions and 2232 deletions
Download patch file Download diff file Expand all files Collapse all files

142
doc/classes/Transform3D.xml
View file

@ -15,29 +15,29 @@
<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
<link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link>
</tutorials>
<methods>
<method name="Transform3D" qualifiers="constructor">
<constructors>
<constructor name="Transform3D">
<return type="Transform3D" />
<description>
Constructs a default-initialized [Transform3D] set to [constant IDENTITY].
</description>
</method>
<method name="Transform3D" qualifiers="constructor">
</constructor>
<constructor name="Transform3D">
<return type="Transform3D" />
<argument index="0" name="from" type="Transform3D" />
<description>
Constructs a [Transform3D] as a copy of the given [Transform3D].
</description>
</method>
<method name="Transform3D" qualifiers="constructor">
</constructor>
<constructor name="Transform3D">
<return type="Transform3D" />
<argument index="0" name="basis" type="Basis" />
<argument index="1" name="origin" type="Vector3" />
<description>
Constructs a Transform3D from a [Basis] and [Vector3].
</description>
</method>
<method name="Transform3D" qualifiers="constructor">
</constructor>
<constructor name="Transform3D">
<return type="Transform3D" />
<argument index="0" name="x_axis" type="Vector3" />
<argument index="1" name="y_axis" type="Vector3" />
@ -46,7 +46,9 @@
<description>
Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled).
</description>
</method>
</constructor>
</constructors>
<methods>
<method name="affine_inverse" qualifiers="const">
<return type="Transform3D" />
<description>
@ -83,66 +85,6 @@
The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting transform is orthonormalized. The existing rotation, scale, and skew information from the original transform is discarded. The [code]target[/code] and [code]up[/code] vectors cannot be zero, cannot be parallel to each other, and are defined in global/parent space.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Transform3D" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="PackedVector3Array" />
<argument index="0" name="right" type="PackedVector3Array" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Transform3D" />
<argument index="0" name="right" type="Transform3D" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="AABB" />
<argument index="0" name="right" type="AABB" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3" />
<argument index="0" name="right" type="Vector3" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Transform3D" />
<argument index="0" name="right" type="float" />
<description>
This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Transform3D" />
<argument index="0" name="right" type="int" />
<description>
This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool" />
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool" />
<argument index="0" name="right" type="Transform3D" />
<description>
</description>
</method>
<method name="orthonormalized" qualifiers="const">
<return type="Transform3D" />
<description>
@ -195,4 +137,66 @@
[Transform3D] with mirroring applied perpendicular to the XY plane.
</constant>
</constants>
<operators>
<operator name="operator !=">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="Transform3D" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="PackedVector3Array" />
<argument index="0" name="right" type="PackedVector3Array" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Transform3D" />
<argument index="0" name="right" type="Transform3D" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="AABB" />
<argument index="0" name="right" type="AABB" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Vector3" />
<argument index="0" name="right" type="Vector3" />
<description>
</description>
</operator>
<operator name="operator *">
<return type="Transform3D" />
<argument index="0" name="right" type="float" />
<description>
This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
</description>
</operator>
<operator name="operator *">
<return type="Transform3D" />
<argument index="0" name="right" type="int" />
<description>
This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<argument index="0" name="right" type="Transform3D" />
<description>
</description>
</operator>
</operators>
</class>