diff options
| author | CowThing | 2016-05-15 19:01:21 -0400 |
|---|---|---|
| committer | Rémi Verschelde | 2016-06-04 22:20:02 +0200 |
| commit | c6e2c0f01dc9f1b9a55201da8e38dd30724fabc7 (patch) | |
| tree | ec6ba285e1035956f28e1807794a4b8a20082091 | |
| parent | 481c076febb774d86e39e656347d06feb7a5da1f (diff) | |
| download | godot-c6e2c0f01dc9f1b9a55201da8e38dd30724fabc7.tar.gz godot-c6e2c0f01dc9f1b9a55201da8e38dd30724fabc7.tar.zst godot-c6e2c0f01dc9f1b9a55201da8e38dd30724fabc7.zip | |
Filling in documentation.
AABB, Color, Rect2, Transform, Vector2, and Vector3.
(cherry picked from commit 0749db2cf8dfaacb70cb5817f60473fa811c0145)
| -rw-r--r-- | doc/base/classes.xml | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 7c52bc5e4..7bf4150f3 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -2072,6 +2072,7 @@ <argument index="1" name="to" type="Vector3"> </argument> <description> + Return true if the [AABB] intersects the line segment between from and to </description> </method> <method name="merge"> @@ -2097,10 +2098,13 @@ </methods> <members> <member name="pos" type="Vector3"> + Position (starting corner). </member> <member name="size" type="Vector3"> + Size from position to end. </member> <member name="end" type="Vector3"> + Ending corner. </member> </members> <constants> @@ -7961,26 +7965,37 @@ </methods> <members> <member name="r" type="float"> + Red (0 to 1) </member> <member name="g" type="float"> + Green (0 to 1) </member> <member name="b" type="float"> + Blue (0 to 1) </member> <member name="a" type="float"> + Alpha (0 to 1) </member> <member name="h" type="float"> + Hue (0 to 1) </member> <member name="s" type="float"> + Saturation (0 to 1) </member> <member name="v" type="float"> + Value (0 to 1) </member> <member name="r8" type="int"> + Red (0 to 255) </member> <member name="g8" type="int"> + Green (0 to 255) </member> <member name="b8" type="int"> + Blue (0 to 255) </member> <member name="a8" type="int"> + Alpha (0 to 255) </member> </members> <constants> @@ -28011,10 +28026,13 @@ This method controls whether the position between two cached points is interpola </methods> <members> <member name="pos" type="Vector2"> + Position (starting corner). </member> <member name="size" type="Vector2"> + Size from position to end. </member> <member name="end" type="Vector2"> + Ending corner. </member> </members> <constants> @@ -37702,6 +37720,7 @@ This method controls whether the position between two cached points is interpola <return type="Transform"> </return> <description> + Returns the inverse of the transfrom, even if the transform has scale or the axis vectors are not orthogonal. </description> </method> <method name="inverse"> @@ -37719,12 +37738,14 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="up" type="Vector3"> </argument> <description> + Rotate the transform around the up vector to face the target. </description> </method> <method name="orthonormalized"> <return type="Transform"> </return> <description> + Returns a transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. </description> </method> <method name="rotated"> @@ -37735,6 +37756,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="phi" type="float"> </argument> <description> + Rotate the transform locally. </description> </method> <method name="scaled"> @@ -37743,6 +37765,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="scale" type="Vector3"> </argument> <description> + Scale the transform locally. </description> </method> <method name="translated"> @@ -37751,6 +37774,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="ofs" type="Vector3"> </argument> <description> + Translate the transform locally. </description> </method> <method name="xform"> @@ -37783,6 +37807,7 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="origin" type="Vector3"> </argument> <description> + Construct the Transform from four Vector3. Each axis creates the basis. </description> </method> <method name="Transform"> @@ -37793,6 +37818,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="origin" type="Vector3"> </argument> <description> + Construct the Transform from a Matrix3 and Vector3. </description> </method> <method name="Transform"> @@ -37801,6 +37827,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="from" type="Matrix32"> </argument> <description> + Construct the Transform from a Matrix32. </description> </method> <method name="Transform"> @@ -37809,6 +37836,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="from" type="Quat"> </argument> <description> + Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0) </description> </method> <method name="Transform"> @@ -37817,13 +37845,16 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="from" type="Matrix3"> </argument> <description> + Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0) </description> </method> </methods> <members> <member name="basis" type="Matrix3"> + The basis contains 3 [Vector3]. X axis, Y axis, and Z axis. </member> <member name="origin" type="Vector3"> + The origin of the transform. Which is the translation offset. </member> </members> <constants> @@ -39525,12 +39556,16 @@ This method controls whether the position between two cached points is interpola </methods> <members> <member name="x" type="float"> + X component of the vector. </member> <member name="y" type="float"> + Y component of the vector. </member> <member name="width" type="float"> + Width of the vector (Same as X). </member> <member name="height" type="float"> + Height of the vector (Same as Y). </member> </members> <constants> @@ -39774,10 +39809,13 @@ This method controls whether the position between two cached points is interpola </methods> <members> <member name="x" type="float"> + X component of the vector. </member> <member name="y" type="float"> + Y component of the vector. </member> <member name="z" type="float"> + Z component of the vector. </member> </members> <constants> |
