QuickTween 1.3
Loading...
Searching...
No Matches
UQuickVector2DTween Class Reference

#include <QuickVector2DTween.h>

Inheritance diagram for UQuickVector2DTween:
UQuickTweenBase UQuickTweenable

Public Member Functions

FVector2D GetCurrentValue () const
FVector2D GetStartValue () const
FVector2D GetEndValue () const
Public Member Functions inherited from UQuickTweenBase
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)
virtual void SetOwner (UQuickTweenable *owner) override
virtual void Play () override
virtual void Pause () override
virtual void Reverse () override
virtual void Restart () override
virtual void Complete (bool bSnapToEnd=true) override
virtual void Kill () override
virtual void Update (float deltaTime) override
virtual void Evaluate (bool bIsActive, float value, const UQuickTweenable *instigator) override
virtual bool GetIsPendingKill () const override
virtual float GetLoopDuration () const override
virtual float GetTotalDuration () const override
virtual float GetElapsedTime () const override
virtual float GetTimeScale () const override
virtual bool GetIsPlaying () const override
virtual bool GetIsCompleted () const override
virtual bool GetIsReversed () const override
virtual EEaseType GetEaseType () const override
virtual UCurveFloat * GetEaseCurve () const override
virtual int32 GetLoops () const override
virtual ELoopType GetLoopType () const override
virtual FString GetTweenTag () const override
virtual int32 GetCurrentLoop () const override
virtual bool GetAutoKill () const override
virtual bool GetShouldPlayWhilePaused () const override
bool GetSnapToEndOnComplete () const
bool InstigatorIsOwner (const UQuickTweenable *instigator) const
bool HasOwner () const
void AssignOnStartEvent (FDynamicDelegateTween callback)
void AssignOnUpdateEvent (FDynamicDelegateTween callback)
void AssignOnCompleteEvent (FDynamicDelegateTween callback)
void AssignOnKilledEvent (FDynamicDelegateTween callback)
void AssignOnLoopEvent (FDynamicDelegateTween callback)
void RemoveAllOnStartEvent (const UObject *object)
void RemoveAllOnUpdateEvent (const UObject *object)
void RemoveAllOnCompleteEvent (const UObject *object)
void RemoveAllOnKilledEvent (const UObject *object)
void RemoveAllOnLoopEvent (const UObject *object)

Static Public Member Functions

static UQuickVector2DTweenCreateTween (UObject *worldContextObject, FNativeVector2DGetter from, FNativeVector2DGetter to, FNativeVector2DSetter 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)

Protected Member Functions

virtual void ApplyAlphaValue (float alpha) override
virtual void HandleOnStart () override
virtual void HandleOnComplete () override
Protected Member Functions inherited from UQuickTweenBase
virtual void HandleOnKill ()

Additional Inherited Members

Public Attributes inherited from UQuickTweenBase
FNativeDelegateTween OnStart
FNativeDelegateTween OnUpdate
FNativeDelegateTween OnComplete
FNativeDelegateTween OnKilled
FNativeDelegateTween OnLoop

Detailed Description

Tween class for interpolating between two FVector2D values over time. Inherits from UQuickTweenBase and provides vector-specific tweening functionality.

Member Function Documentation

◆ ApplyAlphaValue()

void UQuickVector2DTween::ApplyAlphaValue ( float alpha)
overrideprotectedvirtual

Apply the interpolated alpha value to the tweened property.

Parameters
alphaInterpolated alpha value (0.0 to 1.0).

Reimplemented from UQuickTweenBase.

◆ CreateTween()

UQuickVector2DTween * UQuickVector2DTween::CreateTween ( UObject * worldContextObject,
FNativeVector2DGetter from,
FNativeVector2DGetter to,
FNativeVector2DSetter 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 )
inlinestatic

Create a new UQuickVector2DTween instance and initialize it.

Note: The start and end value will be cached at the first update.

Parameters
worldContextObjectContext object for world access.
fromFunction to get the FROM value.
toFunction to get the TO value.
setterFunction to apply the interpolated value.
durationDuration of the loop in seconds.
timeScaleMultiplier for the tween's speed.
easeTypeType of easing to apply.
easeCurveOptional custom curve for easing.
loopsNumber of times to loop the tween.
loopTypeType of looping behavior.
tweenTagOptional tag for identifying the tween.
bShouldAutoKillWhether to auto-kill the tween on completion.
bShouldPlayWhilePausedWhether the tween should play while the game is paused.
bShouldAutoPlayWhether to start playing the tween immediately after setup.

◆ GetCurrentValue()

FVector2D UQuickVector2DTween::GetCurrentValue ( ) const
inlinenodiscard

Get the current interpolated FVector2D value.

◆ GetEndValue()

FVector2D UQuickVector2DTween::GetEndValue ( ) const
inlinenodiscard

Get the ending FVector2D value. Set after the first tick

◆ GetStartValue()

FVector2D UQuickVector2DTween::GetStartValue ( ) const
inlinenodiscard

Get the starting FVector2D value. Set after the first tick

◆ HandleOnComplete()

void UQuickVector2DTween::HandleOnComplete ( )
overrideprotectedvirtual

Called when the tween transitions to the Complete state.

Reimplemented from UQuickTweenBase.

◆ HandleOnStart()

void UQuickVector2DTween::HandleOnStart ( )
overrideprotectedvirtual

Called when the tween transitions to the Start state.

This is invoked once when the tween begins. Implementations should perform any initialization required before the first update tick (e.g. set initial values, invoke start events).

Reimplemented from UQuickTweenBase.


The documentation for this class was generated from the following files:
  • D:/UnrealEngine/TweenPlugin/Plugins/QuickTween/Source/QuickTween/Public/Tweens/QuickVector2DTween.h
  • D:/UnrealEngine/TweenPlugin/Plugins/QuickTween/Source/QuickTween/Private/Tweens/QuickVector2DTween.cpp