Jumpvalley.Tweening.MethodTween Class Reference

Provides a way of tweening via Godot using method overrides.
The advantage of using this over a normal Godot Tween is that the Tween doesn't have to be in the scene tree in order to operate.
Another difference is that unlike a normal Godot Tween, this tween doesn't start automatically after being instantiated. Developers must call Resume() manually in order to get the tween running.
Syntax is inspired by JavaFX's animation package. More...

Inheritance diagram for Jumpvalley.Tweening.MethodTween:

Public Member Functions
	MethodTween (double transitionTime, Tween.TransitionType transitionType, Tween.EaseType easeType)
double	GetCurrentValue ()
	Returns the current value of the tween. This value is calculated by performing linear interpolation between InitialValue and EndingValue with the fraction between the value being CurrentFraction
bool	IsFinished ()
	Returns if the tween is finished. The tween is considered to be finished if one of the following is true: ElapsedTime equals TransitionTime when Speed is greater than or equal to 0 ElapsedTime equals 0 when Speed is less than 0
virtual void	Pause ()
	Pauses the tween.
virtual void	Resume ()
	Starts or resumes the tween.
void	Step (double delta)
	Moves the current tweening position by a custom step in seconds.
void	Step ()
	Calls Step(double) where the "double" argument is the number of seconds that Step() (with no arguments) was called. If this is the first time that Step() (with no arguments) was called since instantiation, the "double" argument will instead be the number of seconds since the tween started running.
virtual void	Dispose ()

Static Public Member Functions
static double	Lerp (double initVal, double finalVal, double frac)
	Returns a linear interpolation between an initial value and a final value for a given fraction.

Public Attributes
double	TransitionTime
	The duration of the entire tween in seconds.
Tween.TransitionType	TransitionType
	The transition type (parent function that will be doing the easing) as defined in Godot's Tween.TransitionType
Tween.EaseType	EaseType
	The easing type This controls how the tween speeds up and slows down over time. See Godot's documentation for Tween.EaseType for more details.
double	InitialValue = 0
	The initial value of the tween.
double	FinalValue = 0
	The final value of the tween.
float	Speed = 1
	The speed of the tweening where 1 represents normal speed, 0 represents freezing, and -1 represents backwards at normal speed.

Protected Member Functions
void	RaiseOnStep (float frac)
void	RaiseOnResume ()
void	RaiseOnPause ()
void	RaiseOnFinish ()

Properties
virtual bool	IsPlaying [get, protected set]
	Whether or not the tween is current playing/running.
float	CurrentFraction [get]
	The current fraction of the tween that has been completed so far, typically in the range of [0, 1].
double	ElapsedTime [get]
	The elapsed time that the tween has been running in seconds. This speed at which this value changes is affected by Speed

Events
EventHandler< float >	OnStep
	Event that gets raised on each step of the tween until the animation pauses or finishes. The float argument of the event is the current fraction of the tween that has been completed so far, typically in the range of [0, 1]. Example usage:
EventHandler	OnResume
	Event raised when the tween resumes playback.
EventHandler	OnPause
	Event raised when the tween is paused during playback.
EventHandler	OnFinish
	Event raised when the tween finishes playback. This event only raises when IsFinished() would return true. See IsFinished() for more details.

Detailed Description

Provides a way of tweening via Godot using method overrides.
The advantage of using this over a normal Godot Tween is that the Tween doesn't have to be in the scene tree in order to operate.
Another difference is that unlike a normal Godot Tween, this tween doesn't start automatically after being instantiated. Developers must call Resume() manually in order to get the tween running.
Syntax is inspired by JavaFX's animation package.

Member Function Documentation

GetCurrentValue()

double Jumpvalley.Tweening.MethodTween.GetCurrentValue ( )

inline

Returns the current value of the tween. This value is calculated by performing linear interpolation between InitialValue and EndingValue with the fraction between the value being CurrentFraction

Returns

said result

IsFinished()

bool Jumpvalley.Tweening.MethodTween.IsFinished ( )

inline

Returns if the tween is finished.
The tween is considered to be finished if one of the following is true:

• ElapsedTime equals TransitionTime when Speed is greater than or equal to 0
• ElapsedTime equals 0 when Speed is less than 0

Returns

If the tween is finished

Lerp()

static double Jumpvalley.Tweening.MethodTween.Lerp ( double initVal, double finalVal, double frac )

inlinestatic

Returns a linear interpolation between an initial value and a final value for a given fraction.

Parameters

initVal	The initial value
finalVal	The final value
frac	The fraction of the interpolation, typically in the range of [0, 1].

Returns

Step()

void Jumpvalley.Tweening.MethodTween.Step ( double delta )

inline

Moves the current tweening position by a custom step in seconds.

Parameters

delta

The time in seconds to increment elapsed time in.

Event Documentation

OnStep

EventHandler<float> Jumpvalley.Tweening.MethodTween.OnStep

Event that gets raised on each step of the tween until the animation pauses or finishes.
The float argument of the event is the current fraction of the tween that has been completed so far, typically in the range of [0, 1].
Example usage:

MethodTween t = new MethodTween();

public void HandleTweenStep(object sender, float frac) { Console.WriteLine($"The current fraction of the tween is {frac}"); }

public void ConnectToTweenStep() { t.OnStep += HandleTweenStep; }

---

The documentation for this class was generated from the following file:

• MethodTween.cs