.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/Basis.xml. .. _class_Basis: Basis ===== .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. note:: There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+----------------------------------+----------------------+ | :ref:`Vector3` | :ref:`x` | ``Vector3(1, 0, 0)`` | +-------------------------------+----------------------------------+----------------------+ | :ref:`Vector3` | :ref:`y` | ``Vector3(0, 1, 0)`` | +-------------------------------+----------------------------------+----------------------+ | :ref:`Vector3` | :ref:`z` | ``Vector3(0, 0, 1)`` | +-------------------------------+----------------------------------+----------------------+ .. rst-class:: classref-reftable-group Constructors ------------ .. table:: :widths: auto +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Basis` from **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Quaternion` from **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`determinant` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`from_euler` **(** :ref:`Vector3` euler, :ref:`int` order=2 **)** |static| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`from_scale` **(** :ref:`Vector3` scale **)** |static| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_euler` **(** :ref:`int` order=2 **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Quaternion` | :ref:`get_rotation_quaternion` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_scale` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`inverse` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_conformal` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Basis` b **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** |static| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`orthonormalized` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`slerp` **(** :ref:`Basis` to, :ref:`float` weight **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`transposed` **(** **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Operators --------- .. table:: :widths: auto +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`Basis` right **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`operator *` **(** :ref:`Basis` right **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3` right **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`operator *` **(** :ref:`float` right **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`operator *` **(** :ref:`int` right **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`operator /` **(** :ref:`float` right **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`operator /` **(** :ref:`int` right **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`Basis` right **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`operator []` **(** :ref:`int` index **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_Basis_constant_IDENTITY: .. rst-class:: classref-constant **IDENTITY** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_Basis_constant_FLIP_X: .. rst-class:: classref-constant **FLIP_X** = ``Basis(-1, 0, 0, 0, 1, 0, 0, 0, 1)`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_Basis_constant_FLIP_Y: .. rst-class:: classref-constant **FLIP_Y** = ``Basis(1, 0, 0, 0, -1, 0, 0, 0, 1)`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_Basis_constant_FLIP_Z: .. rst-class:: classref-constant **FLIP_Z** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, -1)`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Basis_property_x: .. rst-class:: classref-property :ref:`Vector3` **x** = ``Vector3(1, 0, 0)`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_property_y: .. rst-class:: classref-property :ref:`Vector3` **y** = ``Vector3(0, 1, 0)`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_property_z: .. rst-class:: classref-property :ref:`Vector3` **z** = ``Vector3(0, 0, 1)`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constructor Descriptions ------------------------ .. _class_Basis_constructor_Basis: .. rst-class:: classref-constructor :ref:`Basis` **Basis** **(** **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Basis` **Basis** **(** :ref:`Basis` from **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` angle **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Basis` **Basis** **(** :ref:`Quaternion` from **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Basis_method_determinant: .. rst-class:: classref-method :ref:`float` **determinant** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_from_euler: .. rst-class:: classref-method :ref:`Basis` **from_euler** **(** :ref:`Vector3` euler, :ref:`int` order=2 **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_from_scale: .. rst-class:: classref-method :ref:`Basis` **from_scale** **(** :ref:`Vector3` scale **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_get_euler: .. rst-class:: classref-method :ref:`Vector3` **get_euler** **(** :ref:`int` order=2 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_get_rotation_quaternion: .. rst-class:: classref-method :ref:`Quaternion` **get_rotation_quaternion** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_get_scale: .. rst-class:: classref-method :ref:`Vector3` **get_scale** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_inverse: .. rst-class:: classref-method :ref:`Basis` **inverse** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_is_conformal: .. rst-class:: classref-method :ref:`bool` **is_conformal** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_is_equal_approx: .. rst-class:: classref-method :ref:`bool` **is_equal_approx** **(** :ref:`Basis` b **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_is_finite: .. rst-class:: classref-method :ref:`bool` **is_finite** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_looking_at: .. rst-class:: classref-method :ref:`Basis` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_orthonormalized: .. rst-class:: classref-method :ref:`Basis` **orthonormalized** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_rotated: .. rst-class:: classref-method :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_scaled: .. rst-class:: classref-method :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_slerp: .. rst-class:: classref-method :ref:`Basis` **slerp** **(** :ref:`Basis` to, :ref:`float` weight **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_tdotx: .. rst-class:: classref-method :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_tdoty: .. rst-class:: classref-method :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_tdotz: .. rst-class:: classref-method :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_method_transposed: .. rst-class:: classref-method :ref:`Basis` **transposed** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Operator Descriptions --------------------- .. _class_Basis_operator_neq_Basis: .. rst-class:: classref-operator :ref:`bool` **operator !=** **(** :ref:`Basis` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_operator_mul_Basis: .. rst-class:: classref-operator :ref:`Basis` **operator *** **(** :ref:`Basis` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_operator_mul_Vector3: .. rst-class:: classref-operator :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_operator_mul_float: .. rst-class:: classref-operator :ref:`Basis` **operator *** **(** :ref:`float` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_operator_mul_int: .. rst-class:: classref-operator :ref:`Basis` **operator *** **(** :ref:`int` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_operator_div_float: .. rst-class:: classref-operator :ref:`Basis` **operator /** **(** :ref:`float` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_operator_div_int: .. rst-class:: classref-operator :ref:`Basis` **operator /** **(** :ref:`int` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_operator_eq_Basis: .. rst-class:: classref-operator :ref:`bool` **operator ==** **(** :ref:`Basis` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Basis_operator_idx_int: .. rst-class:: classref-operator :ref:`Vector3` **operator []** **(** :ref:`int` index **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`