1、命名法
Tweener(补间器):一种控制某个值并对其进行动画处理的补间。
Sequence(序列):一种特殊的补间,它不直接控制某个值,而是控制其他补间并将它们作为一个组进行动画处理。
Tween(补间):一个通用术语,既指代 Tweener 也指代 Sequence。
Nested tween(嵌套补间):包含在 Sequence 中的补间。
前缀
前缀对于充分利用 IntelliSense 非常重要,所以尽量记住这些:
DO :前缀用于所有补间快捷方式(可以从已知对象,如变换或材质直接启动的操作)。
transform.DOMoveX(100, 1);
transform.DORestart();
DOTween.Play();
Set:所有可以链接到补间的设置(除了 From,因为它作为设置应用但并不真正属于设置)的前缀。
myTween.SetLoops(4, LoopType.Yoyo).SetSpeedBased();
On :用于所有可以链接到补间的回调函数。
myTween.OnStart(myStartFunction).OnComplete(myCompleteFunction);
2、DOTween.Init
首次创建补间时,DOTween 会使用默认值自动初始化自身。如果你希望手动初始化它(推荐),请在创建任何补间之前调用一次此方法(之后调用将不会有任何效果)。请注意,你仍然可以通过 DOTween 的全局设置随时更改所有初始化设置。另外,你可以将 SetCapacity 方法链接到 Init 方法上,这允许设置 Tweeners/Sequences 的初始容量(这与稍后调用 DOTween.SetTweensCapacity 是相同的)。
public static IDOTweenInit Init(bool? recycleAllByDefault = null, bool? useSafeMode = null, LogBehaviour? logBehaviour = null);
初始化 DOTween。调用时不带任何参数以使用你在 DOTween 的工具面板中设置的首选项(否则这些首选项将被传递的任何参数覆盖)。
recycleAllByDefault:如果为 TRUE,则所有新的补间都将被设置为可回收,这意味着当它们被销毁时不会真正销毁,而是会被放入池中并重用,而不是创建新的补间。此选项允许你通过重用补间来避免垃圾回收分配,但你需要小心处理补间引用,因为即使补间已被销毁,它们也可能依然活跃(因为它们可能已经被重新生成并作为完全不同的补间在使用)。
如果你希望在补间被销毁时自动将其引用设置为 NULL,可以使用 OnKill 回调,如下所示:
// 使用 OnKill 回调自动将补间引用设置为 NULL
myTween.OnKill(() => myTween = null);
你可以随时通过更改静态属性 DOTween.defaultRecyclable 来修改此设置,或者你可以使用 SetRecyclable 为每个补间单独设置回收行为。
useSafeMode:如果设置为 TRUE,补间会稍微慢一些,但更安全,允许 DOTween 自动处理诸如在补间运行时目标被销毁的情况。
警告:在 iOS 上,safeMode 仅在剥离级别设置为 "Strip Assemblies" 或脚本调用优化设置为 "Slow and Safe" 时有效,而在 Windows 10 WSA 上,如果选择了 Master Configuration 和 .NET,则不会生效。
logBehaviour:根据所选模式,DOTween 将记录仅错误、错误和警告,或所有信息加上附加信息。
// 示例 A:使用 DOTween 的工具面板中设置的首选项进行初始化
DOTween.Init();
// 示例 B:使用自定义设置进行初始化,并立即设置容量
DOTween.Init(true, true, LogBehaviour.Verbose).SetCapacity(200, 10);
3、创建一个Tweener
截至目前,DOTween
可以补间这些类型的值: float
,double
,int
,uint
,long
,ulong
,Vector2 / 3/4
,Quaternion
,Rect
,RectOffset
,Color
,string
(其中一些值可以通过特殊方式进行补间) 此外,您可以创建自定义DOTween
插件以补间自定义值类型。
有3种方法来创建一个Tweener
:在通用的方式,快捷方式和更多的通用方式。
A. 通用方式
这是最灵活的补间方式,允许你几乎任何值,公共或私有,静态或动态 (只是你知道,快捷方式实际上在后台使用通用方式)。
与快捷方式一样,通用方式具有FROM
备用版本。只需将From
链接到Tweener
,使补间表现为FROM
补间而不是TO
补间。
static DOTween.To(getter,setter,to,float duration)
B. 快捷方式
DOTween
包含一些已知Unity
对象的快捷方式,如Transform
,Rigidbody
和Material
。您可以直接从对这些对象的引用启动补间(这也将自动将对象本身设置为补间目标),如:
transform.DOMove(new Vector3(2,3,4), 1);rigidbody.DOMove(new Vector3(2,3,4), 1);material.DOColor(Color.green, 1);
除非另有说明,否则这些快捷方式中的每一个都具有FROM
备用版本。只需将From
链接到Tweener
,使补间表现为FROM
补间而不是TO
补间。
重要提示:当您将一个FROM
分配给补间时,目标将立即跳转到FROM
位置(就像“编写该行代码的那一刻”,而不是“补间开始的那一刻”)。
transform.DOMove(new Vector3(2,3,4), 1).From();rigidbody.DOMove(new Vector3(2,3,4), 1).From();material.DOColor(Color.green, 1).From();
AudioSource
DOFade(float to, float duration)
DOPitch(float to, float duration)
Camera
DOAspect(float to, float duration)
DOColor(Color to, float duration)
DOFarClipPlane(float to, float duration)
DOFieldOfView(float to, float duration)
DONearClipPlane(float to, float duration)
DOOrthoSize(float to, float duration)
DOPixelRect(Rect to, float duration)
DORect(Rect to, float duration)
DOShakePosition(float duration, float/Vector3 strength, int vibrato, bool fadeOut)
DOShakeRotation(float duration, float/Vector3 strength, int vibrato, float randomness bool fadeOut)
Light
DOColor(Color to, float duration)
DOIntensity(float to, float duration)
DOShadowStrength(float to, float duration)
可混合的补间
DOBlendableColor(Color to, float duration)
LineRenderer
DOColor(Color2 startValue, Color2 endValue, float duration)
Material
DOColor(Color to, float duration)
DOColor(Color to, string property, float duration)
DOFade(float to, float duration)
DOFade(float to, string property, float duration)
DOFloat(float to, string property, float duration)
DOGradientColor(Gradient to, float duration)
DOGradientColor(Gradient to, string property, float duration)
DOOffset(Vector2 to, float duration)
DOOffset(Vector2 to, string property, float duration)
DOTiling(Vector2 to, float duration)
DOTiling(Vector2 to, string property, float duration)
DOVector(Vector4 to, string property, float duration)
可混合的补间
DOBlendableColor(Color to, float duration)
DOBlendableColor(Color to, string property, float duration)
Rigidbody这些快捷方式在后台使用刚体的MovePosition
/ MoveRotation
方法,以正确设置与物理对象相关的内容。
DOMove(Vector3 to,float duration,bool snapping)
DOMoveX / DOMoveY / DOMoveZ(float to,float duration,bool snapping)
DOJump(Vector3 endValue,float jumpPower,int numJumps,float duration,bool snapping)
DORotate(Vector3 to, float duration, RotateMode mode)
DOLookAt(Vector3 towards, float duration, AxisConstraint axisConstraint = AxisConstraint.None, Vector3 up = Vector3.up)
PRO ONLY ➨ Spiral – no FROM
DOSpiral(float duration, Vector3 axis = null, SpiralMode mode = SpiralMode.Expand, float speed = 1, float frequency = 10, float depth = 0, bool snapping = false)
SpriteRenderer
DOColor(Color to, float duration)
DOFade(float to, float duration)
DOGradientColor(Gradient to, float duration)
C. 其他通用方法
这些是允许以特定方式补间值的其他通用方法。这些也有FROM
备用版本,除非另有说明。只需将From
链接到Tweener
,使补间表现为FROM
补间而不是TO
补间。
static DOTween.Punch(getter, setter, Vector3 direction, float duration, int vibrato, float elasticity)
static DOTween.Shake(getter, setter, float duration, float/Vector3 strength, int vibrato, float randomness, bool ignoreZAxis)
static DOTween.ToAlpha(getter, setter, float to, float duration)
static DOTween.ToArray(getter, setter, float to, float duration)
static DOTween.ToAxis(getter, setter, float to, float duration, AxisConstraint axis)
4、创建序列
序列类似于Tweeners
,但它们不是动画属性或值,而是将其他Tweeners
或Sequences
作为一组动画。序列可以包含在其他序列中,而不限制层次结构的深度。排序的补间不必一个接一个。您可以使用Insert
方法重叠补间。
补间(序列或Tweener
)只能嵌套在单个其他序列中,这意味着您不能在多个序列中重用相同的补间。此外,主序列将控制其所有嵌套元素,并且您将无法单独控制嵌套补间(将序列视为电影时间轴,一旦它第一次启动就会变为固定)。
重要提示:不要使用空序列。
1.获取要使用的新序列并将其存储为引用
static DOTween.Sequence()
2.将补间,间隔和回调添加到序列
请注意,所有这些方法都需要在序列开始之前应用(通常是在创建它之后的下一帧,除非它已暂停),否则它们将没有任何效果。另请注意,任何嵌套的Tweener
/ Sequence
都需要在将其添加到Sequence
之前完全创建,因为之后它将被锁定。
Append(Tween tween)AppendCallback(TweenCallback callback)AppendInterval(float interval)Insert(float atPosition, Tween tween)InsertCallback(float atPosition, TweenCallback callback)Join(Tween tween)Prepend(Tween tween)PrependCallback(TweenCallback callback)PrependInterval(float interval)
// 创建一个 Sequence
Sequence mySequence = DOTween.Sequence();// 在 Sequence 的开头添加一个 1 秒的延迟
mySequence.PrependInterval(1);// 在 Sequence 的末尾添加一个移动 Tween,物体将在 X 轴上移动到 45,耗时 1 秒
mySequence.Append(transform.DOMoveX(45, 1));// 在移动 Tween 完成后,添加一个旋转 Tween,物体将旋转到 (0, 180, 0) 的角度,耗时 1 秒
mySequence.Append(transform.DORotate(new Vector3(0, 180, 0), 1));// 在 Sequence 的 0 秒处插入一个缩放 Tween,物体将缩放到 (3, 3, 3) 的大小,持续整个 Sequence 的时长
mySequence.Insert(0, transform.DOScale(new Vector3(3, 3, 3), mySequence.Duration()));动画流程
延迟 1 秒:Sequence 开始前会等待 1 秒。
移动动画:物体在 X 轴上从当前位置移动到 45,耗时 1 秒。
旋转动画:物体旋转到 (0, 180, 0) 的角度,耗时 1 秒。
缩放动画:物体从 Sequence 开始时就逐渐缩放到 (3, 3, 3) 的大小,持续整个 Sequence 的时长。Sequence mySequence = DOTween.Sequence();mySequence.Append(transform.DOMoveX(45, 1)).Append(transform.DORotate(new Vector3(0,180,0), 1)).PrependInterval(1).Insert(0, transform.DOScale(new Vector3(3,3,3), mySequence.Duration()));
5、设置,选项和回调
在将设置应用于补间时,DOTween
使用链接方法。或者,您可以更改将应用于所有新创建的补间的全局默认选项。
全局设置
static LogBehaviour DOTween.logBehaviourstatic bool DOTween.maxSmoothUnscaledTimestatic bool DOTween.showUnityEditorReportstatic float DOTween.timeScalestatic bool DOTween.useSafeModestatic bool DOTween.useSmoothDeltaTimestatic DOTween.SetTweensCapacity(int maxTweeners, int maxSequences)
应用于所有新创建的补间的设置
static bool DOTween.defaultAutoKillstatic AutoPlay DOTween.defaultAutoPlaystatic float DOTween.defaultEaseOvershootOrAmplitudestatic float DOTween.defaultEasePeriodstatic Ease DOTween.defaultEaseTypestatic LoopType DOTween.defaultLoopTypestatic bool DOTween.defaultRecyclablestatic bool DOTween.defaultTimeScaleIndependentstatic UpdateType DOTween.defaultUpdateType
Tweener 和 Sequence 设置
SetAs(Tween tween \ TweenParams tweenParams)SetAutoKill(bool autoKillOnCompletion = true)SetEase(Ease easeType \ AnimationCurve animCurve \ EaseFunction customEase)SetId(object id)SetLoops(int loops, LoopType loopType = LoopType.Restart)SetRecyclable(bool recyclable)SetRelative(bool isRelative = true)SetUpdate(UpdateType updateType, bool isIndependentUpdate = false)
OnComplete(TweenCallback callback)OnKill(TweenCallback callback)OnPlay(TweenCallback callback)OnPause(TweenCallback callback)OnRewind(TweenCallback callback)OnStart(TweenCallback callback)OnStepComplete(TweenCallback callback)OnUpdate(TweenCallback callback)OnWaypointChange(TweenCallback<int> callback)
特定于Tweener的设置和选项
这些设置特定于Tweeners
,对序列没有影响。 除了SetEase
在补间运行时链接这些设置将不起作用。
From(bool isRelative = false)SetDelay(float delay)SetSpeedBased(bool isSpeedBased = true)
需要记住的重要一点是,虽然所有其他设置可以按任何顺序链接在一起,但SetOptions
必须在补间创建功能之后立即链接,否则它将不再可用。
DOPath特定选项
Path tween ➨ SetOptions(bool closePath, AxisConstraint lockPosition = AxisConstraint.None, AxisConstraint lockRotation = AxisConstraint.None)Path tween ➨ SetLookAt(Vector3 lookAtPosition/lookAtTarget/lookAhead, Vector3 forwardDirection, Vector3 up = Vector3.up)
6、路径动画 API
1. 路径动画概述
路径动画允许物体沿着指定的路径移动。Dotween 提供了两种主要的路径动画方式:
-
使用
DOPath
: 物体沿着路径移动,但不会调整自身方向。 -
使用
DOLocalPath
: 物体沿着局部路径移动。 -
使用
DOPath
和PathType.CatmullRom
: 使用 Catmull-Rom 样条曲线生成平滑路径。
2.解析
2.1 transform.DOPath
让物体沿着指定的路径点移动。
参数:
-
path
(Vector3[]): 路径点的数组。 -
duration
(float): 动画持续时间。 -
pathType
(PathType): 路径类型,默认为直线路径(PathType.Linear
)。 -
pathMode
(PathMode): 路径模式,默认为 3D 路径(PathMode.Full3D
)。 -
resolution
(int): 路径分辨率,默认为 10。 -
gizmoColor
(Color): 在 Scene 视图中绘制路径的颜色。
// 定义路径点
Vector3[] pathPoints = new Vector3[] {new Vector3(0, 0, 0),new Vector3(5, 5, 0),new Vector3(10, 0, 0)
};// 让物体沿着路径移动,耗时 3 秒
transform.DOPath(pathPoints, 3, PathType.CatmullRom).SetEase(Ease.Linear).OnComplete(() => Debug.Log("路径动画完成"));
2.2 transform.DOLocalPath
让物体沿着局部坐标系下的路径移动。
参数:
与 DOPath
相同。
// 定义局部路径点
Vector3[] localPathPoints = new Vector3[] {new Vector3(0, 0, 0),new Vector3(2, 2, 0),new Vector3(4, 0, 0)
};// 让物体沿着局部路径移动,耗时 2 秒
transform.DOLocalPath(localPathPoints, 2, PathType.CatmullRom).SetEase(Ease.Linear);
2.3 transform.DOPath 的 LookAt 功能
让物体在移动时始终朝向路径方向。
参数:
-
lookAhead
(float): 向前看的位置偏移量,默认为 0.01。 -
forwardDirection
(Vector3): 物体的前方方向,默认为Vector3.forward
。 -
up
(Vector3): 物体的上方方向,默认为Vector3.up
。
// 让物体沿着路径移动,并始终朝向路径方向
transform.DOPath(pathPoints, 3, PathType.CatmullRom).SetLookAt(0.01f) // 朝向路径方向.SetEase(Ease.Linear);
2.4 tween.PathLength
计算路径的长度。
2.5t ween.PathGetPoint
参数:
-
t
(float): 时间点(0 到 1 之间)。
void Test_06(){Vector3[] pathPoints = new[] {new Vector3(0,1,0),new Vector3(0,2,0),new Vector3(0,3,0),new Vector3(0,4,0)};Tween tween = transform.DOPath(pathPoints, 3, PathType.Linear);tween.ForceInit();float pathLength = tween.PathLength();Debug.Log("路径长度: " + pathLength);// 获取路径上 50% 时间点的位置Vector3 point = tween.PathGetPoint(0.5f);Debug.Log("路径中点位置: " + point);}
3. 路径动画的高级功能
3.1 自定义路径缓动
可以通过 SetEase
方法设置路径动画的缓动函数。
// 使用缓动函数
transform.DOPath(pathPoints, 3, PathType.CatmullRom).SetEase(Ease.InOutSine);
3.2 路径动画的循环
可以通过 SetLoops
方法设置路径动画的循环次数。
// 让路径动画循环 3 次
transform.DOPath(pathPoints, 3, PathType.CatmullRom).SetLoops(3, LoopType.Restart);
3.3 路径动画的回调
可以通过 OnComplete
、OnStart
、OnUpdate
等方法设置路径动画的回调。
// 设置路径动画的回调
transform.DOPath(pathPoints, 3, PathType.CatmullRom).OnStart(() => Debug.Log("路径动画开始")).OnUpdate(() => Debug.Log("路径动画进行中")).OnComplete(() => Debug.Log("路径动画完成"));