virtualx-engine/doc/classes/Vector3.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Vector3" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Vector used for 3D math using floating point coordinates.
	</brief_description>
	<description>
		3-element structure that can be used to represent positions in 3D space or any other triplet of numeric values.
		It uses floating-point coordinates. See [Vector3i] for its integer counterpart.
		[b]Note:[/b] In a boolean context, a Vector3 will evaluate to [code]false[/code] if it's equal to [code]Vector3(0, 0, 0)[/code]. Otherwise, a Vector3 will always evaluate to [code]true[/code].
	</description>
	<tutorials>
		<link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link>
		<link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link>
		<link title="Advanced vector math">$DOCS_URL/tutorials/math/vectors_advanced.html</link>
		<link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link>
		<link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link>
		<link title="All 3D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/3d</link>
	</tutorials>
	<constructors>
		<constructor name="Vector3">
			<return type="Vector3" />
			<description>
				Constructs a default-initialized [Vector3] with all components set to [code]0[/code].
			</description>
		</constructor>
		<constructor name="Vector3">
			<return type="Vector3" />
			<param index="0" name="from" type="Vector3" />
			<description>
				Constructs a [Vector3] as a copy of the given [Vector3].
			</description>
		</constructor>
		<constructor name="Vector3">
			<return type="Vector3" />
			<param index="0" name="from" type="Vector3i" />
			<description>
				Constructs a new [Vector3] from [Vector3i].
			</description>
		</constructor>
		<constructor name="Vector3">
			<return type="Vector3" />
			<param index="0" name="x" type="float" />
			<param index="1" name="y" type="float" />
			<param index="2" name="z" type="float" />
			<description>
				Returns a [Vector3] with the given components.
			</description>
		</constructor>
	</constructors>
	<methods>
		<method name="abs" qualifiers="const">
			<return type="Vector3" />
			<description>
				Returns a new vector with all components in absolute values (i.e. positive).
			</description>
		</method>
		<method name="angle_to" qualifiers="const">
			<return type="float" />
			<param index="0" name="to" type="Vector3" />
			<description>
				Returns the unsigned minimum angle to the given vector, in radians.
			</description>
		</method>
		<method name="bezier_interpolate" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="control_1" type="Vector3" />
			<param index="1" name="control_2" type="Vector3" />
			<param index="2" name="end" type="Vector3" />
			<param index="3" name="t" type="float" />
			<description>
				Returns the point at the given [param t] on the [url=https://en.wikipedia.org/wiki/B%C3%A9zier_curve]Bezier curve[/url] defined by this vector and the given [param control_1], [param control_2], and [param end] points.
			</description>
		</method>
		<method name="bounce" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="n" type="Vector3" />
			<description>
				Returns the vector "bounced off" from a plane defined by the given normal.
			</description>
		</method>
		<method name="ceil" qualifiers="const">
			<return type="Vector3" />
			<description>
				Returns a new vector with all components rounded up (towards positive infinity).
			</description>
		</method>
		<method name="clamp" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="min" type="Vector3" />
			<param index="1" name="max" type="Vector3" />
			<description>
				Returns a new vector with all components clamped between the components of [param min] and [param max], by running [method @GlobalScope.clamp] on each component.
			</description>
		</method>
		<method name="cross" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="with" type="Vector3" />
			<description>
				Returns the cross product of this vector and [param with].
			</description>
		</method>
		<method name="cubic_interpolate" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="b" type="Vector3" />
			<param index="1" name="pre_a" type="Vector3" />
			<param index="2" name="post_b" type="Vector3" />
			<param index="3" name="weight" type="float" />
			<description>
				Performs a cubic interpolation between this vector and [param b] using [param pre_a] and [param post_b] as handles, and returns the result at position [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation.
			</description>
		</method>
		<method name="cubic_interpolate_in_time" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="b" type="Vector3" />
			<param index="1" name="pre_a" type="Vector3" />
			<param index="2" name="post_b" type="Vector3" />
			<param index="3" name="weight" type="float" />
			<param index="4" name="b_t" type="float" />
			<param index="5" name="pre_a_t" type="float" />
			<param index="6" name="post_b_t" type="float" />
			<description>
				Performs a cubic interpolation between this vector and [param b] using [param pre_a] and [param post_b] as handles, and returns the result at position [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation.
				It can perform smoother interpolation than [code]cubic_interpolate()[/code] by the time values.
			</description>
		</method>
		<method name="direction_to" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="to" type="Vector3" />
			<description>
				Returns the normalized vector pointing from this vector to [param to]. This is equivalent to using [code](b - a).normalized()[/code].
			</description>
		</method>
		<method name="distance_squared_to" qualifiers="const">
			<return type="float" />
			<param index="0" name="to" type="Vector3" />
			<description>
				Returns the squared distance between this vector and [param to].
				This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula.
			</description>
		</method>
		<method name="distance_to" qualifiers="const">
			<return type="float" />
			<param index="0" name="to" type="Vector3" />
			<description>
				Returns the distance between this vector and [param to].
			</description>
		</method>
		<method name="dot" qualifiers="const">
			<return type="float" />
			<param index="0" name="with" type="Vector3" />
			<description>
				Returns the dot product of this vector and [param with]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player.
				The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees.
				When using unit (normalized) vectors, the result will always be between [code]-1.0[/code] (180 degree angle) when the vectors are facing opposite directions, and [code]1.0[/code] (0 degree angle) when the vectors are aligned.
				[b]Note:[/b] [code]a.dot(b)[/code] is equivalent to [code]b.dot(a)[/code].
			</description>
		</method>
		<method name="floor" qualifiers="const">
			<return type="Vector3" />
			<description>
				Returns a new vector with all components rounded down (towards negative infinity).
			</description>
		</method>
		<method name="inverse" qualifiers="const">
			<return type="Vector3" />
			<description>
				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].
			</description>
		</method>
		<method name="is_equal_approx" qualifiers="const">
			<return type="bool" />
			<param index="0" name="to" type="Vector3" />
			<description>
				Returns [code]true[/code] if this vector and [param to] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
			</description>
		</method>
		<method name="is_finite" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if this vector is finite, by calling [method @GlobalScope.is_finite] on each component.
			</description>
		</method>
		<method name="is_normalized" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if the vector is [method normalized], [code]false[/code] otherwise.
			</description>
		</method>
		<method name="is_zero_approx" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if this vector's values are approximately zero, by running [method @GlobalScope.is_zero_approx] on each component.
				This method is faster than using [method is_equal_approx] with one value as a zero vector.
			</description>
		</method>
		<method name="length" qualifiers="const">
			<return type="float" />
			<description>
				Returns the length (magnitude) of this vector.
			</description>
		</method>
		<method name="length_squared" qualifiers="const">
			<return type="float" />
			<description>
				Returns the squared length (squared magnitude) of this vector.
				This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula.
			</description>
		</method>
		<method name="lerp" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="to" type="Vector3" />
			<param index="1" name="weight" type="float" />
			<description>
				Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation.
			</description>
		</method>
		<method name="limit_length" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="length" type="float" default="1.0" />
			<description>
				Returns the vector with a maximum length by limiting its length to [param length].
			</description>
		</method>
		<method name="max_axis_index" qualifiers="const">
			<return type="int" />
			<description>
				Returns the axis of the vector's highest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_X].
			</description>
		</method>
		<method name="min_axis_index" qualifiers="const">
			<return type="int" />
			<description>
				Returns the axis of the vector's lowest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_Z].
			</description>
		</method>
		<method name="move_toward" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="to" type="Vector3" />
			<param index="1" name="delta" type="float" />
			<description>
				Returns a new vector moved toward [param to] by the fixed [param delta] amount. Will not go past the final value.
			</description>
		</method>
		<method name="normalized" qualifiers="const">
			<return type="Vector3" />
			<description>
				Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized].
			</description>
		</method>
		<method name="octahedron_decode" qualifiers="static">
			<return type="Vector3" />
			<param index="0" name="uv" type="Vector2" />
			<description>
				Returns the [Vector3] from an octahedral-compressed form created using [method octahedron_encode] (stored as a [Vector2]).
			</description>
		</method>
		<method name="octahedron_encode" qualifiers="const">
			<return type="Vector2" />
			<description>
				Returns the octahedral-encoded (oct32) form of this [Vector3] as a [Vector2]. Since a [Vector2] occupies 1/3 less memory compared to [Vector3], this form of compression can be used to pass greater amounts of [method normalized] [Vector3]s without increasing storage or memory requirements. See also [method octahedron_decode].
				[b]Note:[/b] [method octahedron_encode] can only be used for [method normalized] vectors. [method octahedron_encode] does [i]not[/i] check whether this [Vector3] is normalized, and will return a value that does not decompress to the original value if the [Vector3] is not normalized.
				[b]Note:[/b] Octahedral compression is [i]lossy[/i], although visual differences are rarely perceptible in real world scenarios.
			</description>
		</method>
		<method name="outer" qualifiers="const">
			<return type="Basis" />
			<param index="0" name="with" type="Vector3" />
			<description>
				Returns the outer product with [param with].
			</description>
		</method>
		<method name="posmod" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="mod" type="float" />
			<description>
				Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param mod].
			</description>
		</method>
		<method name="posmodv" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="modv" type="Vector3" />
			<description>
				Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param modv]'s components.
			</description>
		</method>
		<method name="project" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="b" type="Vector3" />
			<description>
				Returns this vector projected onto the vector [param b].
			</description>
		</method>
		<method name="reflect" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="n" type="Vector3" />
			<description>
				Returns this vector reflected from a plane defined by the given normal.
			</description>
		</method>
		<method name="rotated" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="axis" type="Vector3" />
			<param index="1" name="angle" type="float" />
			<description>
				Rotates this vector around a given axis by [param angle] (in radians). The axis must be a normalized vector.
			</description>
		</method>
		<method name="round" qualifiers="const">
			<return type="Vector3" />
			<description>
				Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
			</description>
		</method>
		<method name="sign" qualifiers="const">
			<return type="Vector3" />
			<description>
				Returns a new vector with each component set to one or negative one, depending on the signs of the components, or zero if the component is zero, by calling [method @GlobalScope.sign] on each component.
			</description>
		</method>
		<method name="signed_angle_to" qualifiers="const">
			<return type="float" />
			<param index="0" name="to" type="Vector3" />
			<param index="1" name="axis" type="Vector3" />
			<description>
				Returns the signed angle to the given vector, in radians. The sign of the angle is positive in a counter-clockwise direction and negative in a clockwise direction when viewed from the side specified by the [param axis].
			</description>
		</method>
		<method name="slerp" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="to" type="Vector3" />
			<param index="1" name="weight" type="float" />
			<description>
				Returns the result of spherical linear interpolation between this vector and [param to], by amount [param weight]. [param weight] is on the range of 0.0 to 1.0, representing the amount of interpolation.
				This method also handles interpolating the lengths if the input vectors have different lengths. For the special case of one or both input vectors having zero length, this method behaves like [method lerp].
			</description>
		</method>
		<method name="slide" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="n" type="Vector3" />
			<description>
				Returns this vector slid along a plane defined by the given normal.
			</description>
		</method>
		<method name="snapped" qualifiers="const">
			<return type="Vector3" />
			<param index="0" name="step" type="Vector3" />
			<description>
				Returns this vector with each component snapped to the nearest multiple of [param step]. This can also be used to round to an arbitrary number of decimals.
			</description>
		</method>
	</methods>
	<members>
		<member name="x" type="float" setter="" getter="" default="0.0">
			The vector's X component. Also accessible by using the index position [code][0][/code].
		</member>
		<member name="y" type="float" setter="" getter="" default="0.0">
			The vector's Y component. Also accessible by using the index position [code][1][/code].
		</member>
		<member name="z" type="float" setter="" getter="" default="0.0">
			The vector's Z component. Also accessible by using the index position [code][2][/code].
		</member>
	</members>
	<constants>
		<constant name="AXIS_X" value="0">
			Enumerated value for the X axis. Returned by [method max_axis_index] and [method min_axis_index].
		</constant>
		<constant name="AXIS_Y" value="1">
			Enumerated value for the Y axis. Returned by [method max_axis_index] and [method min_axis_index].
		</constant>
		<constant name="AXIS_Z" value="2">
			Enumerated value for the Z axis. Returned by [method max_axis_index] and [method min_axis_index].
		</constant>
		<constant name="ZERO" value="Vector3(0, 0, 0)">
			Zero vector, a vector with all components set to [code]0[/code].
		</constant>
		<constant name="ONE" value="Vector3(1, 1, 1)">
			One vector, a vector with all components set to [code]1[/code].
		</constant>
		<constant name="INF" value="Vector3(inf, inf, inf)">
			Infinity vector, a vector with all components set to [constant @GDScript.INF].
		</constant>
		<constant name="LEFT" value="Vector3(-1, 0, 0)">
			Left unit vector. Represents the local direction of left, and the global direction of west.
		</constant>
		<constant name="RIGHT" value="Vector3(1, 0, 0)">
			Right unit vector. Represents the local direction of right, and the global direction of east.
		</constant>
		<constant name="UP" value="Vector3(0, 1, 0)">
			Up unit vector.
		</constant>
		<constant name="DOWN" value="Vector3(0, -1, 0)">
			Down unit vector.
		</constant>
		<constant name="FORWARD" value="Vector3(0, 0, -1)">
			Forward unit vector. Represents the local direction of forward, and the global direction of north.
		</constant>
		<constant name="BACK" value="Vector3(0, 0, 1)">
			Back unit vector. Represents the local direction of back, and the global direction of south.
		</constant>
	</constants>
	<operators>
		<operator name="operator !=">
			<return type="bool" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Returns [code]true[/code] if the vectors are not equal.
				[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
			</description>
		</operator>
		<operator name="operator *">
			<return type="Vector3" />
			<param index="0" name="right" type="Basis" />
			<description>
				Inversely transforms (multiplies) the [Vector3] by the given [Basis] matrix.
			</description>
		</operator>
		<operator name="operator *">
			<return type="Vector3" />
			<param index="0" name="right" type="Quaternion" />
			<description>
				Inversely transforms (multiplies) the [Vector3] by the given [Quaternion].
			</description>
		</operator>
		<operator name="operator *">
			<return type="Vector3" />
			<param index="0" name="right" type="Transform3D" />
			<description>
				Inversely transforms (multiplies) the [Vector3] by the given [Transform3D] transformation matrix.
			</description>
		</operator>
		<operator name="operator *">
			<return type="Vector3" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Multiplies each component of the [Vector3] by the components of the given [Vector3].
				[codeblock]
				print(Vector3(10, 20, 30) * Vector3(3, 4, 5)) # Prints "(30, 80, 150)"
				[/codeblock]
			</description>
		</operator>
		<operator name="operator *">
			<return type="Vector3" />
			<param index="0" name="right" type="float" />
			<description>
				Multiplies each component of the [Vector3] by the given [float].
			</description>
		</operator>
		<operator name="operator *">
			<return type="Vector3" />
			<param index="0" name="right" type="int" />
			<description>
				Multiplies each component of the [Vector3] by the given [int].
			</description>
		</operator>
		<operator name="operator +">
			<return type="Vector3" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Adds each component of the [Vector3] by the components of the given [Vector3].
				[codeblock]
				print(Vector3(10, 20, 30) + Vector3(3, 4, 5)) # Prints "(13, 24, 35)"
				[/codeblock]
			</description>
		</operator>
		<operator name="operator -">
			<return type="Vector3" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Subtracts each component of the [Vector3] by the components of the given [Vector3].
				[codeblock]
				print(Vector3(10, 20, 30) - Vector3(3, 4, 5)) # Prints "(7, 16, 25)"
				[/codeblock]
			</description>
		</operator>
		<operator name="operator /">
			<return type="Vector3" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Divides each component of the [Vector3] by the components of the given [Vector3].
				[codeblock]
				print(Vector3(10, 20, 30) / Vector3(2, 5, 3)) # Prints "(5, 4, 10)"
				[/codeblock]
			</description>
		</operator>
		<operator name="operator /">
			<return type="Vector3" />
			<param index="0" name="right" type="float" />
			<description>
				Divides each component of the [Vector3] by the given [float].
			</description>
		</operator>
		<operator name="operator /">
			<return type="Vector3" />
			<param index="0" name="right" type="int" />
			<description>
				Divides each component of the [Vector3] by the given [int].
			</description>
		</operator>
		<operator name="operator &lt;">
			<return type="bool" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Compares two [Vector3] vectors by first checking if the X value of the left vector is less than the X value of the [param right] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors.
			</description>
		</operator>
		<operator name="operator &lt;=">
			<return type="bool" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Compares two [Vector3] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [param right] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors.
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Returns [code]true[/code] if the vectors are exactly equal.
				[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
			</description>
		</operator>
		<operator name="operator &gt;">
			<return type="bool" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Compares two [Vector3] vectors by first checking if the X value of the left vector is greater than the X value of the [param right] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors.
			</description>
		</operator>
		<operator name="operator &gt;=">
			<return type="bool" />
			<param index="0" name="right" type="Vector3" />
			<description>
				Compares two [Vector3] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [param right] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors.
			</description>
		</operator>
		<operator name="operator []">
			<return type="float" />
			<param index="0" name="index" type="int" />
			<description>
				Access vector components using their [param index]. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code].
			</description>
		</operator>
		<operator name="operator unary+">
			<return type="Vector3" />
			<description>
				Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable.
			</description>
		</operator>
		<operator name="operator unary-">
			<return type="Vector3" />
			<description>
				Returns the negative value of the [Vector3]. This is the same as writing [code]Vector3(-v.x, -v.y, -v.z)[/code]. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative.
			</description>
		</operator>
	</operators>
</class>