godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added various docs, mostly mathematical basics

This commit is contained in:
Grosskopf 2017-10-22 22:43:35 +02:00
parent fc09e14366
commit 03e2508e45
7 changed files with 85 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/Curve2D.xml
View File

@ -32,6 +32,7 @@
<return type="void">
</return>
<description>
Removes all points from the curve.
</description>
</method>
<method name="get_bake_interval" qualifiers="const">
@ -191,8 +192,10 @@
</methods>
<members>
<member name="_data" type="Dictionary" setter="_set_data" getter="_get_data">
The points describing the curve. Value is a [Dictionary] with the keys [code]in[/code], [code]out[/code], and [code]pos[/code]. The key pos is the position of a vertex of the curve, the key in is the vector from that position to the control point before this vertex, the key out is the vector from that position to the controlpoint after this vertex.
</member>
<member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval">
The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.
</member>
</members>
<constants>

36
doc/classes/Node2D.xml
View File

@ -26,7 +26,7 @@
<argument index="0" name="pivot" type="Vector2">
</argument>
<description>
Set the pivot position of the 2D node to 'pivot' value. Only some Node2Ds implement this method.
Sets the node's pivot position.
</description>
</method>
<method name="get_angle_to" qualifiers="const">
@ -143,7 +143,7 @@
<argument index="1" name="scaled" type="bool" default="false">
</argument>
<description>
Apply a local translation on the node's X axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement.
Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is false, normalizes the movement.
</description>
</method>
<method name="move_local_y">
@ -154,7 +154,7 @@
<argument index="1" name="scaled" type="bool" default="false">
</argument>
<description>
Apply a local translation on the node's Y axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement.
Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is false, normalizes the movement.
</description>
</method>
<method name="rotate">
@ -163,7 +163,7 @@
<argument index="0" name="radians" type="float">
</argument>
<description>
Apply a rotation to the node, in radians, starting from its current rotation.
Applies a rotation to the node, in radians, starting from its current rotation.
</description>
</method>
<method name="set_global_position">
@ -172,7 +172,7 @@
<argument index="0" name="position" type="Vector2">
</argument>
<description>
Set the node's global position.
Sets the node's global position.
</description>
</method>
<method name="set_global_rotation">
@ -181,7 +181,7 @@
<argument index="0" name="radians" type="float">
</argument>
<description>
Set the node's global rotation in radians.
Sets the node's global rotation in radians.
</description>
</method>
<method name="set_global_rotation_in_degrees">
@ -190,7 +190,7 @@
<argument index="0" name="degrees" type="float">
</argument>
<description>
Set the node's global rotation in degrees.
Sets the node's global rotation in degrees.
</description>
</method>
<method name="set_global_scale">
@ -199,7 +199,7 @@
<argument index="0" name="scale" type="Vector2">
</argument>
<description>
Set the node's global scale.
Sets the node's global scale.
</description>
</method>
<method name="set_global_transform">
@ -208,7 +208,7 @@
<argument index="0" name="xform" type="Transform2D">
</argument>
<description>
Set the node's global [Transform2D].
Sets the node's global [Transform2D].
</description>
</method>
<method name="set_position">
@ -217,7 +217,7 @@
<argument index="0" name="position" type="Vector2">
</argument>
<description>
Set the node's position.
Sets the node's position.
</description>
</method>
<method name="set_rotation">
@ -226,7 +226,7 @@
<argument index="0" name="radians" type="float">
</argument>
<description>
Set the node's rotation in radians.
Sets the node's rotation in radians.
</description>
</method>
<method name="set_rotation_in_degrees">
@ -235,7 +235,7 @@
<argument index="0" name="degrees" type="float">
</argument>
<description>
Set the node's rotation in degrees.
Sets the node's rotation in degrees.
</description>
</method>
<method name="set_scale">
@ -244,7 +244,7 @@
<argument index="0" name="scale" type="Vector2">
</argument>
<description>
Set the node's scale.
Sets the node's scale.
</description>
</method>
<method name="set_transform">
@ -253,7 +253,7 @@
<argument index="0" name="xform" type="Transform2D">
</argument>
<description>
Set the node's local [Transform2D].
Sets the node's local [Transform2D].
</description>
</method>
<method name="set_z">
@ -262,7 +262,7 @@
<argument index="0" name="z" type="int">
</argument>
<description>
Set the node's Z-index.
Sets the node's Z-index.
</description>
</method>
<method name="set_z_as_relative">
@ -271,7 +271,7 @@
<argument index="0" name="enable" type="bool">
</argument>
<description>
Make the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5.
Makes the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5.
</description>
</method>
<method name="to_global" qualifiers="const">
@ -280,6 +280,7 @@
<argument index="0" name="local_point" type="Vector2">
</argument>
<description>
Converts a local point's coordinates to global coordinates.
</description>
</method>
<method name="to_local" qualifiers="const">
@ -288,6 +289,7 @@
<argument index="0" name="global_point" type="Vector2">
</argument>
<description>
Converts a global point's coordinates to local coordinates.
</description>
</method>
<method name="translate">
@ -296,7 +298,7 @@
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
Translate the node locally by the 'offset' vector, starting from its current local position.
Translates the node by the given [code]offset[/code] in local coordinates.
</description>
</method>
</methods>

5
doc/classes/Path2D.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Path2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Container for a [Curve2D].
Contains a [Curve2D] path for [PathFollow2D] nodes to follow.
</brief_description>
<description>
This class is a container/Node-ification of a [Curve2D], so it can have [Node2D] properties and [Node] info.
Can have [PathFollow2D] child-nodes moving along the [Curve2D]. See [PathFollow2D] for more information on this usage.
</description>
<tutorials>
</tutorials>
@ -30,6 +30,7 @@
</methods>
<members>
<member name="curve" type="Curve2D" setter="set_curve" getter="get_curve">
A [Curve2D] describing the path.
</member>
</members>
<constants>

15
doc/classes/Quat.xml
View File

@ -4,7 +4,10 @@
Quaternion.
</brief_description>
<description>
Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between two rotations. Multiplying quaternions also cheaply reproduces rotation sequences. However quaternions need to be often renormalized, or else they suffer from precision issues.
A 4-dimensional vector representing a rotation.
The vector represents a 4 dimensional complex number where multiplication of the basis elements is not commutative (multiplying i with j gives a different result than multiplying j with i).
Multiplying quaternions reproduces rotation sequences. However quaternions need to be often renormalized, or else they suffer from precision issues.
It can be used to perform SLERP (spherical-linear interpolation) between two rotations.
</description>
<tutorials>
</tutorials>
@ -23,6 +26,7 @@
<argument index="3" name="w" type="float">
</argument>
<description>
Returns a quaternion defined by these values.
</description>
</method>
<method name="Quat">
@ -57,6 +61,7 @@
<argument index="3" name="t" type="float">
</argument>
<description>
Performs a cubic spherical-linear interpolation with another quaternion.
</description>
</method>
<method name="dot">
@ -111,7 +116,7 @@
<argument index="1" name="t" type="float">
</argument>
<description>
Perform a spherical-linear interpolation with another quaternion.
Performs a spherical-linear interpolation with another quaternion.
</description>
</method>
<method name="slerpni">
@ -122,6 +127,7 @@
<argument index="1" name="t" type="float">
</argument>
<description>
Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°.
</description>
</method>
<method name="xform">
@ -130,17 +136,22 @@
<argument index="0" name="v" type="Vector3">
</argument>
<description>
Transforms the vector [code]v[/code] by this quaternion.
</description>
</method>
</methods>
<members>
<member name="w" type="float" setter="" getter="">
W component of the quaternion. Default value: [code]1[/code]
</member>
<member name="x" type="float" setter="" getter="">
X component of the quaternion. Default value: [code]0[/code]
</member>
<member name="y" type="float" setter="" getter="">
Y component of the quaternion. Default value: [code]0[/code]
</member>
<member name="z" type="float" setter="" getter="">
Z component of the quaternion. Default value: [code]0[/code]
</member>
</members>
<constants>

24
doc/classes/Rect2.xml
View File

@ -4,7 +4,7 @@
2D Axis-aligned bounding box.
</brief_description>
<description>
Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
</description>
<tutorials>
</tutorials>
@ -19,7 +19,7 @@
<argument index="1" name="size" type="Vector2">
</argument>
<description>
Construct a [code]Rect2[/code] by position and size.
Constructs a [code]Rect2[/code] by position and size.
</description>
</method>
<method name="Rect2">
@ -34,7 +34,7 @@
<argument index="3" name="height" type="float">
</argument>
<description>
Construct a [code]Rect2[/code] by x, y, width and height.
Constructs a [code]Rect2[/code] by x, y, width, and height.
</description>
</method>
<method name="clip">
@ -52,7 +52,7 @@
<argument index="0" name="b" type="Rect2">
</argument>
<description>
Returns true if this [code]Rect2[/code] completely encloses another one.
Returns [code]true[/code] if this [code]Rect2[/code] completely encloses another one.
</description>
</method>
<method name="expand">
@ -61,14 +61,14 @@
<argument index="0" name="to" type="Vector2">
</argument>
<description>
Return this [code]Rect2[/code] expanded to include a given point.
Returns this [code]Rect2[/code] expanded to include a given point.
</description>
</method>
<method name="get_area">
<return type="float">
</return>
<description>
Get the area of the [code]Rect2[/code].
Returns the area of the [code]Rect2[/code].
</description>
</method>
<method name="grow">
@ -77,7 +77,7 @@
<argument index="0" name="by" type="float">
</argument>
<description>
Return a copy of the [code]Rect2[/code] grown a given amount of units towards all the sides.
Returns a copy of the [code]Rect2[/code] grown a given amount of units towards all the sides.
</description>
</method>
<method name="grow_individual">
@ -92,6 +92,7 @@
<argument index="3" name=" bottom" type="float">
</argument>
<description>
Returns a copy of the [code]Rect2[/code] grown a given amount of units towards each direction individually.
</description>
</method>
<method name="grow_margin">
@ -102,13 +103,14 @@
<argument index="1" name="by" type="float">
</argument>
<description>
Returns a copy of the [code]Rect2[/code] grown a given amount of units towards the [Margin] direction.
</description>
</method>
<method name="has_no_area">
<return type="bool">
</return>
<description>
Return true if the [code]Rect2[/code] is flat or empty.
Returns [code]true[/code] if the [code]Rect2[/code] is flat or empty.
</description>
</method>
<method name="has_point">
@ -117,7 +119,7 @@
<argument index="0" name="point" type="Vector2">
</argument>
<description>
Return true if the [code]Rect2[/code] contains a point.
Returns [code]true[/code] if the [code]Rect2[/code] contains a point.
</description>
</method>
<method name="intersects">
@ -126,7 +128,7 @@
<argument index="0" name="b" type="Rect2">
</argument>
<description>
Return true if the [code]Rect2[/code] overlaps with another.
Returns [code]true[/code] if the [code]Rect2[/code] overlaps with another.
</description>
</method>
<method name="merge">
@ -135,7 +137,7 @@
<argument index="0" name="b" type="Rect2">
</argument>
<description>
Combine this [code]Rect2[/code] with another, a larger one is returned that contains both.
Returns a larger Rect2 that contains this Rect2 and [code]with[/code].
</description>
</method>
</methods>

43
doc/classes/Rect3.xml
View File

@ -4,7 +4,7 @@
Axis-Aligned Bounding Box.
</brief_description>
<description>
Rect3 provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests.
Rect3 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
</description>
<tutorials>
</tutorials>
@ -28,7 +28,7 @@
<argument index="0" name="with" type="Rect3">
</argument>
<description>
Return true if this [code]Rect3[/code] completely encloses another one.
Returns [code]true[/code] if this [code]Rect3[/code] completely encloses another one.
</description>
</method>
<method name="expand">
@ -37,14 +37,14 @@
<argument index="0" name="to_point" type="Vector3">
</argument>
<description>
Return this [code]Rect3[/code] expanded to include a given point.
Returns this [code]Rect3[/code] expanded to include a given point.
</description>
</method>
<method name="get_area">
<return type="float">
</return>
<description>
Get the area of the [code]Rect3[/code].
Gets the area of the [code]Rect3[/code].
</description>
</method>
<method name="get_endpoint">
@ -53,49 +53,49 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Get the position of the 8 endpoints of the [code]Rect3[/code] in space.
Gets the position of the 8 endpoints of the [code]Rect3[/code] in space.
</description>
</method>
<method name="get_longest_axis">
<return type="Vector3">
</return>
<description>
Return the normalized longest axis of the [code]Rect3[/code].
Returns the normalized longest axis of the [code]Rect3[/code].
</description>
</method>
<method name="get_longest_axis_index">
<return type="int">
</return>
<description>
Return the index of the longest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum).
Returns the index of the longest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum).
</description>
</method>
<method name="get_longest_axis_size">
<return type="float">
</return>
<description>
Return the scalar length of the longest axis of the [code]Rect3[/code].
Returns the scalar length of the longest axis of the [code]Rect3[/code].
</description>
</method>
<method name="get_shortest_axis">
<return type="Vector3">
</return>
<description>
Return the normalized shortest axis of the [code]Rect3[/code].
Returns the normalized shortest axis of the [code]Rect3[/code].
</description>
</method>
<method name="get_shortest_axis_index">
<return type="int">
</return>
<description>
Return the index of the shortest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum).
Returns the index of the shortest axis of the [code]Rect3[/code] (according to [Vector3]::AXIS* enum).
</description>
</method>
<method name="get_shortest_axis_size">
<return type="float">
</return>
<description>
Return the scalar length of the shortest axis of the [code]Rect3[/code].
Returns the scalar length of the shortest axis of the [code]Rect3[/code].
</description>
</method>
<method name="get_support">
@ -104,7 +104,7 @@
<argument index="0" name="dir" type="Vector3">
</argument>
<description>
Return the support point in a given direction. This is useful for collision detection algorithms.
Returns the support point in a given direction. This is useful for collision detection algorithms.
</description>
</method>
<method name="grow">
@ -113,21 +113,21 @@
<argument index="0" name="by" type="float">
</argument>
<description>
Return a copy of the [code]Rect3[/code] grown a given amount of units towards all the sides.
Returns a copy of the [code]Rect3[/code] grown a given amount of units towards all the sides.
</description>
</method>
<method name="has_no_area">
<return type="bool">
</return>
<description>
Return true if the [code]Rect3[/code] is flat or empty.
Returns [code]true[/code] if the [code]Rect3[/code] is flat or empty.
</description>
</method>
<method name="has_no_surface">
<return type="bool">
</return>
<description>
Return true if the [code]Rect3[/code] is empty.
Returns [code]true[/code] if the [code]Rect3[/code] is empty.
</description>
</method>
<method name="has_point">
@ -136,7 +136,7 @@
<argument index="0" name="point" type="Vector3">
</argument>
<description>
Return true if the [code]Rect3[/code] contains a point.
Returns [code]true[/code] if the [code]Rect3[/code] contains a point.
</description>
</method>
<method name="intersection">
@ -145,7 +145,7 @@
<argument index="0" name="with" type="Rect3">
</argument>
<description>
Return the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure.
Returns the intersection between two [code]Rect3[/code]. An empty Rect3 (size 0,0,0) is returned on failure.
</description>
</method>
<method name="intersects">
@ -154,7 +154,7 @@
<argument index="0" name="with" type="Rect3">
</argument>
<description>
Return true if the [code]Rect3[/code] overlaps with another.
Returns [code]true[/code] if the [code]Rect3[/code] overlaps with another.
</description>
</method>
<method name="intersects_plane">
@ -163,7 +163,7 @@
<argument index="0" name="plane" type="Plane">
</argument>
<description>
Return true if the [code]Rect3[/code] is at both sides of a plane.
Returns [code]true[/code] if the [code]Rect3[/code] is on both sides of a plane.
</description>
</method>
<method name="intersects_segment">
@ -174,7 +174,7 @@
<argument index="1" name="to" type="Vector3">
</argument>
<description>
Return true if the [code]Rect3[/code] intersects the line segment between from and to
Returns [code]true[/code] if the [code]Rect3[/code] intersects the line segment between [code]from[/code] and [code]to[/code].
</description>
</method>
<method name="merge">
@ -183,7 +183,7 @@
<argument index="0" name="with" type="Rect3">
</argument>
<description>
Combine this [code]Rect3[/code] with another, a larger one is returned that contains both.
Returns a larger Rect3 that contains this Rect3 and [code]with[/code].
</description>
</method>
</methods>
@ -192,6 +192,7 @@
Ending corner.
</member>
<member name="position" type="Vector3" setter="" getter="">
Beginning corner.
</member>
<member name="size" type="Vector3" setter="" getter="">
Size from position to end.

23
doc/classes/Vector3.xml
View File

@ -37,6 +37,7 @@
<argument index="0" name="to" type="Vector3">
</argument>
<description>
Returns the vector's minimum angle to the vector [code]to[/code].
</description>
</method>
<method name="bounce">
@ -61,7 +62,7 @@
<argument index="0" name="b" type="Vector3">
</argument>
<description>
Return the cross product with b.
Returns the cross product with [code]b[/code].
</description>
</method>
<method name="cubic_interpolate">
@ -76,7 +77,7 @@
<argument index="3" name="t" type="float">
</argument>
<description>
Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t).
Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount (t).
</description>
</method>
<method name="distance_squared_to">
@ -85,7 +86,7 @@
<argument index="0" name="b" type="Vector3">
</argument>
<description>
Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula.
Returns the squared distance to [code]b[/code]. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula.
</description>
</method>
<method name="distance_to">
@ -94,7 +95,7 @@
<argument index="0" name="b" type="Vector3">
</argument>
<description>
Return the distance to b.
Returns the distance to b.
</description>
</method>
<method name="dot">
@ -103,7 +104,7 @@
<argument index="0" name="b" type="Vector3">
</argument>
<description>
Return the dot product with b.
Returns the dot product with b.
</description>
</method>
<method name="floor">
@ -131,14 +132,14 @@
<return type="float">
</return>
<description>
Return the length of the vector.
Returns the length of the vector.
</description>
</method>
<method name="length_squared">
<return type="float">
</return>
<description>
Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula.
Returns the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula.
</description>
</method>
<method name="linear_interpolate">
@ -170,7 +171,7 @@
<return type="Vector3">
</return>
<description>
Return a copy of the normalized vector to unit length. This is the same as v / v.length().
Returns a copy of the normalized vector to unit length. This is the same as v / v.length().
</description>
</method>
<method name="outer">
@ -179,7 +180,7 @@
<argument index="0" name="b" type="Vector3">
</argument>
<description>
Return the outer product with b.
Returns the outer product with b.
</description>
</method>
<method name="reflect">
@ -217,14 +218,14 @@
<argument index="0" name="by" type="float">
</argument>
<description>
Return a copy of the vector, snapped to the lowest neared multiple.
Returns a copy of the vector, snapped to the lowest neared multiple.
</description>
</method>
<method name="to_diagonal_matrix">
<return type="Basis">
</return>
<description>
Return a diagonal matrix with the vector as main diagonal.
Returns a diagonal matrix with the vector as main diagonal.
</description>
</method>
</methods>