diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index a115ebeb22d..784797790ea 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -130,247 +130,257 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`abs`\ (\ x\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`absf`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`absi`\ (\ x\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`acos`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`acosh`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_difference`\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`asin`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`asinh`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`atan`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`atan2`\ (\ y\: :ref:`float`, x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`atanh`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`bezier_derivative`\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`bezier_interpolate`\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`bytes_to_var`\ (\ bytes\: :ref:`PackedByteArray`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`bytes_to_var_with_objects`\ (\ bytes\: :ref:`PackedByteArray`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`ceil`\ (\ x\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`ceilf`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`ceili`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`clamp`\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`clampf`\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`clampi`\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cos`\ (\ angle_rad\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cosh`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cubic_interpolate`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cubic_interpolate_angle`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cubic_interpolate_angle_in_time`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cubic_interpolate_in_time`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`db_to_linear`\ (\ db\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`deg_to_rad`\ (\ deg\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`ease`\ (\ x\: :ref:`float`, curve\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`error_string`\ (\ error\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`exp`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`floor`\ (\ x\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`floorf`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`floori`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`fmod`\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`fposmod`\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash`\ (\ variable\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`instance_from_id`\ (\ instance_id\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`inverse_lerp`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_inf`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_instance_id_valid`\ (\ id\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_instance_valid`\ (\ instance\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_nan`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_same`\ (\ a\: :ref:`Variant`, b\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_zero_approx`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`lerp`\ (\ from\: :ref:`Variant`, to\: :ref:`Variant`, weight\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`lerp_angle`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`lerpf`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`linear_to_db`\ (\ lin\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`log`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`max`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`maxf`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`maxi`\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`min`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`minf`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mini`\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`move_toward`\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`nearest_po2`\ (\ value\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`pingpong`\ (\ value\: :ref:`float`, length\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`posmod`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`pow`\ (\ base\: :ref:`float`, exp\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`print`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`print_rich`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`print_verbose`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`printerr`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`printraw`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`prints`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`printt`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_error`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_warning`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rad_to_deg`\ (\ rad\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`rand_from_seed`\ (\ seed\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randf`\ (\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randf_range`\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randfn`\ (\ mean\: :ref:`float`, deviation\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`randi`\ (\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`randi_range`\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`randomize`\ (\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`remap`\ (\ value\: :ref:`float`, istart\: :ref:`float`, istop\: :ref:`float`, ostart\: :ref:`float`, ostop\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rid_allocate_id`\ (\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`rid_from_int64`\ (\ base\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rotate_toward`\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`round`\ (\ x\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`roundf`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`roundi`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`seed`\ (\ base\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sigmoid`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sigmoid_affine`\ (\ x\: :ref:`float`, amplitude\: :ref:`float`, y_translation\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sigmoid_affine_approx`\ (\ x\: :ref:`float`, amplitude\: :ref:`float`, y_translation\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sigmoid_approx`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`sign`\ (\ x\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`signf`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`signi`\ (\ x\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sin`\ (\ angle_rad\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sinh`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`smoothstep`\ (\ from\: :ref:`float`, to\: :ref:`float`, x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`snapped`\ (\ x\: :ref:`Variant`, step\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`snappedf`\ (\ x\: :ref:`float`, step\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`snappedi`\ (\ x\: :ref:`float`, step\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sqrt`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`step_decimals`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`str`\ (\ ...\ ) |vararg| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`str_to_var`\ (\ string\: :ref:`String`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`str_to_var_with_objects`\ (\ string\: :ref:`String`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`tan`\ (\ angle_rad\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`tanh`\ (\ x\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`type_convert`\ (\ variant\: :ref:`Variant`, type\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`type_string`\ (\ type\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`typeof`\ (\ variable\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`var_to_bytes`\ (\ variable\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`var_to_bytes_with_objects`\ (\ variable\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`var_to_str`\ (\ variable\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`var_to_str_with_objects`\ (\ variable\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`weakref`\ (\ obj\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`wrap`\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`wrapf`\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`wrapi`\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`abs`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`absf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`absi`\ (\ x\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`acos`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`acosh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_difference`\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`asin`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`asinh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`atan`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`atan2`\ (\ y\: :ref:`float`, x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`atanh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`bezier_derivative`\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`bezier_interpolate`\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`bytes_to_var`\ (\ bytes\: :ref:`PackedByteArray`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`bytes_to_var_with_objects`\ (\ bytes\: :ref:`PackedByteArray`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`ceil`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`ceilf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`ceili`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`clamp`\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`clampf`\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`clampi`\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cos`\ (\ angle_rad\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cosh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cubic_interpolate`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cubic_interpolate_angle`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cubic_interpolate_angle_in_time`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cubic_interpolate_in_time`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`db_to_linear`\ (\ db\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`deg_to_rad`\ (\ deg\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`ease`\ (\ x\: :ref:`float`, curve\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`error_string`\ (\ error\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`exp`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`floor`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`floorf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`floori`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`fmod`\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`fposmod`\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`instance_from_id`\ (\ instance_id\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`inverse_lerp`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_inf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_instance_id_valid`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_instance_valid`\ (\ instance\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_nan`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_same`\ (\ a\: :ref:`Variant`, b\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`lerp`\ (\ from\: :ref:`Variant`, to\: :ref:`Variant`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`lerp_angle`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`lerpf`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`linear_to_db`\ (\ lin\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`log`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`max`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`maxf`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`maxi`\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`min`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`minf`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mini`\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`monotonic_cubic_interpolate`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`monotonic_cubic_interpolate_angle`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`monotonic_cubic_interpolate_angle_in_time`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`monotonic_cubic_interpolate_in_time`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`move_toward`\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`nearest_po2`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`pingpong`\ (\ value\: :ref:`float`, length\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`posmod`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`pow`\ (\ base\: :ref:`float`, exp\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_rich`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_verbose`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`printerr`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`printraw`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`prints`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`printt`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_error`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_warning`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rad_to_deg`\ (\ rad\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`rand_from_seed`\ (\ seed\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randf`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randf_range`\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randfn`\ (\ mean\: :ref:`float`, deviation\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`randi`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`randi_range`\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`randomize`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`remap`\ (\ value\: :ref:`float`, istart\: :ref:`float`, istop\: :ref:`float`, ostart\: :ref:`float`, ostop\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`remap_default`\ (\ value\: :ref:`float`, istart\: :ref:`float`, istop\: :ref:`float`, ostart\: :ref:`float`, ostop\: :ref:`float`, default_value\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rid_allocate_id`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`rid_from_int64`\ (\ base\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rotate_toward`\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`round`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`roundf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`roundi`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seed`\ (\ base\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sigmoid`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sigmoid_affine`\ (\ x\: :ref:`float`, amplitude\: :ref:`float`, y_translation\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sigmoid_affine_approx`\ (\ x\: :ref:`float`, amplitude\: :ref:`float`, y_translation\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sigmoid_approx`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`sign`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`signf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`signi`\ (\ x\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sin`\ (\ angle_rad\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sinh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`smoothstep`\ (\ from\: :ref:`float`, to\: :ref:`float`, x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`snapped`\ (\ x\: :ref:`Variant`, step\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`snappedf`\ (\ x\: :ref:`float`, step\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`snappedi`\ (\ x\: :ref:`float`, step\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sqrt`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`step_decimals`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`str`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`str_to_var`\ (\ string\: :ref:`String`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`str_to_var_with_objects`\ (\ string\: :ref:`String`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tan`\ (\ angle_rad\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tanh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`type_convert`\ (\ variant\: :ref:`Variant`, type\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`type_string`\ (\ type\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`typeof`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`var_to_bytes`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`var_to_bytes_with_objects`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`var_to_str`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`var_to_str_with_objects`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`weakref`\ (\ obj\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`wrap`\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`wrapf`\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`wrapi`\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -6199,7 +6209,7 @@ This function is faster than using :ref:`is_equal_approx()` **lerp**\ (\ from\: :ref:`Variant`, to\: :ref:`Variant`, weight\: :ref:`Variant`\ ) :ref:`🔗` +:ref:`Variant` **lerp**\ (\ from\: :ref:`Variant`, to\: :ref:`Variant`, weight\: :ref:`float`\ ) :ref:`🔗` Linearly interpolates between two values by the factor defined in ``weight``. To perform interpolation, ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use :ref:`clampf()` to limit ``weight``. @@ -6403,6 +6413,100 @@ Returns the minimum of two :ref:`int` values. ---- +.. _class_@GlobalScope_method_monotonic_cubic_interpolate: + +.. rst-class:: classref-method + +:ref:`float` **monotonic_cubic_interpolate**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) :ref:`🔗` + +Performs monotonic cubic interpolation between ``from`` and ``to``\ + +using neighboring values ``pre`` and ``post``. + +The interpolation factor ``weight`` is typically between 0.0 and 1.0. + + + +Unlike :ref:`cubic_interpolate()`, this method preserves monotonicity + +by automatically limiting tangents to prevent overshoot between key values. + +This makes it suitable for animation tracks and other data where values + +should not exceed surrounding keyframes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_@GlobalScope_method_monotonic_cubic_interpolate_angle: + +.. rst-class:: classref-method + +:ref:`float` **monotonic_cubic_interpolate_angle**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) :ref:`🔗` + +Performs monotonic cubic interpolation between angular values, rotating + +along the shortest path between ``from`` and ``to``. + + + +The neighboring angles ``pre`` and ``post`` are used to compute + +shape-preserving tangents while accounting for angle wrapping. + +This prevents overshoot while maintaining continuous rotation. + +See also :ref:`lerp_angle()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_@GlobalScope_method_monotonic_cubic_interpolate_angle_in_time: + +.. rst-class:: classref-method + +:ref:`float` **monotonic_cubic_interpolate_angle_in_time**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) :ref:`🔗` + +Time-aware version of :ref:`monotonic_cubic_interpolate_angle()`. + + + +The interpolation factor is derived from the provided keyframe times, + +allowing unevenly spaced keyframes to influence tangent calculation. + +This produces consistent motion when animation keys are not uniformly + +distributed in time while still preventing overshoot. + +.. rst-class:: classref-item-separator + +---- + +.. _class_@GlobalScope_method_monotonic_cubic_interpolate_in_time: + +.. rst-class:: classref-method + +:ref:`float` **monotonic_cubic_interpolate_in_time**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) :ref:`🔗` + +Time-aware version of :ref:`monotonic_cubic_interpolate()`. + + + +The interpolation parameter is normalized using the supplied keyframe + +times, allowing interpolation to account for non-uniform spacing between + +values. Tangents are computed in a way that preserves monotonicity and + +prevents overshoot between keyframes. + +.. rst-class:: classref-item-separator + +---- + .. _class_@GlobalScope_method_move_toward: .. rst-class:: classref-method @@ -6949,7 +7053,26 @@ Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. See also For complex use cases where multiple ranges are needed, consider using :ref:`Curve` or :ref:`Gradient` instead. -\ **Note:** If ``istart == istop``, the return value is undefined (most likely NaN, INF, or -INF). +\ **Note:** If ``istart == istop``, the return value is undefined (most likely NaN, INF, or -INF). See also :ref:`remap_default()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_@GlobalScope_method_remap_default: + +.. rst-class:: classref-method + +:ref:`float` **remap_default**\ (\ value\: :ref:`float`, istart\: :ref:`float`, istop\: :ref:`float`, ostart\: :ref:`float`, ostop\: :ref:`float`, default_value\: :ref:`float`\ ) :ref:`🔗` + +Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]`` and returns ``default_value`` if :ref:`remap()` would've returned ``INF`` or ``NAN``. See also :ref:`remap()`, :ref:`lerp()` and :ref:`inverse_lerp()`. If ``value`` is outside ``[istart, istop]``, then the resulting value will also be outside ``[ostart, ostop]``. If this is not desired, use :ref:`clamp()` on the result of this function. + +:: + + remap_default(75, 0, 100, -1, 1, 3) # Returns 0.5 + remap_default(75, 0, 0, -1, 1, 3) # Returns 3.0 + +For complex use cases where multiple ranges are needed, consider using :ref:`Curve` or :ref:`Gradient` instead. .. rst-class:: classref-item-separator diff --git a/classes/class_aimmodifier3d.rst b/classes/class_aimmodifier3d.rst index 7132d64b538..7bcfb280360 100644 --- a/classes/class_aimmodifier3d.rst +++ b/classes/class_aimmodifier3d.rst @@ -48,6 +48,8 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Axis` | :ref:`get_primary_rotation_axis`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_relative`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_using_euler`\ (\ index\: :ref:`int`\ ) |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_using_secondary_rotation`\ (\ index\: :ref:`int`\ ) |const| | @@ -56,6 +58,8 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_primary_rotation_axis`\ (\ index\: :ref:`int`, axis\: :ref:`Axis`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_relative`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_use_euler`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_use_secondary_rotation`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | @@ -116,6 +120,18 @@ Returns the axis of the first rotation. It is enabled only if :ref:`is_using_eul ---- +.. _class_AimModifier3D_method_is_relative: + +.. rst-class:: classref-method + +:ref:`bool` **is_relative**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if the relative option is enabled in the setting at ``index``. + +.. rst-class:: classref-item-separator + +---- + .. _class_AimModifier3D_method_is_using_euler: .. rst-class:: classref-method @@ -164,6 +180,22 @@ Sets the axis of the first rotation. It is enabled only if :ref:`is_using_euler( ---- +.. _class_AimModifier3D_method_set_relative: + +.. rst-class:: classref-method + +|void| **set_relative**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +Sets relative option in the setting at ``index`` to ``enabled``. + +If sets ``enabled`` to ``true``, the rotation is applied relative to the pose. + +If sets ``enabled`` to ``false``, the rotation is applied relative to the rest. It means to replace the current pose with the **AimModifier3D**'s result. + +.. rst-class:: classref-item-separator + +---- + .. _class_AimModifier3D_method_set_use_euler: .. rst-class:: classref-method diff --git a/classes/class_animation.rst b/classes/class_animation.rst index dd394d5bd5b..371bbc40ad6 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -364,6 +364,14 @@ Linear interpolation. Cubic interpolation. This looks smoother than linear interpolation, but is more expensive to interpolate. Stick to :ref:`INTERPOLATION_LINEAR` for complex 3D animations imported from external software, even if it requires using a higher animation framerate in return. +.. _class_Animation_constant_INTERPOLATION_CUBIC_MONOTONIC: + +.. rst-class:: classref-enumeration-constant + +:ref:`InterpolationType` **INTERPOLATION_CUBIC_MONOTONIC** = ``5`` + +Monotonic Cubic interpolation. This is an alternate version of :ref:`INTERPOLATION_CUBIC` that ensures no overshooting of key points. + .. _class_Animation_constant_INTERPOLATION_LINEAR_ANGLE: .. rst-class:: classref-enumeration-constant @@ -384,6 +392,14 @@ Cubic interpolation with shortest path rotation. \ **Note:** The result value is always normalized and may not match the key value. +.. _class_Animation_constant_INTERPOLATION_CUBIC_MONOTONIC_ANGLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`InterpolationType` **INTERPOLATION_CUBIC_MONOTONIC_ANGLE** = ``6`` + +Monotonic Cubic interpolation with shortest path rotation. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_boneconstraint3d.rst b/classes/class_boneconstraint3d.rst index 87824ca67c3..54a089833d5 100644 --- a/classes/class_boneconstraint3d.rst +++ b/classes/class_boneconstraint3d.rst @@ -31,33 +31,74 @@ Methods .. table:: :widths: auto - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_setting`\ (\ ) | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_amount`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_apply_bone`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_apply_bone_name`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_reference_bone`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_reference_bone_name`\ (\ index\: :ref:`int`\ ) |const| | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_setting_count`\ (\ ) |const| | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_amount`\ (\ index\: :ref:`int`, amount\: :ref:`float`\ ) | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_apply_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_apply_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_reference_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_reference_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_setting_count`\ (\ count\: :ref:`int`\ ) | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_setting`\ (\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_amount`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_apply_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_apply_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_reference_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_reference_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_reference_node`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ReferenceType` | :ref:`get_reference_type`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_setting_count`\ (\ ) |const| | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_amount`\ (\ index\: :ref:`int`, amount\: :ref:`float`\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_apply_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_apply_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_node`\ (\ index\: :ref:`int`, node\: :ref:`NodePath`\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_type`\ (\ index\: :ref:`int`, type\: :ref:`ReferenceType`\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_setting_count`\ (\ count\: :ref:`int`\ ) | + +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_BoneConstraint3D_ReferenceType: + +.. rst-class:: classref-enumeration + +enum **ReferenceType**: :ref:`🔗` + +.. _class_BoneConstraint3D_constant_REFERENCE_TYPE_BONE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ReferenceType` **REFERENCE_TYPE_BONE** = ``0`` + +The reference target is a bone. In this case, the reference target spaces is local space. + +.. _class_BoneConstraint3D_constant_REFERENCE_TYPE_NODE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ReferenceType` **REFERENCE_TYPE_NODE** = ``1`` + +The reference target is a :ref:`Node3D`. In this case, the reference target spaces is model space. + +In other words, the reference target's coordinates are treated as if it were placed directly under :ref:`Skeleton3D` which parent of the **BoneConstraint3D**. .. rst-class:: classref-section-separator @@ -144,6 +185,32 @@ This bone will be only referenced and not modified by this modifier. ---- +.. _class_BoneConstraint3D_method_get_reference_node: + +.. rst-class:: classref-method + +:ref:`NodePath` **get_reference_node**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the reference node path of the setting at ``index``. + +This node will be only referenced and not modified by this modifier. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_get_reference_type: + +.. rst-class:: classref-method + +:ref:`ReferenceType` **get_reference_type**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the reference target type of the setting at ``index``. See also :ref:`ReferenceType`. + +.. rst-class:: classref-item-separator + +---- + .. _class_BoneConstraint3D_method_get_setting_count: .. rst-class:: classref-method @@ -220,6 +287,32 @@ This bone will be only referenced and not modified by this modifier. ---- +.. _class_BoneConstraint3D_method_set_reference_node: + +.. rst-class:: classref-method + +|void| **set_reference_node**\ (\ index\: :ref:`int`, node\: :ref:`NodePath`\ ) :ref:`🔗` + +Sets the reference node path of the setting at ``index`` to ``node``. + +This node will be only referenced and not modified by this modifier. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneConstraint3D_method_set_reference_type: + +.. rst-class:: classref-method + +|void| **set_reference_type**\ (\ index\: :ref:`int`, type\: :ref:`ReferenceType`\ ) :ref:`🔗` + +Sets the reference target type of the setting at ``index`` to ``type``. See also :ref:`ReferenceType`. + +.. rst-class:: classref-item-separator + +---- + .. _class_BoneConstraint3D_method_set_setting_count: .. rst-class:: classref-method diff --git a/classes/class_bonetwistdisperser3d.rst b/classes/class_bonetwistdisperser3d.rst new file mode 100644 index 00000000000..a48edba41b5 --- /dev/null +++ b/classes/class_bonetwistdisperser3d.rst @@ -0,0 +1,581 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/BoneTwistDisperser3D.xml. + +.. _class_BoneTwistDisperser3D: + +BoneTwistDisperser3D +==================== + +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +A node that propagates and disperses the child bone's twist to the parent bones. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This **BoneTwistDisperser3D** allows for smooth twist interpolation between multiple bones by dispersing the end bone's twist to the parents. This only changes the twist without changing the global position of each joint. + +This is useful for smoothly twisting bones in combination with :ref:`CopyTransformModifier3D` and IK. + +\ **Note:** If an extracted twist is greater than 180 degrees, flipping occurs. This is similar to :ref:`ConvertTransformModifier3D`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+---------------------------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`mutable_bone_axes` | ``true`` | + +-------------------------+---------------------------------------------------------------------------------+----------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-------------------------+---------------------------------------------------------------------------------+----------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_settings`\ (\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`get_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`DisperseMode` | :ref:`get_disperse_mode`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_end_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BoneDirection` | :ref:`get_end_bone_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_end_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_bone`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_joint_bone_name`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_count`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_joint_twist_amount`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_reference_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_reference_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_root_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_root_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`get_twist_from`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_weight_position`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_end_bone_extended`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_twist_from_rest`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disperse_mode`\ (\ index\: :ref:`int`, disperse_mode\: :ref:`DisperseMode`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_direction`\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_extend_end_bone`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_twist_amount`\ (\ index\: :ref:`int`, joint\: :ref:`int`, twist_amount\: :ref:`float`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_twist_from`\ (\ index\: :ref:`int`, from\: :ref:`Quaternion`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_twist_from_rest`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_weight_position`\ (\ index\: :ref:`int`, weight_position\: :ref:`float`\ ) | + +-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_BoneTwistDisperser3D_DisperseMode: + +.. rst-class:: classref-enumeration + +enum **DisperseMode**: :ref:`🔗` + +.. _class_BoneTwistDisperser3D_constant_DISPERSE_MODE_EVEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`DisperseMode` **DISPERSE_MODE_EVEN** = ``0`` + +Assign amounts so that they monotonically increase from ``0.0`` to ``1.0``, ensuring all weights are equal. For example, with five joints, the amounts would be ``0.2``, ``0.4``, ``0.6``, ``0.8``, and ``1.0`` starting from the root bone. + +.. _class_BoneTwistDisperser3D_constant_DISPERSE_MODE_WEIGHTED: + +.. rst-class:: classref-enumeration-constant + +:ref:`DisperseMode` **DISPERSE_MODE_WEIGHTED** = ``1`` + +Assign amounts so that they monotonically increase from ``0.0`` to ``1.0``, based on the length of the bones between joint segments. See also :ref:`set_weight_position()`. + +.. _class_BoneTwistDisperser3D_constant_DISPERSE_MODE_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`DisperseMode` **DISPERSE_MODE_CUSTOM** = ``2`` + +You can assign arbitrary amounts to the joint list. See also :ref:`set_joint_twist_amount()`. + +When :ref:`is_end_bone_extended()` is ``false``, a child of the reference bone exists solely to determine the twist axis, so its custom amount has absolutely no effect at all. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_BoneTwistDisperser3D_property_mutable_bone_axes: + +.. rst-class:: classref-property + +:ref:`bool` **mutable_bone_axes** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mutable_bone_axes**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_bone_axes_mutable**\ (\ ) + +If ``true``, the solver retrieves the bone axis from the bone pose every frame. + +If ``false``, the solver retrieves the bone axis from the bone rest and caches it. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_property_setting_count: + +.. rst-class:: classref-property + +:ref:`int` **setting_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_setting_count**\ (\ ) + +The number of settings. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_BoneTwistDisperser3D_method_clear_settings: + +.. rst-class:: classref-method + +|void| **clear_settings**\ (\ ) :ref:`🔗` + +Clears all settings. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_damping_curve: + +.. rst-class:: classref-method + +:ref:`Curve` **get_damping_curve**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the damping curve when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_CUSTOM`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_disperse_mode: + +.. rst-class:: classref-method + +:ref:`DisperseMode` **get_disperse_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns whether to use automatic amount assignment or to allow manual assignment. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_end_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_end_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_end_bone_direction: + +.. rst-class:: classref-method + +:ref:`BoneDirection` **get_end_bone_direction**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the tail direction of the end bone of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_end_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_end_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_joint_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_joint_bone**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the bone index at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_joint_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_joint_bone_name**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the bone name at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_joint_count: + +.. rst-class:: classref-method + +:ref:`int` **get_joint_count**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the joint count of the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_joint_twist_amount: + +.. rst-class:: classref-method + +:ref:`float` **get_joint_twist_amount**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the twist amount at ``joint`` in the bone chain's joint list when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_CUSTOM`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_reference_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_reference_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the reference bone to extract twist of the setting at ``index``. + +This bone is either the end of the chain or its parent, depending on :ref:`is_end_bone_extended()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_reference_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_reference_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the reference bone name to extract twist of the setting at ``index``. + +This bone is either the end of the chain or its parent, depending on :ref:`is_end_bone_extended()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_root_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_root_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_root_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_root_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_twist_from: + +.. rst-class:: classref-method + +:ref:`Quaternion` **get_twist_from**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the rotation to an arbitrary state before twisting for the current bone pose to extract the twist when :ref:`is_twist_from_rest()` is ``false``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_get_weight_position: + +.. rst-class:: classref-method + +:ref:`float` **get_weight_position**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the position at which to divide the segment between joints for weight assignment when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_WEIGHTED`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_is_end_bone_extended: + +.. rst-class:: classref-method + +:ref:`bool` **is_end_bone_extended**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if the end bone is extended to have a tail. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_is_twist_from_rest: + +.. rst-class:: classref-method + +:ref:`bool` **is_twist_from_rest**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if extracting the twist amount from the difference between the bone rest and the current bone pose. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_damping_curve: + +.. rst-class:: classref-method + +|void| **set_damping_curve**\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) :ref:`🔗` + +Sets the damping curve when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_CUSTOM`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_disperse_mode: + +.. rst-class:: classref-method + +|void| **set_disperse_mode**\ (\ index\: :ref:`int`, disperse_mode\: :ref:`DisperseMode`\ ) :ref:`🔗` + +Sets whether to use automatic amount assignment or to allow manual assignment. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_end_bone: + +.. rst-class:: classref-method + +|void| **set_end_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the end bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_end_bone_direction: + +.. rst-class:: classref-method + +|void| **set_end_bone_direction**\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) :ref:`🔗` + +Sets the end bone tail direction of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_end_bone_name: + +.. rst-class:: classref-method + +|void| **set_end_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the end bone name of the bone chain. + +\ **Note:** The end bone must be a child of the root bone. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_extend_end_bone: + +.. rst-class:: classref-method + +|void| **set_extend_end_bone**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +If ``enabled`` is ``true``, the end bone is extended to have a tail. + +If ``enabled`` is ``false``, :ref:`get_reference_bone()` becomes a parent of the end bone and it uses the vector to the end bone as a twist axis. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_joint_twist_amount: + +.. rst-class:: classref-method + +|void| **set_joint_twist_amount**\ (\ index\: :ref:`int`, joint\: :ref:`int`, twist_amount\: :ref:`float`\ ) :ref:`🔗` + +Sets the twist amount at ``joint`` in the bone chain's joint list when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_CUSTOM`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_root_bone: + +.. rst-class:: classref-method + +|void| **set_root_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the root bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_root_bone_name: + +.. rst-class:: classref-method + +|void| **set_root_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the root bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_twist_from: + +.. rst-class:: classref-method + +|void| **set_twist_from**\ (\ index\: :ref:`int`, from\: :ref:`Quaternion`\ ) :ref:`🔗` + +Sets the rotation to an arbitrary state before twisting for the current bone pose to extract the twist when :ref:`is_twist_from_rest()` is ``false``. + +In other words, by calling :ref:`set_twist_from()` by :ref:`SkeletonModifier3D.modification_processed` of a specific :ref:`SkeletonModifier3D`, you can extract only the twists generated by modifiers processed after that but before this **BoneTwistDisperser3D**. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_twist_from_rest: + +.. rst-class:: classref-method + +|void| **set_twist_from_rest**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +If ``enabled`` is ``true``, it extracts the twist amount from the difference between the bone rest and the current bone pose. + +If ``enabled`` is ``false``, it extracts the twist amount from the difference between :ref:`get_twist_from()` and the current bone pose. See also :ref:`set_twist_from()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_BoneTwistDisperser3D_method_set_weight_position: + +.. rst-class:: classref-method + +|void| **set_weight_position**\ (\ index\: :ref:`int`, weight_position\: :ref:`float`\ ) :ref:`🔗` + +Sets the position at which to divide the segment between joints for weight assignment when :ref:`get_disperse_mode()` is :ref:`DISPERSE_MODE_WEIGHTED`. + +For example, when ``weight_position`` is ``0.5``, if two bone segments with a length of ``1.0`` exist between three joints, weights are assigned to each joint from root to end at ratios of ``0.5``, ``1.0``, and ``0.5``. Then amounts become ``0.25``, ``0.75``, and ``1.0`` respectively. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cameraattributes.rst b/classes/class_cameraattributes.rst index d79914732cc..371f5445fa2 100644 --- a/classes/class_cameraattributes.rst +++ b/classes/class_cameraattributes.rst @@ -71,6 +71,8 @@ Property Descriptions If ``true``, enables the tonemapping auto exposure mode of the scene renderer. If ``true``, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light. +\ **Note:** Auto-exposure is only supported in the Forward+ rendering method, not Mobile or Compatibility. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_cameraattributesphysical.rst b/classes/class_cameraattributesphysical.rst index 529fd930152..caf1272a65b 100644 --- a/classes/class_cameraattributesphysical.rst +++ b/classes/class_cameraattributesphysical.rst @@ -27,6 +27,8 @@ The default settings are intended for use in an outdoor environment, tips for se \ **Note:** Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. +\ **Note:** Auto-exposure is only supported in the Forward+ rendering method, not Mobile or Compatibility. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_cameraattributespractical.rst b/classes/class_cameraattributespractical.rst index 73d0d636ca5..bde8a03a30a 100644 --- a/classes/class_cameraattributespractical.rst +++ b/classes/class_cameraattributespractical.rst @@ -23,6 +23,10 @@ Controls camera-specific attributes such as auto-exposure, depth of field, and e When used in a :ref:`WorldEnvironment` it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own :ref:`CameraAttributes`, including the editor camera. When used in a :ref:`Camera3D` it will override any :ref:`CameraAttributes` set in the :ref:`WorldEnvironment`. When used in :ref:`VoxelGI` or :ref:`LightmapGI`, only the exposure settings will be used. +\ **Note:** Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. + +\ **Note:** Auto-exposure is only supported in the Forward+ rendering method, not Mobile or Compatibility. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_ccdik3d.rst b/classes/class_ccdik3d.rst new file mode 100644 index 00000000000..56becf5e66c --- /dev/null +++ b/classes/class_ccdik3d.rst @@ -0,0 +1,36 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/CCDIK3D.xml. + +.. _class_CCDIK3D: + +CCDIK3D +======= + +**Inherits:** :ref:`IterateIK3D` **<** :ref:`ChainIK3D` **<** :ref:`IKModifier3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +Rotation based cyclic coordinate descent inverse kinematics solver. + +.. rst-class:: classref-introduction-group + +Description +----------- + +**CCDIK3D** is rotation based IK, enabling fast and effective tracking even with large joint rotations. It's especially suitable for chains with limitations, providing smoother and more stable target tracking compared to :ref:`FABRIK3D`. + +The resulting twist around the forward vector will always be kept from the previous pose. + +\ **Note:** When the target is close to the root, it can cause unnatural movement, including joint flips and oscillations. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_chainik3d.rst b/classes/class_chainik3d.rst new file mode 100644 index 00000000000..7cf5c634fe6 --- /dev/null +++ b/classes/class_chainik3d.rst @@ -0,0 +1,291 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/ChainIK3D.xml. + +.. _class_ChainIK3D: + +ChainIK3D +========= + +**Inherits:** :ref:`IKModifier3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`IterateIK3D`, :ref:`SplineIK3D` + +A :ref:`SkeletonModifier3D` to apply inverse kinematics to bone chains containing an arbitrary number of bones. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Base class of :ref:`SkeletonModifier3D` that automatically generates a joint list from the bones between the root bone and the end bone. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_end_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BoneDirection` | :ref:`get_end_bone_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_end_bone_length`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_end_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_bone`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_joint_bone_name`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_count`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_root_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_root_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_end_bone_extended`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_direction`\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_length`\ (\ index\: :ref:`int`, length\: :ref:`float`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_extend_end_bone`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_ChainIK3D_method_get_end_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_end_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_get_end_bone_direction: + +.. rst-class:: classref-method + +:ref:`BoneDirection` **get_end_bone_direction**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the tail direction of the end bone of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_get_end_bone_length: + +.. rst-class:: classref-method + +:ref:`float` **get_end_bone_length**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone tail length of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_get_end_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_end_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_get_joint_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_joint_bone**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the bone index at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_get_joint_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_joint_bone_name**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the bone name at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_get_joint_count: + +.. rst-class:: classref-method + +:ref:`int` **get_joint_count**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the joint count of the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_get_root_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_root_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_get_root_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_root_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_is_end_bone_extended: + +.. rst-class:: classref-method + +:ref:`bool` **is_end_bone_extended**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if the end bone is extended to have a tail. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_set_end_bone: + +.. rst-class:: classref-method + +|void| **set_end_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the end bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_set_end_bone_direction: + +.. rst-class:: classref-method + +|void| **set_end_bone_direction**\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) :ref:`🔗` + +Sets the end bone tail direction of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_set_end_bone_length: + +.. rst-class:: classref-method + +|void| **set_end_bone_length**\ (\ index\: :ref:`int`, length\: :ref:`float`\ ) :ref:`🔗` + +Sets the end bone tail length of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_set_end_bone_name: + +.. rst-class:: classref-method + +|void| **set_end_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the end bone name of the bone chain. + +\ **Note:** The end bone must be the root bone or a child of the root bone. If they are the same, the tail must be extended by :ref:`set_extend_end_bone()` to modify the bone. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_set_extend_end_bone: + +.. rst-class:: classref-method + +|void| **set_extend_end_bone**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +If ``enabled`` is ``true``, the end bone is extended to have a tail. + +The extended tail config is allocated to the last element in the joint list. In other words, if you set ``enabled`` to ``false``, the config of the last element in the joint list has no effect in the simulated result. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_set_root_bone: + +.. rst-class:: classref-method + +|void| **set_root_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the root bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ChainIK3D_method_set_root_bone_name: + +.. rst-class:: classref-method + +|void| **set_root_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the root bone name of the bone chain. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_color.rst b/classes/class_color.rst index daf3b9c2ddb..592e6ffbe30 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -112,6 +112,8 @@ Methods .. table:: :widths: auto + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`apply_intensity`\ (\ intensity\: :ref:`float`\ ) |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`blend`\ (\ over\: :ref:`Color`\ ) |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1681,6 +1683,22 @@ Constructs a **Color** from RGBA values, typically between 0.0 and 1.0. Method Descriptions ------------------- +.. _class_Color_method_apply_intensity: + +.. rst-class:: classref-method + +:ref:`Color` **apply_intensity**\ (\ intensity\: :ref:`float`\ ) |const| :ref:`🔗` + +Adjusts the color's intensity by multiplying the RGB components with a factor derived from the given intensity. + +The factor is calculated as 2 raised to the power of the provided intensity value. + +The adjusted RGB values are clamped to the range ``0.0`` and ``1.0``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Color_method_blend: .. rst-class:: classref-method diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index bf14c54d487..559ded4e5a0 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -57,6 +57,8 @@ Properties +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`hex_visible` | ``true`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`intensity` | ``0.0`` | + +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`old_color` | ``Color(0, 0, 0, 1)`` | +----------------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`PickerShapeType` | :ref:`picker_shape` | ``0`` | @@ -484,6 +486,25 @@ If ``true``, the hex color code input field is visible. ---- +.. _class_ColorPicker_property_intensity: + +.. rst-class:: classref-property + +:ref:`float` **intensity** = ``0.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_intensity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_intensity**\ (\ ) + +The currently selected intensity. + +Note: ``set_intensity`` clamps the value in the range ``[-10.0, 10.0]`` + +.. rst-class:: classref-item-separator + +---- + .. _class_ColorPicker_property_old_color: .. rst-class:: classref-property diff --git a/classes/class_converttransformmodifier3d.rst b/classes/class_converttransformmodifier3d.rst index 94058ab2e9d..8609a6e767d 100644 --- a/classes/class_converttransformmodifier3d.rst +++ b/classes/class_converttransformmodifier3d.rst @@ -39,6 +39,10 @@ There are 4 ways to apply the transform, depending on the combination of :ref:`s - Extract reference pose absolutely and the apply bone's pose is replaced with it. +\ **Note:** Relative option is available only in the case :ref:`BoneConstraint3D.get_reference_type()` is :ref:`BoneConstraint3D.REFERENCE_TYPE_BONE`. See also :ref:`ReferenceType`. + +\ **Note:** If there is a rotation greater than ``180`` degrees with constrained axes, flipping may occur. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_copytransformmodifier3d.rst b/classes/class_copytransformmodifier3d.rst index a299e191ff1..6042528d965 100644 --- a/classes/class_copytransformmodifier3d.rst +++ b/classes/class_copytransformmodifier3d.rst @@ -39,6 +39,8 @@ There are 4 ways to apply the transform, depending on the combination of :ref:`s - Extract reference pose absolutely and the apply bone's pose is replaced with it. +\ **Note:** Relative option is available only in the case :ref:`BoneConstraint3D.get_reference_type()` is :ref:`BoneConstraint3D.REFERENCE_TYPE_BONE`. See also :ref:`ReferenceType`. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 70c5e7f8a7d..f65fa80b7a4 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -489,6 +489,15 @@ Finds and returns the first key whose associated value is equal to ``value``, or Returns the corresponding value for the given ``key`` in the dictionary. If the ``key`` does not exist, returns ``default``, or ``null`` if the parameter is omitted. +\ **Note:** If the ``default`` argument is computationally expensive or has unwanted side effects, consider using the :ref:`has()` method instead: + +:: + + # Always calls `expensive_function()`. + dict.get("key", expensive_function()) + # Calls `expensive_function()` only if the key does not exist. + dict.get("key") if dict.has("key") else expensive_function() + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 0fcc255d97f..4e4a9f1150a 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -227,6 +227,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/gridmap_grid` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/ik_chain` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint` | @@ -785,6 +787,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`text_editor/external/exec_path` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/external/prefer_tabs_in_external_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/external/use_external_editor` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/help/class_reference_examples` | @@ -2051,6 +2055,18 @@ The 3D editor gizmo color for the :ref:`GridMap` grid. ---- +.. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/ik_chain: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d_gizmos/gizmo_colors/ik_chain** :ref:`🔗` + +The 3D editor gizmo color for the :ref:`IKModifier3D` guides. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/3d_gizmos/gizmo_colors/instantiated: .. rst-class:: classref-property @@ -5668,6 +5684,20 @@ The path to the text editor executable used to edit text files if :ref:`text_edi ---- +.. _class_EditorSettings_property_text_editor/external/prefer_tabs_in_external_editor: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/external/prefer_tabs_in_external_editor** :ref:`🔗` + +If set, this will instruct the editor to attempt to reopen previously open scripts as tabs in a single instance of the external editor, + +by passing them in as command line args instead of trying to launch a single instance for each script file. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/external/use_external_editor: .. rst-class:: classref-property diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 27e59d8eb39..b79a2abe3f1 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -356,7 +356,7 @@ Every :ref:`Dictionary` contains a ``name`` identifier, and a Returns a :ref:`Dictionary` of categorized donor names. Each entry is an :ref:`Array` of strings: -{``donors``} +\ ``donors`` .. rst-class:: classref-item-separator diff --git a/classes/class_fabrik3d.rst b/classes/class_fabrik3d.rst new file mode 100644 index 00000000000..00f332c589d --- /dev/null +++ b/classes/class_fabrik3d.rst @@ -0,0 +1,43 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/FABRIK3D.xml. + +.. _class_FABRIK3D: + +FABRIK3D +======== + +**Inherits:** :ref:`IterateIK3D` **<** :ref:`ChainIK3D` **<** :ref:`IKModifier3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +Position based forward and backward reaching inverse kinematics solver. + +.. rst-class:: classref-introduction-group + +Description +----------- + +**FABRIK3D** is position based IK, allowing precise and accurate tracking of targets. It's ideal for simple chains without limitations. + +The resulting twist around the forward vector will always be kept from the previous pose. + +\ **Note:** When the target is close to the root, it tends to produce zig-zag patterns, resulting in unnatural visual movement. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- `Inverse Kinematics Returns to Godot 4.6 - IKModifier3D `__ + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_foldablecontainer.rst b/classes/class_foldablecontainer.rst index cb4cd345bec..e25b46448a9 100644 --- a/classes/class_foldablecontainer.rst +++ b/classes/class_foldablecontainer.rst @@ -211,7 +211,7 @@ The :ref:`FoldableGroup` associated with the container. Whe - |void| **set_folded**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_folded**\ (\ ) -If ``true``, the container will becomes folded and will hide all its children. +If ``true``, the container will become folded and will hide all its children. .. rst-class:: classref-item-separator diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 0419f7296c0..e7b098c4fe6 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -619,7 +619,20 @@ Generates a baked mesh that represents all meshes in the assigned :ref:`MeshLibr :ref:`Vector3` **map_to_local**\ (\ map_position\: :ref:`Vector3i`\ ) |const| :ref:`🔗` -Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node3D.to_global()`. See also :ref:`local_to_map()`. +Returns the position of a grid cell in the GridMap's local coordinate space. The returned position, for each axis, is either cell center or the cell edge closer to negative infinity, based on the values of :ref:`cell_center_x`, :ref:`cell_center_y`, :ref:`cell_center_z`. To convert the returned value into global coordinates, use :ref:`Node3D.to_global()`. See also :ref:`local_to_map()`. + +:: + + # All examples for: cell_size = Vector3(2.0, 3.0, 4.0) + + # cell_center_x = true, cell_center_y = true, cell_center_z = true + map_to_local(Vector3i(0, 0, 0)) # Returns Vector3(1.0, 1.5, 2.0) + + # cell_center_x = false, cell_center_y = false, cell_center_z = false + map_to_local(Vector3i(0, 0, 0)) # Returns Vector3(0.0, 0.0, 0.0) + + # cell_center_x = true, cell_center_y = false, cell_center_z = true + map_to_local(Vector3i(0, 0, 0)) # Returns Vector3(1.0, 0.0, 2.0) .. rst-class:: classref-item-separator diff --git a/classes/class_ikmodifier3d.rst b/classes/class_ikmodifier3d.rst new file mode 100644 index 00000000000..87f3ba07d6d --- /dev/null +++ b/classes/class_ikmodifier3d.rst @@ -0,0 +1,148 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/IKModifier3D.xml. + +.. _class_IKModifier3D: + +IKModifier3D +============ + +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`ChainIK3D`, :ref:`TwoBoneIK3D` + +A node for inverse kinematics which may modify more than one bone. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Base class of :ref:`SkeletonModifier3D`\ s that has some joint lists and applies inverse kinematics. This class has some structs, enums, and helper methods which are useful to solve inverse kinematics. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- `Inverse Kinematics Returns to Godot 4.6 - IKModifier3D `__ + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+-------------------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`mutable_bone_axes` | ``true`` | + +-------------------------+-------------------------------------------------------------------------+----------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------+------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_settings`\ (\ ) | + +-----------------------+------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_setting_count`\ (\ ) |const| | + +-----------------------+------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +-----------------------+------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_setting_count`\ (\ count\: :ref:`int`\ ) | + +-----------------------+------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_IKModifier3D_property_mutable_bone_axes: + +.. rst-class:: classref-property + +:ref:`bool` **mutable_bone_axes** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mutable_bone_axes**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_bone_axes_mutable**\ (\ ) + +If ``true``, the solver retrieves the bone axis from the bone pose every frame. + +If ``false``, the solver retrieves the bone axis from the bone rest and caches it, which increases performance slightly, but position changes in the bone pose made before processing this **IKModifier3D** are ignored. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_IKModifier3D_method_clear_settings: + +.. rst-class:: classref-method + +|void| **clear_settings**\ (\ ) :ref:`🔗` + +Clears all settings. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IKModifier3D_method_get_setting_count: + +.. rst-class:: classref-method + +:ref:`int` **get_setting_count**\ (\ ) |const| :ref:`🔗` + +Returns the number of settings. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IKModifier3D_method_reset: + +.. rst-class:: classref-method + +|void| **reset**\ (\ ) :ref:`🔗` + +Resets a state with respect to the current bone pose. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IKModifier3D_method_set_setting_count: + +.. rst-class:: classref-method + +|void| **set_setting_count**\ (\ count\: :ref:`int`\ ) :ref:`🔗` + +Sets the number of settings. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_iterateik3d.rst b/classes/class_iterateik3d.rst new file mode 100644 index 00000000000..4b35ec8a2eb --- /dev/null +++ b/classes/class_iterateik3d.rst @@ -0,0 +1,385 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/IterateIK3D.xml. + +.. _class_IterateIK3D: + +IterateIK3D +=========== + +**Inherits:** :ref:`ChainIK3D` **<** :ref:`IKModifier3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +**Inherited By:** :ref:`CCDIK3D`, :ref:`FABRIK3D`, :ref:`JacobianIK3D` + +A :ref:`SkeletonModifier3D` to approach the goal by repeating small rotations. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Base class of :ref:`SkeletonModifier3D` to approach the goal by repeating small rotations. + +Each bone chain (setting) has one effector, which is processed in order of the setting list. You can set some limitations for each joint. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+----------------------------------------------------------------------------+-----------------+ + | :ref:`float` | :ref:`angular_delta_limit` | ``0.034906585`` | + +---------------------------+----------------------------------------------------------------------------+-----------------+ + | :ref:`bool` | :ref:`deterministic` | ``false`` | + +---------------------------+----------------------------------------------------------------------------+-----------------+ + | :ref:`int` | :ref:`max_iterations` | ``4`` | + +---------------------------+----------------------------------------------------------------------------+-----------------+ + | :ref:`float` | :ref:`min_distance` | ``0.001`` | + +---------------------------+----------------------------------------------------------------------------+-----------------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +---------------------------+----------------------------------------------------------------------------+-----------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JointLimitation3D` | :ref:`get_joint_limitation`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SecondaryDirection` | :ref:`get_joint_limitation_right_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_joint_limitation_right_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`get_joint_limitation_rotation_offset`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RotationAxis` | :ref:`get_joint_rotation_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_joint_rotation_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_target_node`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_limitation`\ (\ index\: :ref:`int`, joint\: :ref:`int`, limitation\: :ref:`JointLimitation3D`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_limitation_right_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`, direction\: :ref:`SecondaryDirection`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_limitation_right_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`, vector\: :ref:`Vector3`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_limitation_rotation_offset`\ (\ index\: :ref:`int`, joint\: :ref:`int`, offset\: :ref:`Quaternion`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_rotation_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_rotation_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis_vector\: :ref:`Vector3`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_target_node`\ (\ index\: :ref:`int`, target_node\: :ref:`NodePath`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_IterateIK3D_property_angular_delta_limit: + +.. rst-class:: classref-property + +:ref:`float` **angular_delta_limit** = ``0.034906585`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_angular_delta_limit**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_delta_limit**\ (\ ) + +The maximum amount each bone can rotate in a single iteration. + +\ **Note:** This limitation is applied during each iteration. For example, if :ref:`max_iterations` is ``4`` and :ref:`angular_delta_limit` is ``5`` degrees, the maximum rotation possible in a single frame is ``20`` degrees. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_property_deterministic: + +.. rst-class:: classref-property + +:ref:`bool` **deterministic** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_deterministic**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_deterministic**\ (\ ) + +If ``false``, the result is calculated from the previous frame's **IterateIK3D** result as the initial state. + +If ``true``, the previous frame's **IterateIK3D** result is discarded. At this point, the new result is calculated from the bone pose excluding the **IterateIK3D** as the initial state. This means the result will be always equal as long as the target position and the previous bone pose are the same. However, if :ref:`angular_delta_limit` and :ref:`max_iterations` are set too small, the end bone of the chain will never reach the target. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_property_max_iterations: + +.. rst-class:: classref-property + +:ref:`int` **max_iterations** = ``4`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_max_iterations**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_iterations**\ (\ ) + +The number of iteration loops used by the IK solver to produce more accurate results. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_property_min_distance: + +.. rst-class:: classref-property + +:ref:`float` **min_distance** = ``0.001`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_min_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min_distance**\ (\ ) + +The minimum distance between the end bone and the target. If the distance is below this value, the IK solver stops any further iterations. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_property_setting_count: + +.. rst-class:: classref-property + +:ref:`int` **setting_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_setting_count**\ (\ ) + +The number of settings. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_IterateIK3D_method_get_joint_limitation: + +.. rst-class:: classref-method + +:ref:`JointLimitation3D` **get_joint_limitation**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the joint limitation at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_get_joint_limitation_right_axis: + +.. rst-class:: classref-method + +:ref:`SecondaryDirection` **get_joint_limitation_right_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the joint limitation right axis at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_get_joint_limitation_right_axis_vector: + +.. rst-class:: classref-method + +:ref:`Vector3` **get_joint_limitation_right_axis_vector**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the joint limitation right axis vector at ``joint`` in the bone chain's joint list. + +If :ref:`get_joint_limitation_right_axis()` is :ref:`SkeletonModifier3D.SECONDARY_DIRECTION_NONE`, this method returns ``Vector3(0, 0, 0)``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_get_joint_limitation_rotation_offset: + +.. rst-class:: classref-method + +:ref:`Quaternion` **get_joint_limitation_rotation_offset**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the joint limitation rotation offset at ``joint`` in the bone chain's joint list. + +Rotation is done in the local space which is constructed by the bone direction (in general parent to child) as the +Y axis and :ref:`get_joint_limitation_right_axis_vector()` as the +X axis. + +If the +X and +Y axes are not orthogonal, the +X axis is implicitly modified to make it orthogonal. + +Also, if the length of :ref:`get_joint_limitation_right_axis_vector()` is zero, the space is created by rotating the bone rest using the shortest arc that rotates the +Y axis of the bone rest to match the bone direction. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_get_joint_rotation_axis: + +.. rst-class:: classref-method + +:ref:`RotationAxis` **get_joint_rotation_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the rotation axis at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_get_joint_rotation_axis_vector: + +.. rst-class:: classref-method + +:ref:`Vector3` **get_joint_rotation_axis_vector**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the rotation axis vector for the specified joint in the bone chain. This vector represents the axis around which the joint can rotate. It is determined based on the rotation axis set for the joint. + +If :ref:`get_joint_rotation_axis()` is :ref:`SkeletonModifier3D.ROTATION_AXIS_ALL`, this method returns ``Vector3(0, 0, 0)``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_get_target_node: + +.. rst-class:: classref-method + +:ref:`NodePath` **get_target_node**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the target node that the end bone is trying to reach. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_set_joint_limitation: + +.. rst-class:: classref-method + +|void| **set_joint_limitation**\ (\ index\: :ref:`int`, joint\: :ref:`int`, limitation\: :ref:`JointLimitation3D`\ ) :ref:`🔗` + +Sets the joint limitation at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_set_joint_limitation_right_axis: + +.. rst-class:: classref-method + +|void| **set_joint_limitation_right_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`, direction\: :ref:`SecondaryDirection`\ ) :ref:`🔗` + +Sets the joint limitation right axis at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_set_joint_limitation_right_axis_vector: + +.. rst-class:: classref-method + +|void| **set_joint_limitation_right_axis_vector**\ (\ index\: :ref:`int`, joint\: :ref:`int`, vector\: :ref:`Vector3`\ ) :ref:`🔗` + +Sets the optional joint limitation right axis vector at ``joint`` in the bone chain's joint list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_set_joint_limitation_rotation_offset: + +.. rst-class:: classref-method + +|void| **set_joint_limitation_rotation_offset**\ (\ index\: :ref:`int`, joint\: :ref:`int`, offset\: :ref:`Quaternion`\ ) :ref:`🔗` + +Sets the joint limitation rotation offset at ``joint`` in the bone chain's joint list. + +Rotation is done in the local space which is constructed by the bone direction (in general parent to child) as the +Y axis and :ref:`get_joint_limitation_right_axis_vector()` as the +X axis. + +If the +X and +Y axes are not orthogonal, the +X axis is implicitly modified to make it orthogonal. + +Also, if the length of :ref:`get_joint_limitation_right_axis_vector()` is zero, the space is created by rotating the bone rest using the shortest arc that rotates the +Y axis of the bone rest to match the bone direction. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_set_joint_rotation_axis: + +.. rst-class:: classref-method + +|void| **set_joint_rotation_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) :ref:`🔗` + +Sets the rotation axis at ``joint`` in the bone chain's joint list. + +The axes are based on the :ref:`Skeleton3D.get_bone_rest()`'s space, if ``axis`` is :ref:`SkeletonModifier3D.ROTATION_AXIS_CUSTOM`, you can specify any axis. + +\ **Note:** The rotation axis and the forward vector shouldn't be colinear to avoid unintended rotation since :ref:`ChainIK3D` does not factor in twisting forces. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_set_joint_rotation_axis_vector: + +.. rst-class:: classref-method + +|void| **set_joint_rotation_axis_vector**\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis_vector\: :ref:`Vector3`\ ) :ref:`🔗` + +Sets the rotation axis vector for the specified joint in the bone chain. + +This vector is normalized by an internal process and represents the axis around which the bone chain can rotate. + +If the vector length is ``0``, it is considered synonymous with :ref:`SkeletonModifier3D.ROTATION_AXIS_ALL`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_IterateIK3D_method_set_target_node: + +.. rst-class:: classref-method + +|void| **set_target_node**\ (\ index\: :ref:`int`, target_node\: :ref:`NodePath`\ ) :ref:`🔗` + +Sets the target node that the end bone is trying to reach. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_jacobianik3d.rst b/classes/class_jacobianik3d.rst new file mode 100644 index 00000000000..56d6e095003 --- /dev/null +++ b/classes/class_jacobianik3d.rst @@ -0,0 +1,36 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/JacobianIK3D.xml. + +.. _class_JacobianIK3D: + +JacobianIK3D +============ + +**Inherits:** :ref:`IterateIK3D` **<** :ref:`ChainIK3D` **<** :ref:`IKModifier3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +Jacobian transpose based inverse kinematics solver. + +.. rst-class:: classref-introduction-group + +Description +----------- + +**JacobianIK3D** calculates rotations for all joints simultaneously, producing natural and smooth movement. It is particularly suited for biological animations. + +The resulting twist around the forward vector will always be kept from the previous pose. + +\ **Note:** It converges more slowly than other IK solvers, leading to gentler and less immediate tracking of targets. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_jointlimitation3d.rst b/classes/class_jointlimitation3d.rst new file mode 100644 index 00000000000..7fba70ecb6e --- /dev/null +++ b/classes/class_jointlimitation3d.rst @@ -0,0 +1,34 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/JointLimitation3D.xml. + +.. _class_JointLimitation3D: + +JointLimitation3D +================= + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +**Inherited By:** :ref:`JointLimitationCone3D` + +A base class of the limitation that interacts with :ref:`ChainIK3D`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +The limitation is attached to each joint and limits the rotation of the bone. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_jointlimitationcone3d.rst b/classes/class_jointlimitationcone3d.rst new file mode 100644 index 00000000000..e9a40c68652 --- /dev/null +++ b/classes/class_jointlimitationcone3d.rst @@ -0,0 +1,68 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/JointLimitationCone3D.xml. + +.. _class_JointLimitationCone3D: + +JointLimitationCone3D +===================== + +**Inherits:** :ref:`JointLimitation3D` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +A cone shape limitation that interacts with :ref:`ChainIK3D`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +A cone shape limitation that interacts with :ref:`ChainIK3D`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+----------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`angle` | ``1.5707964`` | + +---------------------------+----------------------------------------------------------+---------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_JointLimitationCone3D_property_angle: + +.. rst-class:: classref-property + +:ref:`float` **angle** = ``1.5707964`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angle**\ (\ ) + +The radius range of the hole made by the cone. + +\ ``0`` degrees makes a sphere without hole, ``180`` degrees makes a hemisphere, and ``360`` degrees become empty (no limitation). + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_limitangularvelocitymodifier3d.rst b/classes/class_limitangularvelocitymodifier3d.rst new file mode 100644 index 00000000000..e4f9aa7ef3d --- /dev/null +++ b/classes/class_limitangularvelocitymodifier3d.rst @@ -0,0 +1,279 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/LimitAngularVelocityModifier3D.xml. + +.. _class_LimitAngularVelocityModifier3D: + +LimitAngularVelocityModifier3D +============================== + +**Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +Limit bone rotation angular velocity. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This modifier limits bone rotation angular velocity by comparing poses between previous and current frame. + +You can add bone chains by specifying their root and end bones, then add the bones between them to a list. Modifier processes either that list or the bones excluding those in the list depending on the option :ref:`exclude`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+-------------------------------------------------------------------------------------------------+---------------+ + | :ref:`int` | :ref:`chain_count` | ``0`` | + +---------------------------+-------------------------------------------------------------------------------------------------+---------------+ + | :ref:`bool` | :ref:`exclude` | ``false`` | + +---------------------------+-------------------------------------------------------------------------------------------------+---------------+ + | :ref:`int` | :ref:`joint_count` | ``0`` | + +---------------------------+-------------------------------------------------------------------------------------------------+---------------+ + | :ref:`float` | :ref:`max_angular_velocity` | ``6.2831855`` | + +---------------------------+-------------------------------------------------------------------------------------------------+---------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_chains`\ (\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_end_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_end_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_root_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_root_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_LimitAngularVelocityModifier3D_property_chain_count: + +.. rst-class:: classref-property + +:ref:`int` **chain_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_chain_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_chain_count**\ (\ ) + +The number of chains. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_property_exclude: + +.. rst-class:: classref-property + +:ref:`bool` **exclude** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_exclude**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_exclude**\ (\ ) + +If ``true``, the modifier processes bones not included in the bone list. + +If ``false``, the bones processed by the modifier are equal to the bone list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_property_joint_count: + +.. rst-class:: classref-property + +:ref:`int` **joint_count** = ``0`` :ref:`🔗` + +The number of joints in the list which created by chains dynamically. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_property_max_angular_velocity: + +.. rst-class:: classref-property + +:ref:`float` **max_angular_velocity** = ``6.2831855`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_max_angular_velocity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_angular_velocity**\ (\ ) + +The maximum angular velocity per second. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_LimitAngularVelocityModifier3D_method_clear_chains: + +.. rst-class:: classref-method + +|void| **clear_chains**\ (\ ) :ref:`🔗` + +Clear all chains. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_get_end_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_end_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_get_end_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_end_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_get_root_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_root_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_get_root_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_root_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone name of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_reset: + +.. rst-class:: classref-method + +|void| **reset**\ (\ ) :ref:`🔗` + +Sets the reference pose for angle comparison to the current pose with the influence of constraints removed. This function is automatically triggered when joints change or upon activation. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_set_end_bone: + +.. rst-class:: classref-method + +|void| **set_end_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the end bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_set_end_bone_name: + +.. rst-class:: classref-method + +|void| **set_end_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the end bone name of the bone chain. + +\ **Note:** End bone must be the root bone or a child of the root bone. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_set_root_bone: + +.. rst-class:: classref-method + +|void| **set_root_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the root bone index of the bone chain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LimitAngularVelocityModifier3D_method_set_root_bone_name: + +.. rst-class:: classref-method + +|void| **set_root_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the root bone name of the bone chain. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_lookatmodifier3d.rst b/classes/class_lookatmodifier3d.rst index 12c02153490..e494f703b44 100644 --- a/classes/class_lookatmodifier3d.rst +++ b/classes/class_lookatmodifier3d.rst @@ -68,6 +68,8 @@ Properties +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ | :ref:`Axis` | :ref:`primary_rotation_axis` | ``1`` | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`relative` | ``true`` | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`secondary_damp_threshold` | | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`secondary_limit_angle` | | @@ -475,6 +477,23 @@ The axis of the first rotation. This :ref:`SkeletonModifier3D` **relative** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_relative**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_relative**\ (\ ) + +The relative option. If ``true``, the rotation is applied relative to the pose. If ``false``, the rotation is applied relative to the rest. It means to replace the current pose with the **LookAtModifier3D**'s result. + +.. rst-class:: classref-item-separator + +---- + .. _class_LookAtModifier3D_property_secondary_damp_threshold: .. rst-class:: classref-property diff --git a/classes/class_node.rst b/classes/class_node.rst index 80a09533798..edd60973905 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1949,7 +1949,7 @@ If ``owned`` is ``true``, only descendants with a valid :ref:`owner` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match()`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. -If ``type`` is not empty, only ancestors inheriting from ``type`` are included (see :ref:`Object.is_class()`). +If ``type`` is not empty, only descendants inheriting from ``type`` are included (see :ref:`Object.is_class()`). If ``recursive`` is ``false``, only this node's direct children are checked. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. Internal children are also included in the search (see ``internal`` parameter in :ref:`add_child()`). diff --git a/classes/class_quaternion.rst b/classes/class_quaternion.rst index 6974574212c..86b457e11b3 100644 --- a/classes/class_quaternion.rst +++ b/classes/class_quaternion.rst @@ -94,45 +94,49 @@ Methods .. table:: :widths: auto - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Quaternion`\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Quaternion`\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`exp`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`from_euler`\ (\ euler\: :ref:`Vector3`\ ) |static| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_angle`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_axis`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_euler`\ (\ order\: :ref:`int` = 2\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`inverse`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Quaternion`\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`log`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`normalized`\ (\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`slerp`\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`slerpni`\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`spherical_cubic_interpolate`\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`spherical_cubic_interpolate_in_time`\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Quaternion`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Quaternion`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`exp`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`from_euler`\ (\ euler\: :ref:`Vector3`\ ) |static| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_angle`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_axis`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_euler`\ (\ order\: :ref:`int` = 2\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`inverse`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Quaternion`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`log`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`slerp`\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`slerpni`\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`spherical_cubic_interpolate`\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`spherical_cubic_interpolate_in_time`\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`spherical_monotonic_cubic_interpolate`\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`spherical_monotonic_cubic_interpolate_in_time`\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -570,6 +574,32 @@ Performs a spherical cubic interpolation between quaternions ``pre_a``, this vec It can perform smoother interpolation than :ref:`spherical_cubic_interpolate()` by the time values. +.. rst-class:: classref-item-separator + +---- + +.. _class_Quaternion_method_spherical_monotonic_cubic_interpolate: + +.. rst-class:: classref-method + +:ref:`Quaternion` **spherical_monotonic_cubic_interpolate**\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| :ref:`🔗` + +Performs a spherical monotonic cubic interpolation between quaternions ``pre_a``, this vector, ``b``, and ``post_b``, by the given amount ``weight``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Quaternion_method_spherical_monotonic_cubic_interpolate_in_time: + +.. rst-class:: classref-method + +:ref:`Quaternion` **spherical_monotonic_cubic_interpolate_in_time**\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| :ref:`🔗` + +Performs a spherical monotonic cubic interpolation between quaternions ``pre_a``, this vector, ``b``, and ``post_b``, by the given amount ``weight``. + +It can perform smoother interpolation than :ref:`spherical_monotonic_cubic_interpolate()` by the time values. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index b6f7a105882..7ac7db05b46 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`ImageFramesFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SignalSmith`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`ImageFramesFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`SoundSmith`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 2a3bbbf211c..49502a65a08 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -12,7 +12,7 @@ Resource **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`ColorPalette`, :ref:`Compositor`, :ref:`CompositorEffect`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`FoldableGroup`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImageFrames`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRBindingModifier`, :ref:`OpenXRHapticBase`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`ColorPalette`, :ref:`Compositor`, :ref:`CompositorEffect`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`FoldableGroup`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImageFrames`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JointLimitation3D`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRBindingModifier`, :ref:`OpenXRHapticBase`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` Base class for serializable objects. @@ -249,7 +249,7 @@ The unique path to this resource. If it has been saved to disk, the value will b - |void| **set_scene_unique_id**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_scene_unique_id**\ (\ ) -A unique identifier relative to the this resource's scene. If left empty, the ID is automatically generated when this resource is saved inside a :ref:`PackedScene`. If the resource is not inside a scene, this property is empty by default. +A unique identifier relative to this resource's scene. If left empty, the ID is automatically generated when this resource is saved inside a :ref:`PackedScene`. If the resource is not inside a scene, this property is empty by default. \ **Note:** When the :ref:`PackedScene` is saved, if multiple resources in the same scene use the same ID, only the earliest resource in the scene hierarchy keeps the original ID. The other resources are assigned new IDs from :ref:`generate_scene_unique_id()`. diff --git a/classes/class_skeletonmodifier3d.rst b/classes/class_skeletonmodifier3d.rst index 3f0074e4820..0869f567cee 100644 --- a/classes/class_skeletonmodifier3d.rst +++ b/classes/class_skeletonmodifier3d.rst @@ -12,7 +12,7 @@ SkeletonModifier3D **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BoneConstraint3D`, :ref:`LookAtModifier3D`, :ref:`ModifierBoneTarget3D`, :ref:`PhysicalBoneSimulator3D`, :ref:`RetargetModifier3D`, :ref:`SkeletonIK3D`, :ref:`SpringBoneSimulator3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` +**Inherited By:** :ref:`BoneConstraint3D`, :ref:`BoneTwistDisperser3D`, :ref:`IKModifier3D`, :ref:`LimitAngularVelocityModifier3D`, :ref:`LookAtModifier3D`, :ref:`ModifierBoneTarget3D`, :ref:`PhysicalBoneSimulator3D`, :ref:`RetargetModifier3D`, :ref:`SkeletonIK3D`, :ref:`SpringBoneSimulator3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` A node that may modify a Skeleton3D's bones. @@ -150,6 +150,196 @@ Enumerated value for the +Z axis. Enumerated value for the -Z axis. +.. rst-class:: classref-item-separator + +---- + +.. _enum_SkeletonModifier3D_BoneDirection: + +.. rst-class:: classref-enumeration + +enum **BoneDirection**: :ref:`🔗` + +.. _class_SkeletonModifier3D_constant_BONE_DIRECTION_PLUS_X: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneDirection` **BONE_DIRECTION_PLUS_X** = ``0`` + +Enumerated value for the +X axis. + +.. _class_SkeletonModifier3D_constant_BONE_DIRECTION_MINUS_X: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneDirection` **BONE_DIRECTION_MINUS_X** = ``1`` + +Enumerated value for the -X axis. + +.. _class_SkeletonModifier3D_constant_BONE_DIRECTION_PLUS_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneDirection` **BONE_DIRECTION_PLUS_Y** = ``2`` + +Enumerated value for the +Y axis. + +.. _class_SkeletonModifier3D_constant_BONE_DIRECTION_MINUS_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneDirection` **BONE_DIRECTION_MINUS_Y** = ``3`` + +Enumerated value for the -Y axis. + +.. _class_SkeletonModifier3D_constant_BONE_DIRECTION_PLUS_Z: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneDirection` **BONE_DIRECTION_PLUS_Z** = ``4`` + +Enumerated value for the +Z axis. + +.. _class_SkeletonModifier3D_constant_BONE_DIRECTION_MINUS_Z: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneDirection` **BONE_DIRECTION_MINUS_Z** = ``5`` + +Enumerated value for the -Z axis. + +.. _class_SkeletonModifier3D_constant_BONE_DIRECTION_FROM_PARENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`BoneDirection` **BONE_DIRECTION_FROM_PARENT** = ``6`` + +Enumerated value for the axis from a parent bone to the child bone. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_SkeletonModifier3D_SecondaryDirection: + +.. rst-class:: classref-enumeration + +enum **SecondaryDirection**: :ref:`🔗` + +.. _class_SkeletonModifier3D_constant_SECONDARY_DIRECTION_NONE: + +.. rst-class:: classref-enumeration-constant + +:ref:`SecondaryDirection` **SECONDARY_DIRECTION_NONE** = ``0`` + +Enumerated value for the case when the axis is undefined. + +.. _class_SkeletonModifier3D_constant_SECONDARY_DIRECTION_PLUS_X: + +.. rst-class:: classref-enumeration-constant + +:ref:`SecondaryDirection` **SECONDARY_DIRECTION_PLUS_X** = ``1`` + +Enumerated value for the +X axis. + +.. _class_SkeletonModifier3D_constant_SECONDARY_DIRECTION_MINUS_X: + +.. rst-class:: classref-enumeration-constant + +:ref:`SecondaryDirection` **SECONDARY_DIRECTION_MINUS_X** = ``2`` + +Enumerated value for the -X axis. + +.. _class_SkeletonModifier3D_constant_SECONDARY_DIRECTION_PLUS_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`SecondaryDirection` **SECONDARY_DIRECTION_PLUS_Y** = ``3`` + +Enumerated value for the +Y axis. + +.. _class_SkeletonModifier3D_constant_SECONDARY_DIRECTION_MINUS_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`SecondaryDirection` **SECONDARY_DIRECTION_MINUS_Y** = ``4`` + +Enumerated value for the -Y axis. + +.. _class_SkeletonModifier3D_constant_SECONDARY_DIRECTION_PLUS_Z: + +.. rst-class:: classref-enumeration-constant + +:ref:`SecondaryDirection` **SECONDARY_DIRECTION_PLUS_Z** = ``5`` + +Enumerated value for the +Z axis. + +.. _class_SkeletonModifier3D_constant_SECONDARY_DIRECTION_MINUS_Z: + +.. rst-class:: classref-enumeration-constant + +:ref:`SecondaryDirection` **SECONDARY_DIRECTION_MINUS_Z** = ``6`` + +Enumerated value for the -Z axis. + +.. _class_SkeletonModifier3D_constant_SECONDARY_DIRECTION_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`SecondaryDirection` **SECONDARY_DIRECTION_CUSTOM** = ``7`` + +Enumerated value for an optional axis. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_SkeletonModifier3D_RotationAxis: + +.. rst-class:: classref-enumeration + +enum **RotationAxis**: :ref:`🔗` + +.. _class_SkeletonModifier3D_constant_ROTATION_AXIS_X: + +.. rst-class:: classref-enumeration-constant + +:ref:`RotationAxis` **ROTATION_AXIS_X** = ``0`` + +Enumerated value for the rotation of the X axis. + +.. _class_SkeletonModifier3D_constant_ROTATION_AXIS_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`RotationAxis` **ROTATION_AXIS_Y** = ``1`` + +Enumerated value for the rotation of the Y axis. + +.. _class_SkeletonModifier3D_constant_ROTATION_AXIS_Z: + +.. rst-class:: classref-enumeration-constant + +:ref:`RotationAxis` **ROTATION_AXIS_Z** = ``2`` + +Enumerated value for the rotation of the Z axis. + +.. _class_SkeletonModifier3D_constant_ROTATION_AXIS_ALL: + +.. rst-class:: classref-enumeration-constant + +:ref:`RotationAxis` **ROTATION_AXIS_ALL** = ``3`` + +Enumerated value for the unconstrained rotation. + +.. _class_SkeletonModifier3D_constant_ROTATION_AXIS_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`RotationAxis` **ROTATION_AXIS_CUSTOM** = ``4`` + +Enumerated value for an optional rotation axis. + .. rst-class:: classref-section-separator ---- @@ -228,6 +418,8 @@ Override this virtual method to implement a custom skeleton modifier. You should \ ``delta`` is passed from parent :ref:`Skeleton3D`. See also :ref:`Skeleton3D.advance()`. +\ **Note:** This method may be called outside :ref:`Node._process()` and :ref:`Node._physics_process()` with ``delta`` is ``0.0``, since the modification should be processed immediately after initialization of the :ref:`Skeleton3D`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_signalsmith.rst b/classes/class_soundsmith.rst similarity index 70% rename from classes/class_signalsmith.rst rename to classes/class_soundsmith.rst index 5e2b4c82541..8015f82a363 100644 --- a/classes/class_signalsmith.rst +++ b/classes/class_soundsmith.rst @@ -3,23 +3,23 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Redot engine sources. .. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/SignalSmith.xml. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/SoundSmith.xml. -.. _class_SignalSmith: +.. _class_SoundSmith: -SignalSmith -=========== +SoundSmith +========== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -Performs time-stretching and pitch-shifting on raw audio buffers using Signalsmith. +Performs time-stretching and pitch-shifting on raw audio buffers using Soundsmith. .. rst-class:: classref-introduction-group Description ----------- -SignalSmith is a low-level audio processing utility which wraps the Signalsmith time-stretching library. It operates on raw interleaved floating-point PCM audio buffers and allows independent control of playback tempo and pitch. +SoundSmith is a low-level audio processing utility which wraps the Soundsmith time-stretching library. It operates on raw interleaved floating-point PCM audio buffers and allows independent control of playback tempo and pitch. .. rst-class:: classref-reftable-group @@ -29,25 +29,25 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamWAV` | :ref:`change_tempo`\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_channels`\ (\ ) |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_sample_rate`\ (\ ) |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`process`\ (\ input\: :ref:`PackedFloat32Array`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reset`\ (\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_channels`\ (\ channels\: :ref:`int`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_pitch`\ (\ pitch\: :ref:`float`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_sample_rate`\ (\ rate\: :ref:`int`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_tempo`\ (\ tempo\: :ref:`float`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamWAV` | :ref:`change_tempo`\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_channels`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_sample_rate`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`process`\ (\ input\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_channels`\ (\ channels\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pitch`\ (\ pitch\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_sample_rate`\ (\ rate\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tempo`\ (\ tempo\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -58,13 +58,13 @@ Methods Method Descriptions ------------------- -.. _class_SignalSmith_method_change_tempo: +.. _class_SoundSmith_method_change_tempo: .. rst-class:: classref-method -:ref:`AudioStreamWAV` **change_tempo**\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) :ref:`🔗` +:ref:`AudioStreamWAV` **change_tempo**\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) :ref:`🔗` -Loads an MP3 file, applies time-stretching and pitch-shifting using the Signalsmith engine, and returns a streamable AudioStreamWAV. +Loads an MP3 file, applies time-stretching and pitch-shifting using the Soundsmith engine, and returns a streamable AudioStreamWAV. The `tempo` parameter controls playback speed without affecting pitch. A value of `1.0` preserves the original speed. @@ -76,11 +76,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_get_last_channels: +.. _class_SoundSmith_method_get_last_channels: .. rst-class:: classref-method -:ref:`int` **get_last_channels**\ (\ ) |const| :ref:`🔗` +:ref:`int` **get_last_channels**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -90,11 +90,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_get_last_sample_rate: +.. _class_SoundSmith_method_get_last_sample_rate: .. rst-class:: classref-method -:ref:`int` **get_last_sample_rate**\ (\ ) |const| :ref:`🔗` +:ref:`int` **get_last_sample_rate**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -104,11 +104,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_process: +.. _class_SoundSmith_method_process: .. rst-class:: classref-method -:ref:`PackedFloat32Array` **process**\ (\ input\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` +:ref:`PackedFloat32Array` **process**\ (\ input\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Processes a block of interleaved audio samples and returns a new buffer containing the time-stretched and pitch-shifted result. @@ -118,11 +118,11 @@ The effective playback speed is determined by the ratio of input samples to outp ---- -.. _class_SignalSmith_method_reset: +.. _class_SoundSmith_method_reset: .. rst-class:: classref-method -|void| **reset**\ (\ ) :ref:`🔗` +|void| **reset**\ (\ ) :ref:`🔗` Resets the internal processing state. @@ -132,11 +132,11 @@ This should be called when restarting playback or discontinuously changing input ---- -.. _class_SignalSmith_method_set_channels: +.. _class_SoundSmith_method_set_channels: .. rst-class:: classref-method -|void| **set_channels**\ (\ channels\: :ref:`int`\ ) :ref:`🔗` +|void| **set_channels**\ (\ channels\: :ref:`int`\ ) :ref:`🔗` Sets the number of audio channels. @@ -146,11 +146,11 @@ Input and output buffers are expected to be interleaved according to this channe ---- -.. _class_SignalSmith_method_set_pitch: +.. _class_SoundSmith_method_set_pitch: .. rst-class:: classref-method -|void| **set_pitch**\ (\ pitch\: :ref:`float`\ ) :ref:`🔗` +|void| **set_pitch**\ (\ pitch\: :ref:`float`\ ) :ref:`🔗` Sets the pitch transpose factor. @@ -160,11 +160,11 @@ A value of `1.0` leaves pitch unchanged. Values greater than `1.0` raise pitch, ---- -.. _class_SignalSmith_method_set_sample_rate: +.. _class_SoundSmith_method_set_sample_rate: .. rst-class:: classref-method -|void| **set_sample_rate**\ (\ rate\: :ref:`int`\ ) :ref:`🔗` +|void| **set_sample_rate**\ (\ rate\: :ref:`int`\ ) :ref:`🔗` Sets the sample rate, in Hz, used by the internal processing engine. @@ -174,11 +174,11 @@ Changing the sample rate resets the internal state. ---- -.. _class_SignalSmith_method_set_tempo: +.. _class_SoundSmith_method_set_tempo: .. rst-class:: classref-method -|void| **set_tempo**\ (\ tempo\: :ref:`float`\ ) :ref:`🔗` +|void| **set_tempo**\ (\ tempo\: :ref:`float`\ ) :ref:`🔗` Sets the tempo multiplier used during processing. diff --git a/classes/class_splineik3d.rst b/classes/class_splineik3d.rst new file mode 100644 index 00000000000..2927b4e4b67 --- /dev/null +++ b/classes/class_splineik3d.rst @@ -0,0 +1,209 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/SplineIK3D.xml. + +.. _class_SplineIK3D: + +SplineIK3D +========== + +**Inherits:** :ref:`ChainIK3D` **<** :ref:`IKModifier3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +A :ref:`SkeletonModifier3D` for aligning bones along a :ref:`Path3D`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +A :ref:`SkeletonModifier3D` for aligning bones along a :ref:`Path3D`. The smoothness of the fitting depends on the :ref:`Curve3D.bake_interval`. + +If you want the :ref:`Path3D` to attach to a specific bone, it is recommended to place a :ref:`ModifierBoneTarget3D` before the **SplineIK3D** in the :ref:`SkeletonModifier3D` list (children of the :ref:`Skeleton3D`), and then place a :ref:`Path3D` as the :ref:`ModifierBoneTarget3D`'s child. + +Bone twist is determined based on the :ref:`Curve3D.get_point_tilt()`. + +If the root bone joint and the start point of the :ref:`Curve3D` are separated, it assumes that there is a linear line segment between them. This means that the vector pointing toward the start point of the :ref:`Curve3D` takes precedence over the shortest intersection point along the :ref:`Curve3D`. + +If the end bone joint exceeds the path length, it is bent as close as possible to the end point of the :ref:`Curve3D`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------+---------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-----------------------+---------------------------------------------------------------+-------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_path_3d`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tilt_fade_in`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tilt_fade_out`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_tilt_enabled`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_path_3d`\ (\ index\: :ref:`int`, path_3d\: :ref:`NodePath`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tilt_enabled`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tilt_fade_in`\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tilt_fade_out`\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_SplineIK3D_property_setting_count: + +.. rst-class:: classref-property + +:ref:`int` **setting_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_setting_count**\ (\ ) + +The number of settings. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_SplineIK3D_method_get_path_3d: + +.. rst-class:: classref-method + +:ref:`NodePath` **get_path_3d**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the node path of the :ref:`Path3D` which is describing the path. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplineIK3D_method_get_tilt_fade_in: + +.. rst-class:: classref-method + +:ref:`int` **get_tilt_fade_in**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the tilt interpolation method used between the root bone and the start point of the :ref:`Curve3D` when they are apart. See also :ref:`set_tilt_fade_in()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplineIK3D_method_get_tilt_fade_out: + +.. rst-class:: classref-method + +:ref:`int` **get_tilt_fade_out**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the tilt interpolation method used between the end bone and the end point of the :ref:`Curve3D` when they are apart. See also :ref:`set_tilt_fade_out()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplineIK3D_method_is_tilt_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **is_tilt_enabled**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns if the tilt property of the :ref:`Curve3D` affects the bone twist. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplineIK3D_method_set_path_3d: + +.. rst-class:: classref-method + +|void| **set_path_3d**\ (\ index\: :ref:`int`, path_3d\: :ref:`NodePath`\ ) :ref:`🔗` + +Sets the node path of the :ref:`Path3D` which is describing the path. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplineIK3D_method_set_tilt_enabled: + +.. rst-class:: classref-method + +|void| **set_tilt_enabled**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +Sets if the tilt property of the :ref:`Curve3D` should affect the bone twist. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplineIK3D_method_set_tilt_fade_in: + +.. rst-class:: classref-method + +|void| **set_tilt_fade_in**\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` + +If ``size`` is greater than ``0``, the tilt is interpolated between ``size`` start bones from the start point of the :ref:`Curve3D` when they are apart. + +If ``size`` is equal ``0``, the tilts between the root bone head and the start point of the :ref:`Curve3D` are unified with a tilt of the start point of the :ref:`Curve3D`. + +If ``size`` is less than ``0``, the tilts between the root bone and the start point of the :ref:`Curve3D` are ``0.0``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SplineIK3D_method_set_tilt_fade_out: + +.. rst-class:: classref-method + +|void| **set_tilt_fade_out**\ (\ index\: :ref:`int`, size\: :ref:`int`\ ) :ref:`🔗` + +If ``size`` is greater than ``0``, the tilt is interpolated between ``size`` end bones from the end point of the :ref:`Curve3D` when they are apart. + +If ``size`` is equal ``0``, the tilts between the end bone tail and the end point of the :ref:`Curve3D` are unified with a tilt of the end point of the :ref:`Curve3D`. + +If ``size`` is less than ``0``, the tilts between the end bone and the end point of the :ref:`Curve3D` are ``0.0``. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_springbonesimulator3d.rst b/classes/class_springbonesimulator3d.rst index db8384b0492..da9063ed237 100644 --- a/classes/class_springbonesimulator3d.rst +++ b/classes/class_springbonesimulator3d.rst @@ -41,11 +41,13 @@ Properties .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------+----------------------+ - | :ref:`Vector3` | :ref:`external_force` | ``Vector3(0, 0, 0)`` | - +-------------------------------+----------------------------------------------------------------------------+----------------------+ - | :ref:`int` | :ref:`setting_count` | ``0`` | - +-------------------------------+----------------------------------------------------------------------------+----------------------+ + +-------------------------------+----------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`external_force` | ``Vector3(0, 0, 0)`` | + +-------------------------------+----------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`mutable_bone_axes` | ``true`` | + +-------------------------------+----------------------------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group @@ -55,161 +57,161 @@ Methods .. table:: :widths: auto - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`are_all_child_collisions_enabled`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_collisions`\ (\ index\: :ref:`int`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_exclude_collisions`\ (\ index\: :ref:`int`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_settings`\ (\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_center_bone`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_center_bone_name`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CenterFrom` | :ref:`get_center_from`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_center_node`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_count`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_collision_path`\ (\ index\: :ref:`int`, collision\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_drag`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Curve` | :ref:`get_drag_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_end_bone`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BoneDirection` | :ref:`get_end_bone_direction`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_end_bone_length`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_end_bone_name`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_exclude_collision_count`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_exclude_collision_path`\ (\ index\: :ref:`int`, collision\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_gravity`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Curve` | :ref:`get_gravity_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_gravity_direction`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_joint_bone`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_joint_bone_name`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_joint_count`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_joint_drag`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_joint_gravity`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_joint_gravity_direction`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_joint_radius`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RotationAxis` | :ref:`get_joint_rotation_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_joint_rotation_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_joint_stiffness`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_radius`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Curve` | :ref:`get_radius_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_root_bone`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_root_bone_name`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RotationAxis` | :ref:`get_rotation_axis`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_rotation_axis_vector`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_stiffness`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Curve` | :ref:`get_stiffness_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_config_individual`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_end_bone_extended`\ (\ index\: :ref:`int`\ ) |const| | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reset`\ (\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_center_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_center_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_center_from`\ (\ index\: :ref:`int`, center_from\: :ref:`CenterFrom`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_center_node`\ (\ index\: :ref:`int`, node_path\: :ref:`NodePath`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_collision_count`\ (\ index\: :ref:`int`, count\: :ref:`int`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_collision_path`\ (\ index\: :ref:`int`, collision\: :ref:`int`, node_path\: :ref:`NodePath`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_drag`\ (\ index\: :ref:`int`, drag\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_drag_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_enable_all_child_collisions`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_end_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_end_bone_direction`\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_end_bone_length`\ (\ index\: :ref:`int`, length\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_end_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_exclude_collision_count`\ (\ index\: :ref:`int`, count\: :ref:`int`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_exclude_collision_path`\ (\ index\: :ref:`int`, collision\: :ref:`int`, node_path\: :ref:`NodePath`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_extend_end_bone`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gravity`\ (\ index\: :ref:`int`, gravity\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gravity_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_gravity_direction`\ (\ index\: :ref:`int`, gravity_direction\: :ref:`Vector3`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_individual_config`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_joint_drag`\ (\ index\: :ref:`int`, joint\: :ref:`int`, drag\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_joint_gravity`\ (\ index\: :ref:`int`, joint\: :ref:`int`, gravity\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_joint_gravity_direction`\ (\ index\: :ref:`int`, joint\: :ref:`int`, gravity_direction\: :ref:`Vector3`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_joint_radius`\ (\ index\: :ref:`int`, joint\: :ref:`int`, radius\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_joint_rotation_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_joint_rotation_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`, vector\: :ref:`Vector3`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_joint_stiffness`\ (\ index\: :ref:`int`, joint\: :ref:`int`, stiffness\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_radius`\ (\ index\: :ref:`int`, radius\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_radius_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_root_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_root_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_rotation_axis`\ (\ index\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_rotation_axis_vector`\ (\ index\: :ref:`int`, vector\: :ref:`Vector3`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_stiffness`\ (\ index\: :ref:`int`, stiffness\: :ref:`float`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_stiffness_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`are_all_child_collisions_enabled`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_collisions`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_exclude_collisions`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_settings`\ (\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_center_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_center_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CenterFrom` | :ref:`get_center_from`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_center_node`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_count`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_collision_path`\ (\ index\: :ref:`int`, collision\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_drag`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`get_drag_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_end_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BoneDirection` | :ref:`get_end_bone_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_end_bone_length`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_end_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_exclude_collision_count`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_exclude_collision_path`\ (\ index\: :ref:`int`, collision\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_gravity`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`get_gravity_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_gravity_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_bone`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_joint_bone_name`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_count`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_joint_drag`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_joint_gravity`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_joint_gravity_direction`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_joint_radius`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RotationAxis` | :ref:`get_joint_rotation_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_joint_rotation_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_joint_stiffness`\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_radius`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`get_radius_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_root_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_root_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RotationAxis` | :ref:`get_rotation_axis`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_rotation_axis_vector`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_stiffness`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`get_stiffness_damping_curve`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_config_individual`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_end_bone_extended`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_center_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_center_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_center_from`\ (\ index\: :ref:`int`, center_from\: :ref:`CenterFrom`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_center_node`\ (\ index\: :ref:`int`, node_path\: :ref:`NodePath`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_count`\ (\ index\: :ref:`int`, count\: :ref:`int`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_path`\ (\ index\: :ref:`int`, collision\: :ref:`int`, node_path\: :ref:`NodePath`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_drag`\ (\ index\: :ref:`int`, drag\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_drag_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_enable_all_child_collisions`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_direction`\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_length`\ (\ index\: :ref:`int`, length\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_exclude_collision_count`\ (\ index\: :ref:`int`, count\: :ref:`int`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_exclude_collision_path`\ (\ index\: :ref:`int`, collision\: :ref:`int`, node_path\: :ref:`NodePath`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_extend_end_bone`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gravity`\ (\ index\: :ref:`int`, gravity\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gravity_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gravity_direction`\ (\ index\: :ref:`int`, gravity_direction\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_individual_config`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_drag`\ (\ index\: :ref:`int`, joint\: :ref:`int`, drag\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_gravity`\ (\ index\: :ref:`int`, joint\: :ref:`int`, gravity\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_gravity_direction`\ (\ index\: :ref:`int`, joint\: :ref:`int`, gravity_direction\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_radius`\ (\ index\: :ref:`int`, joint\: :ref:`int`, radius\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_rotation_axis`\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_rotation_axis_vector`\ (\ index\: :ref:`int`, joint\: :ref:`int`, vector\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_stiffness`\ (\ index\: :ref:`int`, joint\: :ref:`int`, stiffness\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_radius`\ (\ index\: :ref:`int`, radius\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_radius_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_rotation_axis`\ (\ index\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_rotation_axis_vector`\ (\ index\: :ref:`int`, vector\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stiffness`\ (\ index\: :ref:`int`, stiffness\: :ref:`float`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stiffness_damping_curve`\ (\ index\: :ref:`int`, curve\: :ref:`Curve`\ ) | + +-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -220,72 +222,6 @@ Methods Enumerations ------------ -.. _enum_SpringBoneSimulator3D_BoneDirection: - -.. rst-class:: classref-enumeration - -enum **BoneDirection**: :ref:`🔗` - -.. _class_SpringBoneSimulator3D_constant_BONE_DIRECTION_PLUS_X: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneDirection` **BONE_DIRECTION_PLUS_X** = ``0`` - -Enumerated value for the +X axis. - -.. _class_SpringBoneSimulator3D_constant_BONE_DIRECTION_MINUS_X: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneDirection` **BONE_DIRECTION_MINUS_X** = ``1`` - -Enumerated value for the -X axis. - -.. _class_SpringBoneSimulator3D_constant_BONE_DIRECTION_PLUS_Y: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneDirection` **BONE_DIRECTION_PLUS_Y** = ``2`` - -Enumerated value for the +Y axis. - -.. _class_SpringBoneSimulator3D_constant_BONE_DIRECTION_MINUS_Y: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneDirection` **BONE_DIRECTION_MINUS_Y** = ``3`` - -Enumerated value for the -Y axis. - -.. _class_SpringBoneSimulator3D_constant_BONE_DIRECTION_PLUS_Z: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneDirection` **BONE_DIRECTION_PLUS_Z** = ``4`` - -Enumerated value for the +Z axis. - -.. _class_SpringBoneSimulator3D_constant_BONE_DIRECTION_MINUS_Z: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneDirection` **BONE_DIRECTION_MINUS_Z** = ``5`` - -Enumerated value for the -Z axis. - -.. _class_SpringBoneSimulator3D_constant_BONE_DIRECTION_FROM_PARENT: - -.. rst-class:: classref-enumeration-constant - -:ref:`BoneDirection` **BONE_DIRECTION_FROM_PARENT** = ``6`` - -Enumerated value for the axis from a parent bone to the child bone. - -.. rst-class:: classref-item-separator - ----- - .. _enum_SpringBoneSimulator3D_CenterFrom: .. rst-class:: classref-enumeration @@ -320,56 +256,6 @@ The bone pose origin of the parent :ref:`Skeleton3D` specified If :ref:`Node3D` is not found, the parent :ref:`Skeleton3D` is treated as center. -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpringBoneSimulator3D_RotationAxis: - -.. rst-class:: classref-enumeration - -enum **RotationAxis**: :ref:`🔗` - -.. _class_SpringBoneSimulator3D_constant_ROTATION_AXIS_X: - -.. rst-class:: classref-enumeration-constant - -:ref:`RotationAxis` **ROTATION_AXIS_X** = ``0`` - -Enumerated value for the rotation of the X axis. - -.. _class_SpringBoneSimulator3D_constant_ROTATION_AXIS_Y: - -.. rst-class:: classref-enumeration-constant - -:ref:`RotationAxis` **ROTATION_AXIS_Y** = ``1`` - -Enumerated value for the rotation of the Y axis. - -.. _class_SpringBoneSimulator3D_constant_ROTATION_AXIS_Z: - -.. rst-class:: classref-enumeration-constant - -:ref:`RotationAxis` **ROTATION_AXIS_Z** = ``2`` - -Enumerated value for the rotation of the Z axis. - -.. _class_SpringBoneSimulator3D_constant_ROTATION_AXIS_ALL: - -.. rst-class:: classref-enumeration-constant - -:ref:`RotationAxis` **ROTATION_AXIS_ALL** = ``3`` - -Enumerated value for the unconstrained rotation. - -.. _class_SpringBoneSimulator3D_constant_ROTATION_AXIS_CUSTOM: - -.. rst-class:: classref-enumeration-constant - -:ref:`RotationAxis` **ROTATION_AXIS_CUSTOM** = ``4`` - -Enumerated value for an optional rotation axis. See also :ref:`set_joint_rotation_axis_vector()`. - .. rst-class:: classref-section-separator ---- @@ -398,6 +284,25 @@ This is useful for effects such as wind and anti-gravity. ---- +.. _class_SpringBoneSimulator3D_property_mutable_bone_axes: + +.. rst-class:: classref-property + +:ref:`bool` **mutable_bone_axes** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mutable_bone_axes**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_bone_axes_mutable**\ (\ ) + +If ``true``, the solver retrieves the bone axis from the bone pose every frame. + +If ``false``, the solver retrieves the bone axis from the bone rest and caches it, which increases performance slightly, but position changes in the bone pose made before processing this **SpringBoneSimulator3D** are ignored. + +.. rst-class:: classref-item-separator + +---- + .. _class_SpringBoneSimulator3D_property_setting_count: .. rst-class:: classref-property @@ -580,9 +485,9 @@ Returns the end bone index of the bone chain. .. rst-class:: classref-method -:ref:`BoneDirection` **get_end_bone_direction**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` +:ref:`BoneDirection` **get_end_bone_direction**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the end bone's tail direction of the bone chain when :ref:`is_end_bone_extended()` is ``true``. +Returns the tail direction of the end bone of the bone chain when :ref:`is_end_bone_extended()` is ``true``. .. rst-class:: classref-item-separator @@ -594,7 +499,7 @@ Returns the end bone's tail direction of the bone chain when :ref:`is_end_bone_e :ref:`float` **get_end_bone_length**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the end bone's tail length of the bone chain when :ref:`is_end_bone_extended()` is ``true``. +Returns the end bone tail length of the bone chain when :ref:`is_end_bone_extended()` is ``true``. .. rst-class:: classref-item-separator @@ -760,7 +665,7 @@ Returns the radius at ``joint`` in the bone chain's joint list. .. rst-class:: classref-method -:ref:`RotationAxis` **get_joint_rotation_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` +:ref:`RotationAxis` **get_joint_rotation_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`\ ) |const| :ref:`🔗` Returns the rotation axis at ``joint`` in the bone chain's joint list. @@ -776,7 +681,7 @@ Returns the rotation axis at ``joint`` in the bone chain's joint list. Returns the rotation axis vector for the specified joint in the bone chain. This vector represents the axis around which the joint can rotate. It is determined based on the rotation axis set for the joint. -If :ref:`get_joint_rotation_axis()` is :ref:`ROTATION_AXIS_ALL`, this method returns ``Vector3(0, 0, 0)``. +If :ref:`get_joint_rotation_axis()` is :ref:`SkeletonModifier3D.ROTATION_AXIS_ALL`, this method returns ``Vector3(0, 0, 0)``. .. rst-class:: classref-item-separator @@ -846,7 +751,7 @@ Returns the root bone name of the bone chain. .. rst-class:: classref-method -:ref:`RotationAxis` **get_rotation_axis**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` +:ref:`RotationAxis` **get_rotation_axis**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the rotation axis of the bone chain. @@ -862,7 +767,7 @@ Returns the rotation axis of the bone chain. Returns the rotation axis vector of the bone chain. This vector represents the axis around which the bone chain can rotate. It is determined based on the rotation axis set for the bone chain. -If :ref:`get_rotation_axis()` is :ref:`ROTATION_AXIS_ALL`, this method returns ``Vector3(0, 0, 0)``. +If :ref:`get_rotation_axis()` is :ref:`SkeletonModifier3D.ROTATION_AXIS_ALL`, this method returns ``Vector3(0, 0, 0)``. .. rst-class:: classref-item-separator @@ -910,7 +815,7 @@ Returns ``true`` if the config can be edited individually for each joint. :ref:`bool` **is_end_bone_extended**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns ``true`` if the end bone is extended to have the tail. +Returns ``true`` if the end bone is extended to have a tail. .. rst-class:: classref-item-separator @@ -1064,7 +969,7 @@ Sets the end bone index of the bone chain. .. rst-class:: classref-method -|void| **set_end_bone_direction**\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) :ref:`🔗` +|void| **set_end_bone_direction**\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) :ref:`🔗` Sets the end bone tail direction of the bone chain when :ref:`is_end_bone_extended()` is ``true``. @@ -1128,11 +1033,9 @@ Sets the node path of the :ref:`SpringBoneCollision3D`, enabled\: :ref:`bool`\ ) :ref:`🔗` -If ``enabled`` is ``true``, the end bone is extended to have the tail. - -The extended tail config is allocated to the last element in the joint list. +If ``enabled`` is ``true``, the end bone is extended to have a tail. -In other words, if you set ``enabled`` is ``false``, the config of last element in the joint list has no effect in the simulated result. +The extended tail config is allocated to the last element in the joint list. In other words, if you set ``enabled`` to ``false``, the config of the last element in the joint list has no effect in the simulated result. .. rst-class:: classref-item-separator @@ -1244,11 +1147,11 @@ Sets the joint radius at ``joint`` in the bone chain's joint list when :ref:`is_ .. rst-class:: classref-method -|void| **set_joint_rotation_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) :ref:`🔗` +|void| **set_joint_rotation_axis**\ (\ index\: :ref:`int`, joint\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) :ref:`🔗` Sets the rotation axis at ``joint`` in the bone chain's joint list when :ref:`is_config_individual()` is ``true``. -The axes are based on the :ref:`Skeleton3D.get_bone_rest()`'s space, if ``axis`` is :ref:`ROTATION_AXIS_CUSTOM`, you can specify any axis. +The axes are based on the :ref:`Skeleton3D.get_bone_rest()`'s space, if ``axis`` is :ref:`SkeletonModifier3D.ROTATION_AXIS_CUSTOM`, you can specify any axis. \ **Note:** The rotation axis and the forward vector shouldn't be colinear to avoid unintended rotation since **SpringBoneSimulator3D** does not factor in twisting forces. @@ -1266,7 +1169,7 @@ Sets the rotation axis vector for the specified joint in the bone chain. This vector is normalized by an internal process and represents the axis around which the bone chain can rotate. -If the vector length is ``0``, it is considered synonymous with :ref:`ROTATION_AXIS_ALL`. +If the vector length is ``0``, it is considered synonymous with :ref:`SkeletonModifier3D.ROTATION_AXIS_ALL`. .. rst-class:: classref-item-separator @@ -1338,11 +1241,11 @@ Sets the root bone name of the bone chain. .. rst-class:: classref-method -|void| **set_rotation_axis**\ (\ index\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) :ref:`🔗` +|void| **set_rotation_axis**\ (\ index\: :ref:`int`, axis\: :ref:`RotationAxis`\ ) :ref:`🔗` Sets the rotation axis of the bone chain. If set to a specific axis, it acts like a hinge joint. The value is cached in each joint setting in the joint list. -The axes are based on the :ref:`Skeleton3D.get_bone_rest()`'s space, if ``axis`` is :ref:`ROTATION_AXIS_CUSTOM`, you can specify any axis. +The axes are based on the :ref:`Skeleton3D.get_bone_rest()`'s space, if ``axis`` is :ref:`SkeletonModifier3D.ROTATION_AXIS_CUSTOM`, you can specify any axis. \ **Note:** The rotation axis vector and the forward vector shouldn't be colinear to avoid unintended rotation since **SpringBoneSimulator3D** does not factor in twisting forces. @@ -1360,7 +1263,7 @@ Sets the rotation axis vector of the bone chain. The value is cached in each joi This vector is normalized by an internal process and represents the axis around which the bone chain can rotate. -If the vector length is ``0``, it is considered synonymous with :ref:`ROTATION_AXIS_ALL`. +If the vector length is ``0``, it is considered synonymous with :ref:`SkeletonModifier3D.ROTATION_AXIS_ALL`. .. rst-class:: classref-item-separator diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 702fbebc589..caeb28c73f5 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -711,6 +711,8 @@ If ``true``, column titles are visible. The number of columns. +Prints an error and does not allow setting the columns during mouse selection. + .. rst-class:: classref-item-separator ---- @@ -849,6 +851,8 @@ Method Descriptions Clears the tree. This removes all items. +Prints an error and does not allow clearing the tree if called during mouse selection. + .. rst-class:: classref-item-separator ---- @@ -865,6 +869,8 @@ If ``parent`` is ``null``, the root item will be the parent, or the new item wil The new item will be the ``index``-th child of parent, or it will be the last child if there are not enough siblings. +Prints an error and returns ``null`` if called during mouse selection, or if the ``parent`` does not belong to this tree. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_twoboneik3d.rst b/classes/class_twoboneik3d.rst new file mode 100644 index 00000000000..c207cb06914 --- /dev/null +++ b/classes/class_twoboneik3d.rst @@ -0,0 +1,491 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/TwoBoneIK3D.xml. + +.. _class_TwoBoneIK3D: + +TwoBoneIK3D +=========== + +**Inherits:** :ref:`IKModifier3D` **<** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +Rotation based intersection of two circles inverse kinematics solver. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This :ref:`IKModifier3D` requires a pole target. It provides deterministic results by constructing a plane from each joint and pole target and finding the intersection of two circles (disks in 3D). + +This IK can handle twist by setting the pole direction. If there are more than one bone between each set bone, their rotations are ignored, and the straight line connecting the root-middle and middle-end joints are treated as virtual bones. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------+----------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-----------------------+----------------------------------------------------------------+-------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_end_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BoneDirection` | :ref:`get_end_bone_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_end_bone_length`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_end_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_middle_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_middle_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SecondaryDirection` | :ref:`get_pole_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_pole_direction_vector`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_pole_node`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_root_bone`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_root_bone_name`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_target_node`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_end_bone_extended`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_using_virtual_end`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_direction`\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_length`\ (\ index\: :ref:`int`, length\: :ref:`float`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_extend_end_bone`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_middle_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_middle_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pole_direction`\ (\ index\: :ref:`int`, direction\: :ref:`SecondaryDirection`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pole_direction_vector`\ (\ index\: :ref:`int`, vector\: :ref:`Vector3`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pole_node`\ (\ index\: :ref:`int`, pole_node\: :ref:`NodePath`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_target_node`\ (\ index\: :ref:`int`, target_node\: :ref:`NodePath`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_use_virtual_end`\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_TwoBoneIK3D_property_setting_count: + +.. rst-class:: classref-property + +:ref:`int` **setting_count** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_setting_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_setting_count**\ (\ ) + +The number of settings. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_TwoBoneIK3D_method_get_end_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_end_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_end_bone_direction: + +.. rst-class:: classref-method + +:ref:`BoneDirection` **get_end_bone_direction**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone's tail direction when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_end_bone_length: + +.. rst-class:: classref-method + +:ref:`float` **get_end_bone_length**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone tail length of the bone chain when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_end_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_end_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the end bone name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_middle_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_middle_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the middle bone index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_middle_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_middle_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the middle bone name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_pole_direction: + +.. rst-class:: classref-method + +:ref:`SecondaryDirection` **get_pole_direction**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the pole direction. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_pole_direction_vector: + +.. rst-class:: classref-method + +:ref:`Vector3` **get_pole_direction_vector**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the pole direction vector. + +If :ref:`get_pole_direction()` is :ref:`SkeletonModifier3D.SECONDARY_DIRECTION_NONE`, this method returns ``Vector3(0, 0, 0)``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_pole_node: + +.. rst-class:: classref-method + +:ref:`NodePath` **get_pole_node**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the pole target node that constructs a plane which the joints are all on and the pole is trying to direct. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_root_bone: + +.. rst-class:: classref-method + +:ref:`int` **get_root_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_root_bone_name: + +.. rst-class:: classref-method + +:ref:`String` **get_root_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the root bone name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_get_target_node: + +.. rst-class:: classref-method + +:ref:`NodePath` **get_target_node**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the target node that the end bone is trying to reach. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_is_end_bone_extended: + +.. rst-class:: classref-method + +:ref:`bool` **is_end_bone_extended**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if the end bone is extended to have a tail. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_is_using_virtual_end: + +.. rst-class:: classref-method + +:ref:`bool` **is_using_virtual_end**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns ``true`` if the end bone is extended from the middle bone as a virtual bone. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_end_bone: + +.. rst-class:: classref-method + +|void| **set_end_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the end bone index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_end_bone_direction: + +.. rst-class:: classref-method + +|void| **set_end_bone_direction**\ (\ index\: :ref:`int`, bone_direction\: :ref:`BoneDirection`\ ) :ref:`🔗` + +Sets the end bone tail direction when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_end_bone_length: + +.. rst-class:: classref-method + +|void| **set_end_bone_length**\ (\ index\: :ref:`int`, length\: :ref:`float`\ ) :ref:`🔗` + +Sets the end bone tail length when :ref:`is_end_bone_extended()` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_end_bone_name: + +.. rst-class:: classref-method + +|void| **set_end_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the end bone name. + +\ **Note:** The end bone must be a child of the middle bone. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_extend_end_bone: + +.. rst-class:: classref-method + +|void| **set_extend_end_bone**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +If ``enabled`` is ``true``, the end bone is extended to have a tail. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_middle_bone: + +.. rst-class:: classref-method + +|void| **set_middle_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the middle bone index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_middle_bone_name: + +.. rst-class:: classref-method + +|void| **set_middle_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the middle bone name. + +\ **Note:** The middle bone must be a child of the root bone. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_pole_direction: + +.. rst-class:: classref-method + +|void| **set_pole_direction**\ (\ index\: :ref:`int`, direction\: :ref:`SecondaryDirection`\ ) :ref:`🔗` + +Sets the pole direction. + +The pole is on the middle bone and will direct to the pole target. + +The rotation axis is a vector that is orthogonal to this and the forward vector. + +\ **Note:** The pole direction and the forward vector shouldn't be colinear to avoid unintended rotation. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_pole_direction_vector: + +.. rst-class:: classref-method + +|void| **set_pole_direction_vector**\ (\ index\: :ref:`int`, vector\: :ref:`Vector3`\ ) :ref:`🔗` + +Sets the pole direction vector. + +This vector is normalized by an internal process. + +If the vector length is ``0``, it is considered synonymous with :ref:`SkeletonModifier3D.SECONDARY_DIRECTION_NONE`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_pole_node: + +.. rst-class:: classref-method + +|void| **set_pole_node**\ (\ index\: :ref:`int`, pole_node\: :ref:`NodePath`\ ) :ref:`🔗` + +Sets the pole target node that constructs a plane which the joints are all on and the pole is trying to direct. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_root_bone: + +.. rst-class:: classref-method + +|void| **set_root_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` + +Sets the root bone index. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_root_bone_name: + +.. rst-class:: classref-method + +|void| **set_root_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` + +Sets the root bone name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_target_node: + +.. rst-class:: classref-method + +|void| **set_target_node**\ (\ index\: :ref:`int`, target_node\: :ref:`NodePath`\ ) :ref:`🔗` + +Sets the target node that the end bone is trying to reach. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TwoBoneIK3D_method_set_use_virtual_end: + +.. rst-class:: classref-method + +|void| **set_use_virtual_end**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` + +If ``enabled`` is ``true``, the end bone is extended from the middle bone as a virtual bone. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |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.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index a45cf7d9d68..b46fcdc83c8 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -82,103 +82,107 @@ Methods .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`abs`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_to_point`\ (\ to\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`aspect`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`bezier_derivative`\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`bezier_interpolate`\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`bounce`\ (\ n\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`ceil`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`clamp`\ (\ min\: :ref:`Vector2`, max\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cross`\ (\ with\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`direction_to`\ (\ to\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`floor`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`from_angle`\ (\ angle\: :ref:`float`\ ) |static| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`lerp`\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`limit_length`\ (\ length\: :ref:`float` = 1.0\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`max`\ (\ with\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`min`\ (\ with\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`move_toward`\ (\ to\: :ref:`Vector2`, delta\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`normalized`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`orthogonal`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`posmodv`\ (\ modv\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`project`\ (\ b\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`reflect`\ (\ line\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`rotated`\ (\ angle\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`round`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`sign`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`slerp`\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`slide`\ (\ n\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`snapped`\ (\ step\: :ref:`Vector2`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`abs`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_to_point`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`aspect`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`bezier_derivative`\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`bezier_interpolate`\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`bounce`\ (\ n\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`ceil`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`clamp`\ (\ min\: :ref:`Vector2`, max\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cross`\ (\ with\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`direction_to`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`floor`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`from_angle`\ (\ angle\: :ref:`float`\ ) |static| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`lerp`\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`limit_length`\ (\ length\: :ref:`float` = 1.0\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`max`\ (\ with\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`min`\ (\ with\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`monotonic_cubic_interpolate`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`monotonic_cubic_interpolate_in_time`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`move_toward`\ (\ to\: :ref:`Vector2`, delta\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`orthogonal`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`posmodv`\ (\ modv\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`project`\ (\ b\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`reflect`\ (\ line\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`rotated`\ (\ angle\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`round`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`sign`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`slerp`\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`slide`\ (\ n\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`snapped`\ (\ step\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -855,6 +859,32 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector2 ---- +.. _class_Vector2_method_monotonic_cubic_interpolate: + +.. rst-class:: classref-method + +:ref:`Vector2` **monotonic_cubic_interpolate**\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| :ref:`🔗` + +Performs a monotonic cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector2_method_monotonic_cubic_interpolate_in_time: + +.. rst-class:: classref-method + +:ref:`Vector2` **monotonic_cubic_interpolate_in_time**\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| :ref:`🔗` + +Performs a monotonic cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. + +It can perform smoother interpolation than :ref:`monotonic_cubic_interpolate()` by the time values. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2_method_move_toward: .. rst-class:: classref-method diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 6e4b7c7f264..0a812dac32a 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -84,103 +84,107 @@ Methods .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`abs`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`bezier_derivative`\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`bezier_interpolate`\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`bounce`\ (\ n\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`ceil`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`clamp`\ (\ min\: :ref:`Vector3`, max\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`cross`\ (\ with\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`direction_to`\ (\ to\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`floor`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`inverse`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`lerp`\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`limit_length`\ (\ length\: :ref:`float` = 1.0\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`max`\ (\ with\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`min`\ (\ with\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`move_toward`\ (\ to\: :ref:`Vector3`, delta\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`normalized`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`octahedron_decode`\ (\ uv\: :ref:`Vector2`\ ) |static| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`octahedron_encode`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`outer`\ (\ with\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`posmodv`\ (\ modv\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`project`\ (\ b\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`reflect`\ (\ n\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`rotated`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`round`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`sign`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`signed_angle_to`\ (\ to\: :ref:`Vector3`, axis\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`slerp`\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`slide`\ (\ n\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`snapped`\ (\ step\: :ref:`Vector3`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`abs`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`bezier_derivative`\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`bezier_interpolate`\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`bounce`\ (\ n\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`ceil`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`clamp`\ (\ min\: :ref:`Vector3`, max\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`cross`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`direction_to`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`floor`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`inverse`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`lerp`\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`limit_length`\ (\ length\: :ref:`float` = 1.0\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`max`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`min`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`monotonic_cubic_interpolate`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`monotonic_cubic_interpolate_in_time`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`move_toward`\ (\ to\: :ref:`Vector3`, delta\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`octahedron_decode`\ (\ uv\: :ref:`Vector2`\ ) |static| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`octahedron_encode`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`outer`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`posmodv`\ (\ modv\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`project`\ (\ b\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`reflect`\ (\ n\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`rotated`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`round`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`sign`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`signed_angle_to`\ (\ to\: :ref:`Vector3`, axis\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`slerp`\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`slide`\ (\ n\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`snapped`\ (\ step\: :ref:`Vector3`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -887,6 +891,32 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector3 ---- +.. _class_Vector3_method_monotonic_cubic_interpolate: + +.. rst-class:: classref-method + +:ref:`Vector3` **monotonic_cubic_interpolate**\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| :ref:`🔗` + +Performs a monotonic cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector3_method_monotonic_cubic_interpolate_in_time: + +.. rst-class:: classref-method + +:ref:`Vector3` **monotonic_cubic_interpolate_in_time**\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| :ref:`🔗` + +Performs a monotonic cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. + +It can perform smoother interpolation than :ref:`monotonic_cubic_interpolate()` by the time values. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3_method_move_toward: .. rst-class:: classref-method diff --git a/classes/class_vector4.rst b/classes/class_vector4.rst index c0382fc4ac7..97f2a8fb8cb 100644 --- a/classes/class_vector4.rst +++ b/classes/class_vector4.rst @@ -69,71 +69,75 @@ Methods .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`abs`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`ceil`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`clamp`\ (\ min\: :ref:`Vector4`, max\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`direction_to`\ (\ to\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`floor`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`inverse`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`lerp`\ (\ to\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`max`\ (\ with\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`min`\ (\ with\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`normalized`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`posmodv`\ (\ modv\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`round`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`sign`\ (\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`snapped`\ (\ step\: :ref:`Vector4`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`abs`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`ceil`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`clamp`\ (\ min\: :ref:`Vector4`, max\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`clampf`\ (\ min\: :ref:`float`, max\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`direction_to`\ (\ to\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`floor`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`inverse`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`lerp`\ (\ to\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`max`\ (\ with\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`maxf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`min`\ (\ with\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`minf`\ (\ with\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`monotonic_cubic_interpolate`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`monotonic_cubic_interpolate_in_time`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`posmodv`\ (\ modv\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`round`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`sign`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`snapped`\ (\ step\: :ref:`Vector4`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`snappedf`\ (\ step\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -678,6 +682,32 @@ Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4 ---- +.. _class_Vector4_method_monotonic_cubic_interpolate: + +.. rst-class:: classref-method + +:ref:`Vector4` **monotonic_cubic_interpolate**\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| :ref:`🔗` + +Performs a monotonic cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Vector4_method_monotonic_cubic_interpolate_in_time: + +.. rst-class:: classref-method + +:ref:`Vector4` **monotonic_cubic_interpolate_in_time**\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| :ref:`🔗` + +Performs a monotonic cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. + +It can perform smoother interpolation than :ref:`monotonic_cubic_interpolate()` by the time values. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector4_method_normalized: .. rst-class:: classref-method diff --git a/classes/index.rst b/classes/index.rst index 4eba42a0b5a..923fbf4e1d9 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -50,6 +50,7 @@ Nodes class_bone2d class_boneattachment3d class_boneconstraint3d + class_bonetwistdisperser3d class_boxcontainer class_button class_camera2d @@ -58,7 +59,9 @@ Nodes class_canvasitem class_canvaslayer class_canvasmodulate + class_ccdik3d class_centercontainer + class_chainik3d class_characterbody2d class_characterbody3d class_checkbox @@ -105,6 +108,7 @@ Nodes class_editorscriptpicker class_editorspinslider class_editortoaster + class_fabrik3d class_filedialog class_filesystemdock class_flowcontainer @@ -139,9 +143,12 @@ Nodes class_hslider class_hsplitcontainer class_httprequest + class_ikmodifier3d class_importermeshinstance3d class_instanceplaceholder class_itemlist + class_iterateik3d + class_jacobianik3d class_joint2d class_joint3d class_label @@ -151,6 +158,7 @@ Nodes class_lightmapgi class_lightmapprobe class_lightoccluder2d + class_limitangularvelocitymodifier3d class_line2d class_lineedit class_linkbutton @@ -245,6 +253,7 @@ Nodes class_sliderjoint3d class_softbody3d class_spinbox + class_splineik3d class_splitcontainer class_spotlight3d class_springarm3d @@ -272,6 +281,7 @@ Nodes class_timer class_touchscreenbutton class_tree + class_twoboneik3d class_vboxcontainer class_vehiclebody3d class_vehiclewheel3d @@ -479,6 +489,8 @@ Resources class_inputeventscreentouch class_inputeventshortcut class_inputeventwithmodifiers + class_jointlimitation3d + class_jointlimitationcone3d class_json class_labelsettings class_lightmapgidata @@ -969,8 +981,8 @@ Other objects class_scriptlanguageextension class_semaphore class_shaderincludedb - class_signalsmith class_skinreference + class_soundsmith class_streampeer class_streampeerbuffer class_streampeerextension