Skip to content

Commit b88cb31

Browse files
aXu-APWhalesState
authored andcommitted
Add support for Transform2D/3D in lerp()
Implements godotengine/godot-proposals#10579
1 parent e82fc92 commit b88cb31

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

core/variant/variant_utility.cpp

+9-1
Original file line numberDiff line numberDiff line change
@@ -452,12 +452,14 @@ Variant VariantUtilityFunctions::lerp(const Variant &from, const Variant &to, do
452452
case Variant::QUATERNION:
453453
case Variant::BASIS:
454454
case Variant::COLOR:
455+
case Variant::TRANSFORM2D:
456+
case Variant::TRANSFORM3D:
455457
break;
456458
default:
457459
r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
458460
r_error.argument = 0;
459461
r_error.expected = Variant::NIL;
460-
return R"(Argument "from" must be "int", "float", "Vector2", "Vector3", "Vector4", "Quaternion", "Basis, or "Color".)";
462+
return R"(Argument "from" must be "int", "float", "Vector2", "Vector3", "Vector4", "Color", "Quaternion", "Basis", "Transform2D", or "Transform3D".)";
461463
}
462464

463465
if (from.get_type() != to.get_type()) {
@@ -490,6 +492,12 @@ Variant VariantUtilityFunctions::lerp(const Variant &from, const Variant &to, do
490492
case Variant::BASIS: {
491493
return VariantInternalAccessor<Basis>::get(&from).slerp(VariantInternalAccessor<Basis>::get(&to), weight);
492494
} break;
495+
case Variant::TRANSFORM2D: {
496+
return VariantInternalAccessor<Transform2D>::get(&from).interpolate_with(VariantInternalAccessor<Transform2D>::get(&to), weight);
497+
} break;
498+
case Variant::TRANSFORM3D: {
499+
return VariantInternalAccessor<Transform3D>::get(&from).interpolate_with(VariantInternalAccessor<Transform3D>::get(&to), weight);
500+
} break;
493501
case Variant::COLOR: {
494502
return VariantInternalAccessor<Color>::get(&from).lerp(VariantInternalAccessor<Color>::get(&to), weight);
495503
} break;

doc/classes/@GlobalScope.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -621,13 +621,13 @@
621621
<param index="1" name="to" type="Variant" />
622622
<param index="2" name="weight" type="Variant" />
623623
<description>
624-
Linearly interpolates between two values by the factor defined in [param weight]. To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method clamp] on the result of this function.
625-
Both [param from] and [param to] must be the same type. Supported types: [int], [float], [Vector2], [Vector3], [Vector4], [Color], [Quaternion], [Basis].
624+
Linearly interpolates between two values by the factor defined in [param weight]. To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method clampf] to limit [param weight].
625+
Both [param from] and [param to] must be the same type. Supported types: [int], [float], [Vector2], [Vector3], [Vector4], [Color], [Quaternion], [Basis], [Transform2D], [Transform3D].
626626
[codeblock]
627627
lerp(0, 4, 0.75) # Returns 3.0
628628
[/codeblock]
629629
See also [method inverse_lerp] which performs the reverse of this operation. To perform eased interpolation with [method lerp], combine it with [method ease] or [method smoothstep]. See also [method remap] to map a continuous series of values to another.
630-
[b]Note:[/b] For better type safety, use [method lerpf], [method Vector2.lerp], [method Vector3.lerp], [method Vector4.lerp], [method Color.lerp], [method Quaternion.slerp] or [method Basis.slerp].
630+
[b]Note:[/b] For better type safety, use [method lerpf], [method Vector2.lerp], [method Vector3.lerp], [method Vector4.lerp], [method Color.lerp], [method Quaternion.slerp], [method Basis.slerp], [method Transform2D.interpolate_with], or [method Transform3D.interpolate_with].
631631
</description>
632632
</method>
633633
<method name="lerp_angle" keywords="interpolate">

0 commit comments

Comments
 (0)