diff options
| author | Luis Lopez <luisl@stellarscience.com> | 2020-04-28 07:34:27 -0600 |
|---|---|---|
| committer | Micky <micheledevita2@gmail.com> | 2022-10-04 17:14:03 +0200 |
| commit | c262589e26a5057e5d161af2961973caaecc1196 (patch) | |
| tree | 897c48ccb51bdf997495277e28cf60f6461946d1 /doc/classes | |
| parent | e5aa5eb8067fada41ad8ecb5027a7917d6d5084c (diff) | |
Add rotation smoothing to Camera2D
Camera2D has follow smoothing to interpolate towards a target position, but no rotation smoothing to align with the target rotation.
This adds rotation smoothing directly into the Camera2D API by having two new properties:
- `rotation_smoothing_enabled`
- `rotation_smoothing_speed`
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Camera2D.xml | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index a1d24f778d..671ecb6af1 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -150,6 +150,13 @@ <member name="process_callback" type="int" setter="set_process_callback" getter="get_process_callback" enum="Camera2D.Camera2DProcessCallback" default="1"> The camera's process callback. See [enum Camera2DProcessCallback]. </member> + <member name="rotation_smoothing_enabled" type="bool" setter="set_rotation_smoothing_enabled" getter="is_rotation_smoothing_enabled" default="false"> + If [code]true[/code], the camera's view smoothly rotates, via asymptotic smoothing, to align with its target rotation at [member rotation_smoothing_speed]. + [b]Note:[/b] This property has no effect if [member ignore_rotation] is [code]true[/code]. + </member> + <member name="rotation_smoothing_speed" type="float" setter="set_rotation_smoothing_speed" getter="get_rotation_smoothing_speed" default="5.0"> + The angular, asymptotic speed of the camera's rotation smoothing effect when [member rotation_smoothing_enabled] is [code]true[/code]. + </member> <member name="smoothing_enabled" type="bool" setter="set_enable_follow_smoothing" getter="is_follow_smoothing_enabled" default="false"> If [code]true[/code], the camera smoothly moves towards the target at [member smoothing_speed]. </member> |