mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-23 12:26:59 +01:00
508 lines
16 KiB
XML
508 lines
16 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
||
<class name="Basis" version="4.2">
|
||
<brief_description>
|
||
3×3 matrix datatype.
|
||
</brief_description>
|
||
<description>
|
||
3×3 matrix used for 3D rotation and scale. Almost always used as an orthogonal basis for a Transform.
|
||
Contains 3 vector fields X, Y and Z as its columns, which are typically interpreted as the local basis vectors of a transformation. For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S).
|
||
Can also be accessed as array of 3D vectors. These vectors are normally orthogonal to each other, but are not necessarily normalized (due to scaling).
|
||
For more information, read the "Matrices and transforms" documentation article.
|
||
</description>
|
||
<tutorials>
|
||
<link title="Math tutorial index">$DOCS_URL/tutorials/math/index.md</link>
|
||
<link title="Matrices and transforms">$DOCS_URL/tutorials/math/matrices_and_transforms.md</link>
|
||
<link title="Using 3D transforms">$DOCS_URL/tutorials/3d/using_transforms.md</link>
|
||
<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="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
|
||
<link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link>
|
||
</tutorials>
|
||
<methods>
|
||
<method name="Basis">
|
||
<return type="Basis" />
|
||
<argument index="0" name="from" type="Quaternion" />
|
||
<description>
|
||
Constructs a pure rotation basis matrix from the given quaternion.
|
||
</description>
|
||
</method>
|
||
<method name="Basis">
|
||
<return type="Basis" />
|
||
<argument index="0" name="from" type="Vector3" />
|
||
<description>
|
||
Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle).
|
||
Consider using the [Quaternion] constructor instead, which uses a quaternion instead of Euler angles.
|
||
</description>
|
||
</method>
|
||
<method name="Basis">
|
||
<return type="Basis" />
|
||
<argument index="0" name="axis" type="Vector3" />
|
||
<argument index="1" name="phi" type="float" />
|
||
<description>
|
||
Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector.
|
||
</description>
|
||
</method>
|
||
<method name="Basis">
|
||
<return type="Basis" />
|
||
<argument index="0" name="x_axis" type="Vector3" />
|
||
<argument index="1" name="y_axis" type="Vector3" />
|
||
<argument index="2" name="z_axis" type="Vector3" />
|
||
<description>
|
||
Constructs a basis matrix from 3 axis vectors (matrix columns).
|
||
</description>
|
||
</method>
|
||
<method name="determinant">
|
||
<return type="float" />
|
||
<description>
|
||
Returns the determinant of the basis matrix. If the basis is uniformly scaled, its determinant is the square of the scale.
|
||
A negative determinant means the basis has a negative scale. A zero determinant means the basis isn't invertible, and is usually considered invalid.
|
||
</description>
|
||
</method>
|
||
<method name="diagonalize">
|
||
<return type="Basis" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="from_z">
|
||
<argument index="0" name="z" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_axis">
|
||
<return type="Vector3" />
|
||
<argument index="0" name="i" type="int" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_column">
|
||
<return type="Vector3" />
|
||
<argument index="0" name="i" type="int" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_euler">
|
||
<return type="Vector3" />
|
||
<description>
|
||
Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle).
|
||
Consider using the [method get_rotation_quaternion] method instead, which returns a [Quaternion] quaternion instead of Euler angles.
|
||
</description>
|
||
</method>
|
||
<method name="get_euler_xyz">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_euler_xzy">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_euler_yxz">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_euler_zxy">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_euler_zyx">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_main_diagonal">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_orthogonal_index">
|
||
<return type="int" />
|
||
<description>
|
||
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the [GridMap] editor. For further details, refer to the Godot source code.
|
||
</description>
|
||
</method>
|
||
<method name="get_quaternion">
|
||
<return type="Quaternion" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_rotation">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_rotation_euler">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_rotation_quaternion">
|
||
<return type="Quaternion" />
|
||
<description>
|
||
Returns the basis's rotation in the form of a quaternion. See [method get_euler] if you need Euler angles, but keep in mind quaternions should generally be preferred to Euler angles.
|
||
</description>
|
||
</method>
|
||
<method name="get_row">
|
||
<return type="Vector3" />
|
||
<argument index="0" name="i" type="int" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_scale">
|
||
<return type="Vector3" />
|
||
<description>
|
||
Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis.
|
||
</description>
|
||
</method>
|
||
<method name="get_scale_abs">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_scale_local">
|
||
<return type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="get_uniform_scale">
|
||
<return type="float" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="inverse">
|
||
<return type="Basis" />
|
||
<description>
|
||
Returns the inverse of the matrix.
|
||
</description>
|
||
</method>
|
||
<method name="invert">
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="is_diagonal">
|
||
<return type="bool" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="is_equal_approx">
|
||
<return type="bool" />
|
||
<argument index="0" name="b" type="Basis" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="is_equal_approx_ratio">
|
||
<return type="bool" />
|
||
<argument index="0" name="b" type="Basis" />
|
||
<argument index="1" name="epsilon" type="float" default="1e-05" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="is_orthogonal">
|
||
<return type="bool" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="is_rotation">
|
||
<return type="bool" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="is_symmetric">
|
||
<return type="bool" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="lerp">
|
||
<return type="Basis" />
|
||
<argument index="0" name="to" type="Basis" />
|
||
<argument index="1" name="weight" type="float" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="make_scale_uniform">
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="orthogonalize">
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="orthogonalized">
|
||
<return type="Basis" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="orthonormalize">
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="orthonormalized">
|
||
<return type="Basis" />
|
||
<description>
|
||
Returns the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix.
|
||
</description>
|
||
</method>
|
||
<method name="rotate">
|
||
<argument index="0" name="axis" type="Vector3" />
|
||
<argument index="1" name="phi" type="float" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="rotate_local">
|
||
<return type="Basis" />
|
||
<argument index="0" name="axis" type="Vector3" />
|
||
<argument index="1" name="phi" type="float" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="rotate_to_align">
|
||
<argument index="0" name="direction" type="Vector3" />
|
||
<argument index="1" name="end_direction" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="rotated">
|
||
<return type="Basis" />
|
||
<argument index="0" name="axis" type="Vector3" />
|
||
<argument index="1" name="phi" type="float" />
|
||
<description>
|
||
Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector.
|
||
</description>
|
||
</method>
|
||
<method name="rotatedq">
|
||
<return type="Basis" />
|
||
<argument index="0" name="quat" type="Quaternion" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="rotatedv">
|
||
<return type="Basis" />
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="rotateq">
|
||
<argument index="0" name="quat" type="Quaternion" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="rotatev">
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="scale">
|
||
<argument index="0" name="scale" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="scale_local">
|
||
<argument index="0" name="scale" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="scale_orthogonal">
|
||
<argument index="0" name="scale" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="scaled">
|
||
<return type="Basis" />
|
||
<argument index="0" name="scale" type="Vector3" />
|
||
<description>
|
||
Introduce an additional scaling specified by the given 3D scaling factor.
|
||
</description>
|
||
</method>
|
||
<method name="scaled_local">
|
||
<return type="Basis" />
|
||
<argument index="0" name="scale" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="scaled_orthogonal">
|
||
<return type="Basis" />
|
||
<argument index="0" name="scale" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_axis">
|
||
<argument index="0" name="i" type="int" />
|
||
<argument index="1" name="axis" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_axis_angle_scale">
|
||
<argument index="0" name="axis" type="Vector3" />
|
||
<argument index="1" name="phi" type="float" />
|
||
<argument index="2" name="scale" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_column">
|
||
<argument index="0" name="index" type="int" />
|
||
<argument index="1" name="value" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_columns">
|
||
<argument index="0" name="x" type="Vector3" />
|
||
<argument index="1" name="y" type="Vector3" />
|
||
<argument index="2" name="z" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_diagonal">
|
||
<argument index="0" name="diag" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_euler">
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_euler_scale">
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<argument index="1" name="scale" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_euler_xyz">
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_euler_xzy">
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_euler_yxz">
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_euler_zxy">
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_euler_zyx">
|
||
<argument index="0" name="euler" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_orthogonal_index">
|
||
<argument index="0" name="index" type="int" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_quaternion">
|
||
<argument index="0" name="quaternion" type="Quaternion" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_quaternion_scale">
|
||
<argument index="0" name="quat" type="Quaternion" />
|
||
<argument index="1" name="scale" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_row">
|
||
<argument index="0" name="i" type="int" />
|
||
<argument index="1" name="axis" type="Vector3" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_zero">
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="slerp">
|
||
<return type="Basis" />
|
||
<argument index="0" name="to" type="Basis" />
|
||
<argument index="1" name="weight" type="float" />
|
||
<description>
|
||
Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix.
|
||
</description>
|
||
</method>
|
||
<method name="tdotx">
|
||
<return type="float" />
|
||
<argument index="0" name="with" type="Vector3" />
|
||
<description>
|
||
Transposed dot product with the X axis of the matrix.
|
||
</description>
|
||
</method>
|
||
<method name="tdoty">
|
||
<return type="float" />
|
||
<argument index="0" name="with" type="Vector3" />
|
||
<description>
|
||
Transposed dot product with the Y axis of the matrix.
|
||
</description>
|
||
</method>
|
||
<method name="tdotz">
|
||
<return type="float" />
|
||
<argument index="0" name="with" type="Vector3" />
|
||
<description>
|
||
Transposed dot product with the Z axis of the matrix.
|
||
</description>
|
||
</method>
|
||
<method name="transpose">
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="transpose_xform">
|
||
<return type="Basis" />
|
||
<argument index="0" name="m" type="Basis" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="transposed">
|
||
<return type="Basis" />
|
||
<description>
|
||
Returns the transposed version of the matrix.
|
||
</description>
|
||
</method>
|
||
<method name="xform">
|
||
<return type="Vector3" />
|
||
<argument index="0" name="v3_or_v3i" type="Variant" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="xform_inv">
|
||
<return type="Vector3" />
|
||
<argument index="0" name="v3_or_v3i" type="Variant" />
|
||
<description>
|
||
</description>
|
||
</method>
|
||
</methods>
|
||
<members>
|
||
<member name="x" type="Vector3" setter="" getter="" default="Vector3( 1, 0, 0 )">
|
||
The basis matrix's X vector (column 0). Equivalent to array index [code]0[/code].
|
||
</member>
|
||
<member name="y" type="Vector3" setter="" getter="" default="Vector3( 0, 1, 0 )">
|
||
The basis matrix's Y vector (column 1). Equivalent to array index [code]1[/code].
|
||
</member>
|
||
<member name="z" type="Vector3" setter="" getter="" default="Vector3( 0, 0, 1 )">
|
||
The basis matrix's Z vector (column 2). Equivalent to array index [code]2[/code].
|
||
</member>
|
||
</members>
|
||
<constants>
|
||
<constant name="IDENTITY" value="Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )">
|
||
The identity basis, with no rotation or scaling applied.
|
||
This is identical to calling [code]Basis()[/code] without any parameters. This constant can be used to make your code clearer, and for consistency with C#.
|
||
</constant>
|
||
<constant name="FLIP_X" value="Basis( -1, 0, 0, 0, 1, 0, 0, 0, 1 )">
|
||
The basis that will flip something along the X axis when used in a transformation.
|
||
</constant>
|
||
<constant name="FLIP_Y" value="Basis( 1, 0, 0, 0, -1, 0, 0, 0, 1 )">
|
||
The basis that will flip something along the Y axis when used in a transformation.
|
||
</constant>
|
||
<constant name="FLIP_Z" value="Basis( 1, 0, 0, 0, 1, 0, 0, 0, -1 )">
|
||
The basis that will flip something along the Z axis when used in a transformation.
|
||
</constant>
|
||
</constants>
|
||
</class>
|