2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 13:40:43 +01:00
<class name= "Vector3" category= "Built-In Types" version= "3.1" >
2017-09-12 22:42:36 +02:00
<brief_description >
Vector class, which performs basic 3D vector math operations.
</brief_description>
<description >
Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations.
</description>
<tutorials >
2018-11-05 08:46:27 +01:00
<link > https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "Vector3" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "x" type= "float" >
</argument>
<argument index= "1" name= "y" type= "float" >
</argument>
<argument index= "2" name= "z" type= "float" >
</argument>
<description >
Returns a Vector3 with the given components.
</description>
</method>
<method name= "abs" >
<return type= "Vector3" >
</return>
<description >
Returns a new vector with all components in absolute values (i.e. positive).
</description>
</method>
<method name= "angle_to" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector3" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the minimum angle to the given vector.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "bounce" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "n" type= "Vector3" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector "bounced off" from a plane defined by the given normal.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "ceil" >
<return type= "Vector3" >
</return>
<description >
Returns a new vector with all components rounded up.
</description>
</method>
<method name= "cross" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<description >
2017-10-22 22:43:35 +02:00
Returns the cross product with [code]b[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "cubic_interpolate" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<argument index= "1" name= "pre_a" type= "Vector3" >
</argument>
<argument index= "2" name= "post_b" type= "Vector3" >
</argument>
<argument index= "3" name= "t" type= "float" >
</argument>
<description >
2018-08-27 00:31:09 +02:00
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 [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation.
2017-09-12 22:42:36 +02:00
</description>
</method>
2019-03-27 11:51:05 +01:00
<method name= "direction_to" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<description >
Returns the normalized vector pointing from this vector to [code]b[/code].
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "distance_squared_to" >
<return type= "float" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the squared distance to [code]b[/code]. Prefer this function over [method distance_to] if you need to sort vectors or need the squared distance for some formula.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "distance_to" >
<return type= "float" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the distance to [code]b[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "dot" >
<return type= "float" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the dot product with [code]b[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "floor" >
<return type= "Vector3" >
</return>
<description >
Returns a new vector with all components rounded down.
</description>
</method>
<method name= "inverse" >
<return type= "Vector3" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the inverse of the vector. This is the same as [code]Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "is_normalized" >
<return type= "bool" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns [code]true[/code] if the vector is normalized.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "length" >
<return type= "float" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector's length.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "length_squared" >
<return type= "float" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector's length squared. Prefer this function over [method length] if you need to sort vectors or need the squared length for some formula.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "linear_interpolate" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<argument index= "1" name= "t" type= "float" >
</argument>
<description >
2018-08-27 00:31:09 +02:00
Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation..
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "max_axis" >
<return type= "int" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the axis of the vector's largest value. See [code]AXIS_*[/code] constants.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "min_axis" >
<return type= "int" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "normalized" >
<return type= "Vector3" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "outer" >
<return type= "Basis" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the outer product with [code]b[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-08-21 00:35:30 +02:00
<method name= "project" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<description >
Returns the vector projected onto the vector [code]b[/code].
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "reflect" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "n" type= "Vector3" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector reflected from a plane defined by the given normal.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "rotated" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "axis" type= "Vector3" >
</argument>
<argument index= "1" name= "phi" type= "float" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Rotates the vector around a given axis by [code]phi[/code] radians. The axis must be a normalized vector.
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-05-12 09:38:00 +02:00
<method name= "round" >
<return type= "Vector3" >
</return>
<description >
2018-06-27 00:02:24 +02:00
Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
2018-05-12 09:38:00 +02:00
</description>
</method>
2018-05-12 02:14:39 +02:00
<method name= "slerp" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "b" type= "Vector3" >
</argument>
<argument index= "1" name= "t" type= "float" >
</argument>
<description >
2018-08-27 00:31:09 +02:00
Returns the result of SLERP between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation.
2018-05-12 02:14:39 +02:00
Both vectors need to be normalized.
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "slide" >
<return type= "Vector3" >
</return>
<argument index= "0" name= "n" type= "Vector3" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the component of the vector along a plane defined by the given normal.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "snapped" >
<return type= "Vector3" >
</return>
2018-02-03 19:09:16 +01:00
<argument index= "0" name= "by" type= "Vector3" >
2017-09-12 22:42:36 +02:00
</argument>
<description >
2017-10-22 22:43:35 +02:00
Returns a copy of the vector, snapped to the lowest neared multiple.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "to_diagonal_matrix" >
<return type= "Basis" >
</return>
<description >
2017-10-22 22:43:35 +02:00
Returns a diagonal matrix with the vector as main diagonal.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "x" type= "float" setter= "" getter= "" >
2018-10-21 19:53:16 +02:00
The vector's x component. Also accessible by using the index position [code][0][/code].
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "y" type= "float" setter= "" getter= "" >
2018-10-21 19:53:16 +02:00
The vector's y component. Also accessible by using the index position [code][1][/code].
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "z" type= "float" setter= "" getter= "" >
2018-10-21 19:53:16 +02:00
The vector's z component. Also accessible by using the index position [code][2][/code].
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "AXIS_X" value= "0" >
2018-05-13 02:58:45 +02:00
Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis].
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "AXIS_Y" value= "1" >
2017-09-12 22:42:36 +02:00
Enumerated value for the Y axis.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "AXIS_Z" value= "2" >
2017-09-12 22:42:36 +02:00
Enumerated value for the Z axis.
</constant>
2018-08-21 00:35:30 +02:00
<constant name= "ZERO" value= "Vector3( 0, 0, 0 )" >
2018-10-06 20:13:41 +02:00
Zero vector.
</constant>
<constant name= "ONE" value= "Vector3( 1, 1, 1 )" >
One vector.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "INF" value= "Vector3( inf, inf, inf )" >
2018-08-27 00:31:09 +02:00
Infinite vector.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "LEFT" value= "Vector3( -1, 0, 0 )" >
2018-08-27 00:31:09 +02:00
Left unit vector.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "RIGHT" value= "Vector3( 1, 0, 0 )" >
2018-08-27 00:31:09 +02:00
Right unit vector.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "UP" value= "Vector3( 0, 1, 0 )" >
2018-08-27 00:31:09 +02:00
Up unit vector.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "DOWN" value= "Vector3( 0, -1, 0 )" >
2018-08-27 00:31:09 +02:00
Down unit vector.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "FORWARD" value= "Vector3( 0, 0, -1 )" >
2018-08-27 00:31:09 +02:00
Forward unit vector.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "BACK" value= "Vector3( 0, 0, 1 )" >
2018-08-27 00:31:09 +02:00
Back unit vector.
2018-08-21 00:35:30 +02:00
</constant>
2017-09-12 22:42:36 +02:00
</constants>
</class>