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

235 lines
9.0 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>
Add link titles for all links in the class reference This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-05 12:43:40 +00:00
<link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
<link title="Matrices and transforms">https://docs.godotengine.org/en/latest/tutorials/math/matrices_and_transforms.html</link>
<link title="Using 3D transforms">https://docs.godotengine.org/en/latest/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>
<methods>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<method name="Transform3D" qualifiers="constructor">
<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
</return>
<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>
</method>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<method name="Transform3D" qualifiers="constructor">
<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
</return>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<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
</argument>
<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>
</method>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<method name="Transform3D" qualifiers="constructor">
<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
</return>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<argument index="0" name="basis" type="Basis">
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
</argument>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<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
</argument>
<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>
</method>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<method name="Transform3D" qualifiers="constructor">
<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
</return>
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-09 16:46:03 +00:00
<argument index="0" name="x_axis" type="Vector3">
</argument>
<argument index="1" name="y_axis" type="Vector3">
</argument>
<argument index="2" name="z_axis" type="Vector3">
</argument>
<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
</argument>
<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>
</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="affine_inverse" qualifiers="const">
Update documentation for Transform3D
2020-05-03 08:27:36 +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
</return>
<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">
Update documentation for Transform3D
2020-05-03 08:27:36 +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
</return>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<argument index="0" name="xform" 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
</argument>
<argument index="1" name="weight" type="float">
</argument>
<description>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
Interpolates the transform to other Transform3D by weight amount (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">
Update documentation for Transform3D
2020-05-03 08:27:36 +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
</return>
<description>
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling).
</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: Sync classref with current source
2019-11-08 07:33:48 +00:00
<return type="bool">
</return>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<argument index="0" name="xform" type="Transform3D">
doc: Sync classref with current source
2019-11-08 07:33:48 +00:00
</argument>
<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">
Update documentation for Transform3D
2020-05-03 08:27:36 +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
</return>
<argument index="0" name="target" type="Vector3">
</argument>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<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
</argument>
<description>
[DOCS] Clarify look_at and looking_at
2018-04-29 13:44:07 +00:00
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.
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 to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<argument index="0" name="right" type="Transform3D">
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="PackedVector3Array">
</return>
<argument index="0" name="right" type="PackedVector3Array">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<return type="Transform3D">
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
</return>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<argument index="0" name="right" type="Transform3D">
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="AABB">
</return>
<argument index="0" name="right" type="AABB">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
Allow multiplying Transforms and Basis by numbers
2021-06-16 01:15:38 +00:00
<method name="operator *" qualifiers="operator">
<return type="Transform3D">
</return>
<argument index="0" name="right" type="float">
</argument>
<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">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
<argument index="0" name="right" type="Transform3D">
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
</argument>
<description>
</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">
Update documentation for Transform3D
2020-05-03 08:27:36 +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
</return>
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.
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">
Update documentation for Transform3D
2020-05-03 08:27:36 +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
</return>
<argument index="0" name="axis" type="Vector3">
</argument>
<argument index="1" name="phi" type="float">
</argument>
<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">
Update documentation for Transform3D
2020-05-03 08:27:36 +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
</return>
<argument index="0" name="scale" type="Vector3">
</argument>
<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">
Update documentation for Transform3D
2020-05-03 08:27:36 +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
</return>
Document that translated does not behave like rotated or scaled
2019-12-13 20:23:26 +00:00
<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
</argument>
<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>
</class>