Tweener< T > Class Template Reference

The main tweening class. More...

Inheritance diagram for Tweener< T >:

Collaboration diagram for Tweener< T >:

Public Member Functions
	Tweener ()
	Creats a new tweener instance. More...
void	Dispose ()
	Disposes the tweener object. More...
void	Start (T tweenTo)
	Start a tween action. More...
void	Start (T tweenTo, float duration)
	Start a tween action. More...
void	Start (T tweenTo, float duration, float delay, Easing easing)
	Start a tween action. More...
void	Stop ()
	Stop any currently running tween action. More...

Properties
T	currentValue [get, set]
	Gets the current value. More...
float	delay [get, set]
	Gets or sets the delay before performing the tween action. More...
float	duration [get, set]
	Gets or sets the duration of the tween action. More...
Easing	easing [get, set]
	Gets or sets the easing of the tween action. More...
T	end [get, set]
	Gets or sets the final tween value. More...
bool	hasEnded [get]
	Gets a value indicating whether the current tween action has ended. More...
bool	hasStarted [get]
	Gets a value indicating whether the current tween action has started. More...
bool	isDisposed [get]
	Gets a value indicating whether this tweener has been disposed. More...
bool	isEnabled [get]
	Gets a value indicating whether this tweener is enabled. More...
System.Action	onTween
	Occurs every frame while an object is tweening. More...
T	start [get, set]
	Gets or sets the initial tween value. More...
float	startTime [get]
	Gets the start time for the tween action. Returns -1 when stopped. More...

Detailed Description

The main tweening class.

Provides tween support (with easing) for the following types:

• float
• Vector2
• Vector3
• Vector4
• Color
• Color32

Tween updates are independent of the current time scale.

Type Constraints

T

:

struct

Constructor & Destructor Documentation

Tweener ( )

inline

Creats a new tweener instance.

Member Function Documentation

void Dispose ( )

inline

Disposes the tweener object.

Here is the caller graph for this function:

void Start ( T  tweenTo )

inline

Start a tween action.

Parameters

tweenTo

The value to tween to.

Here is the caller graph for this function:

void Start ( T  tweenTo, float  duration  )

inline

Start a tween action.

Parameters

tweenTo	The value to tween to.
duration	The duration of the tween action.

void Start ( T  tweenTo, float  duration, float  delay, Easing  easing  )

inline

Start a tween action.

Parameters

tweenTo	The value to tween to.
duration	The duration of the tween action.
delay	The delay before starting the tween action.
easing	The easing of the tween action.

void Stop ( )

inline

Stop any currently running tween action.

Here is the caller graph for this function:

Property Documentation

T currentValue

getset

Gets the current value.

float delay

getset

Gets or sets the delay before performing the tween action.

float duration

getset

Gets or sets the duration of the tween action.

Easing easing

getset

Gets or sets the easing of the tween action.

T end

getset

Gets or sets the final tween value.

bool hasEnded

get

Gets a value indicating whether the current tween action has ended.

bool hasStarted

get

Gets a value indicating whether the current tween action has started.

bool isDisposed

get

Gets a value indicating whether this tweener has been disposed.

bool isEnabled

get

Gets a value indicating whether this tweener is enabled.

System.Action onTween

addremove

Occurs every frame while an object is tweening.

T start

getset

Gets or sets the initial tween value.

float startTime

get

Gets the start time for the tween action. Returns -1 when stopped.