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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

256 lines
12 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" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="Transform3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="basis" type="Basis" />
<param 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">
Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
<return type="Transform3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="from" type="Projection" />
Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
<description>
C#: Add missing `Transform{2D,3D}` and `Basis` constructors - Remove `Transform3D(Quaternion, Vector3)` constructor from C#. - Add `Transform3D(Projection)` constructor to C#. - Add documentation to the `Transform3D(Projection)` constructor in Core. - Add `Transform3D` constructor with only real_t params to C# that mirrors `Transform2D`. - Expose `Basis` constructor with only real_t params in C#. - Add `Transform2D(real_t, Vector2, real_t, Vector2)` constructor to C#.
2023-01-14 17:03:01 +00:00
Constructs a Transform3D from a [Projection] by trimming the last row of the projection matrix ([code]from.x.w[/code], [code]from.y.w[/code], [code]from.z.w[/code], and [code]from.w.w[/code] are not copied over).
Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
</description>
</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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="x_axis" type="Vector3" />
<param index="1" name="y_axis" type="Vector3" />
<param index="2" name="z_axis" type="Vector3" />
<param 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="xform" type="Transform3D" />
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a transform interpolated between this transform and another by a given [param weight] (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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="xform" type="Transform3D" />
doc: Sync classref with current source
2019-11-08 07:33:48 +00:00
<description>
Fixed typos in the Transform2D and Transform3D class reference (cherry picked from commit 36270d39d2f53bae5ac78f6b475be3d0ecb9184c)
2023-03-08 22:49:37 +00:00
Returns [code]true[/code] if this transform and [param xform] 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>
Add `is_finite` method for checking built-in types
2022-08-11 08:12:27 +00:00
<method name="is_finite" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if this transform is finite, by calling [method @GlobalScope.is_finite] on each component.
</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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="target" type="Vector3" />
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a copy of the transform rotated such that the forward axis (-Z) points towards the [param target] position.
The up axis (+Y) points as close to the [param up] 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 [param target] and [param up] 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="axis" type="Vector3" />
<param index="1" name="angle" 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a copy of the transform rotated around the given [param axis] by the given [param angle] (in radians).
The [param axis] must be a normalized vector.
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding rotation transform [code]R[/code] from the left, i.e., [code]R * X[/code].
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
This can be seen as transforming with respect to the global/parent frame.
</description>
</method>
<method name="rotated_local" qualifiers="const">
<return type="Transform3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="axis" type="Vector3" />
<param index="1" name="angle" type="float" />
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a copy of the transform rotated around the given [param axis] by the given [param angle] (in radians).
The [param axis] must be a normalized vector.
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding rotation transform [code]R[/code] from the right, i.e., [code]X * R[/code].
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
This can be seen as transforming with respect to the local frame.
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a copy of the transform scaled by the given [param scale] factor.
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding scaling transform [code]S[/code] from the left, i.e., [code]S * X[/code].
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
This can be seen as transforming with respect to the global/parent frame.
</description>
</method>
<method name="scaled_local" qualifiers="const">
<return type="Transform3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="scale" type="Vector3" />
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a copy of the transform scaled by the given [param scale] factor.
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding scaling transform [code]S[/code] from the right, i.e., [code]X * S[/code].
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
This can be seen as transforming with respect to the local frame.
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>
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
<method name="translated" qualifiers="const">
<return type="Transform3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="offset" type="Vector3" />
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a copy of the transform translated by the given [param offset].
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding translation transform [code]T[/code] from the left, i.e., [code]T * X[/code].
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
This can be seen as transforming with respect to the global/parent frame.
</description>
</method>
rename translate(d) to translate(d)_local in Transform 2D/3D
2022-07-16 09:47:54 +00:00
<method name="translated_local" 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a copy of the transform translated by the given [param offset].
Fix typos and inconsistencies in classref (cherry picked from commit 57d4272984fc0dd4c668503ead82a9dd01020bfd)
2023-03-16 05:56:09 +00:00
This method is an optimized version of multiplying the given transform [code]X[/code] with a corresponding translation transform [code]T[/code] from the right, i.e., [code]X * T[/code].
Fix consistency of translated/scaled/rotated in Transform2D and Transform3D
2022-07-30 10:17:33 +00:00
This can be seen as transforming with respect to the local frame.
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="Transform3D" />
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="AABB" />
Enable sorting of operator methods in class documentation.
2021-11-28 08:48:57 +00:00
<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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="PackedVector3Array" />
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<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>
Add `operator*` to `Plane`
2022-07-30 22:32:03 +00:00
<operator name="operator *">
<return type="Plane" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="Plane" />
Add `operator*` to `Plane`
2022-07-30 22:32:03 +00:00
<description>
Transforms (multiplies) the [Plane] by the given [Transform3D] transformation 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="Transform3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="Transform3D" />
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="Vector3" />
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="float" />
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="int" />
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="right" type="Transform3D" />
Move the docs for constructors and operators out of methods section
2021-09-21 02:49:02 +00:00
<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>