godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7640dc2c73
godot/doc/classes/Transform3D.xml

211 lines
9.5 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<class name="Transform3D" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
3D transformation (3×4 matrix).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Update core documentation to match recent C# changes Also a few minor API changes like adding AABB.abs() Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-07-21 18:07:00 +00:00
3×4 matrix (3 rows, 4 columns) used for 3D linear transformations. It can represent transformations such as translation, rotation, or scaling. It consists of a [member basis] (first 3 columns) and a [Vector3] for the [member origin] (last column).
For more information, read the "Matrices and transforms" documentation article.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
<link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link>
<link title="Matrices and transforms">$DOCS_URL/tutorials/math/matrices_and_transforms.html</link>
<link title="Using 3D transforms">$DOCS_URL/tutorials/3d/using_transforms.html</link>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link>
<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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<constructors>
<constructor name="Transform3D">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
Constructs a default-initialized [Transform3D] set to [constant IDENTITY].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Transform3D">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
<argument index="0" name="from" type="Transform3D" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
Constructs a [Transform3D] as a copy of the given [Transform3D].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Transform3D">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
<argument index="0" name="basis" type="Basis" />
<argument index="1" name="origin" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
Constructs a Transform3D from a [Basis] and [Vector3].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
<constructor name="Transform3D">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
<argument index="0" name="x_axis" type="Vector3" />
<argument index="1" name="y_axis" type="Vector3" />
<argument index="2" name="z_axis" type="Vector3" />
<argument index="3" name="origin" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</constructor>
</constructors>
<methods>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="affine_inverse" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="interpolate_with" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
<argument index="0" name="xform" type="Transform3D" />
<argument index="1" name="weight" type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Unify similar method descriptions Notably: * `Packed*Array.size()` and `Array.size()`. * Shared methods of `Transform2D` and `Transform3D`. * Shared methods of `Vector2`, `Vector3`, and `Vector2i`. This reduces the Deja Vu when translating the class reference :)
2022-01-06 10:37:08 +00:00
Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="inverse" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Unify similar method descriptions Notably: * `Packed*Array.size()` and `Array.size()`. * Shared methods of `Transform2D` and `Transform3D`. * Shared methods of `Vector2`, `Vector3`, and `Vector2i`. This reduces the Deja Vu when translating the class reference :)
2022-01-06 10:37:08 +00:00
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use [method affine_inverse] for transforms with scaling).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="is_equal_approx" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="xform" type="Transform3D" />
doc: Sync classref with current source
2019-11-08 07:33:48 +00:00
<description>
Add docs for is_equal_approx on structures
2019-11-30 20:08:50 +00:00
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
doc: Sync classref with current source
2019-11-08 07:33:48 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="looking_at" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
<argument index="0" name="target" type="Vector3" />
<argument index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Move code for looking_at to Basis
2021-07-21 03:32:00 +00:00
Returns a copy of the transform rotated such that the forward axis (-Z) points towards the [code]target[/code] position.
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="orthonormalized" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Unify similar method descriptions Notably: * `Packed*Array.size()` and `Array.size()`. * Shared methods of `Transform2D` and `Transform3D`. * Shared methods of `Vector2`, `Vector3`, and `Vector2i`. This reduces the Deja Vu when translating the class reference :)
2022-01-06 10:37:08 +00:00
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="rotated" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
<argument index="0" name="axis" type="Vector3" />
<argument index="1" name="phi" type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Document that translated does not behave like rotated or scaled
2019-12-13 20:23:26 +00:00
Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="scaled" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
<argument index="0" name="scale" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Clarify Transform scaled Method description.
2020-04-10 20:27:45 +00:00
Scales basis and origin of the transform by the given scale factor, using matrix multiplication.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00:00
<method name="translated" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Transform3D" />
<argument index="0" name="offset" type="Vector3" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Document that translated does not behave like rotated or scaled
2019-12-13 20:23:26 +00:00
Translates the transform by the given offset, relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="basis" type="Basis" setter="" getter="" default="Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="origin" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
Update core documentation to match recent C# changes Also a few minor API changes like adding AABB.abs() Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-07-21 18:07:00 +00:00
The translation offset of the transform (column 3, the fourth column). Equivalent to array index [code]3[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<constant name="IDENTITY" value="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)">
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
[Transform3D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</constant>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<constant name="FLIP_X" value="Transform3D(-1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)">
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
[Transform3D] with mirroring applied perpendicular to the YZ plane.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</constant>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<constant name="FLIP_Y" value="Transform3D(1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0)">
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
[Transform3D] with mirroring applied perpendicular to the XZ plane.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</constant>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<constant name="FLIP_Z" value="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0)">
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
[Transform3D] with mirroring applied perpendicular to the XY plane.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<operators>
<operator name="operator !=">
<return type="bool" />
<description>
</description>
</operator>
<operator name="operator !=">
<return type="bool" />
<argument index="0" name="right" type="Transform3D" />
<description>
Add documentation to operators for math types Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 15:58:20 +00:00
Returns [code]true[/code] if the transforms are not equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</description>
</operator>
Enable sorting of operator methods in class documentation.
2021-11-28 08:48:57 +00:00
<operator name="operator *">
<return type="AABB" />
<argument index="0" name="right" type="AABB" />
<description>
Transforms (multiplies) the [AABB] by the given [Transform3D] matrix.
</description>
</operator>
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<operator name="operator *">
<return type="PackedVector3Array" />
<argument index="0" name="right" type="PackedVector3Array" />
<description>
Add documentation to operators for math types Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 15:58:20 +00:00
Transforms (multiplies) each element of the [Vector3] array by the given [Transform3D] matrix.
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</description>
</operator>
<operator name="operator *">
<return type="Transform3D" />
<argument index="0" name="right" type="Transform3D" />
<description>
Add documentation to operators for math types Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 15:58:20 +00:00
Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent).
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</description>
</operator>
<operator name="operator *">
<return type="Vector3" />
<argument index="0" name="right" type="Vector3" />
<description>
Add documentation to operators for math types Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 15:58:20 +00:00
Transforms (multiplies) the [Vector3] by the given [Transform3D] matrix.
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</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>
Add documentation to operators for math types Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 15:58:20 +00:00
Returns [code]true[/code] if the transforms are exactly equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
</description>
</operator>
</operators>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</class>
Reference in New Issue Copy Permalink