TweenVar Class Reference

A special class used to setup a "virtual" tween, which will not actually be tweened nor updated, but will just set and return a value when you call Update. More...

List of all members.

Public Member Functions
	TweenVar (float p_startVal, float p_endVal, float p_duration)
	Creates a new TweenVar instance using Linear ease.
	TweenVar (float p_startVal, float p_endVal, float p_duration, EaseType p_easeType)
	Creates a new TweenVar instance.
float	Update (float p_elapsed)
	Sets and returns the value at which this TweenVar would be after the given absolute time.
float	Update (float p_elapsed, bool p_relative)
	Sets and returns the value at which this TweenVar would be after the given time.
Public Attributes
float	duration
	Virtual duration (you could also set it to 1 or 100 to treat it as a percentage).
Properties
float	startVal [get, set]
	Start value (FROM).
float	endVal [get, set]
	End value (TO).
EaseType	easeType [get, set]
	Ease type.
float	value [get]
	The current value of this TweenVar
float	elapsed [get]
	The current elapsed time.

---

Detailed Description

A special class used to setup a "virtual" tween, which will not actually be tweened nor updated, but will just set and return a value when you call Update.

---

Constructor & Destructor Documentation

TweenVar	(	float	p_startVal,
		float	p_endVal,
		float	p_duration
	)

Creates a new TweenVar instance using Linear ease.

Parameters:

p_startVal	Start value (FROM).
p_endVal	End value (TO).
p_duration	Virtual duration. (you could also set it to 1 or 100 to treat it as a percentage).

TweenVar	(	float	p_startVal,
		float	p_endVal,
		float	p_duration,
		EaseType	p_easeType
	)

Creates a new TweenVar instance.

Parameters:

p_startVal	Start value (FROM).
p_endVal	End value (TO).
p_duration	Virtual duration. (you could also set it to 1 or 100 to treat it as a percentage).
p_easeType	Ease type.

---

Member Function Documentation

float Update

(

float

p_elapsed

)

Sets and returns the value at which this TweenVar would be after the given absolute time.

Parameters:

p_elapsed

The elapsed time to calculate.

float Update	(	float	p_elapsed,
		bool	p_relative
	)

Sets and returns the value at which this TweenVar would be after the given time.

Parameters:

p_elapsed	The elapsed time to calculate.
p_relative	If true consideres p_elapsed as relative, meaning it will be added to the previous elapsed time, otherwise it is considered absolute.

---

Member Data Documentation

float duration

Virtual duration (you could also set it to 1 or 100 to treat it as a percentage).

---

Property Documentation

EaseType easeType [get, set]

Ease type.

float elapsed [get]

The current elapsed time.

float endVal [get, set]

End value (TO).

float startVal [get, set]

Start value (FROM).

float value [get]

The current value of this TweenVar