QuickTween 1.4.1
Loading...
Searching...
No Matches
QuickColorTween.h
1// Copyright 2025 Juan Pablo Hernandez Mosti. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6#include "QuickTweenBase.h"
7#include "QuickColorTween.generated.h"
8
10DECLARE_DELEGATE_RetVal_OneParam(FColor, FNativeColorGetter, UQuickColorTween*);
11DECLARE_DELEGATE_TwoParams( FNativeColorSetter, const FColor&, UQuickColorTween* );
12
17UCLASS(BlueprintType)
18class QUICKTWEEN_API UQuickColorTween : public UQuickTweenBase
19{
20 GENERATED_BODY()
21private:
22 UQuickColorTween() = default;
23
27 void SetUp(
28 const UObject* worldContextObject,
29 FNativeColorGetter from,
30 FNativeColorGetter to,
31 FNativeColorSetter setter,
32 float duration = 1.0f,
33 float timeScale = 1.0f,
34 EEaseType easeType = EEaseType::Linear,
35 UCurveFloat* easeCurve = nullptr,
36 int32 loops = 1,
37 ELoopType loopType = ELoopType::Restart,
38 const FString& tweenTag = FString(),
39 bool bShouldAutoKill = true,
40 bool bShouldPlayWhilePaused = false,
41 bool bShouldAutoPlay = false)
42 {
43 From = MoveTemp(from);
44 To = MoveTemp(to);
45 Setter = MoveTemp(setter);
47 worldContextObject,
48 duration,
49 timeScale,
50 easeType,
51 easeCurve,
52 loops,
53 loopType,
54 tweenTag,
55 bShouldAutoKill,
56 bShouldPlayWhilePaused,
57 bShouldAutoPlay);
58
59 }
60public:
61
82 static UQuickColorTween* CreateTween(
83 UObject* worldContextObject,
84 FNativeColorGetter from,
85 FNativeColorGetter to,
86 FNativeColorSetter setter,
87 float duration = 1.0f,
88 float timeScale = 1.0f,
89 EEaseType easeType = EEaseType::Linear,
90 UCurveFloat* easeCurve = nullptr,
91 int32 loops = 1,
92 ELoopType loopType = ELoopType::Restart,
93 const FString& tweenTag = FString(),
94 bool bShouldAutoKill = true,
95 bool bShouldPlayWhilePaused = false,
96 bool bShouldAutoPlay = false)
97 {
98 if (!from.IsBound() || !to.IsBound() || !setter.IsBound())
99 {
100 UE_LOG(LogQuickTweenBase, Warning, TEXT("UQuickColorTween::CreateTween: One or more delegate functions are not bound."));
101 return nullptr;
102 }
103
104 UQuickColorTween* tween = NewObject<UQuickColorTween>(worldContextObject);
105 tween->SetUp(
106 worldContextObject,
107 MoveTemp(from),
108 MoveTemp(to),
109 MoveTemp(setter),
110 duration,
111 timeScale,
112 easeType,
113 easeCurve,
114 loops,
115 loopType,
116 tweenTag,
117 bShouldAutoKill,
118 bShouldPlayWhilePaused,
119 bShouldAutoPlay);
120 return tween;
121 }
122
124 UFUNCTION(BlueprintPure, meta = (Keywords = "Tween"), Category = "Tween|Info")
125 [[nodiscard]] FColor GetCurrentValue() const { return CurrentValue; }
126
128 UFUNCTION(BlueprintPure, meta = (Keywords = "Tween"), Category = "Tween|Info")
129 [[nodiscard]] FColor GetStartValue() const { return StartValue.Get(FColor::White); }
130
132 UFUNCTION(BlueprintPure, meta = (Keywords = "Tween"), Category = "Tween|Info")
133 [[nodiscard]] FColor GetEndValue() const { return EndValue.Get(FColor::White); }
134protected:
135 virtual void ApplyAlphaValue(float alpha) override;
136
137 virtual void HandleOnStart() override;
138
139 virtual void HandleOnComplete() override;
140
141private:
143 FNativeColorGetter From;
144
146 FNativeColorGetter To;
147
149 TOptional<FColor> StartValue;
150
152 TOptional<FColor> EndValue;
153
155 FNativeColorSetter Setter;
156
158 FColor CurrentValue;
159};
Definition QuickColorTween.h:19
virtual void ApplyAlphaValue(float alpha) override
Definition QuickColorTween.cpp:8
virtual void HandleOnStart() override
Definition QuickColorTween.cpp:23
FColor GetStartValue() const
Definition QuickColorTween.h:129
virtual void HandleOnComplete() override
Definition QuickColorTween.cpp:48
FColor GetEndValue() const
Definition QuickColorTween.h:133
static UQuickColorTween * CreateTween(UObject *worldContextObject, FNativeColorGetter from, FNativeColorGetter to, FNativeColorSetter setter, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag=FString(), bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
Definition QuickColorTween.h:82
FColor GetCurrentValue() const
Definition QuickColorTween.h:125
Definition QuickTweenBase.h:26
void SetUp(const UObject *worldContextObject, float duration, float timeScale, EEaseType easeType, UCurveFloat *easeCurve, int32 loops, ELoopType loopType, const FString &tweenTag=FString(), bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
Definition QuickTweenBase.cpp:20